diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2014-03-04 17:17:54 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2014-03-04 17:17:54 +0400 |
commit | 28f2e682eab325a3cc4df7b638baf30b2a83d7a8 (patch) | |
tree | 2c26aea0c6a1f80c9cb8e6013e8e8728af11e6f7 /tests/README.screenshots.md | |
parent | 1fba3d06c3f83d54f64fbc1c165ccab5ccb1b64e (diff) |
Add missing links to screenshot test readme and attempt to diagnose build timeout on travis.
Diffstat (limited to 'tests/README.screenshots.md')
-rw-r--r-- | tests/README.screenshots.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/tests/README.screenshots.md b/tests/README.screenshots.md index 5cbe305abe..af1c451d1d 100644 --- a/tests/README.screenshots.md +++ b/tests/README.screenshots.md @@ -35,6 +35,8 @@ To fix a broken build, follow these steps: Then "Save this file as" and save it in the piwik/tests/PHPUnit/UI/expected-ui-screenshots/ directory. (If the screenshot test is for a plugin and not Piwik Core, the expected screenshot should be added to the plugin's expected screenshot directory. For example: piwik/plugins/DBStats/tests/UI/expected-ui-screenshots.) + + _Note: When determining whether a screenshot is correct, the data displayed is not important. Report data correctness is verified through Integration and other PHP tests. The UI tests should only test UI behavior._ * 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! @@ -88,13 +90,13 @@ The following options may be useful if you plan on running the UI tests locally ## Writing Tests -UI screenshot tests are run directly by phantomjs and are written using [mocha]() and [chai](). +UI screenshot tests are run directly by phantomjs and are written using [mocha](http://visionmedia.github.io/mocha/) and [chai](http://chaijs.com). -To create a new test, first decide whether it will belong to Piwik Core or a plugin. If it will belong to Piwik Core, the test should be placed within the [piwik-ui-tests]() repository. Otherwise, it should be placed within tests/UI sub-directory of your plugin. +To create a new test, first decide whether it will belong to Piwik Core or a plugin. If it will belong to Piwik Core, the test should be placed within the [piwik-ui-tests](https://github.com/piwik/piwik-ui-tests) repository. Otherwise, it should be placed within tests/UI sub-directory of your plugin. All test files should have \_spec.js file name suffixes (for example, **ActionsDataTable\_spec.js**). -Tests should be written using [BDD]() style, for example: +Tests should be written using [BDD](http://en.wikipedia.org/wiki/Behavior-driven_development) style, for example: describe("TheControlImTesting", function () { // ... |