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

[DG] updated manual testing instructions #289

Merged
merged 3 commits into from
Nov 8, 2020
Merged

[DG] updated manual testing instructions #289

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0004f2d
[DG] Added manual testing instructions for capcalc commands.
vanessa-kang Nov 8, 2020
8938cbb
[DG] some improvements to manual testing instructions.
vanessa-kang Nov 8, 2020
08c96f4
Merge branch 'master' into WIP_van
Khenus Nov 8, 2020
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
192 changes: 154 additions & 38 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,12 +521,14 @@ __Extensions__

- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.

- 1b1. PlanNUS shows an _invalid module code_ error message.


Use case ends.

- 3a. User enters an invalid semester.
Expand Down Expand Up @@ -569,6 +571,7 @@ __Extensions__

- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.
Expand Down Expand Up @@ -614,6 +617,7 @@ __Extensions__
- 1a. User did not specify a module code while removing a module.
- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.
Expand Down Expand Up @@ -647,7 +651,7 @@ __Extensions__
- 1a. User did not specify a module code while viewing details of a module.
- 1a1. PlanNUS shows a _missing parameter_ error message.

Use case ends.
Use case ends.

- 1b. User enters a module code that is not offered by NUS.
- 1b1. PlanNUS shows an _invalid module code_ error message.
Expand Down Expand Up @@ -932,46 +936,56 @@ Given below are instructions to test the app manually.

1. Initial launch

1. Download the jar file and copy it into an empty folder.
2. Open a command prompt and navigate to the folder.
1. Download the jar file and copy it into an empty folder.

2. Open a command prompt and navigate to the folder.

3. Enter `java -jar PlanNus.jar` and press enter to launch the app.

Expected: The PlanNUS main menu is displayed, and the save file is loaded. If a save file does not exist, a new one is created.

2. Shutdown
1. Test case: `exit`
Expected: PlanNUS saves data from the current session, prints a goodbye message, and exits the app entirely.

Expected: PlanNUS saves data from the current session, prints a goodbye message, and exits the software entirely.

<br>

**Entering and exiting the various apps**
**Entering and exiting apps**

1. Entering apps from the main menu

1. Entering the _Academic Planner_ app from the main menu
1. Test case - entering the _Academic Planner_ app.

1. Test case: `acadplan` or `a`
Input: `acadplan` or `a`

Expected: PlanNUS enters the _Academic Planner_ app.

2. Entering the _CAP Calculator_ app from the main menu
2. Test case - entering the _CAP Calculator_ app.

1. Test case: `capcalc` or `c`
Input: `capcalc` or `c`

Expected: PlanNUS enters the _CAP Calculator_ app.

3. Switching to the _CAP Calculator_ app while in the _Academic Planner_ app
2. Switching between apps

1. Test case: `capcalc`
1. Test case - switching to the _CAP Calculator_ app while in the _Academic Planner_ app.

Input: `capcalc`

Expected: PlanNUS enters the _CAP Calculator_ app.

4. Switching to the _Academic Planner_ app while in the _CAP Calculator_ app
2. Test case - Switching to the _Academic Planner_ app while in the _CAP Calculator_ app.

1. Test case: `acadplan`
Input: `acadplan`

Expected: PlanNUS enters the _Academic Planner_ app.

5. Exiting to the main menu while in either the _Academic Planner_ or _CAP Calculator_ app
3. Exiting to the main menu from within an app.

1. Test case: `exit`
1. Test case - exiting to the main menu.

Input: `exit`

Expected: PlanNUS exits to the main menu.

Expand All @@ -981,21 +995,21 @@ Given below are instructions to test the app manually.

1. Prerequisites: User is currently in the _Academic Planner_ app.

2. Test case - all inputs are valid
2. Test case - all inputs are valid.

Input: `add cs1010`
Input: `add cs2113t`

Expected: PlanNUS prompts user to enter semester that they plan to take the module.

Input: `2`
Input: `1`

Expected: PlanNUS prompts user to enter grade received for the module.

Input: `B+`
Input: `NT`

Expected: PlanNUS adds the module, with the associated semester and grade information, to the user's academic calendar. Prints a _module added_ confirmation message.

3. Test case - invalid module code
3. Test case - invalid module code.

Input: `add cs1111`

Expand All @@ -1009,35 +1023,53 @@ Given below are instructions to test the app manually.

**Editing a module currently in the academic calendar**

1. Prerequisites: User is currently in the _Academic Planner_ app.
1. Prerequisites: User is currently in the _Academic Planner_ app, and the module being edited is currently in their academic calendar.

2. Test case - all inputs are valid.
2. Test case - all inputs are valid. Feature being edited is semester.

Input: `edit cs1010`
Input: `edit cs2113t`

Expected: PlanNUS prompts user to enter number corresponding to feature to be edited (1 - semester, 2 - grade).
Expected: PlanNUS prompts user to enter number corresponding to feature to be edited.

(1 - semester, 2 - grade).

Input: `1`

Expected: PlanNUS prompts user to enter new semester value.

Input: `5`
Input: `3`

Expected: PlanNUS edits semester accordingly, and prints a _update successful_ confirmation message.

