jest-image-snapshot 2.9.0 → 2.12.0

package/__tests__/integration.spec.js

@@ -1,310 +0,0 @@
-/*
- * Copyright (c) 2017 American Express Travel Related Services Company, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
- */
-
-const fs = require('fs');
-const path = require('path');
-const rimraf = require('rimraf');
-const uniqueId = require('lodash/uniqueId');
-const sizeOf = require('image-size');
-const { SnapshotState } = require('jest-snapshot');
-const { toMatchImageSnapshot } = require('../src');
-
-describe('toMatchImageSnapshot', () => {
-  const fromStubs = file => path.resolve(__dirname, './stubs', file);
-  const imageData = fs.readFileSync(fromStubs('TestImage.png'));
-  const diffOutputDir = (snapshotsDir = '__image_snapshots__') => path.join(snapshotsDir, '/__diff_output__/');
-  const customSnapshotsDir = path.resolve(__dirname, '__custom_snapshots_dir__');
-  const cleanupRequiredIndicator = 'cleanup-required-';
-  const getIdentifierIndicatingCleanupIsRequired = () => uniqueId(cleanupRequiredIndicator);
-  const getSnapshotFilename = identifier => `${identifier}-snap.png`;
-  const diffExists = identifier => fs.existsSync(path.join(__dirname, diffOutputDir(), `${identifier}-diff.png`));
-
-  beforeAll(() => {
-    // In tests, skip reporting (skip snapshotState update to not mess with our test report)
-    global.UNSTABLE_SKIP_REPORTING = true;
-    expect.extend({ toMatchImageSnapshot });
-  });
-
-  beforeEach(() => {
-    rimraf.sync(`**/${cleanupRequiredIndicator}*`);
-  });
-
-  afterAll(() => {
-    rimraf.sync(`**/${cleanupRequiredIndicator}*`);
-  });
-
-  describe('happy path', () => {
-    it('writes snapshot with no error if there is not one stored already', () => {
-      const snapshotsDir = path.resolve(__dirname, '__image_snapshots__');
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-      expect(
-        fs.existsSync(path.join(snapshotsDir, getSnapshotFilename(customSnapshotIdentifier)))
-      ).toBe(true);
-    });
-
-    it('matches an identical snapshot', () => {
-      expect(() => expect(imageData).toMatchImageSnapshot()).not.toThrowError();
-    });
-
-    it('creates a snapshot in a custom directory if such is specified', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier, customSnapshotsDir }) // eslint-disable-line max-len
-      ).not.toThrowError();
-
-      expect(
-        fs.existsSync(path.join(customSnapshotsDir, getSnapshotFilename(customSnapshotIdentifier)))
-      ).toBe(true);
-    });
-
-    it('does not write a result image for passing tests', () => {
-      const customSnapshotIdentifier = 'integration-6';
-
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      expect(diffExists(customSnapshotIdentifier)).toBe(false);
-    });
-  });
-
-  describe('updates', () => {
-    const customSnapshotIdentifier = 'integration-update';
-    const updateImageData = fs.readFileSync(fromStubs('TestImageUpdate1pxOff.png'));
-    const updateImageSnapshotPath = path.join(__dirname, '__image_snapshots__', `${customSnapshotIdentifier}-snap.png`);
-
-    beforeEach(() => {
-      fs.writeFileSync(updateImageSnapshotPath, imageData);
-    });
-
-    afterAll(() => {
-      fs.writeFileSync(updateImageSnapshotPath, imageData);
-    });
-
-    it('does not write a result image for passing tests in update mode by default', () => {
-      const updateModeMatcher = toMatchImageSnapshot.bind({
-        snapshotState: new SnapshotState(__filename, {
-          updateSnapshot: 'all',
-        }),
-        testPath: __filename,
-      });
-      updateModeMatcher(updateImageData, {
-        customSnapshotIdentifier,
-        failureThreshold: 2,
-        failureThresholdType: 'pixel',
-      });
-      expect(fs.readFileSync(updateImageSnapshotPath)).toEqual(imageData);
-    });
-
-    it('writes a result image for passing test in update mode with updatePassedSnapshots: true', () => {
-      const updateModeMatcher = toMatchImageSnapshot.bind({
-        snapshotState: new SnapshotState(__filename, {
-          updateSnapshot: 'all',
-        }),
-        testPath: __filename,
-      });
-      updateModeMatcher(updateImageData, {
-        customSnapshotIdentifier,
-        updatePassedSnapshots: true,
-        failureThreshold: 2,
-        failureThresholdType: 'pixel',
-      });
-      expect(fs.readFileSync(updateImageSnapshotPath)).not.toEqual(updateImageData);
-    });
-
-    it('writes a result image for failing test in update mode by default', () => {
-      const updateModeMatcher = toMatchImageSnapshot.bind({
-        snapshotState: new SnapshotState(__filename, {
-          updateSnapshot: 'all',
-        }),
-        testPath: __filename,
-      });
-      updateModeMatcher(updateImageData, {
-        customSnapshotIdentifier,
-        failureThreshold: 0,
-        failureThresholdType: 'pixel',
-      });
-      expect(fs.readFileSync(updateImageSnapshotPath)).toEqual(updateImageData);
-    });
-
-    it('writes a result image for failing test in update mode with updatePassedSnapshots: false', () => {
-      const updateModeMatcher = toMatchImageSnapshot.bind({
-        snapshotState: new SnapshotState(__filename, {
-          updateSnapshot: 'all',
-        }),
-        testPath: __filename,
-      });
-      updateModeMatcher(updateImageData, {
-        customSnapshotIdentifier,
-        updatePassedSnapshots: true,
-        failureThreshold: 0,
-        failureThresholdType: 'pixel',
-      });
-      expect(fs.readFileSync(updateImageSnapshotPath)).toEqual(updateImageData);
-    });
-  });
-
-  describe('failures', () => {
-    const failImageData = fs.readFileSync(fromStubs('TestImageFailure.png'));
-    const oversizeImageData = fs.readFileSync(fromStubs('TestImageFailureOversize.png'));
-    const biggerImageData = fs.readFileSync(fromStubs('TestImage150x150.png'));
-
-    it('fails for a different snapshot', () => {
-      const expectedError = /^Expected image to match or be a close match to snapshot but was 86\.55000000000001% different from snapshot \(8655 differing pixels\)\./;
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-
-      // Write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      // Test against a different image
-      expect(
-        () => expect(failImageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).toThrowError(expectedError);
-    });
-
-    it('fails with differently sized images and outputs diff', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      // Test against an image much larger than the snapshot.
-      expect(
-        () => expect(oversizeImageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).toThrowError(/Expected image to be the same size as the snapshot \(100x100\), but was different \(153x145\)/);
-
-      expect(diffExists(customSnapshotIdentifier)).toBe(true);
-    });
-
-    it('fails with images without diff pixels after being resized', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      expect(
-        () => expect(biggerImageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).toThrowError(/Expected image to be the same size as the snapshot \(100x100\), but was different \(150x150\)/);
-
-      expect(diffExists(customSnapshotIdentifier)).toBe(true);
-    });
-
-    it('writes a result image for failing tests', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-      const pathToResultImage = path.join(__dirname, diffOutputDir(), `${customSnapshotIdentifier}-diff.png`);
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      // then test against a different image
-      expect(
-        () => expect(failImageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).toThrow();
-
-      expect(fs.existsSync(pathToResultImage)).toBe(true);
-
-      // just because file was written does not mean it is a png image
-      expect(sizeOf(pathToResultImage)).toHaveProperty('type', 'png');
-    });
-
-    it('writes a result image for failing tests with horizontal layout', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-      const pathToResultImage = path.join(__dirname, diffOutputDir(), `${customSnapshotIdentifier}-diff.png`);
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({
-          customSnapshotIdentifier,
-          diffDirection: 'horizontal',
-        })
-      ).not.toThrowError();
-
-      // then test against a different image
-      expect(
-        () => expect(failImageData).toMatchImageSnapshot({
-          customSnapshotIdentifier,
-          diffDirection: 'horizontal',
-        })
-      ).toThrow();
-
-      expect(fs.existsSync(pathToResultImage)).toBe(true);
-
-      expect(sizeOf(pathToResultImage)).toMatchObject({
-        width: 300,
-        height: 100,
-        type: 'png',
-      });
-    });
-
-    it('writes a result image for failing tests with vertical layout', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-      const pathToResultImage = path.join(__dirname, diffOutputDir(), `${customSnapshotIdentifier}-diff.png`);
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({
-          customSnapshotIdentifier,
-          diffDirection: 'vertical',
-        })
-      ).not.toThrowError();
-
-      // then test against a different image
-      expect(
-        () => expect(failImageData).toMatchImageSnapshot({
-          customSnapshotIdentifier,
-          diffDirection: 'vertical',
-        })
-      ).toThrow();
-
-      expect(fs.existsSync(pathToResultImage)).toBe(true);
-
-      expect(sizeOf(pathToResultImage)).toMatchObject({
-        width: 100,
-        height: 300,
-        type: 'png',
-      });
-    });
-
-    it('removes result image from previous test runs for the same snapshot', () => {
-      const customSnapshotIdentifier = getIdentifierIndicatingCleanupIsRequired();
-      // First we need to write a new snapshot image
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      // then test against a different image (to generate a results image)
-      expect(
-        () => expect(failImageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).toThrow();
-
-      // then test against image that should not generate results image (as it is passing test)
-      expect(
-        () => expect(imageData).toMatchImageSnapshot({ customSnapshotIdentifier })
-      ).not.toThrowError();
-
-      expect(diffExists(customSnapshotIdentifier)).toBe(false);
-    });
-  });
-});

