Skip to content

Commit 206b38e

Browse files
committed
Create test suite documentation
1 parent 001320e commit 206b38e

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

test/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Testing PowerTip
2+
3+
This project has an extensive test suite powered by [QUnit][qunit] and an interactive test page for testing a few quirky scenarios.
4+
5+
[qunit]: https://qunitjs.com/
6+
7+
## Running the test suite via the command line
8+
9+
The command line test suite is the preferred method of testing. It has the most comprehensive set of tests, and includes code linting.
10+
11+
* All commands should be run from the project's root directory (where the `package.json` file is).
12+
* The test automation is run with [Node.js][nodejs]. So you must have that installed before you can use the command line tools.
13+
14+
[nodejs]: https://nodejs.org/
15+
16+
Install the necessary npm dependencies with the following command (this only needs to be done once):
17+
18+
```shell
19+
npm install
20+
```
21+
22+
After that you can run the test suite with the following command:
23+
24+
```shell
25+
npm run test
26+
```
27+
28+
## Running the test suite in a web browser
29+
30+
You can also run the main test suite directly in a web browser. This is particularly useful for testing a specific browser. Simply open the `index.html` file in a browser and the test suite will immediately begin the testing process.
31+
32+
## Running the edge case tests
33+
34+
The edge cases test page includes a number of tests that cover scenarios which are either difficult or impossible to automate. So that set of tests can only be done with human interaction. It also includes a helpful status window for debugging.
35+
36+
You can perform those tests by opening `edge-cases.html` in a web browser. Each test case includes instructions on how to verify correct functionality.

0 commit comments

Comments
 (0)