feat: read insecure config key, fall back to allowSelfSigned

Author: agateau-gg

src/lib/ggshield-configuration-utils.ts

@@ -14,19 +14,19 @@ export async function getConfiguration(
   const config = workspace.getConfiguration("gitguardian");
 
   const apiUrl: string | undefined = config.get("apiUrl");
-  const allowSelfSigned: boolean = config.get("allowSelfSigned", false);
+  const insecure: boolean = config.get(
+    "insecure",
+    // Read allowSelfSigned for backward compatibility
+    config.get("allowSelfSigned", false),
+  );
 
   const pathToGGShield: string = await getGGShield(
     os.platform(),
     os.arch(),
     context,
     outputChannel,
-    allowSelfSigned,
+    insecure,
   );
 
-  return new GGShieldConfiguration(
-    pathToGGShield,
-    apiUrl,
-    allowSelfSigned || false,
-  );
+  return new GGShieldConfiguration(pathToGGShield, apiUrl, insecure || false);
 }

src/test/suite/lib/ggshield-configuration-utils.test.ts

@@ -27,21 +27,35 @@ suite("getConfiguration", () => {
     simple.restore();
   });
 
+  /**
+   * Helper class to fake different configurations of the extension
+   */
+  class FakeConfiguration {
+    records: Record<string, any>;
+
+    constructor(records: Record<string, any>) {
+      this.records = records;
+    }
+
+    public get(section: string, defaultValue: any): any {
+      if (this.records.hasOwnProperty(section)) {
+        return this.records[section];
+      }
+      return defaultValue;
+    }
+  }
+
   test("Vscode settings are correctly read", async () => {
     const context = {} as ExtensionContext;
     const outputChannel = window.createOutputChannel("GitGuardian");
     simple.mock(context, "asAbsolutePath").returnWith("");
 
-    getConfigurationMock.returnWith({
-      get: (key: string) => {
-        if (key === "apiUrl") {
-          return "https://custom-url.com";
-        }
-        if (key === "allowSelfSigned") {
-          return true;
-        }
-      },
-    });
+    getConfigurationMock.returnWith(
+      new FakeConfiguration({
+        apiUrl: "https://custom-url.com",
+        insecure: true,
+      } as Record<string, any>),
+    );
     const configuration = await getConfiguration(context, outputChannel);
 
     // Assert both workspace.getConfiguration and GGShieldConfiguration constructor were called
@@ -54,4 +68,19 @@ suite("getConfiguration", () => {
     assert.strictEqual(configuration.apiUrl, "https://custom-url.com");
     assert.strictEqual(configuration.insecure, true);
   });
+  test("insecure falls back on allowSelfSigned", async () => {
+    const context = {} as ExtensionContext;
+    const outputChannel = window.createOutputChannel("GitGuardian");
+    simple.mock(context, "asAbsolutePath").returnWith("");
+
+    getConfigurationMock.returnWith(
+      new FakeConfiguration({
+        allowSelfSigned: true,
+      } as Record<string, any>),
+    );
+    const configuration = await getConfiguration(context, outputChannel);
+
+    // Assert that the configuration has the expected values
+    assert.strictEqual(configuration.insecure, true);
+  });
 });