update tests

Author: thymikee

packages/jest-config/src/normalize.js

@@ -340,6 +340,7 @@ export default function normalize(options: InitialOptions, argv: Argv) {
     comment: DOCUMENTATION_NOTE,
     deprecatedConfig: DEPRECATED_CONFIG,
     exampleConfig: VALID_CONFIG,
+    recursive: true,
   });
 
   options = normalizePreprocessor(

packages/jest-validate/README.md

@@ -18,6 +18,7 @@ Where `ValidationOptions` are:
 
 ```js
 type ValidationOptions = {
+  blacklist?: Array<string>
   comment?: string,
   condition?: (option: any, validOption: any) => boolean,
   deprecate?: (
@@ -34,6 +35,7 @@ type ValidationOptions = {
     options: ValidationOptions,
   ) => void,
   exampleConfig: Object,
+  recursive?: boolean
   title?: Title,
   unknown?: (
     config: Object,
@@ -60,11 +62,13 @@ Almost anything can be overwritten to suite your needs.
 
 ### Options
 
+- `blacklist` – optional array of string keyPaths that should be excluded from deep (recursive) validation.
 - `comment` – optional string to be rendered below error/warning message.
 - `condition` – an optional function with validation condition.
 - `deprecate`, `error`, `unknown` – optional functions responsible for displaying warning and error messages.
 - `deprecatedConfig` – optional object with deprecated config keys.
 - `exampleConfig` – the only **required** option with configuration against which you'd like to test.
+- `recursive` - optional boolean determining whether recursively compare `exampleConfig` to `config`.
 - `title` – optional object of titles for errors and messages.
 
 You will find examples of `condition`, `deprecate`, `error`, `unknown`, and `deprecatedConfig` inside source of this repository, named respectively.
@@ -84,6 +88,7 @@ validate(config, {
   comment: '  Documentation: http://custom-docs.com',
   deprecatedConfig,
   exampleConfig,
+  recursive: true,
   title: {
     deprecation: 'Custom Deprecation',
     // leaving 'error' and 'warning' as default
@@ -116,7 +121,9 @@ This will output:
 
   Example:
   {
-    "transform": {"^.+\\.js$": "<rootDir>/preprocessor.js"}
+    "transform": {
+      "^.+\\.js$": "<rootDir>/preprocessor.js"
+    }
   }
 
   Documentation: http://custom-docs.com

packages/jest-validate/src/__tests__/__snapshots__/validate.test.js.snap

@@ -32,7 +32,12 @@ exports[`pretty prints valid config for Array 1`] = `
 <red></>
 <red>  Example:</>
 <red>  {</>
-<red>    <bold>\\"coverageReporters\\"</>: <bold>[\\"json\\", \\"text\\", \\"lcov\\", \\"clover\\"]</></>
+<red>    <bold>\\"coverageReporters\\"</>: <bold>[</></>
+<red><bold>      \\"json\\",</></>
+<red><bold>      \\"text\\",</></>
+<red><bold>      \\"lcov\\",</></>
+<red><bold>      \\"clover\\"</></>
+<red><bold>    ]</></>
 <red>  }</>
 <red></>"
 `;
@@ -77,7 +82,12 @@ exports[`pretty prints valid config for Object 1`] = `
 <red></>
 <red>  Example:</>
 <red>  {</>
-<red>    <bold>\\"haste\\"</>: <bold>{\\"providesModuleNodeModules\\": [\\"react\\", \\"react-native\\"]}</></>
+<red>    <bold>\\"haste\\"</>: <bold>{</></>
+<red><bold>      \\"providesModuleNodeModules\\": [</></>
+<red><bold>        \\"react\\",</></>
+<red><bold>        \\"react-native\\"</></>
+<red><bold>      ]</></>
+<red><bold>    }</></>
 <red>  }</>
 <red></>"
 `;
@@ -122,7 +132,10 @@ exports[`works with custom errors 1`] = `
 <red></>
 <red>  Example:</>
 <red>  {</>
-<red>    <bold>\\"test\\"</>: <bold>[1, 2]</></>
+<red>    <bold>\\"test\\"</>: <bold>[</></>
+<red><bold>      1,</></>
+<red><bold>      2</></>
+<red><bold>    ]</></>
 <red>  }</>
 <red></>
 <red>My custom comment</>"

packages/jest-validate/src/__tests__/validate.test.js

@@ -18,41 +18,41 @@ const {
   deprecatedConfig,
 } = require('./fixtures/jest_config');
 
-test('validates default Jest config', () => {
+test('recursively validates default Jest config', () => {
   expect(
     validate(defaultConfig, {
       exampleConfig: validConfig,
+      recursive: true,
     }),
   ).toEqual({
     hasDeprecationWarnings: false,
     isValid: true,
   });
 });
 
-test('validates default jest-validate config', () => {
+test('recursively validates default jest-validate config', () => {
   expect(
     validate(jestValidateDefaultConfig, {
       exampleConfig: jestValidateExampleConfig,
+      recursive: true,
     }),
   ).toEqual({
     hasDeprecationWarnings: false,
     isValid: true,
   });
 });
 
-[
-  [{automock: []}, 'Boolean'],
-  [{coverageReporters: {}}, 'Array'],
-  [{preset: 1337}, 'String'],
-  [{haste: 42}, 'Object'],
-].forEach(([config, type]) => {
-  test(`pretty prints valid config for ${type}`, () => {
-    expect(() =>
-      validate(config, {
-        exampleConfig: validConfig,
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
+test.each([
+  ['Boolean', {automock: []}],
+  ['Array', {coverageReporters: {}}],
+  ['String', {preset: 1337}],
+  ['Object', {haste: 42}],
+])('pretty prints valid config for %s', (type, config) => {
+  expect(() =>
+    validate(config, {
+      exampleConfig: validConfig,
+    }),
+  ).toThrowErrorMatchingSnapshot();
 });
 
 test(`pretty prints valid config for Function`, () => {
@@ -61,6 +61,7 @@ test(`pretty prints valid config for Function`, () => {
   expect(() =>
     validate(config, {
       exampleConfig: validConfig,
+      recursive: true,
     }),
   ).toThrowErrorMatchingSnapshot();
 });
@@ -76,6 +77,58 @@ test('omits null and undefined config values', () => {
   });
 });
 
+test('recursively omits null and undefined config values', () => {
+  const config = {
+    haste: {
+      providesModuleNodeModules: null,
+    },
+  };
+  expect(
+    validate(config, {exampleConfig: validConfig, recursive: true}),
+  ).toEqual({
+    hasDeprecationWarnings: false,
+    isValid: true,
+  });
+});
+
+test('respects blacklist', () => {
+  const warn = console.warn;
+  console.warn = jest.fn();
+  const config = {
+    something: {
+      nested: {
+        some_random_key: 'value',
+        some_random_key2: 'value2',
+      },
+    },
+  };
+  const exampleConfig = {
+    something: {
+      nested: {
+        test: true,
+      },
+    },
+  };
+
+  validate(config, {
+    exampleConfig,
+    recursive: true,
+  });
+
+  expect(console.warn).toBeCalled();
+
+  console.warn.mockReset();
+
+  validate(config, {
+    blacklist: ['something.nested'],
+    exampleConfig,
+    recursive: true,
+  });
+
+  expect(console.warn).not.toBeCalled();
+  console.warn = warn;
+});
+
 test('displays warning for unknown config options', () => {
   const config = {unkwon: {}};
   const validConfig = {unknown: 'string'};
@@ -97,6 +150,7 @@ test('displays warning for deprecated config options', () => {
     validate(config, {
       deprecatedConfig,
       exampleConfig: validConfig,
+      recursive: true,
     }),
   ).toEqual({
     hasDeprecationWarnings: true,

packages/jest-validate/src/default_config.js

@@ -12,7 +12,6 @@ import type {ValidationOptions} from './types';
 import {deprecationWarning} from './deprecated';
 import {unknownOptionWarning} from './warnings';
 import {errorMessage} from './errors';
-import exampleConfig from './example_config';
 import validationCondition from './condition';
 import {ERROR, DEPRECATION, WARNING} from './utils';
 
@@ -23,7 +22,8 @@ export default ({
   deprecate: deprecationWarning,
   deprecatedConfig: {},
   error: errorMessage,
-  exampleConfig,
+  exampleConfig: {},
+  recursive: false,
   title: {
     deprecation: DEPRECATION,
     error: ERROR,

packages/jest-validate/src/example_config.js

@@ -10,6 +10,7 @@
 import type {ValidationOptions} from './types';
 
 const config: ValidationOptions = {
+  blacklist: [],
   comment: '  A comment',
   condition: (option, validOption) => true,
   deprecate: (config, option, deprecatedOptions, options) => false,
@@ -18,6 +19,7 @@ const config: ValidationOptions = {
   },
   error: (option, received, defaultValue, options) => {},
   exampleConfig: {key: 'value', test: 'case'},
+  recursive: true,
   title: {
     deprecation: 'Deprecation Warning',
     error: 'Validation Error',

packages/jest-validate/src/types.js

@@ -32,6 +32,7 @@ export type ValidationOptions = {
     path?: Array<string>,
   ) => void,
   exampleConfig: Object,
+  recursive?: boolean,
   title?: Title,
   unknown?: (
     config: Object,

packages/jest-validate/src/validate.js

@@ -13,6 +13,12 @@ import defaultConfig from './default_config';
 
 let hasDeprecationWarnings = false;
 
+const shouldSkipValidationForPath = (
+  path: Array<string>,
+  key: string,
+  blacklist: ?Array<string>,
+) => (blacklist ? blacklist.includes([...path, key].join('.')) : false);
+
 const _validate = (
   config: Object,
   exampleConfig: Object,
@@ -50,20 +56,18 @@ const _validate = (
       ) {
         options.error(key, config[key], exampleConfig[key], options, path);
       }
-    } else if (
-      options.blacklist &&
-      options.blacklist.includes(path.join('.'))
-    ) {
+    } else if (shouldSkipValidationForPath(path, key, options.blacklist)) {
       // skip validating unknown options inside blacklisted paths
     } else {
       options.unknown &&
         options.unknown(config, exampleConfig, key, options, path);
     }
 
     if (
+      options.recursive &&
       !Array.isArray(exampleConfig[key]) &&
       options.blacklist &&
-      !options.blacklist.includes(path.join('.'))
+      !shouldSkipValidationForPath(path, key, options.blacklist)
     ) {
       _validate(config[key], exampleConfig[key], options, [...path, key]);
     }