HowTo

Installation

git clone git@github.com:UprootLabs/grinder.git
git clone git@github.com:UprootStaging/grinderBaselines.git

Now, link or copy the css tests folder:

ln -s grinderBaselines/nightly-unstable grinder/nightly-unstable

or

cp -r grinderBaselines/nightly-unstable grinder/

mkdir -p grinder/data/screenshot

Install `sbt`.

### Running the tests

#### Preparation
`sbt run prepare`

This will parse the ref test description from `nightly-unstable/xhtml1/reftest-toc.xht` and emit an XML file that describes the tests. This is only needed to be run once, and thereafter when the tests are updated.

Start a local web server from `grinder` directory:

cd grinder python -m SimpleHttpServer 8000

#### Running firefox tests

`sbt run compare firefox`

#### Running gngr tests

1. Start gngr with the `-grinder-key=xyz` flag (substitute xyz with any key of your choice).
2. `sbt run compare gngr <key>`

### Viewing the report

1. Start another web server from the parent directory: `python -m SimpleHTTPServer 8001`
2. load the following url into a browser: `http://localhost:8001/grinder/report.html`
3. Click `submit`. By default, this will compare the latest grinder run with the gngr baseline.
4. The tests results will be categorized as regressions, fails, progressions and passes.
5. You can click on the test results to see the screenshots.