Remove unnecessary sinon restore calls

Author: henrymercer

src/diff-informed-analysis-utils.test.ts

@@ -73,10 +73,10 @@ const testShouldPerformDiffInformedAnalysis = makeMacro({
         [Feature.DiffInformedQueries]: testCase.featureEnabled,
       });
 
-      const getGitHubVersionStub = sinon
+      sinon
         .stub(apiClient, "getGitHubVersion")
         .resolves(testCase.gitHubVersion);
-      const getPullRequestBranchesStub = sinon
+      sinon
         .stub(actionsUtil, "getPullRequestBranches")
         .returns(testCase.pullRequestBranches);
 
@@ -89,9 +89,6 @@ const testShouldPerformDiffInformedAnalysis = makeMacro({
       t.is(result, expectedResult);
 
       delete process.env.CODEQL_ACTION_DIFF_INFORMED_QUERIES;
-
-      getGitHubVersionStub.restore();
-      getPullRequestBranchesStub.restore();
     });
   },
   title: (title) => `shouldPerformDiffInformedAnalysis: ${title}`,

src/git-utils.test.ts

@@ -33,7 +33,6 @@ test.serial(
 
       const actualRef = await gitUtils.getRef();
       t.deepEqual(actualRef, expectedRef);
-      callback.restore();
     });
   },
 );
@@ -54,7 +53,6 @@ test.serial(
 
       const actualRef = await gitUtils.getRef();
       t.deepEqual(actualRef, expectedRef);
-      callback.restore();
     });
   },
 );
@@ -73,7 +71,6 @@ test.serial(
 
       const actualRef = await gitUtils.getRef();
       t.deepEqual(actualRef, "refs/pull/1/head");
-      callback.restore();
     });
   },
 );
@@ -100,8 +97,6 @@ test.serial(
 
       const actualRef = await gitUtils.getRef();
       t.deepEqual(actualRef, "refs/pull/2/merge");
-      callback.restore();
-      getAdditionalInputStub.restore();
     });
   },
 );
@@ -161,7 +156,6 @@ test.serial(
             "Both 'ref' and 'sha' are required if one of them is provided.",
         },
       );
-      getAdditionalInputStub.restore();
     });
   },
 );
@@ -188,7 +182,6 @@ test.serial(
             "Both 'ref' and 'sha' are required if one of them is provided.",
         },
       );
-      getAdditionalInputStub.restore();
     });
   },
 );
@@ -242,7 +235,6 @@ test.serial("isAnalyzingDefaultBranch()", async (t) => {
     process.env["GITHUB_EVENT_NAME"] = "schedule";
     process.env["GITHUB_REF"] = "refs/heads/main";
     t.deepEqual(await gitUtils.isAnalyzingDefaultBranch(), false);
-    getAdditionalInputStub.restore();
   });
 });
 
@@ -254,8 +246,6 @@ test.serial("determineBaseBranchHeadCommitOid non-pullrequest", async (t) => {
   const result = await gitUtils.determineBaseBranchHeadCommitOid(__dirname);
   t.deepEqual(result, undefined);
   t.deepEqual(0, infoStub.callCount);
-
-  infoStub.restore();
 });
 
 test.serial(
@@ -276,8 +266,6 @@ test.serial(
       "git call failed. Will calculate the base branch SHA on the server. Error: " +
         "The checkout path provided to the action does not appear to be a git repository.",
     );
-
-    infoStub.restore();
   },
 );
 
@@ -301,8 +289,6 @@ test.serial("determineBaseBranchHeadCommitOid other error", async (t) => {
       "The checkout path provided to the action does not appear to be a git repository.",
     ),
   );
-
-  infoStub.restore();
 });
 
 test.serial(
@@ -315,16 +301,12 @@ test.serial(
     process.env["GITHUB_EVENT_NAME"] = "pull_request";
     process.env["GITHUB_SHA"] = mergeSha;
 
-    const runGitCommandStub = sinon
+    sinon
       .stub(gitUtils as any, "runGitCommand")
       .resolves(`commit ${mergeSha}\nparent ${baseOid}\nparent ${headOid}\n`);
 
-    try {
-      const result = await gitUtils.determineBaseBranchHeadCommitOid(__dirname);
-      t.deepEqual(result, baseOid);
-    } finally {
-      runGitCommandStub.restore();
-    }
+    const result = await gitUtils.determineBaseBranchHeadCommitOid(__dirname);
+    t.deepEqual(result, baseOid);
   },
 );
 

src/overlay/caching.test.ts

