Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit a4b045e
Author: Brendon Barreto <[email protected]>
Date:   Fri Nov 30 09:24:59 2018 -0200

    Delete findExecutable_spec

commit e74bf32
Author: Brendon Barreto <[email protected]>
Date:   Fri Nov 30 09:22:18 2018 -0200

    Revert compare/output/diverged.js

commit 6552891
Author: Brendon Barreto <[email protected]>
Date:   Fri Nov 23 15:22:29 2018 -0200

    Fix lint

commit 9805cad
Author: Brendon Barreto <[email protected]>
Date:   Fri Nov 23 15:02:23 2018 -0200

    Removing Phantom. Slimer and Casper
  • Loading branch information
garris committed Jan 21, 2019
1 parent cd69507 commit 762efb8
Show file tree
Hide file tree
Showing 56 changed files with 79 additions and 1,144 deletions.
49 changes: 4 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ BackstopJS automates visual regression testing of your responsive web UI by comp

- Integrated Docker rendering -- to eliminate cross-platform rendering shenanigans
- CLI reports
- Render tests with **Chrome Headless**, **Phantom** and **Slimer**
- Simulate user interactions with **Puppeteer**, **ChromyJS** and **CasperJS** scripts
- Render tests with **Chrome Headless**
- Simulate user interactions with **Puppeteer** and **ChromyJS** scripts
- JUnit reports
- Plays nice with CI and source control
- Run globally or locally as a standalone package app or `require('backstopjs')` right into your node app
Expand Down Expand Up @@ -411,7 +411,7 @@ You can create reference files (without previewing) by using the command `backst

### Running custom scripts

Simulate user actions (click, scroll, hover, wait, etc.) or states (cookie values) by running your own Casper.js script on ready. For each scenario, the custom .js file you specify is imported and run when the BackstopJS ready events are fulfilled.
Simulate user actions (click, scroll, hover, wait, etc.) or states (cookie values) by running your own script on ready. For each scenario, the custom .js file you specify is imported and run when the BackstopJS ready events are fulfilled.

From your project root, place your scripts in...

Expand Down Expand Up @@ -466,8 +466,6 @@ module.exports = async (page, scenario, vp) => {

By default the base path is a folder called `engine_scripts` inside your BackstopJS installation directory. You can override this by setting the `paths.scripts` property in your `backstop.json` file to point to somewhere in your project directory (recommended).

_**NOTE:** SlimerJS currently requires an absolute path -- so be sure to include the full path when using the `"engine": "slimer"` configuration option._

```json
"paths": {
"engine_scripts": "backstop_data/engine_scripts"
Expand Down Expand Up @@ -538,7 +536,7 @@ By default, BackstopJS saves generated resources into the `backstop_data` direct
```

### Changing the rendering engine
BackstopJS supports using Chrome-Headless, PhantomJS or SlimerJS for web app rendering. Chrome-headless (via Puppeteer) is currently the default value and will be installed by default.
Puppeteer is currently the default value and will be installed by default. You could choose to use Chromy as well.

#### Chrome-Headless (The latest webkit library)
To use chrome headless you have two options for scripting engines, the default _puppeteer_ (https://github.com/GoogleChrome/puppeteer) or the very cool _chromy.js_ (https://github.com/OnetapInc/chromy) library.
Expand All @@ -553,25 +551,6 @@ or
"engine": "chromy"
```

#### Slimer (Gecko/Mozilla rendering)
To run in Slimer, be sure to have SlimerJS installed. From your root directory run...

```sh
$ npm install -g slimerjs
```

Then, in your `backstop.json` config file, update the engine property to...

```json
"engine": "slimerjs"
```

#### To run phantom it's...

```json
"engine": "casper"
```

### Setting Puppeteer option flags
Backstop sets two defaults for Puppeteer:

Expand All @@ -592,18 +571,6 @@ You can add more settings (or override the defaults) with the engineOptions prop
More info here: [Puppeteer on github](https://github.com/GoogleChrome/puppeteer).


### Setting Casper command-line flags
See casperjs documentation for more info on instance options. An example config below...

```json
"casperFlags": [
"--engine=slimerjs",
"--proxy-type=http",
"--proxy=proxyIp:port",
"--proxy-auth=user:pass"
]
```

### Setting Chromy option flags
Chromy enables a lot of behavior via constructor options. See Chromy documentation for more info.

Expand Down Expand Up @@ -999,11 +966,6 @@ Filename formats have changed. To use the 1.x (compatible) file format, use the
}
```

### Windows users...

PhantomJS needs Python -- please make sure you have Python installed...
_see https://github.com/garris/BackstopJS/issues/185_


---

Expand Down Expand Up @@ -1056,10 +1018,7 @@ _see https://github.com/garris/BackstopJS/issues/185_
- [Setting the bitmap and script directory paths](#setting-the-bitmap-and-script-directory-paths)
- [Changing the rendering engine](#changing-the-rendering-engine)
- [Chrome-Headless (The latest webkit library)](#chrome-headless-the-latest-webkit-library)
- [Slimer (Gecko/Mozilla rendering)](#slimer-geckomozilla-rendering)
- [To run phantom it's...](#to-run-phantom-its)
- [Setting Puppeteer option flags](#setting-puppeteer-option-flags)
- [Setting Casper command-line flags](#setting-casper-command-line-flags)
- [Setting Chromy option flags](#setting-chromy-option-flags)
- [Using Chromy static functions](#using-chromy-static-functions)
- [Using Docker for testing across different environments](#using-docker-for-testing-across-different-environments)
Expand Down
25 changes: 0 additions & 25 deletions capture/engine_scripts/casper/clickAndHoverHelper.js

This file was deleted.

15 changes: 0 additions & 15 deletions capture/engine_scripts/casper/loadCookies.js

This file was deleted.

4 changes: 0 additions & 4 deletions capture/engine_scripts/casper/onBefore.js

This file was deleted.

5 changes: 0 additions & 5 deletions capture/engine_scripts/casper/onReady.js

This file was deleted.

18 changes: 0 additions & 18 deletions capture/engine_scripts/casper/waitForHelperHelper.js

This file was deleted.

Loading

0 comments on commit 762efb8

Please sign in to comment.