diff options
| author | mattab <matthieu.aubry@gmail.com> | 2014-02-11 02:52:26 +0400 |
|---|---|---|
| committer | mattab <matthieu.aubry@gmail.com> | 2014-02-11 02:52:26 +0400 |
| commit | 7df0035699818ca65e46941ffee038775755253a (patch) | |
| tree | f938f4b763658256cd69f55d72f9af07d76d3a0d /tests/README.screenshots.md | |
| parent | db95706ad6f92b90642fc5b3fcdaf61ed3705062 (diff) | |
Explains how to fix UI tests build refs #4536
Diffstat (limited to 'tests/README.screenshots.md')
| -rw-r--r-- | tests/README.screenshots.md | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/tests/README.screenshots.md b/tests/README.screenshots.md index 24a989ae71..45224a2661 100644 --- a/tests/README.screenshots.md +++ b/tests/README.screenshots.md @@ -1,9 +1,35 @@ # Screenshots UI tests Piwik contains UI tests that work by taking a screenshot of a URL and comparing it with -an expected screenshot. If the screenshots do not match, there is a bug somewhere. +an expected screenshot. If any screenshots do not match, the build will fail. +These screenshots are taken after each commit to our git repository. +This powerful tool, which we call continuous User Interface tests, enables Piwik to remain stable and innovate faster. + Learn more below! + +## Using screenshots tests + +As a Piwik developer, you may make changes to Piwik User interface. +When you change some CSS or visuals, it may make the Travis UI Test go from green to red. +We have tried to make fixing the build easy, please read below how to fix the screenshot build: + +**As a Piwik developer, how do I fix UI tests build?** + + * If the piwik-ui-tests travis build has failed, go to travis: [https://travis-ci.org/piwik/piwik-ui-tests](https://travis-ci.org/piwik/piwik-ui-tests) + * Click on the latest failed build. + * In the output for this build, you will find a message such as: + http://builds-artifacts.piwik.org/ui-tests.master/1617.1/screenshot-diffs/diffviewer.html + * Visit this URL. It lists all screenshots which have changed in your commit. + * Check that the changes are desired. Sometimes we introduce regression without realising, and screenshot tests can help us spot such regressions. + * If the change is not wanted, revert or fix your commit. + * If the change is wanted, then you can set the new screenshots as the expected screenshot. + To do so, in the diffviewer.html page click on the "Processed" link for this screenshot. + Then "Save this file as" and save it in the piwik/tests/PHPUnit/UI/expected-ui-screenshots/ directory. + * Push the changes (to your code and/or to the expected-ui-screenshots directory. + * Wait for next UI Tests build [on travis](https://travis-ci.org/piwik/piwik-ui-tests). Hopefully, the build should be green! + + +## Setup screenshots tests on your dev box -## Requirements These tests are in another repository but are included in Piwik as a submodule. To get the tests, run the following commands: $ git submodule init |