CSC 217 Lab 05 - Inspection & Debugging

CSC 217 Lab 05 - Inspection & Debugging

CSC 217 Lab 05 - Inspection & Debugging

In the last lab, you integrated the idea of Courses from WolfScheduler into PackScheduler. Now that we have the idea of both Students and Courses in PackScheduler, we need to add in a new type of user - a registrar! A registrar is someone who can work with both the StudentDirectory and CourseCatalog to ensure that the correct students and courses are in the system for registration. As part of this lab, you’ll create a new inheritance hierarchy for Users. Additionally, you’ll receive some code from a colleague elsewhere in the organization. The code provides functionality for a new RegistrationManager class that introduces some new concepts (i.e, the Singleton pattern, inner classes, and properties files). However, the colleague isn’t working on your project, so their code won’t fully integrate into the PackScheduler system without some work. You’ll inspect the code to identify problems. Additionally, you’ll write test cases to exercise that failing code and for use in debugging.

Learning Outcomes

  • Create a class hierarchy for users.
  • Inspect a code for potential problems against a set of requirements.
  • Write tests and debug code written by another person.

Lab Checks

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

  • Library checks: You’ll be working with the SortedList class that is part of the CSC217Collections library. You must remove all of your references to ArrayList 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.

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/28/2022 10:30am https://csc217-201-jenk.csc.ncsu.edu/jenkins/
Section 202 2/28/2022 12:40pm https://csc217-202-jenk.csc.ncsu.edu/jenkins/
Section 203 2/28/2022 2:50pm https://csc217-203-jenk.csc.ncsu.edu/jenkins/
Section 204 2/28/2022 5:10pm https://csc217-204-jenk.csc.ncsu.edu/jenkins/
Section 211 3/1/2022 8:20am https://csc217-211-jenk.csc.ncsu.edu/jenkins/
Section 213 3/1/2022 2:50pm https://csc217-213-jenk.csc.ncsu.edu/jenkins/
Section 214 3/1/2022 5:10pm https://csc217-214-jenk.csc.ncsu.edu/jenkins/
Section 222 3/2/2022 12:40pm https://csc217-222-jenk.csc.ncsu.edu/jenkins/
Section 223 3/2/2022 2:50pm https://csc217-223-jenk.csc.ncsu.edu/jenkins/
Section 231 3/1/2022 11:45pm https://csc217-231-jenk.csc.ncsu.edu/jenkins/
Section 601 3/1/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

Phase 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 every non-UI/non-test class.
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!