Implement object oriented API proposal

nicojs · nicojs · commit ac2b879aa6b0 · 2023-05-02T20:38:50.000+02:00
diff --git a/e2e/__tests__/__snapshots__/runProgrammatically.test.ts.snap b/e2e/__tests__/__snapshots__/runProgrammatically.test.ts.snap
@@ -1,8 +1,8 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`runCore Jest programmatically: stdout 1`] = `"runCore success, 1 passed tests."`;
+exports[`createJest run programmatically: stdout 1`] = `"runCore success, 1 passed tests."`;
 
-exports[`runCore Jest programmatically: summary 1`] = `
+exports[`createJest run programmatically: summary 1`] = `
 "Test Suites: 1 passed, 1 total
 Tests:       1 passed, 1 total
 Snapshots:   0 total
diff --git a/e2e/__tests__/__snapshots__/runProgrammaticallyMultipleProjects.test.ts.snap b/e2e/__tests__/__snapshots__/runProgrammaticallyMultipleProjects.test.ts.snap
@@ -1,14 +1,14 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`runCLI programmatically with multiple projects: summary 1`] = `
+exports[`run jest programmatically with multiple projects: summary 1`] = `
 "Test Suites: 2 passed, 2 total
 Tests:       2 passed, 2 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
 Ran all test suites in 2 projects."
 `;
 
-exports[`runCore programmatically with multiple projects: summary 1`] = `
+exports[`runCLI programmatically with multiple projects: summary 1`] = `
 "Test Suites: 2 passed, 2 total
 Tests:       2 passed, 2 total
 Snapshots:   0 total
diff --git a/e2e/__tests__/runProgrammatically.test.ts b/e2e/__tests__/runProgrammatically.test.ts
@@ -21,8 +21,8 @@ test('run Jest programmatically esm', () => {
   expect(stdout).toMatch(/\d{2}\.\d{1,2}\.\d{1,2}[-\S]*-dev$/);
 });
 
-test('runCore Jest programmatically', () => {
-  const {stderr, stdout} = run('node core.mjs', dir);
+test('createJest run programmatically', () => {
+  const {stderr, stdout} = run('node jest.mjs', dir);
   const {summary} = extractSummary(stripAnsi(stderr));
 
   expect(summary).toMatchSnapshot('summary');
diff --git a/e2e/__tests__/runProgrammaticallyMultipleProjects.test.ts b/e2e/__tests__/runProgrammaticallyMultipleProjects.test.ts
@@ -18,8 +18,8 @@ test('runCLI programmatically with multiple projects', () => {
   expect(summary).toMatchSnapshot('summary');
 });
 
-test('runCore programmatically with multiple projects', () => {
-  const {stderr, exitCode} = run('node run-core.js', dir);
+test('run jest programmatically with multiple projects', () => {
+  const {stderr, exitCode} = run('node run-jest.js', dir);
   const {summary} = extractSummary(stripAnsi(stderr));
   expect(exitCode).toBe(0);
   expect(summary).toMatchSnapshot('summary');
diff --git a/e2e/run-programmatically-multiple-projects/run-jest.js b/e2e/run-programmatically-multiple-projects/run-jest.js
@@ -5,19 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const {runCore, readConfigs} = require('jest');
+const {createJest} = require('jest');
 
 async function main() {
-  const {globalConfig, configs} = await readConfigs(process.argv, ['.']);
-
-  await runCore(
-    {
-      ...globalConfig,
-      collectCoverage: false,
-      watch: false,
-    },
-    configs,
-  );
+  const jest = await createJest();
+  jest.globalConfig = {
+    collectCoverage: false,
+    watch: false,
+    ...jest.globalConfig,
+  };
+  await jest.run();
   console.log('run-programmatically-core-multiple-projects completed');
 }
 
diff --git a/e2e/run-programmatically/jest.mjs b/e2e/run-programmatically/jest.mjs
@@ -4,13 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import jest from 'jest';
+import jestModule from 'jest';
+const {createJest} = jestModule;
 
-const {globalConfig, configs} = await jest.readConfigs(process.argv, ['.']);
-const runConfig = Object.freeze({
-  ...globalConfig,
+const jest = await createJest();
+jest.globalConfig = {
   collectCoverage: false,
   watch: false,
-});
-const {results} = await jest.runCore(runConfig, configs);
+  ...jest.globalConfig,
+};
+const {results} = await jest.run();
 console.log(`runCore success, ${results.numPassedTests} passed tests.`);
diff --git a/e2e/snapshot/__tests__/__snapshots__/secondSnapshot.test.js.snap b/e2e/snapshot/__tests__/__snapshots__/secondSnapshot.test.js.snap
@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`snapshot works with plain objects and the title has \`escape\` characters 1`] = `
+{
+  "a": 1,
+  "b": "2",
+  "c": "three\`",
+  "d": "vier",
+}
+`;
diff --git a/e2e/snapshot/__tests__/__snapshots__/snapshot.test.js.snap b/e2e/snapshot/__tests__/__snapshots__/snapshot.test.js.snap
@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`snapshot is not influenced by previous counter 1`] = `
+{
+  "a": 43,
+  "b": "43",
+  "c": "fortythree",
+}
+`;
+
+exports[`snapshot works with \\r\\n 1`] = `
+"<div>
+</div>"
+`;
+
+exports[`snapshot works with plain objects and the title has \`escape\` characters 1`] = `
+{
+  "a": 1,
+  "b": "2",
+  "c": "three\`",
+}
+`;
+
+exports[`snapshot works with plain objects and the title has \`escape\` characters 2`] = `
+{
+  "a": 1,
+  "b": "2",
+  "c": "three\`",
+  "d": "4",
+}
+`;
diff --git a/e2e/snapshot/__tests__/__snapshots__/snapshot.test_copy.js.snap b/e2e/snapshot/__tests__/__snapshots__/snapshot.test_copy.js.snap
@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`snapshot is not influenced by previous counter 1`] = `
+{
+  "a": 43,
+  "b": "43",
+  "c": "fortythree",
+}
+`;
+
+exports[`snapshot works with \\r\\n 1`] = `
+"<div>
+</div>"
+`;
+
+exports[`snapshot works with plain objects and the title has \`escape\` characters 1`] = `
+{
+  "a": 1,
+  "b": "2",
+  "c": "three\`",
+}
+`;
+
+exports[`snapshot works with plain objects and the title has \`escape\` characters 2`] = `
+{
+  "a": 1,
+  "b": "2",
+  "c": "three\`",
+  "d": "4",
+}
+`;
diff --git a/e2e/snapshot/__tests__/snapshot.test_copy.js b/e2e/snapshot/__tests__/snapshot.test_copy.js
@@ -0,0 +1,41 @@
+/**
+ * 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.
+ *
+ */
+'use strict';
+
+describe('snapshot', () => {
+  it('works with plain objects and the title has `escape` characters', () => {
+    const test = {
+      a: 1,
+      b: '2',
+      c: 'three`',
+    };
+    expect(test).not.toBe(undefined);
+    test.d = '4';
+    expect(test).toMatchSnapshot();
+  });
+
+  it('is not influenced by previous counter', () => {
+    const test = {
+      a: 43,
+      b: '43',
+      c: 'fortythree',
+    };
+    expect(test).toMatchSnapshot();
+  });
+
+  it('cannot be used with .not', () => {
+    expect(() => expect('').not.toMatchSnapshot()).toThrow(
+      'Snapshot matchers cannot be used with not',
+    );
+  });
+
+  // Issue reported here: https://github.com/facebook/jest/issues/2969
+  it('works with \\r\\n', () => {
+    expect('<div>\r\n</div>').toMatchSnapshot();
+  });
+});
diff --git a/e2e/to-match-inline-snapshot/__tests__/async.test.js b/e2e/to-match-inline-snapshot/__tests__/async.test.js
@@ -0,0 +1,3 @@
+it('works with inline snapshots', () => {
+  expect({a: 1}).toMatchInlineSnapshot();
+});
diff --git a/e2e/to-match-snapshot/__tests__/__snapshots__/handle-property-matchers-with-hint.test.js.snap b/e2e/to-match-snapshot/__tests__/__snapshots__/handle-property-matchers-with-hint.test.js.snap
@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`handles property matchers with hint: descriptive hint 1`] = `
+{
+  "createdAt": Any<Date>,
+}
+`;
diff --git a/e2e/to-match-snapshot/__tests__/handle-property-matchers-with-hint.test.js b/e2e/to-match-snapshot/__tests__/handle-property-matchers-with-hint.test.js
@@ -0,0 +1,3 @@
+test('handles property matchers with hint', () => {
+  expect({createdAt: new Date()}).toMatchSnapshot({createdAt: expect.any(Date)}, 'descriptive hint');
+});
diff --git a/packages/jest-core/src/__tests__/jest.test.ts b/packages/jest-core/src/__tests__/jest.test.ts
@@ -0,0 +1,101 @@
+/**
+ * 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 {makeGlobalConfig, makeProjectConfig} from '@jest/test-utils';
+import type {Config} from '@jest/types';
+import * as jestConfig from 'jest-config';
+import * as jestUtil from 'jest-util';
+import {Jest, createJest} from '../jest';
+import runJest from '../runJest';
+import watch from '../watch';
+
+jest.mock('jest-runtime', () => ({
+  createHasteMap: () => ({
+    build: jest.fn(),
+  }),
+}));
+jest.mock('../lib/createContext', () => jest.fn());
+jest.mock('../runJest', () =>
+  jest.fn(({onComplete}) => {
+    onComplete({results: {success: true}});
+  }),
+);
+jest.mock('../watch', () => jest.fn());
+jest.mock('jest-util', () => {
+  const original = jest.requireActual<typeof jestUtil>('jest-util');
+
+  return {
+    ...original,
+    createDirectory: jest.fn(),
+  };
+});
+jest.mock('jest-config', () => ({
+  readConfigs: jest.fn(async () => {
+    const {makeProjectConfig, makeGlobalConfig} = await import(
+      '@jest/test-utils'
+    );
+    return {
+      configs: [makeProjectConfig()],
+      globalConfig: makeGlobalConfig(),
+    };
+  }),
+}));
+
+describe(Jest, () => {
+  let globalConfig: Config.GlobalConfig;
+  beforeEach(() => {
+    globalConfig = makeGlobalConfig();
+    jest.spyOn(jestUtil, 'createDirectory').mockReturnValue();
+    jest.spyOn(jestConfig, 'readConfigs').mockReturnValue(
+      Promise.resolve({
+        configs: [makeProjectConfig()],
+        globalConfig,
+        hasDeprecationWarnings: false,
+      }),
+    );
+  });
+
+  describe(Jest.createJest, () => {
+    it('should provide default values when no args are passed', async () => {
+      await Jest.createJest();
+      expect(jestConfig.readConfigs).toHaveBeenCalledWith(
+        expect.objectContaining({
+          $0: 'programmatic',
+          _: [],
+        }),
+        ['.'],
+      );
+    });
+  });
+
+  describe(Jest.prototype.run, () => {
+    it('should run once and provide the result', async () => {
+      const jestInstance = await createJest();
+      const actualResults = await jestInstance.run();
+      expect(jest.mocked(runJest)).toHaveBeenCalled();
+      expect(actualResults).toEqual({results: {results: {success: true}}});
+    });
+
+    it('should provide stderr as output stream when useStderr is true', async () => {
+      globalConfig.useStderr = true;
+      const jestInstance = await createJest();
+
+      await jestInstance.run();
+
+      expect(jest.mocked(runJest)).toHaveBeenCalledWith(
+        expect.objectContaining({outputStream: process.stderr}),
+      );
+    });
+
+    it('should not watch when watch is false', async () => {
+      globalConfig.watch = false;
+      const jestInstance = await createJest();
+      await jestInstance.run();
+      expect(jest.mocked(watch)).not.toHaveBeenCalled();
+    });
+  });
+});
diff --git a/packages/jest-core/src/__tests__/runCore.test.ts b/packages/jest-core/src/__tests__/runCore.test.ts
diff --git a/packages/jest-core/src/cli/index.ts b/packages/jest-core/src/cli/index.ts
diff --git a/packages/jest-core/src/index.ts b/packages/jest-core/src/index.ts
diff --git a/packages/jest-core/src/jest.ts b/packages/jest-core/src/jest.ts
diff --git a/packages/jest-core/src/types.ts b/packages/jest-core/src/types.ts
diff --git a/packages/jest/src/index.ts b/packages/jest/src/index.ts
