Skip to content

Commit

Permalink
Merge pull request #154 from jylee-git/v1.4-Update-Documentation
Browse files Browse the repository at this point in the history
V1.4 update documentation
  • Loading branch information
Hafizuddin-github committed Nov 12, 2018
2 parents 5eba7f9 + 3687c91 commit 6fbe867
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1655,11 +1655,23 @@ A contact detail that is not meant to be shared with others
[appendix]
== Instructions for Manual Testing

Given below are instructions to test the app manually.
Given below are instructions to test the app manually. *Read the following note and warning messages before
proceeding to conduct the tests*.

[NOTE]
These instructions only provide a starting point for testers to work on; testers are expected to do more _exploratory_ testing.

[WARNING]
====
The following prerequisites apply to *ALL* test cases: - +
. The following test cases assume a *default slate* when the app is first launched or reset, *without any prior
modifications to the employees list and its' corresponding accounts*. Modify your test case according to whatever
changes that were made prior to executing each individual test cases.
. The following test cases assume that the employee list is *neither sorted nor filtered* prior to executing the
test cases. Modify your test cases accordingly if you have sorted or filtered the list.
====

=== Launch and Shutdown

. Initial launch
Expand All @@ -1679,9 +1691,8 @@ These instructions only provide a starting point for testers to work on; testers
//tag::jylee-git_dg_login[]
==== Login to the application
. Logs in to the application using a registered NRIC and associating password when *not logged in prior to executing the command*.
.. Pre-requisites: -
.. Prerequisites: -
... Login NRIC has to be registered in the application, either through the sample data or added manually by an administrator.
... The following test cases assume a *default slate* when the app is first launched, *without any prior modifications to the accounts*.
... You are *not logged in* prior to testing this function.
.. Test case: `login ic/S1234567E pwd/Password` +
Expected: Status message box states that you are logged in successfully, with your name, and your shcedule (if any).
Expand All @@ -1696,7 +1707,7 @@ These instructions only provide a starting point for testers to work on; testers
Expected: Not logged in. Password does not match the one that's registered with the app; Status message box shows error.
Status bar remains unchanged.
. Logs in to the application using a registered NRIC and associating password when *already logged in prior to executing the command*.
.. Pre-requisites: You are *already logged in* prior to testing this function.
.. Prerequisites: You are *already logged in* prior to testing this function.
.. Test case: `login ic/T1234567E pwd/Password` +
Expected: Status message box shows the message: - +
`You are already logged in. Logout first before logging in again`. +
Expand All @@ -1705,18 +1716,18 @@ These instructions only provide a starting point for testers to work on; testers

==== Checks the login status of the application
. Checks the login status of this app. For this case, someone is logged in to the app.
.. Pre-requisites: Someone is logged in to the app.
.. Prerequisites: Someone is logged in to the app.
.. Test case: `checkloginstatus` +
Expected: Status message box shows the NRIC of the user who is logged in to the app.
. Checks the login status of this app. For this case, user is not logged in prior to executing this command.
.. Pre-requisites: User is not logged in prior to executing this command.
.. Prerequisites: User is not logged in prior to executing this command.
.. Test case: `checkloginstatus` +
Expected: Status message box shows that you are not logged in.


==== Logout of the application
. Logs out of the application.
.. Pre-requisites: User is logged into the app prior to executing this command.
.. Prerequisites: User is logged into the app prior to executing this command.
.. Test case: `logout` +
Expected: Status message box shows that you have successfully logged out. Status bar footer now shows: `Not logged in`.
//end::jylee-git_dg_login[]
Expand All @@ -1728,7 +1739,7 @@ Refer to <<UserGuide.adoc#editing-a-person-code-edit-code,EditCommand section of
editable parameters.
====
. Edits the editable particulars of the person who is logged in.
.. Pre-Condition: User must be logged in to the application.
.. Prerequisites: User must be logged in to the application.
.. Test case: `edit n/Stacy Mak e/stacym@banksy.com` +
Expected: Particular of the logged in person gets updated with name of `Stacy Mak` and email of `stacym@banksy.com`.
Status message box shows the details of the updated person. Status bar footer now shows that the new name of the person who is logged in.
Expand Down Expand Up @@ -1776,12 +1787,8 @@ Expected: No employee is added. The NRIC of `Carol Crowe` is the same as `Charlo
Refer to <<UserGuide.adoc#appendix-b-privileges-in-accordance-to-priority-level, Appendix B of User Guide>> for the list of priority level.
====
. Change the priority level of an employee with one logged in as ADMINISTRATOR.
.. Pre-requisites: -
.. Prerequisites: -
... You must be logged in as an administrator.
... The following test cases assume a *default slate* when the app is first launched, *without any prior modifications to the employees list*.
Modify your test case according to whatever changes that were made prior to executing the following test cases.
... The following test cases assume that the employee list is *neither sorted nor filtered* prior to executing the
test cases. Modify your test cases accordingly if you have sorted the list.
... The following test cases assume that you are logged in as Alex Yeoh, an administrator with NRIC of `S1234567E` and
password of `Password`. Modify the test cases accordingly if you have made any modifications to the employee list
prior to executing the following test cases.
Expand All @@ -1796,7 +1803,7 @@ Refer to <<UserGuide.adoc#appendix-b-privileges-in-accordance-to-priority-level,
priority level values. Status message bar shows error message.

. Attempt to change the priority level of an employee with one logged in without admin rights.
.. Pre-requisites: You must be logged in with an account that is not of ADMINISTRATOR priority level.
.. Prerequisites: You must be logged in with an account that is not of ADMINISTRATOR priority level.
.. Test case: `setplvl 2 plvl/3` +
Expected: Priority level of the employee at index 2 is not updated. The user who is attempting to change the priority level
does not have the rights to do so. Status message box shows an error message.
Expand Down Expand Up @@ -1992,7 +1999,7 @@ Expected: Invalid command format. Error details is shown in the status message.
==== Reset the application
. Resets the application, by deleting `data/AddressBook.xml` and `data/leave.xml`, provided that any of the files exist.

.. Pre-requisites: - +
.. Prerequisites: - +
... User must be logged in with a priority level of `I.T. UNIT`.
... In order for the test to be efficient, you may ensure that the files `data/AddressBook.xml` and `data/leave.xml`
exist in the folder `data`.
Expand Down

0 comments on commit 6fbe867

Please sign in to comment.