package/examples/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": "amex/test"
-}

package/examples/README.md

@@ -1,9 +0,0 @@
-# jest-image-snapshot example usage
-
-To run the examples:
-```bash
-git clone https://github.com/americanexpress/jest-image-snapshot.git
-cd jest-image-snapshot/examples
-npm install
-npm test
-```

package/examples/__tests__/local-image.spec.js

@@ -1,24 +0,0 @@
-/*
- * Copyright (c) 2018 American Express Travel Related Services Company, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
- */
-
-const fs = require('fs');
-const path = require('path');
-
-it('works reading an image from the local file system', () => {
-  const imageAtTestPath = path.resolve(__dirname, './stubs', 'image.png');
-  // imageAtTest is a PNG encoded image buffer which is what `toMatchImageSnapshot() expects
-  const imageAtTest = fs.readFileSync(imageAtTestPath);
-
-  expect(imageAtTest).toMatchImageSnapshot();
-});

package/examples/__tests__/puppeteer-example.spec.js

@@ -1,37 +0,0 @@
-/*
- * Copyright (c) 2018 American Express Travel Related Services Company, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
- */
-
-// eslint is looking for `puppeteer` at root level package.json
-// eslint-disable-next-line import/no-unresolved
-const puppeteer = require('puppeteer');
-
-describe('jest-image-snapshot usage with an image received from puppeteer', () => {
-  let browser;
-
-  beforeAll(async () => {
-    browser = await puppeteer.launch();
-  });
-
-  it('works', async () => {
-    const page = await browser.newPage();
-    await page.goto('https://example.com');
-    const image = await page.screenshot();
-
-    expect(image).toMatchImageSnapshot();
-  });
-
-  afterAll(async () => {
-    await browser.close();
-  });
-});