@@ -80,65 +80,46 @@ const testDownloadOverlayBaseDatabaseFromCache = makeMacro({
         await fs.promises.writeFile(baseDatabaseOidsFile, JSON.stringify({}));
       }
 
-      const stubs: sinon.SinonStub[] = [];
+      sinon.stub(apiClient, "getAutomationID").resolves("test-automation-id/");
 
-      const getAutomationIDStub = sinon
-        .stub(apiClient, "getAutomationID")
-        .resolves("test-automation-id/");
-      stubs.push(getAutomationIDStub);
-
-      const isInTestModeStub = sinon
-        .stub(utils, "isInTestMode")
-        .returns(testCase.isInTestMode);
-      stubs.push(isInTestModeStub);
+      sinon.stub(utils, "isInTestMode").returns(testCase.isInTestMode);
 
       if (testCase.restoreCacheResult instanceof Error) {
-        const restoreCacheStub = sinon
+        sinon
           .stub(actionsCache, "restoreCache")
           .rejects(testCase.restoreCacheResult);
-        stubs.push(restoreCacheStub);
       } else {
-        const restoreCacheStub = sinon
+        sinon
           .stub(actionsCache, "restoreCache")
           .resolves(testCase.restoreCacheResult);
-        stubs.push(restoreCacheStub);
       }
 
-      const tryGetFolderBytesStub = sinon
+      sinon
         .stub(utils, "tryGetFolderBytes")
         .resolves(testCase.tryGetFolderBytesSucceeds ? 1024 * 1024 : undefined);
-      stubs.push(tryGetFolderBytesStub);
 
       const codeql = mockCodeQLVersion(testCase.codeQLVersion);
 
       if (testCase.resolveDatabaseOutput instanceof Error) {
-        const resolveDatabaseStub = sinon
+        sinon
           .stub(codeql, "resolveDatabase")
           .rejects(testCase.resolveDatabaseOutput);
-        stubs.push(resolveDatabaseStub);
       } else {
-        const resolveDatabaseStub = sinon
+        sinon
           .stub(codeql, "resolveDatabase")
           .resolves(testCase.resolveDatabaseOutput);
-        stubs.push(resolveDatabaseStub);
       }
 
-      try {
-        const result = await downloadOverlayBaseDatabaseFromCache(
-          codeql,
-          config,
-          logger,
-        );
+      const result = await downloadOverlayBaseDatabaseFromCache(
+        codeql,
+        config,
+        logger,
+      );
 
-        if (expectDownloadSuccess) {
-          t.truthy(result);
-        } else {
-          t.is(result, undefined);
-        }
-      } finally {
-        for (const stub of stubs) {
-          stub.restore();
-        }
+      if (expectDownloadSuccess) {
+        t.truthy(result);
+      } else {
+        t.is(result, undefined);
       }
     });
   },

src/overlay/index.test.ts

@@ -50,31 +50,21 @@ test.serial(
         "modified.js": "ddd444", // Changed OID
         "added.js": "eee555", // New file
       };
-      const getFileOidsStubForOverlay = sinon
-        .stub(gitUtils, "getFileOidsUnderPath")
-        .resolves(currentOids);
+      sinon.stub(gitUtils, "getFileOidsUnderPath").resolves(currentOids);
 
       // Write the overlay changes file, which uses the mocked overlay OIDs
       // and the base database OIDs file
       const diffRangeFilePath = path.join(tempDir, "pr-diff-range.json");
-      const getTempDirStub = sinon
-        .stub(actionsUtil, "getTemporaryDirectory")
-        .returns(tempDir);
-      const getDiffRangesStub = sinon
+      sinon.stub(actionsUtil, "getTemporaryDirectory").returns(tempDir);
+      sinon
         .stub(actionsUtil, "getDiffRangesJsonFilePath")
         .returns(diffRangeFilePath);
-      const getGitRootStub = sinon
-        .stub(gitUtils, "getGitRoot")
-        .resolves(sourceRoot);
+      sinon.stub(gitUtils, "getGitRoot").resolves(sourceRoot);
       const changesFilePath = await writeOverlayChangesFile(
         config,
         sourceRoot,
         logger,
       );
-      getFileOidsStubForOverlay.restore();
-      getTempDirStub.restore();
-      getDiffRangesStub.restore();
-      getGitRootStub.restore();
 
       const fileContent = await fs.promises.readFile(changesFilePath, "utf-8");
       const parsedContent = JSON.parse(fileContent) as { changes: string[] };
@@ -128,20 +118,14 @@ test.serial(
         "modified.js": "ddd444", // Changed OID
         "reverted.js": "eee555", // Same OID as base -- not detected by OID comparison
       };
-      const getFileOidsStubForOverlay = sinon
-        .stub(gitUtils, "getFileOidsUnderPath")
-        .resolves(currentOids);
+      sinon.stub(gitUtils, "getFileOidsUnderPath").resolves(currentOids);
 
       const diffRangeFilePath = path.join(tempDir, "pr-diff-range.json");
-      const getTempDirStub = sinon
-        .stub(actionsUtil, "getTemporaryDirectory")
-        .returns(tempDir);
-      const getDiffRangesStub = sinon
+      sinon.stub(actionsUtil, "getTemporaryDirectory").returns(tempDir);
+      sinon
         .stub(actionsUtil, "getDiffRangesJsonFilePath")
         .returns(diffRangeFilePath);
