fix: rename GGShieldConfiguration.allowSelfSigned to insecure

Author: agateau-gg

src/lib/ggshield-configuration.ts

@@ -1,15 +1,15 @@
 export class GGShieldConfiguration {
   ggshieldPath: string;
   apiUrl: string;
-  allowSelfSigned: boolean;
+  insecure: boolean;
 
   constructor(
     ggshieldPath: string = "",
     apiUrl: string = "",
-    allowSelfSigned: boolean = false,
+    insecure: boolean = false,
   ) {
     this.ggshieldPath = ggshieldPath;
     this.apiUrl = apiUrl;
-    this.allowSelfSigned = allowSelfSigned;
+    this.insecure = insecure;
   }
 }

src/lib/ggshield-resolver-utils.ts

@@ -36,7 +36,7 @@ export async function getGGShield(
   arch: string,
   context: ExtensionContext,
   outputChannel: OutputChannel,
-  allowSelfSigned: boolean,
+  insecure: boolean,
 ): Promise<string> {
   const version = getGGShieldVersion(context);
   console.log(`Latest GGShield version: ${version}`);
@@ -65,13 +65,7 @@ export async function getGGShield(
   }
   fs.mkdirSync(ggshieldFolder);
   // install GGShield
-  await installGGShield(
-    platform,
-    arch,
-    ggshieldFolder,
-    version,
-    allowSelfSigned,
-  );
+  await installGGShield(platform, arch, ggshieldFolder, version, insecure);
   outputChannel.appendLine(
     `Updated to GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`,
   );
@@ -138,7 +132,7 @@ export async function installGGShield(
   arch: string,
   ggshieldFolder: string,
   version: string,
-  allowSelfSigned: boolean,
+  insecure: boolean,
 ): Promise<void> {
   let extension: string = "";
   switch (platform) {
@@ -163,7 +157,7 @@ export async function installGGShield(
     fileName,
     downloadUrl,
     ggshieldFolder,
-    allowSelfSigned,
+    insecure,
   );
   extractGGShieldBinary(path.join(ggshieldFolder, fileName), ggshieldFolder);
 }
@@ -201,11 +195,11 @@ async function downloadGGShieldFromGitHub(
   fileName: string,
   downloadUrl: string,
   ggshieldFolder: string,
-  allowSelfSigned: boolean,
+  insecure: boolean,
 ): Promise<void> {
   console.log(`Downloading GGShield from ${downloadUrl}`);
 
-  const instance = allowSelfSigned
+  const instance = insecure
     ? new Agent({
         rejectUnauthorized: false,
       })

src/lib/run-ggshield.ts

@@ -37,8 +37,8 @@ export function runGGShieldCommand(
   if (workspace.workspaceFolders?.length || 0 > 0) {
     options["cwd"] = workspace.workspaceFolders![0].uri.fsPath;
   }
-  // if allowSelfSigned is enabled, add the --allow-self-signed flag
-  if (configuration.allowSelfSigned) {
+  // if insecure is enabled, add the --allow-self-signed flag
+  if (configuration.insecure) {
     args = ["--allow-self-signed"].concat(args);
   }
 

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

@@ -52,6 +52,6 @@ suite("getConfiguration", () => {
 
     // Assert that the configuration has the expected values
     assert.strictEqual(configuration.apiUrl, "https://custom-url.com");
-    assert.strictEqual(configuration.allowSelfSigned, true);
+    assert.strictEqual(configuration.insecure, true);
   });
 });

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

@@ -36,28 +36,28 @@ suite("runGGShieldCommand", () => {
     delete process.env.TEST_GLOBAL_VAR;
   });
 
-  const testCasesAllowSelfSigned = [
+  const testCasesInsecure = [
     {
-      allowSelfSigned: true,
+      insecure: true,
       description:
-        "GGshield is called with flag --allow-self-signed when allowSelfSigned is true",
+        "GGshield is called with flag --allow-self-signed when insecure is true",
     },
     {
-      allowSelfSigned: false,
+      insecure: false,
       description:
-        "GGshield is not called with flag --allow-self-signed when allowSelfSigned is false",
+        "GGshield is not called with flag --allow-self-signed when insecure is false",
     },
   ];
 
-  testCasesAllowSelfSigned.forEach(({ allowSelfSigned, description }) => {
+  testCasesInsecure.forEach(({ insecure: insecure, description }) => {
     test(description, () => {
       process.env.TEST_GLOBAL_VAR = "GlobalValue";
 
       runGGShield.runGGShieldCommand(
         {
           ggshieldPath: "path/to/ggshield",
           apiUrl: "",
-          allowSelfSigned: allowSelfSigned,
+          insecure: insecure,
         } as GGShieldConfiguration,
         ["test"],
       );
@@ -67,7 +67,7 @@ suite("runGGShieldCommand", () => {
       const spawnSyncArgs = spawnSyncMock.lastCall.args;
       const args = spawnSyncArgs[1];
 
-      assert.strictEqual(args[0] === "--allow-self-signed", allowSelfSigned);
+      assert.strictEqual(args[0] === "--allow-self-signed", insecure);
     });
   });