Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sort test cases and effort in developer guide #197

Merged
merged 4 commits into from
Apr 14, 2024
Merged

Add sort test cases and effort in developer guide #197

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93c4314
Add sort test cases and effort in developer guide
solomonng2001 Apr 14, 2024
4a449ac
Fix merge conflicts
solomonng2001 Apr 14, 2024
c9a24c8
Add sort use case
solomonng2001 Apr 14, 2024
c5dab03
Add extensions to sort use case
solomonng2001 Apr 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 76 additions & 3 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Steps 1a1-1a3 are repeated until the data entered are correct.<br>
Use case resumes at step 2.


**Use case: UC05 - View client details and policies**

**MSS**
Expand All @@ -626,7 +627,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Use case ends.



**Use case: UC06 - Find a client by name**

**MSS**
Expand All @@ -647,6 +647,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1b1. ClientCare lets user know that the list is empty.<br>
Use case ends.


**Use case: UC07 - Adding notes to a client**

**MSS**
Expand Down Expand Up @@ -688,12 +689,25 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Steps 1a1-1a3 are repeated until the data entered are correct.<br>
Use case resumes at step 2.


**Use case: UC09 - Sort clients**

**MSS**
1. PLACEHOLDER
1. User requests to sort clients by `CRITERIA` and `ORDER`.
2. ClientCare sorts the clients by the specified criteria and order.
3. ClientCare shows a success message to the user.<br>
Use case ends.

**Extensions**
* 1a. ClientCare detects that the given command is invalid.
* 1a1. ClientCare shows an error message.
Use case ends.
* 1b. ClientCare detects that the given `CRITERIA` is invalid.
* 1b1. ClientCare shows an error message.
Use case ends.
* 1c. ClientCare detects that the given `ORDER` is invalid.
* 1c1. ClientCare shows an error message.
Use case ends.


**Use case: UC10 - Update client as met**
Expand All @@ -717,6 +731,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1c1. ClientCare shows an error message.<br>
Use case ends.


**Use case: UC11 - Update last met overdue duration**

**MSS**
Expand All @@ -735,7 +750,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1b. ClientCare detects that the given input entered is not a non-negative integer.
* 1b1. ClientCare shows an error message.<br>
Use case ends.



**Use case: UC12 - Schedule an appointment with client**

**MSS**
Expand Down Expand Up @@ -781,6 +797,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1c1. ClientCare shows an error message.<br>
Use case ends.


**Use case: UC14 - Add policies to client**

**MSS**
Expand All @@ -803,6 +820,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1c1. ClientCare shows an error message.<br>
Use case ends.


**Use case: UC15 - Delete policies from client**

**MSS**
Expand All @@ -825,6 +843,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1c1. ClientCare shows an error message.<br>
Use case ends.


### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
Expand Down Expand Up @@ -1041,6 +1060,54 @@ testers are expected to do more *exploratory* testing.

### Sorting clients

1. Sorting clients by priority

1. Prerequisites: Multiple clients in the client list.

2. Test case (valid descending): `sort priority o/desc`<br>
Expected: Clients are sorted by priority in descending order. Success message shown in the status message.

3. Test case (valid ascending): `sort priority o/asc`<br>
Expected: Clients are sorted by priority in ascending order. Success message shown in the status message.

4. Test case (invalid order): `sort priority o/invalid`<br>
Expected: Clients are not sorted. Error message shown in the status message.

5. Test case (invalid criteria): `sort invalid o/asc`<br>
Expected: Similar to previous.

2. Sorting clients by name

1. Prerequisites: Multiple clients in the client list.

2. Test case (valid ascending): `sort name o/asc`<br>
Expected: Clients are sorted by name in ascending order. Success message shown in the status message.

3. Test case (valid descending): `sort name o/desc`<br>
Expected: Clients are sorted by name in descending order. Success message shown in the status message.

4. Test case (invalid order): `sort name o/invalid`<br>
Expected: Clients are not sorted. Error message shown in the status message.

5. Test case (invalid criteria): `sort invalid o/asc`<br>
Expected: Similar to previous.

3. Sorting clients by birthday

1. Prerequisites: Multiple clients in the client list.

2. Test case (valid ascending): `sort birthday o/asc`<br>
Expected: Clients are sorted by birthday in ascending order. Success message shown in the status message.

3. Test case (valid descending): `sort birthday o/desc`<br>
Expected: Clients are sorted by birthday in descending order. Success message shown in the status message.

4. Test case (invalid order): `sort birthday o/invalid`<br>
Expected: Clients are not sorted. Error message shown in the status message.

5. Test case (invalid criteria): `sort invalid o/asc`<br>
Expected: Similar to previous.

### Updating last met

1. Updating the last met of a client while all clients are being shown
Expand Down Expand Up @@ -1292,6 +1359,12 @@ Additional testing was needed to ensure that the policies are saved correctly an
As to keep the `Person` object immutable, we had to create a new `Person` object with the updated policy list when adding or deleting a policy. This made testing for the `addpolicy` and `deletepolicy` commands more difficult as the `addressbook` object prevents us from directly updating the `Person` object. Thus, more methods have to be implemented in `ModelManger` class to enable proper updating of the expected `AddressBook` object when testing.

**3. Additional Client Traits and Features**<br>
Difficulty Level: 3/5<br>
Effort Required: 3/5<br>
Challenges faced: When implementing sorting of clients, the challenge was understanding the design principles behind how `ModelManager#filteredPersons` was implemented in AB3. Since this is an iterative project, we had to ensure that the principles were consistent.
For instance, we recognised that `ModelManager#filteredPersons` was an immutable list, and thus our initial implementation of removing the `final` keyword from the `filteredPersons` field was incorrect and broke the design principles. We had to revert this change and design an alternative solution that adhered to the design principles.
This took some time to understand and implement correctly. `Birthday` and `Priority` are extensions of the `Person` model and required classes of their own. `DateUtil` and `DateTimeUtil` classes were additionally created to handle dates and times, which was used widely, and thus had to be well-designed to ensure utility and prevent bugs.
Testing for most features were very extensive, with multiple edge cases and invalid inputs. Quality of design was ensured and priorities over shortcut alternatives. For instance, data structures like `HashMap` was utilised to map string inputs to `PriorityValue` enums. All these quality design required time and effort.

**4. GUI**<br>
Difficulty Level: 3/5<br>
Expand Down
Loading