Giter Club home page Giter Club logo

jestscreenshot's Introduction

jestscreenshot

Extend Jest and Puppeteer to automatically take screenshots after each test failure or success.

Screen shots will be created in a subdirectory of your test script as follows.

Success: screenshots/scriptname-testname.png Failure: screenshots/0-fail-scriptname-testname.png

Import jestscreenshot

let jestscreenshot = require('@jeeyah/jestscreenshot');

In beforeAll, initialize jestscreenshot after initializing Puppeteer

beforeAll(async () => {
  // Create puppeteer browser and page objects first:
  // 
  // browser = await options.puppeteer.launch
  // page = await ret.browser.newPage();
  
  let path = require('path');
  let scriptName = path.basename(__filename).replace('.js', '');
  /** page: page object returned from Puppeteer
   * dirName: __dirname defaults to same directory as script
   * scriptName: Used in the screen shot file name
   * onlyFailures: ONLY take screenshots on test failures, default: false
   */
  let options = {
    page: page, 
    dirName: __dirname,
    scriptName: scriptName
  };
  
  await jestscreenshot.init(options);
});

In afterAll, configure jestscreenshot cleanup just prior to closing browser

jestscreenshot needs to wait for screen shots to finish before the browser closes.

afterAll((done) => {
  jestscreenshot.cleanup(function () {
    if (browser) {
      browser.close();
    }
    done();
  });
});

Example test file

See tests/test.js for a working example.

jestscreenshot's People

Contributors

fordjas avatar manumaticx avatar redrockzee avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.