feat(ggshield-configuration): Add test for GGshieldConfiguration

Author: salome-voltz

src/extension.ts

@@ -10,7 +10,10 @@ import {
   scanFile,
   showAPIQuota,
 } from "./lib/ggshield-api";
-import { getConfiguration, setApiKey } from "./lib/ggshield-configuration";
+import {
+  getConfiguration,
+  setApiKey,
+} from "./lib/ggshield-configuration-utils";
 import {
   ExtensionContext,
   Uri,

src/lib/ggshield-configuration-utils.ts

@@ -0,0 +1,38 @@
+import { getBinaryAbsolutePath } from "./ggshield-resolver-utils";
+import { ExtensionContext, workspace } from "vscode";
+import * as os from "os";
+import { GGShieldConfiguration } from "./ggshield-configuration";
+
+const apiUrlDefault = "https://dashboard.gitguardian.com/";
+
+/**
+ * Retrieve configuration from settings
+ *
+ * TODO: Check with Mathieu if this behaviour is expected
+ * @returns {GGShieldConfiguration} from the extension settings
+ */
+export function getConfiguration(
+  context: ExtensionContext
+): GGShieldConfiguration {
+  const config = workspace.getConfiguration("gitguardian");
+
+  const ggshieldPath: string | undefined = config.get("GGShieldPath");
+  const apiUrl: string | undefined = config.get("apiUrl");
+  const apiKey: string | undefined = config.get("apiKey");
+  const allowSelfSigned: boolean = config.get("allowSelfSigned", false);
+  return new GGShieldConfiguration(
+    ggshieldPath
+      ? ggshieldPath
+      : getBinaryAbsolutePath(os.platform(), os.arch(), context),
+    apiUrl ? apiUrl : apiUrlDefault,
+    apiKey ? apiKey : "",
+    allowSelfSigned ? allowSelfSigned : false
+  );
+}
+
+export function setApiKey(
+  configuration: GGShieldConfiguration,
+  apiKey: string | undefined
+): void {
+  configuration.apiKey = apiKey ? apiKey : "";
+}

src/lib/ggshield-configuration.ts

@@ -1,9 +1,3 @@
-import { getBinaryAbsolutePath } from "./ggshield-resolver-utils";
-import { ExtensionContext, workspace } from "vscode";
-import * as os from "os";
-
-const apiUrlDefault = "https://dashboard.gitguardian.com/";
-
 export class GGShieldConfiguration {
   ggshieldPath: string;
   apiUrl: string;
@@ -22,36 +16,3 @@ export class GGShieldConfiguration {
     this.allowSelfSigned = allowSelfSigned;
   }
 }
-
-/**
- * Retrieve configuration from settings
- *
- * TODO: Check with Mathieu if this behaviour is expected
- * @returns {GGShieldConfiguration} from the extension settings
- */
-export function getConfiguration(
-  context: ExtensionContext
-): GGShieldConfiguration {
-  const config = workspace.getConfiguration("gitguardian");
-
-  const ggshieldPath: string | undefined = config.get("GGShieldPath");
-  const apiUrl: string | undefined = config.get("apiUrl");
-  const apiKey: string | undefined = config.get("apiKey");
-  const allowSelfSigned: boolean = config.get("allowSelfSigned", false);
-
-  return new GGShieldConfiguration(
-    ggshieldPath
-      ? ggshieldPath
-      : getBinaryAbsolutePath(os.platform(), os.arch(), context),
-    apiUrl ? apiUrl : apiUrlDefault,
-    apiKey ? apiKey : "",
-    allowSelfSigned ? allowSelfSigned : false
-  );
-}
-
-export function setApiKey(
-  configuration: GGShieldConfiguration,
-  apiKey: string | undefined
-): void {
-  configuration.apiKey = apiKey ? apiKey : "";
-}

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

@@ -0,0 +1,66 @@
+import * as simple from "simple-mock";
+import assert = require("assert");
+import { ExtensionContext, workspace } from "vscode";
+import * as GGShieldConfiguration from "../../../lib/ggshield-configuration";
+import { getConfiguration } from "../../../lib/ggshield-configuration-utils";
+
+suite("getConfiguration", () => {
+  let getConfigurationMock: simple.Stub<Function>;
+  let constructorMock: simple.Stub<Function>;
+  let context: Partial<ExtensionContext>;
+
+  setup(() => {
+    // Mock workspace.getConfiguration
+    getConfigurationMock = simple.mock(workspace, "getConfiguration");
+
+    // Mock the GGShieldConfiguration constructor globally
+    constructorMock = simple.mock(
+      GGShieldConfiguration,
+      "GGShieldConfiguration"
+    );
+    context = {} as ExtensionContext;
+  });
+
+  teardown(() => {
+    simple.restore();
+  });
+
+  test("Vscode settings are correctly read", async () => {
+    getConfigurationMock.returnWith({
+      get: (key: string) => {
+        if (key === "GGShieldPath") {
+          return "path/to/ggshield";
+        }
+        if (key === "apiUrl") {
+          return "https://custom-url.com";
+        }
+        if (key === "apiKey") {
+          return "test-api-key";
+        }
+        if (key === "allowSelfSigned") {
+          return true;
+        }
+      },
+    });
+    constructorMock.returnWith({});
+
+    getConfiguration(context as ExtensionContext);
+
+    // Assert both workspace.getConfiguration  and GGShieldConfiguration constructor were called
+    assert(
+      getConfigurationMock.called,
+      "getConfiguration should be called once"
+    );
+    assert(
+      constructorMock.called,
+      "GGShieldConfiguration constructor should be called once"
+    );
+
+    // Check the arguments passed to GGShieldConfiguration constructor
+    const ggshieldConfigurationArgs = constructorMock.lastCall.args;
+    assert.strictEqual(ggshieldConfigurationArgs[0], "path/to/ggshield");
+    assert.strictEqual(ggshieldConfigurationArgs[1], "https://custom-url.com");
+    assert.strictEqual(ggshieldConfigurationArgs[2], "test-api-key");
+    assert.strictEqual(ggshieldConfigurationArgs[3], true);
+  });
+});