feat: add onlyDiff in options (americanexpress#317)

Author: Ayc0

README.md

@@ -113,6 +113,7 @@ See [the examples](./examples/README.md) for more detailed usage or read about a
 * `customReceivedDir`: A custom absolute path of a directory to keep this received image in
 * `customSnapshotIdentifier`: A custom name to give this snapshot. If not provided one is computed automatically. When a function is provided it is called with an object containing `testPath`, `currentTestName`, `counter` and `defaultIdentifier` as its first argument. The function must return an identifier to use for the snapshot. If a path is given, the path will be created inside the snapshot/diff directories.
 * `diffDirection`: (default: `horizontal`) (options `horizontal` or `vertical`) Changes diff image layout direction
+* `onlyDiff`: (default: `false`) Either only include the difference between the baseline and the received image in the diff image, or include the 3 images (following the direction set by `diffDirection`).
 * `noColors`: Removes coloring from console output, useful if storing the results in a file
 * `failureThreshold`: (default `0`) Sets the threshold that would trigger a test failure based on the `failureThresholdType` selected. This is different to the `customDiffConfig.threshold` above, that is the per pixel failure threshold, this is the failure threshold for the entire comparison.
 * `failureThresholdType`: (default `pixel`) (options `percent` or `pixel`) Sets the type of threshold that would trigger a failure.

__tests__/__snapshots__/index.spec.js.snap

@@ -47,6 +47,7 @@ exports[`toMatchImageSnapshot passes diffImageToSnapshot everything it needs to
   "diffDirection": "horizontal",
   "failureThreshold": 0,
   "failureThresholdType": "pixel",
+  "onlyDiff": false,
   "receivedDir": undefined,
   "receivedImageBuffer": "pretendthisisanimagebuffer",
   "snapshotIdentifier": "test-spec-js-test-1-snap",

__tests__/index.spec.js

@@ -443,6 +443,7 @@ describe('toMatchImageSnapshot', () => {
       comparisonMethod: 'pixelmatch',
       customDiffConfig: {},
       diffDirection: 'horizontal',
+      onlyDiff: false,
       failureThreshold: 0,
       failureThresholdType: 'pixel',
       receivedImageBuffer: undefined,
@@ -513,6 +514,7 @@ describe('toMatchImageSnapshot', () => {
       storeReceivedOnFailure: true,
       diffDir: path.join('path', 'to', 'my-custom-diff-dir'),
       diffDirection: 'vertical',
+      onlyDiff: false,
       updateSnapshot: false,
       updatePassedSnapshot: true,
       failureThreshold: 1,
@@ -572,6 +574,7 @@ describe('toMatchImageSnapshot', () => {
       receivedDir: path.join('path', 'to', 'my-custom-received-dir'),
       diffDir: path.join('path', 'to', 'my-custom-diff-dir'),
       diffDirection: 'horizontal',
+      onlyDiff: false,
       storeReceivedOnFailure: true,
       updateSnapshot: false,
       updatePassedSnapshot: false,

__tests__/integration.spec.js

@@ -410,6 +410,45 @@ describe('toMatchImageSnapshot', () => {
         .toBe(false);
     });
 
+    it('only outputs the diff when onlyDiff is enabled', () => {
+      const failureImageData = fs.readFileSync(fromStubs('TestImageUpdate1pxOff.png'));
+      const imageFailureOnlyDiffData =
+        fs.readFileSync(fromStubs('TestImageUpdate1pxOff-onlyDiff-diff.png'));
+
+      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,
+            onlyDiff: true,
+          })
+      )
+        .not
+        .toThrowError();
+
+      // then test against a different image
+      expect(
+        () => expect(failureImageData)
+          .toMatchImageSnapshot({
+            customSnapshotIdentifier,
+            onlyDiff: true,
+            // required for coverage
+            runInProcess: true,
+          })
+      )
+        .toThrow(/Expected image to match or be a close match/);
+
+      expect(fs.existsSync(pathToResultImage))
+        .toBe(true);
+
+      expect(fs.readFileSync(pathToResultImage)).toEqual(imageFailureOnlyDiffData);
+      // just because file was written does not mean it is a png image
+      expect(sizeOf(pathToResultImage))
+        .toHaveProperty('type', 'png');
+    });
+
     it('handles diffs for large images', () => {
       const largeImageData = fs.readFileSync(fromStubs('LargeTestImage.png'));
       const largeFailureImageData = fs.readFileSync(fromStubs('LargeTestImageFailure.png'));

__tests__/stubs/TestImageUpdate1pxOff-onlyDiff-diff.png

@@ -184,6 +184,24 @@ const shouldFail = ({
   };
 };
 
+function composeDiff(options) {
+  const {
+    diffDirection, baselineImage, diffImage, receivedImage, imageWidth, imageHeight, onlyDiff,
+  } = options;
+  const composer = new ImageComposer({
+    direction: diffDirection,
+  });
+
+  if (onlyDiff) {
+    composer.addImage(diffImage, imageWidth, imageHeight);
+  } else {
+    composer.addImage(baselineImage, imageWidth, imageHeight);
+    composer.addImage(diffImage, imageWidth, imageHeight);
+    composer.addImage(receivedImage, imageWidth, imageHeight);
+  }
+  return composer;
+}
+
 function diffImageToSnapshot(options) {
   const {
     receivedImageBuffer,
@@ -193,6 +211,7 @@ function diffImageToSnapshot(options) {
     receivedDir = path.join(options.snapshotsDir, '__received_output__'),
     diffDir = path.join(options.snapshotsDir, '__diff_output__'),
     diffDirection,
+    onlyDiff = false,
     updateSnapshot = false,
     updatePassedSnapshot = false,
     customDiffConfig = {},
@@ -281,14 +300,10 @@ function diffImageToSnapshot(options) {
       }
 
       mkdirp.sync(path.dirname(diffOutputPath));
-      const composer = new ImageComposer({
-        direction: diffDirection,
+      const composer = composeDiff({
+        diffDirection, baselineImage, diffImage, receivedImage, imageWidth, imageHeight, onlyDiff,
       });
 
-      composer.addImage(baselineImage, imageWidth, imageHeight);
-      composer.addImage(diffImage, imageWidth, imageHeight);
-      composer.addImage(receivedImage, imageWidth, imageHeight);
-
       const composerParams = composer.getParams();
 
       const compositeResultImage = new PNG({
@@ -335,6 +350,7 @@ function diffImageToSnapshot(options) {
   return result;
 }
 
+
 function runDiffImageToSnapshot(options) {
   options.receivedImageBuffer = options.receivedImageBuffer.toString('base64');
 

src/diff-snapshot.js

@@ -138,6 +138,7 @@ function configureToMatchImageSnapshot({
   storeReceivedOnFailure: commonStoreReceivedOnFailure = false,
   customReceivedDir: commonCustomReceivedDir,
   customDiffDir: commonCustomDiffDir,
+  onlyDiff: commonOnlyDiff = false,
   diffDirection: commonDiffDirection = 'horizontal',
   noColors: commonNoColors,
   failureThreshold: commonFailureThreshold = 0,
@@ -156,6 +157,7 @@ function configureToMatchImageSnapshot({
     storeReceivedOnFailure = commonStoreReceivedOnFailure,
     customReceivedDir = commonCustomReceivedDir,
     customDiffDir = commonCustomDiffDir,
+    onlyDiff = commonOnlyDiff,
     diffDirection = commonDiffDirection,
     customDiffConfig = {},
     noColors = commonNoColors,
@@ -218,6 +220,7 @@ function configureToMatchImageSnapshot({
         receivedDir,
         diffDir,
         diffDirection,
+        onlyDiff,
         snapshotIdentifier,
         updateSnapshot: snapshotState._updateSnapshot === 'all',
         customDiffConfig: Object.assign({}, commonCustomDiffConfig, customDiffConfig),