Issue 4726 - Add tests for the element hiding emulation content script

README.md

Index: README.md
===================================================================
--- a/README.md
+++ b/README.md
@@ -4,14 +4,29 @@
 This repository contains the generic Adblock Plus code that's shared between
 platforms. This repository is not designed to be used directly, but instead to
 serve as a dependency for `adblockplus`, `adblockpluschrome` and
 `libadblockplus`.
 
 Running the unit tests
 ----------------------
 
+### Requirements
+
 In order to run the unit test suite you need
 [Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run
 `npm install` in the repository directory in order to install the required
-dependencies. After that you can run `npm test` which will execute all tests
-in the `test` directory of the repository. You can also specify specific test
-files on the command line, e.g. `npm test test/synchronizer.js`.
+dependencies.
+
+### Running all tests
+
+`npm test` will run all tests in the `test` directory of the repository.
+
+### Running specific tests
+
+You can specify specific test files or directories on the command line, e.g.:
+`npm test test/synchronizer.js`.

[kzar, 2017/01/10 11:05:33]

Mind also giving an example that runs both a unit test and a browser test file?
Just to make it extra clear for people new to the tests.

[Felix Dahlke, 2017/01/17 19:41:08]

Sure, I've just updated the one example to invoke multiple test files, should be
obvious enough how it works I hope.

This made me reconsider the approach to have a single runner (i.e. HTML file)
for all browser tests. I have now changed that, so we can have one runner per
suite. Otherwise it wouldn't be possible to specify individual browser tests to
run from the command line. What do you think?

[kzar, 2017/01/18 04:17:15]

Oh, I had assumed that the node-qunit-phantomjs allowed you to run the browser
tests by specifying a JavaScript file and that the runner was for when you
wanted to run the tests from your browser. Yea, I agree it's better to have
separate runners in that case.

+
+### Running the browser tests in a real browser
+
+The tests under `test/browser` require a browser environment. `npm test` will
+run these in a headless browser, but you can also run them in a real one by
+opening `test/browser/index.html`.

[kzar, 2017/01/10 11:05:33]

Since the browser tests don't have a build step I guess we could make this a
link to the file. That way people could click on it to try the tests right away
in their browser from the README. (When it's rendered in GitHub at least.)

[Felix Dahlke, 2017/01/17 19:41:08]

Cool idea, done!