README.md

Visual testing for tdd-buffet using Mugshot

---

Install

npm install tdd-buffet @tdd-buffet/visual

Create a visual test

import { describe } from 'tdd-buffet/suite/gui';
import { vit } from '@tdd-buffet/visual';

describe('Visual suite', () => {
  vit('screenshot name', async browser => {
    await browser.url('http://www.github.com');
  });
});

The above will take a screenshot of the first child in body and save it at tests/gui/screenshots/${browser}/${fullTestName}.png (relative to cwd) where

• browser is the name of the browser taken from process.env.BROWSER (see writing GUI tests for more details),
• fullTestName is the full name of the vit test including all parent describe block names (in this case visual_suite_screenshot_name).

You can mix and match "normal" tests (it) and visual tests (vit) and only the visual ones will result in screenshots being taken.