Documentation & Testing

This page lists the milestone requirements for Milestone 2 of the CC 410 Restaurant Project. Read the requirements carefully and discuss any questions with the instructors or TAs.

Purpose

The CC 410 Restaurant Project project for this semester is centered around building a point of sale (POS) system for a fictional restaurant named Game Grub, offering food of all kinds to celebrate our love of games of all kinds.

The second milestone involves writing documentation and unit tests for our existing code base. Our goal is to adequately test each part of our code via unit tests, reaching 100% code coverage at a minimum. In addition, we’ll add all of the required documentation comments in our existing code.

General Requirements

This milestone must follow these professional coding standards:

• All code must be object-oriented.
  • All executable code must be within a class
    • Python package files such as __init__.py and __main__.py are exempt.
  • Classes must be organized into packages based on common usage.
• This project must include automation for compilation, unit testing, documentation generation, and execution.
  • Java: Use Gradle with the application plugin. The project should compile without errors. You may include a main class in a separate package for testing purposes only.
  • Python: Use tox configured to use Python 3.10 and a requirements file to install libraries. You may include a main class in a separate package for testing purposes only.
• All code must properly compile or be interpreted.
  • Java: It must compile using Gradle.
  • Python: It must be interpreted using Python 3.10. Where specified, type hints should be included in the code, and all code should pass a strict Mypy type check.
• Where specified, code should contain appropriate unit tests that achieve the specified level of code coverage.
  • Java: Use JUnit 5. You may choose to use Hamcrest for assertions.
  • Python: Use pytest. You may choose to use Hamcrest for assertions.
• Where specified, code should contain appropriate documentation comments following the language’s style guide.
  • Java: Use javadoc to generate documentation.
  • Python: Use pdoc3 to generate documentation.
• Submissions to Canvas should be tagged GitHub releases that are numbered according to Semantic Versioning.

Assignment Requirements

This milestone should include the following features:

Data Types

• Each Entree, Side, and Drink class should contain complete typing information.
  • Java - this is already handled by the compiler, so no changes are needed.
  • Python - the code should contain complete type annotations and achieve low imprecision percentage in Mypy using strict type checking.

Unit Tests

• Each Entree, Side, and Drink class should have a corresponding class of unit tests that achieve 100% code coverage and adequately test all features of those classes.
  • See the discussion below for more information on unit tests to be included.
  • Each unit test should be in a matching package in the test directory for the class it is testing.
  • Python - unit tests do not require type annotations.
  • Where possible, use parameterized unit tests to reduce the number of individual tests written.
  • You may use any form of assertions, including the Hamcrest library.

Documentation

• Each Entree, Side, Drink, and Enumeration class should have all required documentation comments.
  • Every method must be documented, including parameters and return values.
  • Checkstyle/Flake8 should not give any errors related to documentation in the src directory.
  • You are encouraged, but not required, to create documentation comments for unit tests.
  • You should be able to generate documentation using javadoc/pdoc3 as shown in the “Hello Real World” project.
  • You will be graded on the content of the comments - make sure they are descriptive and succinct, with the appropriate sections/tags.

UML Class Diagram

• Create a UML Class Diagram representing the structure of this program.
  • Store the UML diagram as an image file (PNG preferred).
  • Place the image in the root of the project directory (directly inside the java or python folder).
  • Make sure it is committed to GitHub and included in your project release.
  • You may include additional materials, such as the source file used to create the image.

Time Requirements

Completing this project is estimated to require 3-8 hours.

Grading Rubric

This assignment will be graded based on the rubric below:

• Unit Tests - 60%
  • Entree Classes - 30%
  • Side Classes - 10%
  • Drink Classes - 20%
• Documentation Comments - 30%
  • Entrees Classes - 8%
  • Side Classes - 8%
  • Drink Classes - 8%
  • Enumeration Classes - 6%
• UML Class Diagram - 10%

The following deductions apply:

• Any portion of the project which will not compile (Java), pass a strict type check (Python), or execute properly will be given a grade of 0.
• Any portion of the project which does not meet the general requirements listed above will have a commensurate amount of points deducted.

This is not an exhaustive list of possible deductions. The instructors will strive to provide reasonable and fair grading, but we can’t predict all possible defects. It is up to the student to ensure that the project is complete and correct before submission.

Submission

Submit this assignment by creating a release on GitHub and uploading the release URL to the assignment on Canvas. You should not submit this Codio project or mark it as complete in Codio, in case you need to come back to it and make changes later.

Unit Tests

Entree

Each test class should contain unit tests for the following (this is not an exhaustive list, but should get close to 100% coverage):

• When a new object is created:
  • The instructions list should be empty
  • The default base should be set correctly
  • The toppings should be set correctly
  • The calories should be set correctly
• For every base option:
  • The price should be set correctly, including any surcharges for base types.
  • The string representation of the item should be correct
• For every ingredient
  • Each ingredient should be included by default
  • Adding or removing an ingredient adds or removes an item in the instructions list
• For every topping:
  • If the topping is included by default, it should be in the toppings list on a new object
  • Adding or removing an topping makes the correct modification to the toppings list
• Equality tests:
  • Two instances of the same object are equal
  • Two instances with different bases are not equal
  • Two instances with different ingredients are not equal
  • Two instances with different toppings are not equal
  • An instance of another object is not equal to an instance of this object (should not cause an exception)
• Other tests:
  • Changing multiple ingredients should add or remove multiple items in the instructions list

Sides

Each test class should contain unit tests for the following (this is not an exhaustive list, but should get close to 100% coverage):

• When a new object is created:
  • The default size should be set correctly
• For every size option:
  • The price should be set correctly
  • The calories should be set correctly
  • The string representation of the item should be correct
• Equality tests:
  • Two instances of the same object are equal
  • Two instances with different sizes are not equal
  • An instance of another object is not equal to an instance of this object (should not cause an exception)

Drinks

Each test class should contain unit tests for the following (this is not an exhaustive list, but should get close to 100% coverage):

• When a new object is created:
  • The instructions list should be empty
  • The default size should be set correctly
• For every size option:
  • The price should be set correctly
  • The calories should be set correctly
  • The string representation of the item should be correct
• For every flavor
  • Default flavors should be included by default, others should not be included by default
  • Adding or removing a flavor adds or removes an item in the instructions list
• Equality tests:
  • Two instances of the same object are equal
  • Two instances with different sizes are not equal
  • Two instances with different flavors are not equal
  • An instance of another object is not equal to an instance of this object (should not cause an exception)
• Other tests:
  • Changing multiple flavors should add or remove multiple items in the instructions list