fixup! fix(tests): Update tests for ggshieldAuthStatus

Author: salome-voltz

src/lib/ggshield-api.ts

@@ -234,21 +234,18 @@ export async function ggshieldAuthStatus(
   configuration: GGShieldConfiguration,
   context: ExtensionContext
   ): Promise<void> {
-    let isAuthenticated;
+    let isAuthenticated: boolean;
     const proc = runGGShieldCommand(configuration, ["api-status", "--json"]);
     if (proc.status === 0 && JSON.parse(proc.stdout).status_code === 200) {
-      console.log(proc.stdout, JSON.parse(proc.stdout).status_code === 200);
       isAuthenticated = true;
     }
     else{
       if (proc.stderr && proc.stderr.includes("Config key")){
         window.showErrorMessage(`Gitguardian: ${proc.stderr}`);
-
       }
       console.log(proc.stderr);
       isAuthenticated = false;
     } 
-
     commands.executeCommand('setContext', 'isAuthenticated', isAuthenticated);
     await context.globalState.update('isAuthenticated', isAuthenticated);
 }

src/test/suite/extension.test.ts

@@ -1,15 +1,15 @@
 import * as assert from "assert";
 import { extensions, commands,} from "vscode";
 
-suite("Extension Functionality Tests", () => {
+suite("activate", () => {
 
-  test("Extension activates successfully", async () => {
+  test("Should activate extension successfully", async () => {
     const ext = extensions.getExtension("gitguardian-secret-security.gitguardian");
     await ext?.activate();
     assert.ok(ext?.isActive, "Extension should be active");
   });
 
-  test("Commands are registered", async () => {
+  test("Should register all gitguardian commands", async () => {
     const commandIds = [
         "gitguardian.quota",
         "gitguardian.ignore",

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

@@ -9,6 +9,7 @@ suite('ggshieldAuthStatus', function () {
     let isAuthenticated: boolean;
     let mockGlobalState: Memento & { setKeysForSync(keys: readonly string[]): void; };
     let mockContext: Partial<ExtensionContext>;
+    let runGGShieldMock: simple.Stub<Function>;
 
     setup(function () {
         isAuthenticated = false;
@@ -28,15 +29,16 @@ suite('ggshieldAuthStatus', function () {
         mockContext = {
             globalState: mockGlobalState,
         };
+        runGGShieldMock = simple.mock(runGGShield, "runGGShieldCommand");
     });
     teardown(function () {
         simple.restore();
     });
 
     test('Valid authentication should update isAuthenticated to true', async function () {
-        simple.mock(runGGShield, "runGGShieldCommand").returnWith({
+        runGGShieldMock.returnWith({
             status: 0,
-            stdout: '{"detail": "Valid API key.", "status_code": 200, "app_version": "v2.111.0", "secrets_engine_version": "2.124.1"}',
+            stdout: '{"detail": "Valid API key.", "status_code": 200}',
             stderr: ''
         });
 
@@ -45,9 +47,9 @@ suite('ggshieldAuthStatus', function () {
     });
 
     test('Invalid authentication should keep isAuthenticated to false', async function () {
-        simple.mock(runGGShield, "runGGShieldCommand").returnWith({
+        runGGShieldMock.returnWith({
             status: 0,
-            stdout: '{"detail": "Invalid API key.", "status_code": 401, "app_version": "v2.111.0", "secrets_engine_version": "2.124.1"}',
+            stdout: '{"detail": "Invalid API key.", "status_code": 401}',
             stderr: ''
         });
 

src/test/suite/results-parser.test.ts

@@ -42,10 +42,8 @@ const results = `{
 "secrets_engine_version":"2.96.0"
 }`;
 
-suite("Result Parser Suite", () => {
-  window.showInformationMessage("Start all tests.");
-
-  test("test result parser", () => {
+suite("parseGGShieldResults", () => {
+  test("Should parse ggshield scan output", () => {
     const diagnostics = parseGGShieldResults(JSON.parse(results));
     assert.strictEqual(diagnostics.length, 1);
     const diagnostic = diagnostics[0];
@@ -58,7 +56,7 @@ suite("Result Parser Suite", () => {
     assert.strictEqual(diagnostic.severity, DiagnosticSeverity.Warning);
   });
 
-  test("test result parser with invalid json", () => {
+  test("Should return an empty array on an invalid ggshield output", () => {
     const diagnostics = parseGGShieldResults(JSON.parse("{}"));
 
     assert.strictEqual(diagnostics.length, 0);