package/examples/image-reporter.js

@@ -1,46 +0,0 @@
-/* eslint-disable */
-
-/*
- * To enable this image reporter, add it to your `jest.config.js` "reporters" definition:
-    "reporters": [ "default", "<rootDir>/image-reporter.js" ]
- */
-
-const chalk = require('chalk');
-const fs = require('fs');
-const AWS = require('aws-sdk/global');
-const S3 = require('aws-sdk/clients/s3');
-
-const UPLOAD_BUCKET = 'YOUR_S3_BUCKET_NAME';
-
-const s3 = new AWS.S3({ apiVersion: '2006-03-01' });
-
-class ImageReporter {
-  constructor(globalConfig, options) {
-    this._globalConfig = globalConfig;
-    this._options = options;
-  }
-
-  onTestResult(test, testResult, aggregateResults) {
-    if (testResult.numFailingTests && testResult.failureMessage.match(/different from snapshot/)) {
-      const files = fs.readdirSync('./__tests__/__image_snapshots__/__diff_output__/');
-      files.forEach((value) => {
-        const path = `diff_output/${value}`;
-        const params = {
-          Body: fs.readFileSync(`./__tests__/__image_snapshots__/__diff_output__/${value}`),
-          Bucket: UPLOAD_BUCKET,
-          Key: path,
-          ContentType: 'image/png',
-        };
-        s3.putObject(params, (err) => {
-          if (err) {
-            console.log(err, err.stack);
-          } else {
-            console.log(chalk.red.bold(`Uploaded image diff file to https://${UPLOAD_BUCKET}.s3.amazonaws.com/${path}`));
-          }
-        });
-      });
-    }
-  }
-}
-
-module.exports = ImageReporter;

package/examples/jest-setup.js

@@ -1,19 +0,0 @@
-/*
- * Copyright (c) 2018 American Express Travel Related Services Company, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
- */
-
-// eslint runs from root and only looks at root package.json
-// eslint-disable-next-line import/no-unresolved
-const { toMatchImageSnapshot } = require('jest-image-snapshot');
-
-expect.extend({ toMatchImageSnapshot });

package/examples/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "jest-image-snapshot-examples",
-  "version": "0.0.0",
-  "description": "Example jest-image-snapshot usage",
-  "scripts": {
-    "test": "jest"
-  },
-  "keywords": [
-    "jest-image-snapshot",
-    "examples"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/americanexpress/jest-image-snapshot.git"
-  },
-  "author": "Andres Escobar <andres.escobar@aexp.com> (https://github.com/anescobar1991)",
-  "license": "Apache-2.0",
-  "dependencies": {
-    "jest": "*",
-    "jest-image-snapshot": "*",
-    "puppeteer": "*"
-  },
-  "jest": {
-    "setupFilesAfterEnv": ["<rootDir>/jest-setup.js"]
-  }
-}