migrate to vitest (#2314)

* vitest

* rename jest to vi

* fix test

* remove .skip tests

* make last test works

Author: dimaMachina

.npmrc

@@ -1 +1 @@
-save-exact=true
+save-exact=true

jest.config.js

@@ -31,7 +31,7 @@
     "prettier": "prettier --cache --write --list-different .",
     "release": "pnpm build && pnpm changeset publish",
     "release:canary": "npm run release -- canary",
-    "test": "jest"
+    "test": "vitest ."
   },
   "dependencies": {
     "@sentry/node": "7.41.0",
@@ -52,15 +52,13 @@
     "@types/body-parser": "1.19.2",
     "@types/cors": "2.8.13",
     "@types/express": "4.17.17",
-    "@types/jest": "27.5.2",
     "@types/node": "18.15.5",
     "@types/yargs": "17.0.3",
     "@zeit/ncc": "0.22.3",
     "bob-the-bundler": "1.7.3",
     "eslint": "8.35.0",
     "graphql": "16.6.0",
     "graphql-config": "4.5.0",
-    "jest": "27.5.1",
     "jsesc": "3.0.2",
     "lint-staged": "13.1.2",
     "lodash": "4.17.21",
@@ -69,8 +67,8 @@
     "rimraf": "4.3.1",
     "smee-client": "1.2.3",
     "strip-ansi": "6.0.1",
-    "ts-jest": "27.0.5",
-    "typescript": "4.2.4"
+    "typescript": "4.2.4",
+    "vitest": "0.29.7"
   },
   "sideEffects": false,
   "lint-staged": {

package.json

@@ -6,29 +6,29 @@ import { fileLoader } from '../src/files';
 import { getAssociatedPullRequest } from '../src/git';
 import { run } from '../src/run';
 
-jest.mock('../src/checks');
-jest.mock('../src/git');
-jest.mock('../src/files');
+vi.mock('../src/checks');
+vi.mock('../src/git');
+vi.mock('../src/files');
 
-const mockUpdateCheckRun = updateCheckRun as jest.MockedFunction<typeof updateCheckRun>;
-const mockFileLoader = fileLoader as jest.MockedFunction<typeof fileLoader>;
-const mockGetAssociatedPullRequest = getAssociatedPullRequest as jest.MockedFunction<
+const mockUpdateCheckRun = updateCheckRun as vi.MockedFunction<typeof updateCheckRun>;
+const mockFileLoader = fileLoader as vi.MockedFunction<typeof fileLoader>;
+const mockGetAssociatedPullRequest = getAssociatedPullRequest as vi.MockedFunction<
   typeof getAssociatedPullRequest
 >;
 
 describe('Inspector Action', () => {
-  const mockLoadFile = jest.fn();
+  const mockLoadFile = vi.fn();
 
   beforeEach(() => {
-    jest.clearAllMocks();
+    vi.clearAllMocks();
 
     // Mock error/warning/info/debug
-    jest.spyOn(core, 'error').mockImplementation(jest.fn());
-    jest.spyOn(core, 'warning').mockImplementation(jest.fn());
-    jest.spyOn(core, 'info').mockImplementation(jest.fn());
-    jest.spyOn(core, 'debug').mockImplementation(jest.fn());
+    vi.spyOn(core, 'error').mockImplementation(vi.fn());
+    vi.spyOn(core, 'warning').mockImplementation(vi.fn());
+    vi.spyOn(core, 'info').mockImplementation(vi.fn());
+    vi.spyOn(core, 'debug').mockImplementation(vi.fn());
 
-    jest.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
+    vi.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
       switch (name) {
         case 'github-token':
           return 'MOCK_GITHUB_TOKEN';
@@ -39,16 +39,16 @@ describe('Inspector Action', () => {
       }
     });
 
-    jest.spyOn(github, 'getOctokit').mockReturnValue({
+    vi.spyOn(github, 'getOctokit').mockReturnValue({
       checks: {
-        create: jest.fn().mockResolvedValue({
+        create: vi.fn().mockResolvedValue({
           data: {
             id: '2',
           },
         }),
       },
     });
-    jest.spyOn(github.context, 'repo', 'get').mockImplementation(() => {
+    vi.spyOn(github.context, 'repo', 'get').mockImplementation(() => {
       return {
         owner: 'some-owner',
         repo: 'graphql-inspector',
@@ -69,7 +69,7 @@ describe('Inspector Action', () => {
 
   describe('rules', () => {
     it('should accept a rules list with 1 built in rule', async () => {
-      jest.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
+      vi.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
         switch (name) {
           case 'github-token':
             return 'MOCK_GITHUB_TOKEN';
@@ -129,7 +129,7 @@ describe('Inspector Action', () => {
     });
 
     it('should accept a rules list with 1 custom rule', async () => {
-      jest.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
+      vi.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
         switch (name) {
           case 'github-token':
             return 'MOCK_GITHUB_TOKEN';
@@ -190,7 +190,7 @@ describe('Inspector Action', () => {
     });
 
     it('should accept a rules list with a built-in and a custom rule', async () => {
-      jest.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
+      vi.spyOn(core, 'getInput').mockImplementation((name: string, _options) => {
         switch (name) {
           case 'github-token':
             return 'MOCK_GITHUB_TOKEN';

packages/action/__tests__/run.test.ts

@@ -42,7 +42,7 @@
     "prebuild": "pnpm clean",
     "prepack": "bob prepack",
     "prepublishOnly": "pnpm build",
-    "test": "jest"
+    "test": "vitest ."
   },
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"

packages/action/jest.config.js

@@ -41,7 +41,7 @@
     "prebuild": "pnpm clean",
     "prepack": "bob prepack",
     "prepublishOnly": "pnpm build",
-    "test": "jest"
+    "test": "vitest ."
   },
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"

packages/ci/package.json

@@ -1,5 +1,6 @@
 import { isAbsolute, resolve } from 'path';
 import yargs, { CommandModule as Command } from 'yargs';
+import { hideBin } from 'yargs/helpers';
 import { InspectorConfig } from '@graphql-inspector/config';
 import { Loaders } from '@graphql-inspector/loaders';
 
@@ -78,5 +79,5 @@ export function parseGlobalArgs(args: GlobalArgs) {
 }
 
 export async function mockCommand(mod: Command, cmd: string) {
-  return yargs.command(mod).parseAsync(cmd);
+  return yargs(hideBin(process.argv)).command(mod).parseAsync(cmd);
 }

packages/cli/jest.config.js

@@ -3,9 +3,30 @@ import { buildSchema } from 'graphql';
 import yargs from 'yargs';
 import { mockCommand } from '@graphql-inspector/commands';
 import { mockLogger, unmockLogger } from '@graphql-inspector/logger';
-import '@graphql-inspector/testing';
 import createCommand from '../src';
 
+/*
+ * yargs copies value of `process.exit` in `lib/platform-shims/esm.mjs` file,
+ * but after our vitest mocking of `process.exit` doesn't work and exits Node.js process with
+ * Error: process.exit called with "1"
+ */
+vi.mock('yargs', async () => {
+  const yargsPath = require.resolve('yargs').replace('index.cjs', '');
+  const { YargsFactory } = await vi.importActual(yargsPath + 'build/lib/yargs-factory.js');
+  const { default: esmPlatformShim } = await vi.importActual(
+    yargsPath + 'lib/platform-shims/esm.mjs',
+  );
+  return {
+    default: YargsFactory({
+      ...esmPlatformShim,
+      process: {
+        ...esmPlatformShim.process,
+        exit: () => null,
+      },
+    }),
+  };
+});
+
 const oldSchema = buildSchema(/* GraphQL */ `
   type Post {
     id: ID
@@ -36,33 +57,21 @@ const diff = createCommand({
     loaders: [],
   },
   loaders: {
-    async loadSchema(pointer) {
-      if (pointer.includes('old')) {
-        return oldSchema;
-      }
-
-      return newSchema;
-    },
-    async loadDocuments() {
-      throw new Error('Not implemented');
-    },
+    loadSchema: pointer => (pointer.includes('old') ? oldSchema : newSchema),
   },
 });
 
 describe('diff', () => {
-  let spyReporter: jest.SpyInstance;
-  let spyProcessExit: jest.SpyInstance;
-  let spyProcessCwd: jest.SpyInstance;
+  let spyReporter: vi.SpyInstance;
+  let spyProcessExit: vi.SpyInstance;
+  let spyProcessCwd: vi.SpyInstance;
 
   beforeEach(() => {
     yargs();
-    spyProcessExit = jest.spyOn(process, 'exit');
-    spyProcessExit.mockImplementation();
-
-    spyProcessCwd = jest.spyOn(process, 'cwd').mockImplementation(() => __dirname);
-
-    spyReporter = jest.fn();
-    mockLogger(spyReporter as any);
+    spyProcessExit = vi.spyOn(process, 'exit').mockImplementation(() => null);
+    spyProcessCwd = vi.spyOn(process, 'cwd').mockImplementation(() => __dirname);
+    spyReporter = vi.fn();
+    mockLogger(spyReporter);
   });
 
   afterEach(() => {

packages/cli/package.json

@@ -39,16 +39,14 @@ const introspect = createCommand({
 });
 
 describe('introspect', () => {
-  let spyReporter: jest.SpyInstance;
-  let spyProcessCwd: jest.SpyInstance;
+  let spyReporter: vi.SpyInstance;
+  let spyProcessCwd: vi.SpyInstance;
 
   beforeEach(() => {
     yargs();
-
-    spyProcessCwd = jest.spyOn(process, 'cwd').mockImplementation(() => __dirname);
-
-    spyReporter = jest.fn();
-    mockLogger(spyReporter as any);
+    spyProcessCwd = vi.spyOn(process, 'cwd').mockImplementation(() => __dirname);
+    spyReporter = vi.fn();
+    mockLogger(spyReporter);
   });
 
   afterEach(() => {

packages/commands/commands/src/index.ts

@@ -3,7 +3,6 @@ import { buildSchema, parse } from 'graphql';
 import yargs from 'yargs';
 import { mockCommand } from '@graphql-inspector/commands';
 import { mockLogger, unmockLogger } from '@graphql-inspector/logger';
-import '@graphql-inspector/testing';
 import createCommand from '../src';
 
 const schema = buildSchema(/* GraphQL */ `
@@ -67,18 +66,15 @@ const validate = createCommand({
 });
 
 describe('validate', () => {
-  let spyReporter: jest.SpyInstance;
-  let spyProcessExit: jest.SpyInstance;
-  let spyProcessCwd: jest.SpyInstance;
+  let spyReporter: vi.SpyInstance;
+  let spyProcessExit: vi.SpyInstance;
+  let spyProcessCwd: vi.SpyInstance;
 
   beforeEach(() => {
-    spyProcessExit = jest.spyOn(process, 'exit');
-    spyProcessExit.mockImplementation();
-
-    spyProcessCwd = jest.spyOn(process, 'cwd').mockImplementation(() => __dirname);
-
-    spyReporter = jest.fn();
-    mockLogger(spyReporter as any);
+    spyProcessExit = vi.spyOn(process, 'exit').mockImplementation(() => null);
+    spyProcessCwd = vi.spyOn(process, 'cwd').mockImplementation(() => __dirname);
+    spyReporter = vi.fn();
+    mockLogger(spyReporter);
   });
 
   afterEach(() => {

packages/commands/diff/__tests__/diff-command.spec.ts renamed to packages/commands/diff/__tests__/diff-command.test.ts

@@ -1,6 +1,5 @@
 __tests__/
 src/
-jest.config.js
 tsconfig.json
 tsconfig.test.json
 *.zip

packages/commands/introspect/__tests__/introspect-command.spec.ts renamed to packages/commands/introspect/__tests__/introspect-command.test.ts

@@ -1,5 +1,5 @@
 import { buildSchema, getIntrospectionQuery, parse, print, Source } from 'graphql';
-import { coverage } from '../../src/index';
+import { coverage } from '../../src';
 
 describe('coverage', () => {
   const schema = buildSchema(/* GraphQL */ `

packages/commands/validate/__tests__/validate-command.ts renamed to packages/commands/validate/__tests__/validate-command.test.ts

@@ -1,6 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel } from '../../src/diff/changes/change';
-import { diff } from '../../src/index';
+import { CriticalityLevel, diff } from '../../src';
 import { findFirstChangeByPath } from '../../utils/testing';
 
 describe('argument', () => {

packages/core/.npmignore

@@ -1,6 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel } from '../../src/diff/changes/change';
-import { diff } from '../../src/index';
+import { CriticalityLevel, diff } from '../../src';
 import { findFirstChangeByPath } from '../../utils/testing';
 
 describe('directive', () => {

packages/core/__tests__/coverage/coverage.ts renamed to packages/core/__tests__/coverage/coverage.test.ts

@@ -1,6 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel } from '../../src/diff/changes/change';
-import { diff, DiffRule } from '../../src/index';
+import { CriticalityLevel, diff, DiffRule } from '../../src';
 import { findFirstChangeByPath } from '../../utils/testing';
 
 describe('enum', () => {

packages/core/__tests__/diff/argument.ts renamed to packages/core/__tests__/diff/argument.test.ts

@@ -1,5 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel, diff, DiffRule } from '../../src/index';
+import { CriticalityLevel, diff, DiffRule } from '../../src';
 import { findFirstChangeByPath } from '../../utils/testing';
 
 describe('input', () => {

packages/core/__tests__/diff/directive.ts renamed to packages/core/__tests__/diff/directive.test.ts

@@ -1,5 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel, diff } from '../../src/index';
+import { CriticalityLevel, diff } from '../../src';
 import { findChangesByPath, findFirstChangeByPath } from '../../utils/testing';
 
 describe('interface', () => {

packages/core/__tests__/diff/enum.ts renamed to packages/core/__tests__/diff/enum.test.ts

@@ -1,5 +1,5 @@
 import { buildSchema } from 'graphql';
-import { CriticalityLevel, diff, DiffRule } from '../../src/index';
+import { CriticalityLevel, diff, DiffRule } from '../../src';
 import { findChangesByPath, findFirstChangeByPath } from '../../utils/testing';
 
 describe('object', () => {

packages/core/__tests__/diff/input.ts renamed to packages/core/__tests__/diff/input.test.ts

@@ -1,6 +1,6 @@
 import { buildSchema } from 'graphql';
-import { considerUsage } from '../../../src/diff/rules/consider-usage';
-import { CriticalityLevel, diff } from '../../../src/index';
+import { CriticalityLevel, diff } from '../../../src';
+import { considerUsage } from '../../../src/diff/rules';
 import { findFirstChangeByPath } from '../../../utils/testing';
 
 describe('considerUsage rule', () => {