CSC 217 Lab 03: Deployment

When you deploy your software, you release it to your customer. For CSC 217, that means your work is ready for evaluation by the teaching staff. We will evaluate your work against the Lab 03 rubric. As you compare your submission against the rubric and make your final push to GitHub, you will complete these final tasks:

You have met the requirements and design for the Lab 03 PackScheduler project.
You have a green ball on your lab section’s Jenkins (No test failures and no static analysis notifications).
All student unit tests pass with a green bar (0 errors).
At least 80% statement coverage on Student, StudentRecordIO, and StudentDirectory. (Note you may have a green ball on Jenkins and lose points here. When grading, we look at each class individually. Jenkins gives a green ball for average of 80% statement coverage at the project level! A green ball for coverage does NOT mean full credit for coverage!)
All teaching staff JUnit tests pass with a green bar (0 errors).
You have run system level black box tests on your submission and reported actual results of execution.
There are no SpotBugs notifications.
There are no PMD notifications.
There are no CheckStyle notifications.
All code is commented with meaningful comments.
Javadoc webpages are generated with the latest comments.
That you meet all rubric items for the assignment.

Make sure that you push all code and other required artifacts to GitHub by the assignment deadline. Check your Jenkins results on your lab’s Jenkins server Lab assignments will not be accepted late!

Generate Javadoc

Commenting your code is important! Comments describe what the code is supposed to do. At a minimum, you should comment your classes, fields, and methods. All methods should be Javadoc-ed, including methods that were automatically generated by Eclipse. When working with CSC 216 projects, you should delete any automatically generated non-Javadoc documentation and replace it with Javadoc appropriate for the overridden method.

Java provides the Javadoc tool to generate a set of web pages that display the comments for your code.

Reminder: Generating Javadoc

To generate Javadoc, you need to configure and run the Javadoc tool, fix Javadoc errors and warnings, and check the generated Javadoc pages. Make sure you push your changes to GitHub!

Lab Checks

There are several checks that will occur during your build to ensure that you’re following software engineering best practices:

Library checks: For Lab 03, you’ll be working with the SortedList class that is part of the CSC216Collections library. All of your references to ArrayList MUST be removed from your project - including the Javadoc. If you receive a red ball and a message in the console output about using ArrayList search your project for the string and regenerate your Javadoc!
Coverage checks: You must have 80% coverage for each non-GUI and non-test class in PackScheduler. A tool will check that you have passed the 80% threshold before running any of the teaching tests.

Removing References to `ArrayList`

Now that we’re using the SortedList library, all references to java.util.ArrayList should be removed from your PackScheduler system. Automated grading on Jenkins will be checking that there are no references to java.util.ArrayList in your project. This is a global check, and will consider ALL files in your project! If a reference to java.util.ArrayList is found, Jenkins will fail the build and not run the teaching staff tests.

So where should you look to remove references to ArrayList?

Import statements in all classes
Source Javadoc that has a link to java.util.ArrayList
Generated Javadoc that references java.util.ArrayList

Finding and removing a reference to java.util.ArrayList in your generated Javadoc can be tedious. The easiest way to remove any reference to java.util.ArrayList in generated Javadoc is to:

Remove references to java.util.ArrayList in your source code.
Delete your doc/ folder
Regenerate your Javadoc on your updated code.

We want to purge your code of references to java.util.ArrayList now because from this point on, you’re no longer allowed to use the Java Collections Framework in your code! One of the learning outcomes in CSC216 is to implement and test your own linear data structures. Future labs will cover writing your own ArrayList and LinkedList, which will then be used in PackScheduler rather than any Java Collections Framework classes!

Lab Deadlines & Jenkins Servers

All labs are due 10 minutes before the start of the next lab. Additionally, each lab section has their own dedicated lab Jenkins server. The table below provides the deadline and server URL for each lab section for the current semester.

Lab Section	Deadline	Jenkins Server Link
Section 201	2/14/2022 10:30am	https://csc217-201-jenk.csc.ncsu.edu/jenkins/
Section 202	2/14/2022 12:40pm	https://csc217-202-jenk.csc.ncsu.edu/jenkins/
Section 203	2/14/2022 2:50pm	https://csc217-203-jenk.csc.ncsu.edu/jenkins/
Section 204	2/14/2022 5:10pm	https://csc217-204-jenk.csc.ncsu.edu/jenkins/
Section 211	2/15/2022 8:20am	https://csc217-211-jenk.csc.ncsu.edu/jenkins/
Section 213	2/15/2022 2:50pm	https://csc217-213-jenk.csc.ncsu.edu/jenkins/
Section 214	2/15/2022 5:10pm	https://csc217-214-jenk.csc.ncsu.edu/jenkins/
Section 222	2/16/2022 12:40pm	https://csc217-222-jenk.csc.ncsu.edu/jenkins/
Section 223	2/16/2022 2:50pm	https://csc217-223-jenk.csc.ncsu.edu/jenkins/
Section 231	2/15/2022 11:45pm	https://csc217-231-jenk.csc.ncsu.edu/jenkins/
Section 601	2/15/2022 11:45pm	https://csc217-601-jenk.csc.ncsu.edu/jenkins/

