Analysis and Design
Overview
This is an individual assignment that requires you to document, test and refactor an existing application.
Learning Outcomes Assessed
The following course learning outcomes are assessed by completing this assessment:
- S1. Apply software design principles to design and document software that utilises design patterns
- S2. Analyse source code and develop comprehensive unit test suites
- S3. Operate CASE software to document the design of a piece of software
- S4. Apply refactoring to identify poor programming practice in existing source code and improve its structure and readability
- S5. Apply an appropriate software development methodology to the development of a software system
Assessment Details
You are required to document, test and refactor an existing application.
You will be given a copy of an existing C# application which is responsible for managing pet adoptions for an animal rescue organisation. This application is badly in need of refactoring and even a casual viewing of the source code reveals many examples of the "code smells" talked about in Fowler's book.
The base application consists of five classes: AdoptAPet, Shelter, Animal, Adoption and Client. Clients are able to adopt animals based on availability and choice of animal type.
Assignment Requirements
Step 1 - Rename the base code
1. Download the code from Moodle and unzip it in the filesystem
2. Rename the base folder to "Assignment 1 - yourid" (your id equals your student number)
3. Open the solution up in Visual Studio right click on the Solution and rename it as per (2)
4. Build the solution and inspect the output. Spend some time becoming familiar with the code before you do anything else.
Step 2 - Identify "code smells"
Open up a new document in Word (or equivalent), start documenting any code smells you identify in the code in point form. You might want to cut and paste the code into Word to illustrate the problems.
Step 3 - Create a class diagram of the initial code.
Do this in Enterprise Architect and copy the resultant diagram into your Word file. Ensure your EA file is saved and labelled as "starting code base".
Step 4 - Refactor and unit test code
Ensure that your starting code and EA file is backed up. Once this is done, commence refactoring the code in Visual Studio. Document each change you make and provide an explanation of why you have done so.
Your final code should be fully refactored and have unit tests developed for every method (other than any ToString and Get and Set methods). These unit tests should be documented to demonstrate the results before and after the changes to confirm that the functionality of the code has not changed.
Step 5 - Create diagrams of the final code.
Do this in Enterprise Architect and copy the resultant diagram into your Word file. Create a class diagram of the final code, and a sequence diagram showing how a new adoption request is processed in the final code. Ensure your EA file is saved and labelled as "final code base".
Attachment:- Assignment.rar