summary refs log tree commit diff
path: root/webclient/test/README
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-11-04 14:38:45 +0000
committerKegan Dougal <kegan@matrix.org>2014-11-04 14:38:45 +0000
commitae48e75ad70cfc45d01647a4172a6c7f7659a6c0 (patch)
tree7804004a24c56bc3ee7ee8a05f99b19129c42c46 /webclient/test/README
parentUpdate karma.conf.js to A: actually run the tests, and B: generate JUnit XML. (diff)
downloadsynapse-ae48e75ad70cfc45d01647a4172a6c7f7659a6c0.tar.xz
Use phantomjs as the default browser and not chrome.
Diffstat (limited to 'webclient/test/README')
-rw-r--r--webclient/test/README30
1 files changed, 24 insertions, 6 deletions
diff --git a/webclient/test/README b/webclient/test/README
index 1a7bc832c7..e7ed4eaa87 100644
--- a/webclient/test/README
+++ b/webclient/test/README
@@ -1,13 +1,31 @@
-Requires:
- - nodejs/npm
- - npm install karma
+Testing is done using Karma.
+
+
+UNIT TESTING
+============
+
+Requires the following:
+ - npm/nodejs
+ - phantomjs
+
+Requires the following node packages:
  - npm install jasmine
- - npm install protractor (e2e testing)
+ - npm install karma
+ - npm install karma-jasmine
+ - npm install karma-phantomjs-launcher
+ - npm install karma-junit-reporter
 
-Setting up continuous integration / run the unit tests (make sure you're in
-this directory so it can find the config file):
+Make sure you're in this directory so it can find the config file and run:
   karma start
 
+You should see all the tests pass.
+
+
+E2E TESTING
+===========
+
+npm install protractor
+
 
 Setting up e2e tests (only if you don't have a selenium server to run the tests
 on. If you do, edit the config to point to that url):