-      const getGitRootStub = sinon
-        .stub(gitUtils, "getGitRoot")
-        .resolves(sourceRoot);
+      sinon.stub(gitUtils, "getGitRoot").resolves(sourceRoot);
 
       // Write a pr-diff-range.json file with diff ranges including
       // "reverted.js" (unchanged OIDs) and "modified.js" (already in OID changes)
@@ -159,10 +143,6 @@ test.serial(
         sourceRoot,
         logger,
       );
-      getFileOidsStubForOverlay.restore();
-      getTempDirStub.restore();
-      getDiffRangesStub.restore();
-      getGitRootStub.restore();
 
       const fileContent = await fs.promises.readFile(changesFilePath, "utf-8");
       const parsedContent = JSON.parse(fileContent) as { changes: string[] };
@@ -208,31 +188,21 @@ test.serial(
         "unchanged.js": "aaa111",
         "modified.js": "ddd444",
       };
-      const getFileOidsStubForOverlay = sinon
-        .stub(gitUtils, "getFileOidsUnderPath")
-        .resolves(currentOids);
+      sinon.stub(gitUtils, "getFileOidsUnderPath").resolves(currentOids);
 
       const diffRangeFilePath = path.join(tempDir, "pr-diff-range.json");
-      const getTempDirStub = sinon
-        .stub(actionsUtil, "getTemporaryDirectory")
-        .returns(tempDir);
-      const getDiffRangesStub = sinon
+      sinon.stub(actionsUtil, "getTemporaryDirectory").returns(tempDir);
+      sinon
         .stub(actionsUtil, "getDiffRangesJsonFilePath")
         .returns(diffRangeFilePath);
-      const getGitRootStub = sinon
-        .stub(gitUtils, "getGitRoot")
-        .resolves(sourceRoot);
+      sinon.stub(gitUtils, "getGitRoot").resolves(sourceRoot);
 
       // No pr-diff-range.json file exists - should work the same as before
       const changesFilePath = await writeOverlayChangesFile(
         config,
         sourceRoot,
         logger,
       );
-      getFileOidsStubForOverlay.restore();
-      getTempDirStub.restore();
-      getDiffRangesStub.restore();
-      getGitRootStub.restore();
 
       const fileContent = await fs.promises.readFile(changesFilePath, "utf-8");
       const parsedContent = JSON.parse(fileContent) as { changes: string[] };
@@ -281,21 +251,15 @@ test.serial(
         "app.js": "aaa111",
         "lib/util.js": "bbb222",
       };
-      const getFileOidsStubForOverlay = sinon
-        .stub(gitUtils, "getFileOidsUnderPath")
-        .resolves(currentOids);
+      sinon.stub(gitUtils, "getFileOidsUnderPath").resolves(currentOids);
 
       const diffRangeFilePath = path.join(tempDir, "pr-diff-range.json");
-      const getTempDirStub = sinon
-        .stub(actionsUtil, "getTemporaryDirectory")
-        .returns(tempDir);
-      const getDiffRangesStub = sinon
+      sinon.stub(actionsUtil, "getTemporaryDirectory").returns(tempDir);
+      sinon
         .stub(actionsUtil, "getDiffRangesJsonFilePath")
         .returns(diffRangeFilePath);
       // getGitRoot returns the repo root (parent of sourceRoot)
-      const getGitRootStub = sinon
-        .stub(gitUtils, "getGitRoot")
-        .resolves(repoRoot);
+      sinon.stub(gitUtils, "getGitRoot").resolves(repoRoot);
 
       // Diff ranges use repo-root-relative paths (as returned by the GitHub compare API)
       await fs.promises.writeFile(
@@ -312,10 +276,6 @@ test.serial(
         sourceRoot,
         logger,
       );
-      getFileOidsStubForOverlay.restore();
-      getTempDirStub.restore();
-      getDiffRangesStub.restore();
-      getGitRootStub.restore();
 
       const fileContent = await fs.promises.readFile(changesFilePath, "utf-8");
       const parsedContent = JSON.parse(fileContent) as { changes: string[] };

src/util.test.ts

@@ -418,9 +418,7 @@ for (const [
     `checkActionVersion ${reportErrorDescription} for ${versionsDescription}`,
     async (t) => {
       const warningSpy = sinon.spy(core, "warning");
-      const versionStub = sinon
-        .stub(api, "getGitHubVersion")
-        .resolves(githubVersion);
+      sinon.stub(api, "getGitHubVersion").resolves(githubVersion);
 
       // call checkActionVersion twice and assert below that warning is reported only once
       util.checkActionVersion(version, await api.getGitHubVersion());
@@ -437,7 +435,6 @@ for (const [
       } else {
         t.false(warningSpy.called);
       }
-      versionStub.restore();
     },
   );
 }