patch(vest): prevent skipped tests from persisting after override

shani-arnon · May 11, 2021 · d53d56d · d53d56d
1 parent c0180d1
commit d53d56d
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 42 deletions.
diff --git a/packages/vest/src/__tests__/integration.stateful-async.test.js b/packages/vest/src/__tests__/integration.stateful-async.test.js
@@ -79,6 +79,7 @@ describe('Stateful async tests', () => {
       expect(res).toMatchSnapshot();
       setTimeout(() => {
         const res = validate.get();
+
         expect(res.testCount).toBe(3);
         expect(res.errorCount).toBe(2);
         expect(res.warnCount).toBe(0);

diff --git a/packages/vest/src/core/produce/genTestsSummary.js b/packages/vest/src/core/produce/genTestsSummary.js
@@ -5,37 +5,47 @@ import {
   SEVERITY_GROUP_ERROR,
   TEST_COUNT,
 } from 'resultKeys';
-import { useSuiteId , useTestObjects } from 'stateHooks';
-
+import { useSuiteId, useTestObjects, useSkippedTests } from 'stateHooks';
 
 /**
  * Reads the testObjects list and gets full validation result from it.
  */
 const genTestsSummary = () => {
   const [testObjects] = useTestObjects();
   const [suiteIdState] = useSuiteId();
+  const [skippedTests] = useSkippedTests();
 
   const summary = {
     tests: {},
     groups: {},
     name: suiteIdState.name,
   };
 
-  testObjects.forEach(testObject => {
-    const { fieldName, groupName } = testObject;
+  appendSummary(testObjects);
+  appendSummary(skippedTests, true);
+
+  return countFailures(summary);
 
-    summary.tests[fieldName] = genTestObject(summary.tests, testObject);
+  function appendSummary(testObject, skipped) {
+    testObject.forEach(testObject => {
+      const { fieldName, groupName } = testObject;
 
-    if (groupName) {
-      summary.groups[groupName] = summary.groups[groupName] || {};
-      summary.groups[groupName][fieldName] = genTestObject(
-        summary.groups[groupName],
-        testObject
+      summary.tests[fieldName] = genTestObject(
+        summary.tests,
+        testObject,
+        skipped
       );
-    }
-  });
 
-  return countFailures(summary);
+      if (groupName) {
+        summary.groups[groupName] = summary.groups[groupName] || {};
+        summary.groups[groupName][fieldName] = genTestObject(
+          summary.groups[groupName],
+          testObject,
+          skipped
+        );
+      }
+    });
+  }
 };
 
 /**
@@ -63,8 +73,8 @@ export default genTestsSummary;
  * @param {VestTest} testObject
  * @returns {Object} Test result summary
  */
-const genTestObject = (summaryKey, testObject) => {
-  const { fieldName, isWarning, failed, statement, skipped } = testObject;
+const genTestObject = (summaryKey, testObject, skipped) => {
+  const { fieldName, isWarning, failed, statement } = testObject;
 
   summaryKey[fieldName] = summaryKey[fieldName] || {
     [SEVERITY_COUNT_ERROR]: 0,

diff --git a/packages/vest/src/core/state/createStateRef.js b/packages/vest/src/core/state/createStateRef.js
@@ -4,6 +4,7 @@ export default function createStateRef(state, { suiteId, name }) {
       pending: [],
       lagging: [],
     })),
+    skippedTests: state.registerStateKey(() => []),
     suiteId: state.registerStateKey(() => ({ id: suiteId, name })),
     testCallbacks: state.registerStateKey(() => ({
       fieldCallbacks: [],

diff --git a/packages/vest/src/core/state/stateHooks.js b/packages/vest/src/core/state/stateHooks.js
@@ -14,3 +14,6 @@ export function useTestCallbacks() {
 export function useTestObjects() {
   return getStateRef().testObjects();
 }
+export function useSkippedTests() {
+  return getStateRef().skippedTests();
+}
diff --git a/packages/vest/src/core/suite/__tests__/__snapshots__/subscribe.test.js.snap b/packages/vest/src/core/suite/__tests__/__snapshots__/subscribe.test.js.snap
@@ -4,6 +4,7 @@ exports[`suite.subscribe Should call handler on suite subscription initializatio
 Object {
   "suiteState": Object {
     "pending": [Function],
+    "skippedTests": [Function],
     "suiteId": [Function],
     "testCallbacks": [Function],
     "testObjects": [Function],

diff --git a/packages/vest/src/core/test/__tests__/__snapshots__/runAsyncTest.test.js.snap b/packages/vest/src/core/test/__tests__/__snapshots__/runAsyncTest.test.js.snap
@@ -11,12 +11,12 @@ Object {
         "fieldName": "field_1",
         "id": "0",
         "isWarning": false,
-        "skipped": false,
         "statement": "some statement string",
         "testFn": [Function],
       },
     ],
   },
+  "skippedTests": Array [],
   "suiteId": Object {
     "id": 1000,
     "name": "suite_name",

diff --git a/packages/vest/src/core/test/lib/VestTest.js b/packages/vest/src/core/test/lib/VestTest.js
@@ -19,8 +19,6 @@ function VestTest({ fieldName, statement, testFn, group }) {
     testFn,
   });
 
-  this.skipped = false;
-
   if (group) {
     this.groupName = group;
   }
@@ -57,8 +55,4 @@ VestTest.prototype.cancel = function () {
   removeTestFromState(this);
 };
 
-VestTest.prototype.markSkipped = function () {
-  this.skipped = true;
-};
-
 export default VestTest;
diff --git a/packages/vest/src/core/test/lib/__tests__/__snapshots__/VestTest.test.js.snap b/packages/vest/src/core/test/lib/__tests__/__snapshots__/VestTest.test.js.snap
@@ -6,7 +6,6 @@ VestTest {
   "fieldName": "unicycle",
   "id": "0",
   "isWarning": false,
-  "skipped": false,
   "statement": "I am Root.",
   "testFn": [MockFunction],
 }
@@ -18,7 +17,6 @@ VestTest {
   "fieldName": "unicycle",
   "id": "102",
   "isWarning": true,
-  "skipped": false,
   "statement": "I am Root.",
   "testFn": [MockFunction],
 }

diff --git a/packages/vest/src/core/test/lib/__tests__/__snapshots__/pending.test.js.snap b/packages/vest/src/core/test/lib/__tests__/__snapshots__/pending.test.js.snap
@@ -6,6 +6,7 @@ Object {
     "lagging": Array [],
     "pending": Array [],
   },
+  "skippedTests": Array [],
   "suiteId": Object {
     "id": 1000,
     "name": "suite_name",
@@ -24,6 +25,7 @@ Object {
     "lagging": Array [],
     "pending": Array [],
   },
+  "skippedTests": Array [],
   "suiteId": Object {
     "id": 1000,
     "name": "suite_name",
@@ -47,12 +49,12 @@ Object {
         "groupName": "group_name",
         "id": "4",
         "isWarning": false,
-        "skipped": false,
         "statement": "Some statement string",
         "testFn": [MockFunction],
       },
     ],
   },
+  "skippedTests": Array [],
   "suiteId": Object {
     "id": 1000,
     "name": "suite_name",
@@ -74,7 +76,6 @@ Object {
         "fieldName": "test_2",
         "id": "12",
         "isWarning": false,
-        "skipped": false,
         "statement": "Some statement string",
         "testFn": [MockFunction],
       },
@@ -83,7 +84,6 @@ Object {
         "fieldName": "test_1",
         "id": "11",
         "isWarning": false,
-        "skipped": false,
         "statement": "Some statement string",
         "testFn": [MockFunction],
       },
@@ -95,12 +95,12 @@ Object {
         "groupName": "group_name",
         "id": "15",
         "isWarning": false,
-        "skipped": false,
         "statement": "failure message",
         "testFn": [MockFunction],
       },
     ],
   },
+  "skippedTests": Array [],
   "suiteId": Object {
     "id": 1000,
     "name": "suite_name",

diff --git a/packages/vest/src/core/test/test.js b/packages/vest/src/core/test/test.js
@@ -8,6 +8,7 @@ import isStringValue from 'isStringValue';
 import { isUndefined } from 'isUndefined';
 import { setPending } from 'pending';
 import runAsyncTest from 'runAsyncTest';
+import { useSkippedTests } from 'stateHooks';
 import bindTestEach from 'test.each';
 import bindTestMemo from 'test.memo';
 import throwError from 'throwError';
@@ -44,11 +45,6 @@ const sync = testObject =>
 const register = testObject => {
   addTestToState(testObject);
 
-  if (isExcluded(testObject)) {
-    testObject.markSkipped();
-    return;
-  }
-
   // Run test callback.
   // If a promise is returned, set as async and
   // Move to pending list.
@@ -85,6 +81,7 @@ const register = testObject => {
  */
 function test(fieldName, args) {
   const [testFn, statement] = args.reverse();
+  const [, setSkippedTests] = useSkippedTests();
 
   const { groupName } = context.use();
   const testObject = new VestTest({
@@ -94,8 +91,13 @@ function test(fieldName, args) {
     testFn,
   });
 
+  if (isExcluded(testObject)) {
+    setSkippedTests(skippedTests => skippedTests.concat(testObject));
+    return testObject;
+  }
+
   if (!isFunction(testFn)) {
-    return;
+    return testObject;
   }
 
   register(testObject);

diff --git a/packages/vest/src/hooks/exclusive.js b/packages/vest/src/hooks/exclusive.js
@@ -74,14 +74,7 @@ skip.group = item =>
  * @returns {Boolean}
  */
 const isExcluded = testObject => {
-  const { fieldName, groupName, skipped } = testObject;
-
-  // this only happens after the test registration
-  // first time this gets registered, and in the follow
-  // up runs we can bail quickly
-  if (skipped) {
-    return true;
-  }
+  const { fieldName, groupName } = testObject;
 
   const { exclusion } = context.use();