fix(scanFile): Refacto scanFile function to use status code

Author: salome-voltz

src/lib/ggshield-api.ts

@@ -172,47 +172,42 @@ export async function scanFile(
     filePath,
   ]);
 
-  // Ignore errors concerning usage
-  // This occurs when the path of the file is invalid (i.e.VSCode sending an event for files not on the file system)
-  // or when the file is ignored in the .gitguardian.yaml
-  if (
-    proc.stderr.includes(
-      "Error: An ignored file or directory cannot be scanned"
-    )
-  ) {
-    updateStatusBarItem(StatusBarStatus.ignoredFile);
-    return;
-  }
-  if (proc.stderr.includes("Usage: ggshield secret scan path")) {
-    return undefined;
-  }
-  let errorMessage = "";
-  proc.stderr.split("\n").forEach((stderrLine) => {
+  if (proc.status === 128 || proc.status === 3) {
+    let errorMessage = "";
+    proc.stderr.split("\n").forEach((stderrLine) => {
+      if (
+        stderrLine.length > 0 &&
+        !stderrLine.includes("Scanning Path...") // ggshield outputs this info message on stderr, ignore it
+      ) {
+        errorMessage += stderrLine + "\n";
+      }
+    });
+    if (errorMessage.length > 0) {
+      window.showErrorMessage(`ggshield: ${errorMessage}`);
+      return undefined;
+    }
+  } else if (proc.status === 2) {
+    // Ignore errors concerning usage
+    // This occurs when the path of the file is invalid (i.e.VSCode sending an event for files not on the file system)
+    // or when the file is ignored in the .gitguardian.yaml
     if (
-      stderrLine.length > 0 &&
-      !stderrLine.includes("Scanning Path...") // ggshield outputs this info message on stderr, ignore it
+      proc.stderr.includes(
+        "Error: An ignored file or directory cannot be scanned"
+      )
     ) {
-      errorMessage += stderrLine + "\n";
+      updateStatusBarItem(StatusBarStatus.ignoredFile);
+      return;
     }
-  });
-  if (errorMessage.length > 0) {
-    window.showErrorMessage(`ggshield: ${errorMessage}`);
     return undefined;
-  }
-
-  const results = JSON.parse(proc.stdout);
-  if (!results) {
-    updateStatusBarItem(StatusBarStatus.ready);
+  } else if (proc.status === 0) {
+    updateStatusBarItem(StatusBarStatus.noSecretFound);
     return;
-  }
-  let incidentsDiagnostics: Diagnostic[] = parseGGShieldResults(results);
-  if (incidentsDiagnostics.length !== 0) {
-    updateStatusBarItem(StatusBarStatus.secretFound);
   } else {
-    updateStatusBarItem(StatusBarStatus.noSecretFound);
+    const results = JSON.parse(proc.stdout);
+    let incidentsDiagnostics: Diagnostic[] = parseGGShieldResults(results);
+    updateStatusBarItem(StatusBarStatus.secretFound);
+    diagnosticCollection.set(fileUri, incidentsDiagnostics);
   }
-
-  diagnosticCollection.set(fileUri, incidentsDiagnostics);
 }
 
 export async function loginGGShield(

src/test/suite/lib/ggshield-api.test.ts

@@ -46,7 +46,7 @@ suite("scanFile", () => {
 
   test("successfully scans a file with incidents", async () => {
     runGGShieldCommandMock.returnWith({
-      status: 0,
+      status: 1,
       stdout: scanResultsWithIncident,
       stderr: "",
     });
@@ -78,19 +78,22 @@ suite("scanFile", () => {
       statusBar.StatusBarStatus.ignoredFile
     );
   });
-
-  test("displays an error message if the scan command fails", async () => {
-    runGGShieldCommandMock.returnWith({
-      status: 1,
-      stdout: "",
-      stderr: "Error",
+  
+  const errorCodes = [128, 3];
+  errorCodes.forEach((code) => {
+    test(`displays an error message if the scan command fails with error code ${code}`, async () => {
+      runGGShieldCommandMock.returnWith({
+        status: code,
+        stdout: "",
+        stderr: "Error",
+      });
+
+      await scanFile("test.py", Uri.file("test.py"), {} as GGShieldConfiguration);
+
+      // The error message is displayed
+      assert.strictEqual(errorMessageMock.callCount, 1);
+      assert.strictEqual(errorMessageMock.lastCall.args[0], "ggshield: Error\n");
     });
-
-    await scanFile("test.py", Uri.file("test.py"), {} as GGShieldConfiguration);
-
-    // The error message is displayed
-    assert.strictEqual(errorMessageMock.callCount, 1);
-    assert.strictEqual(errorMessageMock.lastCall.args[0], "ggshield: Error\n");
   });
 
   test("ignores the 'ignored file cannot be scanned' error", async () => {