[dygraphs.git] / auto_tests / README

These tests are run with js-test-driver
(http://code.google.com/p/js-test-driver/).

Running tests
-------------

With phantomjs:

- Install phantomjs (http://www.phantomjs.org).

- Start a terminal window at the dygraphs root directory (one
  directory up from here.)

- Run "./test.sh". This will tell you whether the tests passed.


With a real browser:

- Start a terminal window at the dygraphs root directory (one
  directory up from here.)

- From there, you start the test server and capture at least one slave
  browser:

   Run:
   $ java -jar ./auto_tests/lib/JsTestDriver-1.3.3c.jar --port 9876
  
   Open
   http://localhost:9876/capture
   in the browser you want to use for your test.

- Run the tests with:

  $ java -jar ./auto_tests/lib/JsTestDriver-1.3.3c.jar --tests all


Debugging tests
---------------

This is a bit of a hack, but you can also run tests manually inside the browser
using auto_tests/misc/local.html.

Once you've opened that page, open up the JavaScript console and run something
like:

  new SimpleDrawingTestCase().runTest("testDrawSimpleRangePlusOne")

to run just one test. This is useful for seeing the dygraph that the test
creates, setting breakpoints, etc.

Please don't rely on it as proof that your tests pass; the command-line is the
reference for ensuring Dygraphs automated tests pass.


(This is a specialized version of the instructions found at 
http://code.google.com/p/js-test-driver/wiki/GettingStarted.
They're listed as a courtesy, but you really should get to understand
js-test-driver, which has lots of powerful features.)
Commit	Line	Data
408ae4df DV	1	These tests are run with js-test-driver
	2	(http://code.google.com/p/js-test-driver/).
	3
	4	Running tests
	5	-------------
	6
86a3e64f DV	7	With phantomjs:
	8
	9	- Install phantomjs (http://www.phantomjs.org).
	10
	11	- Start a terminal window at the dygraphs root directory (one
	12	directory up from here.)
	13
	14	- Run "./test.sh". This will tell you whether the tests passed.
	15
	16
	17	With a real browser:
	18
408ae4df DV	19	- Start a terminal window at the dygraphs root directory (one
	20	directory up from here.)
	21
	22	- From there, you start the test server and capture at least one slave
	23	browser:
	24
	25	Run:
1a27bd14	26	$ java -jar ./auto_tests/lib/JsTestDriver-1.3.3c.jar --port 9876
408ae4df DV	27
	28	Open
	29	http://localhost:9876/capture
	30	in the browser you want to use for your test.
	31
	32	- Run the tests with:
	33
1a27bd14	34	$ java -jar ./auto_tests/lib/JsTestDriver-1.3.3c.jar --tests all
408ae4df DV	35
	36
	37	Debugging tests
	38	---------------
	39
	40	This is a bit of a hack, but you can also run tests manually inside the browser
	41	using auto_tests/misc/local.html.
	42
	43	Once you've opened that page, open up the JavaScript console and run something
	44	like:
	45
	46	new SimpleDrawingTestCase().runTest("testDrawSimpleRangePlusOne")
	47
	48	to run just one test. This is useful for seeing the dygraph that the test
	49	creates, setting breakpoints, etc.
	50
	51	Please don't rely on it as proof that your tests pass; the command-line is the
	52	reference for ensuring Dygraphs automated tests pass.
	53
	54
	55	(This is a specialized version of the instructions found at
	56	http://code.google.com/p/js-test-driver/wiki/GettingStarted.
	57	They're listed as a courtesy, but you really should get to understand
	58	js-test-driver, which has lots of powerful features.)