test: switch to vitest

package.json

@@ -14,7 +14,7 @@
     "roll-node": "DEBUG=roller* node lib/node-cron.js",
     "roll-orb": "DEBUG=roller* node lib/orb-cron.js",
     "start": "DEBUG=roller* probot run ./lib/index.js",
-    "test": "jest --config=jest.json --coverage"
+    "test": "vitest run --coverage --reporter=verbose"
   },
   "repository": {
     "type": "git",
@@ -28,15 +28,14 @@
   "homepage": "https://github.com/electron/roller#readme",
   "devDependencies": {
     "@types/debug": "^4.1.12",
-    "@types/jest": "^29.5.14",
     "@types/node": "^22.9.0",
     "@types/semver": "^7.5.8",
+    "@vitest/coverage-v8": "3.0.2",
     "husky": "^9.1.6",
-    "jest": "^29.7.0",
     "lint-staged": "^15.2.10",
     "prettier": "^3.3.3",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "vitest": "^3.0.2"
   },
   "dependencies": {
     "@octokit/auth-app": "^6.0.2",

src/chromium-handler.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 
 import { MAIN_BRANCH, REPOS, ROLL_TARGETS } from './constants';
 import { compareChromiumVersions } from './utils/compare-chromium-versions';

src/index.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 import { Context, Probot } from 'probot';
 import { IssueCommentCreatedEvent, PullRequestClosedEvent } from '@octokit/webhooks-types';
 import { handleNodeCheck } from './node-handler';

src/node-handler.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 import * as semver from 'semver';
 
 import { MAIN_BRANCH, REPOS, ROLL_TARGETS } from './constants';

src/orb-handler.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 
 import * as semver from 'semver';
 import { ORB_TARGETS, OrbTarget, REPO_OWNER } from './constants';

src/utils/roll-orb.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 import * as yamljs from 'yaml';
 
 import { ORB_KEY, OrbTarget, Repository } from '../constants';

src/utils/roll.ts

@@ -1,4 +1,4 @@
-import * as debug from 'debug';
+import debug from 'debug';
 import * as semver from 'semver';
 
 import {

tests/handlers-spec.ts → tests/handlers.spec.ts

@@ -1,3 +1,5 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
 import { MAIN_BRANCH, REPOS, ROLL_TARGETS } from '../src/constants';
 import * as orbHandler from '../src/orb-handler';
 import * as rollOrb from '../src/utils/roll-orb';
@@ -9,26 +11,26 @@ import { getOctokit } from '../src/utils/octokit';
 import { roll } from '../src/utils/roll';
 import { getLatestLTSVersion } from '../src/utils/get-nodejs-lts';
 
-jest.mock('../src/utils/get-chromium-tags');
-jest.mock('../src/utils/octokit');
-jest.mock('../src/utils/roll');
-jest.mock('../src/utils/get-nodejs-lts');
+vi.mock('../src/utils/get-chromium-tags');
+vi.mock('../src/utils/octokit');
+vi.mock('../src/utils/roll');
+vi.mock('../src/utils/get-nodejs-lts');
 
 describe('handleChromiumCheck()', () => {
   let mockOctokit: any;
 
   beforeEach(() => {
     mockOctokit = {
-      paginate: jest.fn(),
+      paginate: vi.fn(),
       repos: {
         listBranches: {
           endpoint: {
-            merge: jest.fn(),
+            merge: vi.fn(),
           },
         },
-        getContent: jest.fn(),
-        get: jest.fn(),
-        getBranch: jest.fn().mockReturnValue({
+        getContent: vi.fn(),
+        get: vi.fn(),
+        getBranch: vi.fn().mockReturnValue({
           data: {
             name: MAIN_BRANCH,
             commit: {
@@ -38,7 +40,7 @@ describe('handleChromiumCheck()', () => {
         }),
       },
     };
-    (getOctokit as jest.Mock).mockReturnValue(mockOctokit);
+    vi.mocked(getOctokit).mockReturnValue(mockOctokit);
   });
 
   describe('release branches', () => {
@@ -58,7 +60,7 @@ describe('handleChromiumCheck()', () => {
           sha: '1234',
         },
       });
-      (getChromiumReleases as jest.Mock).mockReturnValue([
+      vi.mocked(getChromiumReleases).mockResolvedValue([
         {
           time: 1577869261000,
           version: '1.1.0.0',
@@ -167,7 +169,7 @@ describe('handleChromiumCheck()', () => {
       mockOctokit.repos.getBranch.mockReturnValue(null);
 
       const invalid = 'i-am-not-a-valid-release-branch';
-      expect(handleChromiumCheck(invalid)).rejects.toThrow(
+      await expect(handleChromiumCheck(invalid)).rejects.toThrow(
         'One or more upgrade checks failed - see logs for more details',
       );
     });
@@ -224,7 +226,7 @@ describe('handleChromiumCheck()', () => {
     });
 
     it('updates to main', async () => {
-      (getChromiumReleases as jest.Mock).mockReturnValue([
+      vi.mocked(getChromiumReleases).mockResolvedValue([
         {
           time: 1577869261000,
           version: '1.1.0.0',
@@ -259,7 +261,7 @@ describe('handleChromiumCheck()', () => {
     });
 
     it('takes no action if main is already in DEPS', async () => {
-      (getChromiumReleases as jest.Mock).mockReturnValue([
+      vi.mocked(getChromiumReleases).mockResolvedValue([
         {
           time: 1577869261000,
           version: '1.1.0.0',
@@ -298,7 +300,7 @@ describe('handleChromiumCheck()', () => {
         sha: '1234',
       },
     });
-    (getChromiumReleases as jest.Mock).mockReturnValue([
+    vi.mocked(getChromiumReleases).mockResolvedValue([
       {
         time: 1577869261000,
         version: '1.1.0.0',
@@ -322,7 +324,7 @@ describe('handleChromiumCheck()', () => {
       },
     ]);
 
-    (roll as jest.Mock).mockImplementationOnce(() => {
+    vi.mocked(roll).mockImplementationOnce(() => {
       throw new Error('');
     });
     await expect(handleChromiumCheck()).rejects.toThrowError(
@@ -337,17 +339,17 @@ describe('handleNodeCheck()', () => {
 
   beforeEach(() => {
     mockOctokit = {
-      paginate: jest.fn().mockReturnValue([]),
+      paginate: vi.fn().mockReturnValue([]),
       repos: {
-        getBranch: jest.fn().mockReturnValue({
+        getBranch: vi.fn().mockReturnValue({
           data: {
             name: MAIN_BRANCH,
             commit: {
               sha: '1234',
             },
           },
         }),
-        listReleases: jest.fn().mockReturnValue({
+        listReleases: vi.fn().mockReturnValue({
           data: [
             {
               tag_name: 'v11.2.0',
@@ -363,19 +365,19 @@ describe('handleNodeCheck()', () => {
             },
           ],
         }),
-        getContent: jest.fn(),
+        getContent: vi.fn(),
         listBranches: {
           endpoint: {
-            merge: jest.fn(),
+            merge: vi.fn(),
           },
         },
       },
     };
-    (getOctokit as jest.Mock).mockReturnValue(mockOctokit);
+    vi.mocked(getOctokit).mockReturnValue(mockOctokit);
   });
 
   it('rolls even major versions of Node.js with latest minor/patch update', async () => {
-    (getLatestLTSVersion as jest.Mock).mockReturnValue('14.0.0');
+    vi.mocked(getLatestLTSVersion).mockResolvedValue('14.0.0');
 
     mockOctokit.paginate.mockReturnValue([
       {
@@ -420,7 +422,7 @@ describe('handleNodeCheck()', () => {
   });
 
   it('does not roll for uneven major versions of Node.js', async () => {
-    (getLatestLTSVersion as jest.Mock).mockReturnValue('12.0.0');
+    vi.mocked(getLatestLTSVersion).mockResolvedValue('12.0.0');
 
     mockOctokit.repos.getContent.mockReturnValue({
       data: {
@@ -434,7 +436,7 @@ describe('handleNodeCheck()', () => {
   });
 
   it('does not roll if no newer release found', async () => {
-    (getLatestLTSVersion as jest.Mock).mockReturnValue('12.0.0');
+    vi.mocked(getLatestLTSVersion).mockResolvedValue('12.0.0');
 
     mockOctokit.repos.getContent.mockReturnValue({
       data: {
@@ -448,7 +450,7 @@ describe('handleNodeCheck()', () => {
   });
 
   it('throws error if roll() process failed', async () => {
-    (getLatestLTSVersion as jest.Mock).mockReturnValue('14.0.0');
+    vi.mocked(getLatestLTSVersion).mockResolvedValue('14.0.0');
 
     mockOctokit.repos.getContent.mockReturnValue({
       data: {
@@ -457,7 +459,7 @@ describe('handleNodeCheck()', () => {
       },
     });
 
-    (roll as jest.Mock)
+    vi.mocked(roll)
       .mockImplementationOnce(() => {
         throw new Error('');
       })
@@ -490,9 +492,9 @@ describe('node-orb', () => {
   };
 
   beforeEach(() => {
-    // mockReturnValue getReleveantReposList to return a list of repos that use the node orb
-    jest.spyOn(rollOrb, 'rollOrb').mockImplementation(async () => {});
-    jest.spyOn(orbHandler, 'getRelevantReposList').mockImplementation(async () => {
+    // mockReturnValue getRelevantReposList to return a list of repos that use the node orb
+    vi.spyOn(rollOrb, 'rollOrb').mockImplementation(async () => {});
+    vi.spyOn(orbHandler, 'getRelevantReposList').mockImplementation(async () => {
       return [
         {
           repo: 'fiddle',
@@ -506,7 +508,7 @@ describe('node-orb', () => {
     });
 
     mockOctokit = {
-      paginate: jest.fn().mockReturnValue([
+      paginate: vi.fn().mockReturnValue([
         {
           name: 'fiddle',
           owner: 'electron',
@@ -524,31 +526,31 @@ describe('node-orb', () => {
         },
       ]),
       pulls: {
-        create: jest.fn().mockReturnValue({ data: { html_url: 'https://google.com' } }),
+        create: vi.fn().mockReturnValue({ data: { html_url: 'https://google.com' } }),
       },
       git: {
-        createRef: jest.fn(),
+        createRef: vi.fn(),
       },
       repos: {
-        get: jest.fn().mockReturnValue({ data: { default_branch: 'main' } }),
-        getContent: jest.fn().mockReturnValue({
+        get: vi.fn().mockReturnValue({ data: { default_branch: 'main' } }),
+        getContent: vi.fn().mockReturnValue({
           data: {
             type: 'file',
             content: Buffer.from('orbs:\n  node: electronjs/[email protected]\n').toString('base64'),
           },
         }),
-        createOrUpdateFileContents: jest.fn(),
-        getLatestRelease: jest.fn().mockReturnValue({
+        createOrUpdateFileContents: vi.fn(),
+        getLatestRelease: vi.fn().mockReturnValue({
           data: {
             tag_name: '2.0.0',
           },
         }),
-        getBranch: jest.fn().mockReturnValue({
+        getBranch: vi.fn().mockReturnValue({
           data: branch,
         }),
       },
     };
-    (getOctokit as jest.Mock).mockReturnValue(mockOctokit);
+    vi.mocked(getOctokit).mockReturnValue(mockOctokit);
   });
 
   it('rolls relevant repos only', async () => {

tests/mocks/octokit.ts

@@ -1,10 +1,12 @@
+import { vi } from 'vitest';
+
 export const mockOctokit = {
   git: {
-    createRef: jest.fn(),
-    getRef: jest.fn(),
+    createRef: vi.fn(),
+    getRef: vi.fn(),
   },
   repos: {
-    getContent: jest.fn(),
-    updateFile: jest.fn(),
+    getContent: vi.fn(),
+    updateFile: vi.fn(),
   },
 };

tests/utils/pr-text-orb-spec.ts → tests/utils/pr-text-orb.spec.ts

@@ -1,7 +1,8 @@
+import { describe, expect, it, vi } from 'vitest';
+
 import { getOrbPRText } from '../../src/utils/pr-text-orb';
-import { ORB_TARGETS } from '../../src/constants';
 
-jest.mock('../../src/utils/octokit');
+vi.mock('../../src/utils/octokit');
 
 describe('getOrbPRText', () => {
   describe('node-orb target', () => {

tests/utils/pr-text-spec.ts → tests/utils/pr-text.spec.ts

@@ -1,7 +1,9 @@
+import { describe, expect, it, vi } from 'vitest';
+
 import { getPRText } from '../../src/utils/pr-text';
 import { ROLL_TARGETS, RollTarget } from '../../src/constants';
 
-jest.mock('../../src/utils/octokit');
+vi.mock('../../src/utils/octokit');
 
 describe('getPRText()', () => {
   describe('Node.js target', () => {