vest 5.0.0-dev-781e21 → 5.0.2-dev-d315d9

package/src/__tests__/__snapshots__/integration.stateful-tests.test.ts.snap

@@ -0,0 +1,376 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Stateful behavior Should merge skipped fields with previous values 1`] = `
+{
+  "done": [Function],
+  "errorCount": 1,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 1,
+  "tests": {
+    "field_1": {
+      "errorCount": 1,
+      "errors": [
+        "field_statement_1",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_2": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_3": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_4": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_5": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 0,
+}
+`;
+
+exports[`Stateful behavior Should merge skipped fields with previous values 2`] = `
+{
+  "done": [Function],
+  "errorCount": 3,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 3,
+  "tests": {
+    "field_1": {
+      "errorCount": 1,
+      "errors": [
+        "field_statement_1",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_2": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_3": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_4": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_5": {
+      "errorCount": 2,
+      "errors": [
+        "field_statement_5",
+        "field_statement_6",
+      ],
+      "testCount": 2,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 0,
+}
+`;
+
+exports[`Stateful behavior Should merge skipped fields with previous values 3`] = `
+{
+  "done": [Function],
+  "errorCount": 4,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 7,
+  "tests": {
+    "field_1": {
+      "errorCount": 1,
+      "errors": [
+        "field_statement_1",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_2": {
+      "errorCount": 1,
+      "errors": [
+        "field_statement_2",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_3": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 1,
+      "valid": true,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "field_4": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 2,
+      "valid": true,
+      "warnCount": 1,
+      "warnings": [
+        "field_statement_4",
+      ],
+    },
+    "field_5": {
+      "errorCount": 2,
+      "errors": [
+        "field_statement_5",
+        "field_statement_6",
+      ],
+      "testCount": 2,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 1,
+}
+`;
+
+exports[`more complex Should run correctly 1`] = `
+{
+  "errorCount": 0,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 0,
+  "tests": {},
+  "valid": false,
+  "warnCount": 0,
+}
+`;
+
+exports[`more complex Should run correctly 2`] = `
+{
+  "errorCount": 0,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 2,
+  "tests": {
+    "confirm": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "password": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "username": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 2,
+      "valid": true,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 0,
+}
+`;
+
+exports[`more complex Should run correctly 4`] = `
+{
+  "errorCount": 1,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 3,
+  "tests": {
+    "confirm": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "password": {
+      "errorCount": 1,
+      "errors": [
+        "password is required",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "username": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 2,
+      "valid": true,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 0,
+}
+`;
+
+exports[`more complex Should run correctly 6`] = `
+{
+  "errorCount": 1,
+  "getErrors": [Function],
+  "getErrorsByGroup": [Function],
+  "getWarnings": [Function],
+  "getWarningsByGroup": [Function],
+  "groups": {},
+  "hasErrors": [Function],
+  "hasErrorsByGroup": [Function],
+  "hasWarnings": [Function],
+  "hasWarningsByGroup": [Function],
+  "isValid": [Function],
+  "isValidByGroup": [Function],
+  "suiteName": undefined,
+  "testCount": 3,
+  "tests": {
+    "confirm": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 0,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "password": {
+      "errorCount": 1,
+      "errors": [
+        "password is required",
+      ],
+      "testCount": 1,
+      "valid": false,
+      "warnCount": 0,
+      "warnings": [],
+    },
+    "username": {
+      "errorCount": 0,
+      "errors": [],
+      "testCount": 2,
+      "valid": true,
+      "warnCount": 0,
+      "warnings": [],
+    },
+  },
+  "valid": false,
+  "warnCount": 0,
+}
+`;

package/src/__tests__/integration.async-tests.test.ts

@@ -0,0 +1,90 @@
+import wait from 'wait';
+
+import { TestPromise } from '../../testUtils/testPromise';
+
+import * as vest from 'vest';
+import { TTestSuite } from 'testUtils/TVestMock';
+
+function genSuite() {
+  return vest.create(() => {
+    vest.test('field_1', 'field_statement_1', () => false);
+    vest.test('field_2', 'field_statement_2', () => {
+      vest.enforce(2).equals(3);
+    });
+    vest.test('field_3', 'field_statement_3', jest.fn());
+    vest.test('field_4', 'field_statement_4', () => {
+      vest.warn();
+      throw new Error();
+    });
+    vest.test('field_4', 'field_statement_4', () => {
+      vest.warn();
+    });
+    vest.test('field_5', 'field_statement_5', () => false);
+    vest.test('field_5', 'field_statement_6', () => false);
+    vest.test('field_6', 'async_statement_1', async () => {
+      await wait(250);
+    });
+    vest.test('field_7', () => Promise.reject('async_statement_2'));
+  });
+}
+
+let suite: TTestSuite;
+describe('Stateful behavior', () => {
+  let result,
+    callback_1 = jest.fn(),
+    callback_2 = jest.fn(),
+    callback_3 = jest.fn(),
+    control = jest.fn();
+
+  beforeEach(() => {
+    suite = genSuite();
+  });
+
+  beforeAll(() => {
+    callback_1 = jest.fn();
+    callback_2 = jest.fn();
+    callback_3 = jest.fn();
+    control = jest.fn();
+  });
+
+  test('Should have all fields', () =>
+    TestPromise(done => {
+      // ❗️Why is this test async? Because of the `resetState` beforeEach.
+      // We must not clean up before the suite is actually done.
+      result = suite().done(done);
+      expect(result.tests).toHaveProperty('field_1');
+      expect(result.tests).toHaveProperty('field_2');
+      expect(result.tests).toHaveProperty('field_4');
+      expect(result.tests).toHaveProperty('field_5');
+      expect(result.tests).toHaveProperty('field_6');
+      expect(result.tests).toHaveProperty('field_7');
+      expect(result.hasErrors('field_7')).toBe(false);
+      expect(result.tests).toMatchSnapshot();
+    }));
+
+  it('Should invoke done callback specified with sync field immediately, and the others after finishing', () =>
+    TestPromise(done => {
+      result = suite();
+      result
+        .done('field_1', callback_1)
+        .done('field_6', callback_2)
+        .done(callback_3);
+      expect(callback_1).toHaveBeenCalled();
+      expect(callback_2).not.toHaveBeenCalled();
+      expect(callback_3).not.toHaveBeenCalled();
+
+      setTimeout(() => {
+        expect(callback_2).not.toHaveBeenCalled();
+        expect(callback_3).not.toHaveBeenCalled();
+        expect(suite.get().hasErrors('field_7')).toBe(true);
+        control();
+      });
+
+      setTimeout(() => {
+        expect(callback_2).toHaveBeenCalled();
+        expect(callback_3).toHaveBeenCalled();
+        expect(control).toHaveBeenCalled();
+        done();
+      }, 250);
+    }));
+});

package/src/__tests__/integration.base.test.ts

@@ -0,0 +1,45 @@
+import * as vest from 'vest';
+
+const suite = () =>
+  vest.create(() => {
+    vest.skip('field_5');
+    vest.test('field_1', 'field_statement_1', () => false);
+    vest.test('field_2', 'field_statement_2', () => {
+      expect(2).toBe(3);
+    });
+    vest.test('field_3', 'field_statement_3', jest.fn());
+    vest.test('field_4', 'field_statement_4', () => {
+      vest.warn();
+      throw new Error();
+    });
+
+    vest.test('field_4', 'field_statement_4', () => {
+      vest.warn();
+    });
+    vest.test('field_5', 'field_statement_5', () => false);
+    vest.test('field_5', 'field_statement_6', () => false);
+  })();
+
+describe('Base behavior', () => {
+  let res: vest.SuiteRunResult<string>;
+
+  beforeEach(() => {
+    res = suite();
+  });
+
+  test('Should produce correct validation result', () => {
+    expect(res.tests).toHaveProperty('field_1');
+    expect(res.tests).toHaveProperty('field_2');
+    expect(res.tests).toHaveProperty('field_3');
+    expect(res.tests).toHaveProperty('field_4');
+    expect(res.tests.field_5.testCount).toBe(0);
+    expect(suite()).toMatchSnapshot();
+  });
+
+  it('Should run done callbacks immediately', () => {
+    const callback = jest.fn();
+    res.done(callback);
+
+    expect(callback).toHaveBeenCalled();
+  });
+});

package/src/__tests__/integration.exclusive.test.ts

@@ -0,0 +1,88 @@
+import * as vest from 'vest';
+
+let suite: vest.Suite<
+  (exclusion?: Record<string, string | string[]>) => void,
+  string
+>;
+
+beforeEach(() => {
+  suite = genSuite();
+});
+
+describe('only', () => {
+  it('Should only count included fields', () => {
+    const res = suite({
+      only: ['field_1', 'field_2'],
+    });
+
+    expect(res.tests.field_1.testCount).toBe(1);
+    expect(res.tests.field_2.testCount).toBe(1);
+    expect(res.tests.field_3.testCount).toBe(0);
+    expect(res.tests.field_4.testCount).toBe(0);
+    expect(res.tests.field_5.testCount).toBe(0);
+  });
+  it('Should only count included field', () => {
+    const res = suite({
+      only: 'field_1',
+    });
+
+    expect(res.tests.field_1.testCount).toBe(1);
+    expect(res.tests.field_2.testCount).toBe(0);
+    expect(res.tests.field_3.testCount).toBe(0);
+    expect(res.tests.field_4.testCount).toBe(0);
+    expect(res.tests.field_5.testCount).toBe(0);
+  });
+});
+describe('skip', () => {
+  it('Should count all but excluded fields', () => {
+    const res = suite({
+      skip: ['field_1', 'field_2'],
+    });
+
+    expect(res.tests.field_1.testCount).toBe(0);
+    expect(res.tests.field_2.testCount).toBe(0);
+    expect(res.tests.field_3.testCount).toBe(1);
+    expect(res.tests.field_4.testCount).toBe(1);
+    expect(res.tests.field_5.testCount).toBe(1);
+  });
+
+  it('Should count all but excluded field', () => {
+    const res = suite({
+      skip: 'field_1',
+    });
+
+    expect(res.tests.field_1.testCount).toBe(0);
+    expect(res.tests.field_2.testCount).toBe(1);
+    expect(res.tests.field_3.testCount).toBe(1);
+    expect(res.tests.field_4.testCount).toBe(1);
+    expect(res.tests.field_5.testCount).toBe(1);
+  });
+});
+
+describe('Combined', () => {
+  test('Last declaration wins', () => {
+    const res = suite({
+      only: ['field_1', 'field_2', 'field_3'],
+      skip: ['field_1'],
+      skip_last: 'field_3',
+    });
+
+    expect(res.tests.field_1.testCount).toBe(1);
+    expect(res.tests.field_2.testCount).toBe(1);
+    expect(res.tests.field_3.testCount).toBe(0);
+  });
+});
+
+function genSuite() {
+  return vest.create((exclusion: Record<string, string | string[]> = {}) => {
+    vest.skip(exclusion?.skip);
+    vest.only(exclusion?.only);
+    vest.skip(exclusion?.skip_last);
+
+    vest.test('field_1', 'msg', () => {});
+    vest.test('field_2', 'msg', () => {});
+    vest.test('field_3', 'msg', () => {});
+    vest.test('field_4', 'msg', () => {});
+    vest.test('field_5', 'msg', () => {});
+  });
+}