Difference between revisions of "AppSuite:RunTests"

m (fixed linking)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<!-- !!! -->
 +
<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
 +
<!-- !!! -->
 +
 
{{Stability-experimental}}
 
{{Stability-experimental}}
 
<div class="title">Running the ui tests</div>
 
<div class="title">Running the ui tests</div>
Line 11: Line 15:
 
* [http://sinonjs.org/  Sinon.JS] - Standalone test spies, stubs and mocks for JavaScript.
 
* [http://sinonjs.org/  Sinon.JS] - Standalone test spies, stubs and mocks for JavaScript.
 
* [http://karma-runner.github.io/  Karma Runner] - test runner
 
* [http://karma-runner.github.io/  Karma Runner] - test runner
 +
* [http://chaijs.com/ Chai.js] - Assertion framework
  
 
== Setting up your system ==
 
== Setting up your system ==
  
You need at least ''node'' version 0.8 to use the latest version of ''karma'', which we need. To install the (latest version of) karma runner, run
+
=== Before starting: Mac only ===
 +
  brew install phantomjs
 +
...or link it in path and set executable bit on phantomjs binary yourself. After this follow the rest of the guide.
  
    npm install -g karma@canary
+
=== All ===
 +
You need at least ''node'' version 0.8 to use the latest version of ''karma'', which we need. Karma will be installed with all other development dependencies. So just make sure you ran
  
in a shell. You might need admin rights to do that, use ''sudo'' if needed.
+
    npm install
 +
 
 +
within your ui directory in the appsuite repository.
  
 
== Running the tests ==
 
== Running the tests ==
  
Running the tests is pretty easy. For now, in the ''ui'' directory of your sources start the appserver proxy
+
The recommended way to start testing is to run:
 +
 
 +
  grunt dev
  
    ./appserver.sh
+
This will start a connect server, the karma
 +
test server and a watcher for changes. Optionally, it is possible to connect multiple browsers to the host running the karma server (port 9876). Tests will run in those browsers, too. You can trigger a test run manually by running:
  
and then start the karma server with
+
  grunt testrun
  
    karma start
+
in another terminal. This will be done automatically by the grunt watch
 +
task, after any source file of your project has been changed.
  
After that, open up a browser and point it to http://localhost:9876/.
 
  
If you don’t want to use the appserver proxy but your own backend, you need to adjust the proxies section in your ''ui/karma.conf.js''. The appserver or a running backend won’t be needed in the future.
 
  
 
[[Category:AppSuite]]
 
[[Category:AppSuite]]
 
[[Category:UI]]
 
[[Category:UI]]
 
[[Category:Development process]]
 
[[Category:Development process]]
 +
[[Category:Testing]]

Latest revision as of 08:39, 11 February 2016


API status: In Development

Running the ui tests

This article explains the test system of the frontend. It is aimed at developers that want to work with the frontend, be it creating new plugins or applications or modifying existing code using BDD. Bringing a BDD testing infrastructure to the frontend is still a work in progress and subject to (breaking) changes. Please contribute to the stability by reporting any issues or ideas to me.

Libraries

Setting up your system

Before starting: Mac only

  brew install phantomjs

...or link it in path and set executable bit on phantomjs binary yourself. After this follow the rest of the guide.

All

You need at least node version 0.8 to use the latest version of karma, which we need. Karma will be installed with all other development dependencies. So just make sure you ran

   npm install

within your ui directory in the appsuite repository.

Running the tests

The recommended way to start testing is to run:

 grunt dev

This will start a connect server, the karma test server and a watcher for changes. Optionally, it is possible to connect multiple browsers to the host running the karma server (port 9876). Tests will run in those browsers, too. You can trigger a test run manually by running:

 grunt testrun

in another terminal. This will be done automatically by the grunt watch task, after any source file of your project has been changed.