Documenting Meaningful Test Suites

Include title information: A title for the assignment, your name, the date, and the course code (e.g., SWE3720).

Provide a link to a file with a suite of tests you wrote that is available on the main branch.  (This means that you must perform a merge to main with at least that test if it is not already on the main branch.)

Write your report in a tool such as Word that allows "save as PDF" to produce a PDF with a working link.  Having the link work in the resulting PDF could have significant weght within this assignment.

State that you wrote all tests in that file, or name each test that you wrote.

Select one test that you hoped would find a bug. Include the test itself in your report.

Describe the sort of error that you hoped to find with the test.  If your test caught an error, describe how the error captures was what you expected, and any differences there were from what you expected when you wrote the test.  If you have written more than one test, it is strongly preferred that you write about your experience in actually catching a bug.

If you have already written a test that caught a bug, you can write about that test suite and experience. If you have not yet written a test that caught a bug, please plan to write a test suite or extend a suite with new tests that have the potential to catch a bug.

If practical, also include the corrected piece of code that has been fixed after having been identified as a problem spot by the test.

Upload your PDF to this assignment. Note: This assignment is due at the START of our first lab of the week, while the R & R is due at the end.