Towards MKWS-375.

[mkws-moved-to-github.git] / test / README.txt

diff --git a/test/README.txt b/test/README.txt
index 6c6b504..227a35a 100644 (file)
--- a/test/README.txt
+++ b/test/README.txt
@@ -1,10 +1,38 @@
 Jasmine / jasmine-node test frame works
----------------------------------------
+=============================================
 
 This directory contains the MasterKey Widget Set (MKWS) Test framework.
 
 
-to run the tests, run:
+Installation
+-------------------------------------
+1. install node.js, see http://nodejs.org/
+(and apache2 if you have not already)
+
+# debian7
+$ sudo apt-get install npm
+$ sudo apt-get install apache2
+
+# centos6
+$ sudo yum install npm
+$ sudo yum install httpd
+
+
+The nodejs modules are configured in ./package.json
+You can install them manually with
+$ make node-modules
+
+if you want. The top level makefile in ./mkws/Makefile takes care to
+checkout and update the modules automatically.
+
+
+Testing
+---------------------------------------
+
+
+To run the tests, run:
+
+1. basic javscript tests
 
 $ make check
 jasmine-node ./spec
@@ -14,29 +42,38 @@ Finished in 2.024 seconds
 39 tests, 194 assertions, 0 failures, 0 skipped
 
 
+2. Testing the Widgets in a headless browser with Jasmine
+
+$ make phantomjs
+[ headless jasmine test with console.log() messages
+
+$ DEBUG=1 make phantomjs PHANTOM_URL=https://example.indexdata.com/jasmine-popup.html
+[ less debug noise ]
+
+
 To get a basic help, run:
 $ make help
 
 
 File system hierarchy
 --------------------------------------
-./spec         contains *spec.js files
+./spec         contains *spec.js files for phantomjs
+./spec-dev     development *spec.js files
 ./js           jasmine runtime JS lib
-
-README.txt     this file
-
+./phantom      scripts for phantomjs tests
+./bin          helper scripts
+./etc          configuration files
+./logs         apache access and error log files
+./widgets      screenshots for MKWS widgets
+./images       screenshots for testing
 
 Documentation
 ---------------------------------------
 http://pivotal.github.io/jasmine/
 https://github.com/pivotal/jasmine
+http://phantomjs.org/
 
 
-Installation
--------------------------------------
-1. install node.js, see http://nodejs.org/
-2. install node modules with npm: make node-modules
-
 --
-Copyright (c) 2013 IndexData ApS. http://indexdata.com
-Sep 2013, Wolfram
+Copyright (c) 2013-2014 Index Data ApS. http://indexdata.com
+Oct 2014, Wolfram