CPSC 480-020 Software Engineering (SE) Fall 2023

Week 11 Class 20 Tue Nov 14 Posted: Nov 14

Announcements

• Project 3 I posted the following for the first commit on Project 3:

  • Report.md in your repository
  • Exercise 46: Code Analysis TDD First Pass in Brightspace

  In Brightspace are the scores and feedback. Also take a look at the generated report in your repository.

  At this point, all students are allowed to move on from the first commit.

• Project 3 Progress

• Project 3 Overall Feedback

  • Commit Message Focus When composing commit messages, avoid merely stating that a test is included. Instead, emphasize the additional features it supports.
  • Regression Testing and Test Preservation Always retain existing tests. Your work involves adding new tests, not replacing old ones. Familiarize yourself with the concept of regression testing.
  • Adherence to Provided Tests Do not modify the tests that are provided to you.
  • Refactoring Discipline Refactor your code in every commit. Almost every rule can be added with only one additional simple condition.
  • Use of Realistic Test Data When examples are provided, incorporate them into your test cases.
  • Indentation and Flow of Control Pay special attention to indentation, ensuring it aligns with the flow of control in your code. If unfamiliar with this concept, it is crucial to review and understand it thoroughly. Indentation should be consistent and reflective of the code's structure. Indentation should be uniform and follow a standard multiple (like 2, 4, or 8 spaces) throughout your code. Avoid mixing tabs and spaces.
  • Syntax and Formatting Remember that keywords are not function calls. Therefore, maintain the correct syntax, such as using if () instead of if().
  • Code Structuring Separate each test and its optional comment with a single blank line. Avoid multiple blank lines in your code.
  • Final Return Statement The final return statement in your test program should not be part of the last block, because it is not part of the last block.
  • Consistency with Existing Coding Style It’s crucial to adhere to the coding style already present in the code.

Class

• Project Coding Standards

  If you do not follow a project's coding standard, whether explicitly defined or implicit in the code, you will not be viewed favorably by the other developers.

• Exercise 47: Coding Standards Crossword
• HFSD Chapter 10
• Exercise 48: HFSD Chapter 10 Crossword

• Exercise 49: Team DIP & Mock Objects II

  Your notes must be uploaded by the end of class time to receive credit. All commits are due by 3:30 pm on Wednesday, Nov 15.

  A couple of notes about this exercise and real development

  • You would not have 3 branches, main, dip, and mock, and duplicate the tests on all of them. You would choose a method, e.g., mock, and use that one. We did our work on three branches so you could compare the techniques.
  • The commit messages would not mention the techniques you used to implement the tests, e.g., the "using DIP" and "using mock objects". We did that to tell the difference between the commits for the three techniques. The actual commit messages would be similar to the ones we used on the main branch.

Unless stated otherwise, all exercises are due by 3:30 pm on Wed Nov 15