README.md - Issue 29367181: Issue 4726 - Add tests for the element hiding emulation content script

Delta Between Two Patch Sets: README.md

Issue 29367181: Issue 4726 - Add tests for the element hiding emulation content script (Closed) Base URL: https://bitbucket.org/fhd/adblockpluscore

Left Patch Set: Add license header Created Jan. 10, 2017, 9:16 a.m.

Right Patch Set: Wrap and indent QUnit.test invocations consistently Created Jan. 19, 2017, 9:55 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 Adblock Plus core	1 Adblock Plus core

2 =================	2 =================

3	3

4 This repository contains the generic Adblock Plus code that's shared between	4 This repository contains the generic Adblock Plus code that's shared between

5 platforms. This repository is not designed to be used directly, but instead to	5 platforms. This repository is not designed to be used directly, but instead to

6 serve as a dependency for `adblockplus`, `adblockpluschrome` and	6 serve as a dependency for `adblockplus`, `adblockpluschrome` and

7 `libadblockplus`.	7 `libadblockplus`.

8	8

9 Running the unit tests	9 Running the unit tests

10 ----------------------	10 ----------------------

11	11

12 ### Requirements	12 ### Requirements

13	13

14 In order to run the unit test suite you need	14 In order to run the unit test suite you need

15 [Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run	15 [Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run

16 `npm install` in the repository directory in order to install the required	16 `npm install` in the repository directory in order to install the required

17 dependencies.	17 dependencies.

18	18

19 ### Running all tests	19 ### Running all tests

20	20

21 `npm test` will run all tests in the `test` directory of the repository.	21 `npm test` will run all tests in the `test` directory of the repository.

22	22

23 ### Running specific tests	23 ### Running specific tests

24	24

25 You can specify specific test files or directories on the command line, e.g.:	25 You can specify specific test files or directories on the command line, e.g.:

26 `npm test test/synchronizer.js`.	26 `npm test test/synchronizer.js test/browser/elemHideEmulation.html`.
kzar 2017/01/10 11:05:33 Mind also giving an example that runs both a unit 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 Show quoted text On 2017/01/10 11:05:33, kzar wrote: > 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. 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 al Show quoted text On 2017/01/17 19:41:08, Felix Dahlke wrote: > On 2017/01/10 11:05:33, kzar wrote: > > 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. > > 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? 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.
27	27

28 ### Running the browser tests in a real browser	28 ### Running the browser tests in a real browser

29	29

30 The tests under `test/browser` require a browser environment. `npm test` will	30 The tests under `test/browser` require a browser environment. `npm test` will

31 run these in a headless browser, but you can also run them in a real one by	31 run these in a headless browser, but you can also run them in a real one by

32 opening `test/browser/index.html`.	32 opening
kzar 2017/01/10 11:05:33 Since the browser tests don't have a build step I 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! Show quoted text On 2017/01/10 11:05:33, kzar wrote: > 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.) Cool idea, done!
	33 [test/browser/elemHideEmulation.html](test/browser/elemHideEmulation.html).

LEFT	RIGHT