Get all tests passing

src/editor.test.ts

@@ -26,10 +26,9 @@ describe('editor', () => {
       vitest
         .spyOn(envModule, 'getEnvironmentVariables')
         .mockReturnValue({ EDITOR: 'editor' });
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
-        .calledWith('editor')
-        .thenResolve(null);
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
+      const resolveExecutableSpy = vitest.spyOn(miscUtils, 'resolveExecutable');
+      when(resolveExecutableSpy).calledWith('editor').thenResolve(null);
+      when(resolveExecutableSpy)
         .calledWith('code')
         .thenResolve('/path/to/code');
 
@@ -43,12 +42,9 @@ describe('editor', () => {
       vitest
         .spyOn(envModule, 'getEnvironmentVariables')
         .mockReturnValue({ EDITOR: 'editor' });
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
-        .calledWith('editor')
-        .thenResolve(null);
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
-        .calledWith('code')
-        .thenResolve(null);
+      const resolveExecutableSpy = vitest.spyOn(miscUtils, 'resolveExecutable');
+      when(resolveExecutableSpy).calledWith('editor').thenResolve(null);
+      when(resolveExecutableSpy).calledWith('code').thenResolve(null);
 
       expect(await determineEditor()).toBeNull();
     });
@@ -57,10 +53,9 @@ describe('editor', () => {
       vitest
         .spyOn(envModule, 'getEnvironmentVariables')
         .mockReturnValue({ EDITOR: 'editor' });
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
-        .calledWith('editor')
-        .thenResolve(null);
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
+      const resolveExecutableSpy = vitest.spyOn(miscUtils, 'resolveExecutable');
+      when(resolveExecutableSpy).calledWith('editor').thenResolve(null);
+      when(resolveExecutableSpy)
         .calledWith('code')
         .thenReject(new Error('some error'));
 
@@ -71,12 +66,11 @@ describe('editor', () => {
       vitest
         .spyOn(envModule, 'getEnvironmentVariables')
         .mockReturnValue({ EDITOR: 'editor' });
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
+      const resolveExecutableSpy = vitest.spyOn(miscUtils, 'resolveExecutable');
+      when(resolveExecutableSpy)
         .calledWith('editor')
         .thenReject(new Error('some error'));
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
-        .calledWith('code')
-        .thenResolve(null);
+      when(resolveExecutableSpy).calledWith('code').thenResolve(null);
 
       expect(await determineEditor()).toBeNull();
     });
@@ -85,10 +79,11 @@ describe('editor', () => {
       vitest
         .spyOn(envModule, 'getEnvironmentVariables')
         .mockReturnValue({ EDITOR: 'editor' });
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
+      const resolveExecutableSpy = vitest.spyOn(miscUtils, 'resolveExecutable');
+      when(resolveExecutableSpy)
         .calledWith('editor')
         .thenReject(new Error('some error'));
-      when(vitest.spyOn(miscUtils, 'resolveExecutable'))
+      when(resolveExecutableSpy)
         .calledWith('code')
         .thenReject(new Error('some error'));
 

src/fs.test.ts

@@ -202,15 +202,15 @@ describe('fs', () => {
 
         await expect(
           fs.promises.readdir(path.join(sandbox.directoryPath, 'foo')),
-        ).toResolve();
+        ).toBeDefined();
         await expect(
           fs.promises.readdir(path.join(sandbox.directoryPath, 'foo', 'bar')),
-        ).toResolve();
+        ).toBeDefined();
         await expect(
           fs.promises.readdir(
             path.join(sandbox.directoryPath, 'foo', 'bar', 'baz'),
           ),
-        ).toResolve();
+        ).toBeDefined();
       });
     });
 
@@ -228,7 +228,7 @@ describe('fs', () => {
           path.join(sandbox.directoryPath, 'foo', 'bar', 'baz'),
         );
 
-        await expect(ensureDirectoryPathExists(directoryPath)).toResolve();
+        await expect(ensureDirectoryPathExists(directoryPath)).toBeDefined();
       });
     });
 

src/project.test.ts

