From e18f8d78b27a1c58afdbc465502e4894e02facf2 Mon Sep 17 00:00:00 2001 From: Wolfram Schneider Date: Fri, 17 Oct 2014 10:33:04 +0200 Subject: [PATCH] update documentation --- test/README.txt | 49 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/test/README.txt b/test/README.txt index 3d30b7e..221a4a4 100644 --- a/test/README.txt +++ b/test/README.txt @@ -1,15 +1,36 @@ Jasmine / jasmine-node test frame works ---------------------------------------- +============================================= This directory contains the MasterKey Widget Set (MKWS) Test framework. -To install (some) prerequisites, run: +Installation +------------------------------------- +1. install node.js, see http://nodejs.org/ + +# debian7 $ sudo apt-get install npm -$ sudo npm install -g + +# centos6 +$ sudo yum install npm + + +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 ....................................... @@ -18,22 +39,30 @@ 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://mkws-dev.indexdata.com/jasmine-popup.html +$ 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 ./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 --------------------------------------- @@ -42,12 +71,6 @@ 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-2014 Index Data ApS. http://indexdata.com -Feb 2014, Wolfram +Oct 2014, Wolfram -- 1.7.10.4