Lab Rubric

You will be evaluated out of 70 points in the Technical Rubric. Synchronous students will also be evaluated on their teaming: a combination of In-Lab Participation and Out-Lab Participation. Collaborating Asynchronous students will also be evaluated on their participation in their pair.

Pair/teams are expected to work together on all aspects of the lab activity. Points may be deducted for not contributing or for not providing a partner the opportunity to contribute. The teaching staff strongly encourages working synchronously and requires that these collaborative sessions are documented in GitHub commit messages for the teaching staff to note the team contribution.

Technical Rubric

Grade Item	Points	Details
Teaching Staff Unit Tests	15	Pass all of the teaching staff unit tests (no regressions), both provided and hidden.
Student Unit Tests	15	Pass all of your unit tests.
Student Test Coverage	15	80% statement/line coverage on Student, StudentRecordIO, and StudentDirectory
Teaching Staff System Tests	10	Pass all of the teaching staff system tests (note that they will not be provided).
Javadoc Comments	5	All classes, including the tests are commented with meaningful comments.
Javadoc Generation	5	Javadoc tool was used to generate the HTML version of the API, which matches the current version of the in-code Javadoc.
Style	5	Any PMD, CheckStyle, or SpotBugs Scary or Scariest notifications will result in a one point deduction, up to the available points.
Total Points	70

Synchronous Collaboration Rubric

Grade Item	Points	Details
In-Lab Collaboration	10	PTFs will be looking for collaboration with your partner during lab activities. Did you participate in completing the lab assignment? Did you balance your roles of driver and navigator? There will be deductions for observations of non-participation or hogging of one role or the other so a partner cannot participate.
Out-Lab Collaboration	10	Did you make at least one meaningful commit to GitHub for completing the lab (e.g., meaningful means that the commit has to contribute to the solution and isn't superficial)? If you pair programmed, is it noted in the commit message? Did you not allow your partner, who wanted to contribute, to commit?
Tasks	5	Did you add your tasks for the lab to the top of the README file? Did you include owners? Did you include internal deadlines? Are the tasks shown as complete with any other needed updates (e.g., the person who completed or helped with the task changed)
Collaboration Check-in	5	Did you complete the collaboration check-in on time?

Asynchronous Collaboration Rubric

Grade Item	Points	Details
Collaboration	10	Did you make at least one meaningful commit to GitHub for completing the lab (e.g., meaningful means that the commit has to contribute to the solution and isn't superficial)? If you pair programmed, is it noted in the commit message? Did you not allow your partner, who wanted to contribute, to commit?
Tasks	5	Did you add your tasks for the lab to the top of the README file? Did you include owners? Did you include internal deadlines? Are the tasks shown as complete with any other needed updates (e.g., the person who completed or helped with the task changed)
Collaboration Check-in	5	Did you complete the collaboration check-in on time?

Deductions

Grade Item	Points	Details
Misnamed file or incorrect project structure	-5	Incorrect names of files or incorrect project structure. This can include problems when importing the project to Eclipse for acceptance testing, incorrect location of the system test file, incorrect file extension, etc.
Other deductions	-5	If the project has to be manually graded due, you will receive a 5 point deduction. Make sure that your project builds on Jenkins!

Push to GitHub

Finalize your submission by pushing all of your code and other project artifacts to GitHub

Ensure all classes and methods are fully commented and your Javadoc pages are up to date.
Add the unstaged changes to the index.
Commit and push changes. Remember to use a meaningful commit message describing how you have changed the code.

Reminder: Staging and Pushing to GitHub

GitHub Resources:

Check Jenkins

Ensure that your Jenkins job is reflecting the results that you expect for the level of completion of your lab assignment.

Reminder: Interpreting Jenkins

Check the following items on Jenkins for your last build and use the results to estimate your grade:

CSC 217 Lab 03 - Testing

CSC 217 Lab 03 - Collections