Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
spec/ol Merge pull request #7349 from ahocevar/vectortile-url Oct 12, 2017
index.html Always load a gated URL polyfill when testing Oct 19, 2016
module-global.js Use pixelmatch instead of resemble.js Aug 17, 2017
test-extensions.js Allow reference image creation without existing reference image Oct 9, 2017


Included in this directory

  • index.html - the web page used to run the test suite.

  • spec - includes the OpenLayers test/spec files.

  • test-extensions.js - includes OpenLayers-specific extensions to the testing frameworks.

Run the test suite

Install the test dependencies (from the root of the repository):

npm install

Run the tests once:

npm test

This will run tests in Chrome. If you do not have Chrome installed, you can run tests on Firefox instead:

npm test -- --browsers Firefox

To run tests in other browsers, you need to install additional Karma launchers.

To run the tests continuously:

npm run karma

After this, the test server is listening on http://localhost:9876/, and you can attach any number of browsers for testing (during development, tests will run in Chrome by default).

Rendering tests

The test/rendering directory contains rendering tests which compare a rendered map with a reference image using pixelmatch.

To run the tests in the browser, make sure the development server is running (make serve) and open the URL http://localhost:3000/test_rendering/index.html.

From the command-line the tests can be run with the build target make test-rendering.

Adding new tests

When creating a new test case, a reference image has to be created. By appending ?generate to the URL, a canvas with the rendered map will be shown on the page when calling expectResemble. Then the reference image can simply be created with a right-click and "Save image as".

It is recommended to only run a single test case when generating the reference image.

Image difference

When a test fails, an image showing the difference between the reference image and the rendered map can be displayed by appending ?showdiff to the URL.