3. Other incorrect inputs to try: no module code, invalid module codes, valid module codes that are not in the user's academic calendar, invalid features, invalid semester indexes, invalid grades.
3. Test case - all inputs are valid. Feature being edited is grade.

Input: `edit cs2113t`

Expected: PlanNUS prompts user to enter number corresponding to feature to be edited.

(1 - semester, 2 - grade).

Input: `2`

Expected: PlanNUS prompts user to enter new grade.

Input: `A+`

Expected: PlanNUS edits grade accordingly, and prints a _update successful_ confirmation message.

4. Other incorrect inputs to try: no module code, invalid module codes, valid module codes that are not in the user's academic calendar, invalid features, invalid semester indexes, invalid grades.

Expected: PlanNUS shows an error message, and exits back to the _Academic Planner_ app. No module features are edited.

<br>

**Removing a module from the academic calendar**

1. Prerequisites: User is currently in the _Academic Planner_ app.
1. Prerequisites: User is currently in the _Academic Planner_ app, and the module being removed is currently in their academic calendar.

2. Test case - all inputs are valid
2. Test case - all inputs are valid.

Input: `remove cs1010`
Input: `remove cs2113t`

Expected: PlanNUS removes module from user's academic calendar, and prints a _remove successful_ confirmation message.

Expand All @@ -1053,7 +1085,7 @@ Given below are instructions to test the app manually.

2. Test case - all inputs are valid.

Input: `details cs1231`
Input: `details cs2101`

Expected: PlanNUS prints the details of the corresponding module.

Expand All @@ -1069,7 +1101,7 @@ Given below are instructions to test the app manually.

2. Test case - all inputs are valid.

Input: `search cg2`
Input: `search cs21`

Expected: PlanNUS prints the modules that contain the keyword, up to the first 10 results.

Expand All @@ -1081,13 +1113,15 @@ Given below are instructions to test the app manually.

**Viewing the academic calendar**

1. Prerequisites: User is currently in the _Academic Planner_ app.
1. Prerequisites: User is currently in the _Academic Planner_ app, and their academic calendar is currently not empty.

2. Test case - all inputs are valid
2. Test case - all inputs are valid.

Input: `view`

Expected: PlanNUS prompts user to choose a viewing timeframe - the full academic calendar, or a specific semester.
Expected: PlanNUS prompts user to choose a viewing timeframe.

(`full` - full academic calendar, `1-10` - specific semester)

Input: `full`

Expand All @@ -1099,15 +1133,97 @@ Given below are instructions to test the app manually.

<br>

**Printing help for academic calendar**
**Viewing current CAP**

1. Prerequisites: User is currently in the _Academic Planner_ app.
1. Prerequisites: User is currently in the _CAP Calculator_ app.

2. Test case - all inputs are valid.

Input: `current`

Expected: PlanNUS prints the user's current CAP, total graded MCs and total MCs taken.

<br>

**Setting a target CAP**

1. Prerequisites: User is currently in the _CAP Calculator_ app.

2. Test case - all inputs are valid.

2. Test case - all inputs are valid
Input: `set target`

Expected: PlanNUS prompts user to enter their target CAP.

Input: `4.3`

Expected: PlanNUS prompts user to enter the number of graded MCs they are taking to achieve the target cap.

Input: `50`

Expected: PlanNUS prints the minimum CAP required in order to achieve the target CAP.

3. Other incorrect inputs to try: target CAP not within `0.00-5.00` inclusive, number of graded MCs not within `1-180` inclusive.

Expected: PlanNUS shows an error message, and exits back to the _CAP Calculator_ app. No CAP advice is printed.

<br>

**Setting SU**

1. Prerequisites: User is currently in the _CAP Calculator_ app, and their academic calendar is currently not empty.

2. Test case - all inputs are valid. Set S/U by semester.

Input: `set su`

Expected: PlanNUS prompts user to enter number corresponding to S/U method

(1 - semester, 2 - modules)

Input: `1`

Expected: PlanNUS prompts user to enter semester that they wish to S/U.

Input: `1`

Expected: PlanNUS prints the current S/U list, possible S/U scenarios, and S/U advice.

3. Test case - all inputs are valid. Set S/U by modules.

Input: `set su`

Expected: PlanNUS prompts user to enter number corresponding to S/U method

(1 - semester, 2 - modules)

Input: `2`

Expected: PlanNUS prompts user to enter the number of modules that they wish to S/U.

Input: `2`

Expected: PlanNUS prompts user to enter the modules that they wish to S/U.

Input: `CS1231`, then `CS1010`

Expected: PlanNUS prints the current S/U list, possible S/U scenarios, and S/U advice.

4. Other incorrect inputs to try: invalid S/U methods, invalid semester indexes, invalid number of modules (greater than the number of modules that have been taken), invalid module codes, valid module codes that are not in the user's academic calendar.

Expected: PlanNUS shows an error message, and exits back to the _CAP Calculator_ app. No S/U advice is printed.

<br>

**Printing list of available commands**

1. Prerequisites: User is currently in the _Academic Planner_ or _CAP Calculator_ app.

2. Test case - all inputs are valid.

Input: `help`

Expected: PlanNUS prints a list of available commands in the _Academic Planner_ app.
Expected: PlanNUS prints a list of available commands in the app that the user is currently in.

<br>