@@ -75,7 +75,11 @@ describe('project', () => {
         vitest
           .spyOn(actionUtils, 'getWorkspaceLocations')
           .mockResolvedValue(['packages/a', 'packages/subpackages/b']);
-        when(vitest.spyOn(packageModule, 'readMonorepoWorkspacePackage'))
+        const readMonorepoWorkspacePackageSpy = vitest.spyOn(
+          packageModule,
+          'readMonorepoWorkspacePackage',
+        );
+        when(readMonorepoWorkspacePackageSpy)
           .calledWith({
             packageDirectoryPath: path.join(
               projectDirectoryPath,
@@ -89,7 +93,7 @@ describe('project', () => {
             stderr,
           })
           .thenResolve(workspacePackages.a);
-        when(vitest.spyOn(packageModule, 'readMonorepoWorkspacePackage'))
+        when(readMonorepoWorkspacePackageSpy)
           .calledWith({
             packageDirectoryPath: path.join(
               projectDirectoryPath,
@@ -127,6 +131,7 @@ describe('project', () => {
       });
     });
   });
+
   describe('restoreChangelogsForSkippedPackages', () => {
     it('should reset changelog for packages with changes not included in release', async () => {
       const project = buildMockProject({
@@ -146,11 +151,13 @@ describe('project', () => {
 
       const restoreFilesSpy = vitest.spyOn(repoModule, 'restoreFiles');
 
-      when(vitest.spyOn(fs, 'fileExists'))
+      const fileExistsSpy = vitest.spyOn(fs, 'fileExists');
+
+      when(fileExistsSpy)
         .calledWith(project.workspacePackages.b.changelogPath)
         .thenResolve(true);
 
-      when(vitest.spyOn(fs, 'fileExists'))
+      when(fileExistsSpy)
         .calledWith(project.workspacePackages.c.changelogPath)
         .thenResolve(true);
 

src/repo.test.ts

@@ -40,43 +40,29 @@ describe('repo', () => {
       );
     });
 
-    it('throws if the URL of the "origin" remote is in an invalid format', async () => {
-      const repositoryDirectoryPath = '/path/to/project';
-      when(vitest.spyOn(miscUtils, 'getStdoutFromCommand'))
-        .calledWith('git', ['config', '--get', 'remote.origin.url'], {
-          cwd: repositoryDirectoryPath,
-        })
-        // TODO: `vitest-when` doesn't have a `thenResolveOnce` method.
-        .mockResolvedValueOnce('foo')
-        .mockResolvedValueOnce('http://github.com/Foo/Bar')
-        .mockResolvedValueOnce('https://gitbar.foo/Foo/Bar')
-        .mockResolvedValueOnce('[email protected]:Foo/Bar.git')
-        .mockResolvedValueOnce('[email protected]:Foo/Bar.foo');
-
-      await expect(
-        getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).rejects.toThrow('Unrecognized URL for git remote "origin": foo');
-      await expect(
-        getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).rejects.toThrow(
-        'Unrecognized URL for git remote "origin": http://github.com/Foo/Bar',
-      );
-      await expect(
-        getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).rejects.toThrow(
-        'Unrecognized URL for git remote "origin": https://gitbar.foo/Foo/Bar',
-      );
-      await expect(
-        getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).rejects.toThrow(
-        'Unrecognized URL for git remote "origin": [email protected]:Foo/Bar.git',
-      );
-      await expect(
-        getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).rejects.toThrow(
-        'Unrecognized URL for git remote "origin": [email protected]:Foo/Bar.foo',
-      );
-    });
+    it.each([
+      'foo',
+      'http://github.com/Foo/Bar',
+      'https://gitbar.foo/Foo/Bar',
+      '[email protected]:Foo/Bar.git',
+      '[email protected]:Foo/Bar.foo',
+    ])(
+      'throws if the URL of the "origin" remote is in the invalid format "%s"',
+      async (originUrl) => {
+        const repositoryDirectoryPath = '/path/to/project';
+        when(vitest.spyOn(miscUtils, 'getStdoutFromCommand'))
+          .calledWith('git', ['config', '--get', 'remote.origin.url'], {
+            cwd: repositoryDirectoryPath,
+          })
+          .thenResolve(originUrl);
+
+        await expect(
+          getRepositoryHttpsUrl(repositoryDirectoryPath),
+        ).rejects.toThrow(
+          `Unrecognized URL for git remote "origin": ${originUrl}`,
+        );
+      },
+    );
   });
 
   describe('commitAllChanges', () => {

vitest.config.ts

@@ -2,25 +2,19 @@ import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
-    watch: false,
-
-    // Vitest doesn't inject the globals by default. We enable this option to
-    // inject the globals like `describe`, `it`, `expect`, etc.
-    globals: true,
-
     coverage: {
       enabled: true,
 
-      // Configure the coverage provider. We use `istanbul` here, because it
-      // is more stable than `v8`.
-      provider: 'istanbul',
-
       // Only include source files in the `src` directory.
       include: ['src/**/*.test.ts'],
 
       // Exclude certain files from the coverage.
       exclude: ['node_modules/', 'src/cli.ts', 'src/command-line-arguments.ts'],
 
+      // Configure the coverage provider. We use `istanbul` here, because it
+      // is more stable than `v8`.
+      provider: 'istanbul',
+
       // Hide files with 100% coverage.
       skipFull: true,
 
@@ -30,11 +24,30 @@ export default defineConfig({
         // Auto-update the coverage thresholds.
         autoUpdate: true,
 
+        // These should be set to 100 at all times.
         branches: 100,
         functions: 100,
         lines: 100,
         statements: 100,
       },
     },
+
+    // Vitest doesn't inject the globals by default. We enable this option to
+    // inject the globals like `describe`, `it`, `expect`, etc.
+    globals: true,
+
+    // Calls .mockReset on all spies before each test.
+    mockReset: true,
+
+    // Calls .mockRestore on all spies before each test.
+    restoreMocks: true,
+
+    // Calls vi.unstubAllEnvs before each test.
+    unstubEnvs: true,
+
+    // Calls vi.unstubGlobals before each test.
+    unstubGlobals: true,
+
+    watch: false,
   },
 });