https://github.com/terminus-plugin-project/terminus-wraith-plugin

Wraith - A Terminus plugin to assist with visual regression testing of Pantheon site environments.
https://github.com/terminus-plugin-project/terminus-wraith-plugin

composer pantheon plugin regression regression-testing terminus terminus-plugin testing testing-tools wraith

Last synced: about 1 month ago
JSON representation

Wraith - A Terminus plugin to assist with visual regression testing of Pantheon site environments.

• Host: GitHub
• URL: https://github.com/terminus-plugin-project/terminus-wraith-plugin
• Owner: terminus-plugin-project
• License: mit
• Created: 2017-04-21T15:35:04.000Z (almost 8 years ago)
• Default Branch: 1.x
• Last Pushed: 2019-02-22T05:14:50.000Z (almost 6 years ago)
• Last Synced: 2024-11-16T14:13:59.539Z (2 months ago)
• Topics: composer, pantheon, plugin, regression, regression-testing, terminus, terminus-plugin, testing, testing-tools, wraith
• Language: PHP
• Homepage: https://packagist.org/packages/terminus-plugin-project/terminus-wraith-plugin
• Size: 10.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terminus Wraith Plugin

[![CircleCI](https://circleci.com/gh/terminus-plugin-project/terminus-wraith-plugin.svg?style=shield)](https://circleci.com/gh/terminus-plugin-project/terminus-wraith-plugin)

[![Terminus v1.x Compatible](https://img.shields.io/badge/terminus-v1.x-green.svg)](https://github.com/terminus-plugin-project/terminus-wraith-plugin/tree/1.x)

Wraith - A Terminus plugin to assist with visual regression testing of [Pantheon](https://pantheon.io/) site environments.

## Usage:

```

$ terminus wraith [--sites site-name.test,site-name.prod --paths home=/,about=/about,news=/news,... --config --spider]

```

## Examples:

Use the previous configuration or prompt for the environments and pages to compare and then generate snapshots:

```

$ terminus wraith

```

Prompt for the environments and pages to compare and then generate snapshots:

```

$ terminus wraith --config

```

Prompt for new pages to compare the my-site.test and my-site.prod environments and then generate snapshots:

```

$ terminus wraith --sites my-site.test,my-site.prod

```

Prompt for new environments to compare the /, /about and /news pages and then generate snapshots:

```

$ terminus wraith --paths home=/,about=/about,news=/news

```

Use the previous configuration or prompt for new environments, crawl to detect pages and then generate snapshots:

```

$ terminus wraith --spider

```

## Installation:

For installation help, see [Extend with Plugins](https://pantheon.io/docs/terminus/plugins/).

```

mkdir -p ~/.terminus/plugins

composer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-wraith-plugin:~1

```

## Configuration:

Install [Wraith](http://bbc-news.github.io/wraith/) for your [operating system](http://bbc-news.github.io/wraith/os-install.html).  See [http://bbc-news.github.io/wraith/os-install.html](http://bbc-news.github.io/wraith/os-install.html).

## Testing:

Replace `my-site.test` and `my-site.prod` with the site environments you want to test:

```

export TERMINUS_SOURCE_SITE_ENV=my-site.test

export TERMINUS_TARGET_SITE_ENV=my-site.prod

cd ~/.terminus/plugins/terminus-wraith-plugin

composer install

composer test

```

## Help:

Run `terminus help wraith` for help.