Merge pull request #5078 from ellisonbg/js-readme

Updating JS tests README.md
This commit is contained in:
Brian E. Granger 2014-02-09 14:27:33 -08:00
commit 54f7d42244

View File

@ -1,23 +1,28 @@
# IPython Notebook Javascript Tests
# IPython Notebook JavaScript Tests
Regression tests for the web notebook. These tests depend on
[CasperJS](http://casperjs.org/), which in turn requires
a recent version of [PhantomJS](http://phantomjs.org/).
This directory includes regression tests for the web notebook. These tests
depend on [CasperJS](http://casperjs.org/), which in turn requires a recent
version of [PhantomJS](http://phantomjs.org/).
Run the tests using:
The JavaScript tests are organized into subdirectories that match those in
`static` (`base', `notebook`, `services`, `tree`, etc.).
To run all of the JavaScript tests do:
```
iptest js
```
For finer granularity, or to specify more options, you can also run the
following `casperjs` command
To run the JavaScript tests in a single subdirectory (`notebook` in this
case) do:
```sh
/path/to/bin/casperjs test --includes=util.js test_cases
```
iptest js/notebook
```
The file `util.js` contains utility functions for tests, including a path to a
running notebook server on localhost (http://127.0.0.1) with the port number
specified as a command line argument to the test suite. Port 8888 is used if
`--port=` is not specified.
The file `util.js` contains utility functions for tests, including a path to
a running notebook server on localhost (http://127.0.0.1) with the port
number specified as a command line argument to the test suite. Port 8888 is
used if `--port=` is not specified. When you run these tests using `iptest`
you do not, however, have to start a notebook server yourself; that is done
automatically.