FEAT: get and reset as properties of createSuite result (#330)

Author: vligas

packages/vest/src/core/createSuite/index.js

@@ -1,11 +1,13 @@
 import { OPERATION_MODE_STATEFUL } from '../../constants';
+import { get } from '../../hooks';
 import runWithContext from '../../lib/runWithContext';
 import validateSuiteParams from '../../lib/validateSuiteParams';
 import Context from '../Context';
 import produce from '../produce';
 import { getSuite } from '../state';
 import getSuiteState from '../state/getSuiteState';
 import registerSuite from '../state/registerSuite';
+import reset from '../state/reset';
 import mergeExcludedTests from '../test/lib/mergeExcludedTests';
 
 /**
@@ -41,7 +43,7 @@ const createSuite = (name, tests) => {
   // returns validator function
   // and sets the function name
   // to the name of the suite
-  return Object.defineProperty(
+  return Object.defineProperties(
     (...args) => {
       const output = runWithContext(ctxRef, context => {
         registerSuite();
@@ -53,8 +55,17 @@ const createSuite = (name, tests) => {
       });
       return output;
     },
-    'name',
-    { value: name }
+    {
+      name: {
+        value: name,
+      },
+      get: {
+        value: () => get(name),
+      },
+      reset: {
+        value: () => reset(name),
+      },
+    }
   );
 };
 

packages/vest/src/core/createSuite/spec.js

@@ -2,7 +2,9 @@ import faker from 'faker';
 import { noop } from 'lodash';
 import mock from '../../../../../shared/testUtils/mock';
 import resetState from '../../../testUtils/resetState';
+import { dummyTest } from '../../../testUtils/testDummy';
 import { OPERATION_MODE_STATELESS } from '../../constants';
+import { get } from '../../hooks';
 import runWithContext from '../../lib/runWithContext';
 import { getSuite } from '../state';
 import createSuite from '.';
@@ -94,6 +96,25 @@ describe('Test createSuite module', () => {
       expect(getSuite(suiteId)).toMatchSnapshot();
     });
 
+    it('Should be able to get the suite from the result of createSuite', () => {
+      const testsCb = jest.fn();
+      const suiteId = 'test_get_suite';
+      expect(createSuite(suiteId, testsCb).get()).toBe(get(suiteId));
+    });
+
+    it('Should be able to reset the suite from the result of createSuite', () => {
+      const suiteId = 'test_reset_suite';
+      const testSuite = createSuite(suiteId, () => {
+        dummyTest.failing('f1', 'm1');
+      });
+      testSuite();
+      expect(get(suiteId).hasErrors()).toBe(true);
+      expect(get(suiteId).testCount).toBe(1);
+      testSuite.reset();
+      expect(get(suiteId).hasErrors()).toBe(false);
+      expect(get(suiteId).testCount).toBe(0);
+    });
+
     it('Should return without calling tests callback', () => {
       const validate = runCreateSuite();
       expect(testsCb).not.toHaveBeenCalled();

packages/vest/src/vest.d.ts

@@ -313,6 +313,12 @@ declare module 'vest' {
     memo(fieldName: string, testFn: TestCB, dependencies: any[]): VestTest;
   }
 
+  interface ICreateResult {
+    (...args: any[]): IVestResult;
+    get: Vest['get'];
+    reset: Vest['reset'];
+  }
+
   interface Vest {
     test: ITest;
     enforce: IEnforce;
@@ -367,10 +373,7 @@ declare module 'vest' {
      *
      * const res = validate({username: 'example'});
      */
-    create(
-      suiteName: string,
-      tests: (...args: any[]) => void
-    ): (...args: any[]) => IVestResult;
+    create(suiteName: string, tests: (...args: any[]) => void): ICreateResult;
 
     /**
      * Allows grouping tests so you can handle them together