feat: remove snap suffix if use custom identifier (#305)

Co-authored-by: Ivan Kibala <ivankibala@Ivans-MacBook-Air.local>
americanexpress · Aug 31, 2022 · 775ac0a · 775ac0a
1 parent 1f4be75
commit 775ac0a
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 12 deletions.
diff --git a/..._image_snapshots__/integration-6-snap.png → ...s__/__image_snapshots__/integration-6.png b/..._image_snapshots__/integration-6-snap.png → ...s__/__image_snapshots__/integration-6.png
diff --git a/...e_snapshots__/integration-update-snap.png → ..._image_snapshots__/integration-update.png b/...e_snapshots__/integration-update-snap.png → ..._image_snapshots__/integration-update.png
diff --git a/__tests__/__snapshots__/index.spec.js.snap b/__tests__/__snapshots__/index.spec.js.snap
@@ -49,7 +49,7 @@ Object {
   "failureThresholdType": "pixel",
   "receivedDir": undefined,
   "receivedImageBuffer": "pretendthisisanimagebuffer",
-  "snapshotIdentifier": "test-spec-js-test-1",
+  "snapshotIdentifier": "test-spec-js-test-1-snap",
   "snapshotsDir": "path/to/__image_snapshots__",
   "storeReceivedOnFailure": false,
   "updatePassedSnapshot": false,

diff --git a/__tests__/diff-snapshot.spec.js b/__tests__/diff-snapshot.spec.js
@@ -114,7 +114,7 @@ describe('diff-snapshot', () => {
 
       mockFs.existsSync.mockImplementation((p) => {
         switch (p) {
-          case path.join(mockSnapshotsDir, `${mockSnapshotIdentifier}-snap.png`):
+          case path.join(mockSnapshotsDir, `${mockSnapshotIdentifier}.png`):
             return snapshotExists;
           case mockDiffDir:
             return !!outputDirExists;
@@ -127,7 +127,7 @@ describe('diff-snapshot', () => {
       mockFs.readFileSync.mockImplementation((p) => {
         const bn = path.basename(p);
 
-        if (bn === 'id1-snap.png' && snapshotExists) {
+        if (bn === 'id1.png' && snapshotExists) {
           return mockImageBuffer;
         }
 
@@ -638,7 +638,7 @@ describe('diff-snapshot', () => {
       });
 
       expect(mockWriteFileSync).toHaveBeenCalledTimes(1);
-      expect(mockWriteFileSync).toHaveBeenCalledWith(path.join(mockSnapshotsDir, `${mockSnapshotIdentifier}-snap.png`), mockImageBuffer);
+      expect(mockWriteFileSync).toHaveBeenCalledWith(path.join(mockSnapshotsDir, `${mockSnapshotIdentifier}.png`), mockImageBuffer);
     });
 
     it('should return updated flag if snapshot was updated', () => {
@@ -674,7 +674,7 @@ describe('diff-snapshot', () => {
 
       expect(diffResult).toHaveProperty('added', true);
       expect(mockWriteFileSync).toHaveBeenCalledWith(
-        path.join(mockSnapshotsDir, 'id1-snap.png'),
+        path.join(mockSnapshotsDir, 'id1.png'),
         expect.any(Buffer)
       );
     });

diff --git a/__tests__/index.spec.js b/__tests__/index.spec.js
@@ -450,7 +450,7 @@ describe('toMatchImageSnapshot', () => {
       failureThreshold: 0,
       failureThresholdType: 'pixel',
       receivedImageBuffer: undefined,
-      snapshotIdentifier: 'test-spec-js-test-1-1',
+      snapshotIdentifier: 'test-spec-js-test-1-1-snap',
       snapshotsDir: 'path/to/__image_snapshots__',
       storeReceivedOnFailure: false,
       updatePassedSnapshot: false,
@@ -575,7 +575,7 @@ describe('toMatchImageSnapshot', () => {
       customDiffConfig: {
         perceptual: true,
       },
-      snapshotIdentifier: 'test-spec-js-test-1-1',
+      snapshotIdentifier: 'test-spec-js-test-1-1-snap',
       snapshotsDir: path.join('path', 'to', 'my-custom-snapshots-dir'),
       receivedDir: path.join('path', 'to', 'my-custom-received-dir'),
       diffDir: path.join('path', 'to', 'my-custom-diff-dir'),

diff --git a/__tests__/integration.spec.js b/__tests__/integration.spec.js
@@ -27,7 +27,7 @@ describe('toMatchImageSnapshot', () => {
   const customSnapshotsDir = path.resolve(__dirname, '__custom_snapshots_dir__');
   const cleanupRequiredIndicator = 'cleanup-required-';
   const getIdentifierIndicatingCleanupIsRequired = () => uniqueId(cleanupRequiredIndicator);
-  const getSnapshotFilename = identifier => `${identifier}-snap.png`;
+  const getSnapshotFilename = identifier => `${identifier}.png`;
   const diffExists = identifier => fs.existsSync(path.join(__dirname, diffOutputDir(), `${identifier}-diff.png`));
 
   beforeAll(() => {
@@ -103,7 +103,7 @@ describe('toMatchImageSnapshot', () => {
   describe('updates', () => {
     const customSnapshotIdentifier = 'integration-update';
     const updateImageData = fs.readFileSync(fromStubs('TestImageUpdate1pxOff.png'));
-    const updateImageSnapshotPath = path.join(__dirname, '__image_snapshots__', `${customSnapshotIdentifier}-snap.png`);
+    const updateImageSnapshotPath = path.join(__dirname, '__image_snapshots__', `${customSnapshotIdentifier}.png`);
 
     beforeEach(() => {
       fs.writeFileSync(updateImageSnapshotPath, imageData);

diff --git a/src/diff-snapshot.js b/src/diff-snapshot.js
@@ -205,7 +205,7 @@ function diffImageToSnapshot(options) {
 
   const comparisonFn = comparisonMethod === 'ssim' ? ssimMatch : pixelmatch;
   let result = {};
-  const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}-snap.png`);
+  const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}.png`);
   if (!fs.existsSync(baselineSnapshotPath)) {
     mkdirp.sync(path.dirname(baselineSnapshotPath));
     fs.writeFileSync(baselineSnapshotPath, receivedImageBuffer);

diff --git a/src/index.js b/src/index.js
@@ -108,7 +108,7 @@ function createSnapshotIdentifier({
   const counter = snapshotState._counters.get(currentTestName);
   const defaultIdentifier = kebabCase(`${path.basename(testPath)}-${currentTestName}-${counter}`);
 
-  let snapshotIdentifier = customSnapshotIdentifier || defaultIdentifier;
+  let snapshotIdentifier = customSnapshotIdentifier || `${defaultIdentifier}-snap`;
 
   if (typeof customSnapshotIdentifier === 'function') {
     const customRes = customSnapshotIdentifier({
@@ -195,7 +195,7 @@ function configureToMatchImageSnapshot({
     const snapshotsDir = customSnapshotsDir || path.join(path.dirname(testPath), SNAPSHOTS_DIR);
     const receivedDir = customReceivedDir;
     const diffDir = customDiffDir;
-    const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}-snap.png`);
+    const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}.png`);
     OutdatedSnapshotReporter.markTouchedFile(baselineSnapshotPath);
 
     if (snapshotState._updateSnapshot === 'none' && !fs.existsSync(baselineSnapshotPath)) {