From 38c369c0d81d7b3547cb29ae7e9f45a65303d6d8 Mon Sep 17 00:00:00 2001 From: "Brian E. Granger" Date: Sat, 8 Feb 2014 23:08:37 -0800 Subject: [PATCH] Updating JS tests README.md. --- IPython/html/tests/README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/IPython/html/tests/README.md b/IPython/html/tests/README.md index 2a91fff9f..b5c04c423 100644 --- a/IPython/html/tests/README.md +++ b/IPython/html/tests/README.md @@ -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.