fix(expect, jest-snapshot, jest-circus, jest-types): Pass test.failing tests when containing failing snapshot matchers

Author: KhaledElmorsy

CHANGELOG.md

@@ -25,6 +25,7 @@
 
 ### Fixes
 
+- `[expect, jest-snapshot]` Pass `test.failing` tests when containing failing snapshot matchers  ([#14313](https://github.com/jestjs/jest/pull/14313))
 - `[jest-circus]` Prevent false test failures caused by promise rejections handled asynchronously ([#14110](https://github.com/jestjs/jest/pull/14110))
 - `[jest-config]` Handle frozen config object ([#14054](https://github.com/facebook/jest/pull/14054))
 - `[jest-config]` Allow `coverageDirectory` and `collectCoverageFrom` in project config ([#14180](https://github.com/jestjs/jest/pull/14180))

e2e/__tests__/__snapshots__/testFailingSnapshot.test.js.snap

@@ -0,0 +1,27 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`test.failing doesnt update or remove snapshots 1`] = `
+"// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[\`snapshots not updated nor removed 1\`] = \`"1"\`;
+
+exports[\`snapshots not updated nor removed 2\`] = \`"1"\`;
+
+exports[\`snapshots not updated nor removed 3\`] = \`"1"\`;
+"
+`;
+
+exports[`test.failing doesnt update or remove snapshots 2`] = `
+"/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test.failing('inline snapshot not updated', () => {
+  // eslint-disable-next-line quotes
+  expect('0').toMatchInlineSnapshot(\`"1"\`);
+});
+"
+`;

e2e/__tests__/testFailingSnapshot.test.js

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import * as path from 'path';
+import * as fs from 'graceful-fs';
+import runJest from '../runJest';
+
+describe('test.failing', () => {
+  // Skip running tests with Jasmine
+  if (process.env.JEST_JASMINE) {
+    test.skip('No Jasmine runner', () => {});
+    return;
+  }
+
+  describe('should pass when', () => {
+    test.failing('snapshot matchers fails', () => {
+      expect('0').toMatchSnapshot();
+    });
+
+    test.failing('snapshot doesnt exist', () => {
+      expect('0').toMatchSnapshot();
+    });
+
+    test.failing('inline snapshot matchers fails', () => {
+      expect('0').toMatchInlineSnapshot('0');
+    });
+
+    test.failing('at least one snapshot fails', () => {
+      expect('1').toMatchSnapshot();
+      expect('0').toMatchSnapshot();
+    });
+  });
+
+  describe('should fail when', () => {
+    test.each([
+      ['snapshot', 'snapshot'],
+      ['inline snapshot', 'inlineSnapshot'],
+    ])('%s matchers pass', (_, fileName) => {
+      const dir = path.resolve(__dirname, '../test-failing-snapshot-all-pass');
+      const result = runJest(dir, [`./__tests__/${fileName}.test.js`]);
+      expect(result.exitCode).toBe(1);
+    });
+  });
+
+  it('doesnt update or remove snapshots', () => {
+    const dir = path.resolve(__dirname, '../test-failing-snapshot');
+    const result = runJest(dir, ['-u']);
+    expect(result.exitCode).toBe(0);
+    expect(result.stdout).not.toMatch(/snapshots? (written|removed|obsolete)/);
+
+    const snapshot = fs
+      .readFileSync(
+        path.resolve(dir, './__tests__/__snapshots__/snapshot.test.js.snap'),
+      )
+      .toString();
+    expect(snapshot).toMatchSnapshot();
+
+    const inlineSnapshot = fs
+      .readFileSync(path.resolve(dir, './__tests__/inlineSnapshot.test.js'))
+      .toString();
+    expect(inlineSnapshot).toMatchSnapshot();
+  });
+});

e2e/test-failing-snapshot-all-pass/__tests__/__snapshots__/snapshot.test.js.snap

@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`snapshots not updated 1`] = `"1"`;
+
+exports[`snapshots not updated 2`] = `"1"`;

e2e/test-failing-snapshot-all-pass/__tests__/inlineSnapshot.test.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test.failing('inline snapshot not updated', () => {
+  // eslint-disable-next-line quotes
+  expect('1').toMatchInlineSnapshot(`"1"`);
+});

e2e/test-failing-snapshot-all-pass/__tests__/snapshot.test.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test.failing('snapshots not updated', () => {
+  expect('1').toMatchSnapshot();
+  expect('1').toMatchSnapshot();
+});

e2e/test-failing-snapshot-all-pass/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

e2e/test-failing-snapshot/__tests__/__snapshots__/snapshot.test.js.snap

@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`snapshots not updated nor removed 1`] = `"1"`;
+
+exports[`snapshots not updated nor removed 2`] = `"1"`;
+
+exports[`snapshots not updated nor removed 3`] = `"1"`;

e2e/test-failing-snapshot/__tests__/inlineSnapshot.test.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test.failing('inline snapshot not updated', () => {
+  // eslint-disable-next-line quotes
+  expect('0').toMatchInlineSnapshot(`"1"`);
+});

e2e/test-failing-snapshot/__tests__/snapshot.test.js

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test.failing('snapshots not updated nor removed', () => {
+  expect('1').toMatchSnapshot();
+  expect('0').toMatchSnapshot();
+  expect('0').toMatchSnapshot();
+});