Merge pull request #3569 from github/robertbrignull/ghec_dr_mode

Detect when the github-enterprise.uri setting is set

extensions/ql-vscode/test/vscode-tests/cli-integration/variant-analysis/variant-analysis-manager.test.ts

@@ -1,6 +1,15 @@
-import { CancellationTokenSource, commands, window, Uri } from "vscode";
+import {
+  CancellationTokenSource,
+  commands,
+  window,
+  Uri,
+  ConfigurationTarget,
+} from "vscode";
 import { extLogger } from "../../../../src/common/logging/vscode";
-import { setRemoteControllerRepo } from "../../../../src/config";
+import {
+  VSCODE_GITHUB_ENTERPRISE_URI_SETTING,
+  setRemoteControllerRepo,
+} from "../../../../src/config";
 import * as ghApiClient from "../../../../src/variant-analysis/gh-api/gh-api-client";
 import { isAbsolute, join } from "path";
 
@@ -99,6 +108,32 @@ describe("Variant Analysis Manager", () => {
       await setRemoteControllerRepo("github/vscode-codeql");
     });
 
+    it("fails if MRVA is not supported for this GHE URI", async () => {
+      await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+        "https://github.example.com",
+        ConfigurationTarget.Global,
+      );
+
+      const qlPackDetails: QlPackDetails = {
+        queryFiles: [getFileOrDir("data-remote-qlpack/in-pack.ql")],
+        qlPackRootPath: getFileOrDir("data-remote-qlpack"),
+        qlPackFilePath: getFileOrDir("data-remote-qlpack/qlpack.yml"),
+        language: QueryLanguage.Javascript,
+      };
+
+      await expect(
+        variantAnalysisManager.runVariantAnalysis(
+          qlPackDetails,
+          progress,
+          cancellationTokenSource.token,
+        ),
+      ).rejects.toThrow(
+        new Error(
+          "Multi-repository variant analysis is not enabled for https://github.example.com/",
+        ),
+      );
+    });
+
     it("should run a variant analysis that is part of a qlpack", async () => {
       const filePath = getFileOrDir("data-remote-qlpack/in-pack.ql");
       const qlPackRootPath = getFileOrDir("data-remote-qlpack");

extensions/ql-vscode/test/vscode-tests/minimal-workspace/config.test.ts

@@ -1,10 +1,14 @@
-import { workspace } from "vscode";
+import { ConfigurationTarget, workspace } from "vscode";
 
 import type { ConfigListener } from "../../../src/config";
 import {
   CliConfigListener,
   QueryHistoryConfigListener,
   QueryServerConfigListener,
+  VSCODE_GITHUB_ENTERPRISE_URI_SETTING,
+  getEnterpriseUri,
+  hasEnterpriseUri,
+  hasGhecDrUri,
 } from "../../../src/config";
 import { vscodeGetConfigurationMock } from "../test-config";
 
@@ -126,3 +130,49 @@ describe("config listeners", () => {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }
 });
+
+describe("enterprise URI", () => {
+  it("detects no enterprise URI when config value is not set", async () => {
+    expect(getEnterpriseUri()).toBeUndefined();
+    expect(hasEnterpriseUri()).toBe(false);
+    expect(hasGhecDrUri()).toBe(false);
+  });
+
+  it("detects no enterprise URI when config value is set to an invalid value", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "invalid-uri",
+      ConfigurationTarget.Global,
+    );
+    expect(getEnterpriseUri()).toBeUndefined();
+    expect(hasEnterpriseUri()).toBe(false);
+    expect(hasGhecDrUri()).toBe(false);
+  });
+
+  it("detects an enterprise URI when config value is set to a GHES URI", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://github.example.com",
+      ConfigurationTarget.Global,
+    );
+    expect(getEnterpriseUri()?.toString()).toBe("https://github.example.com/");
+    expect(hasEnterpriseUri()).toBe(true);
+    expect(hasGhecDrUri()).toBe(false);
+  });
+
+  it("detects a GHEC-DR URI when config value is set to a GHEC-DR URI", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://example.ghe.com",
+      ConfigurationTarget.Global,
+    );
+    expect(getEnterpriseUri()?.toString()).toBe("https://example.ghe.com/");
+    expect(hasEnterpriseUri()).toBe(true);
+    expect(hasGhecDrUri()).toBe(true);
+  });
+
+  it("Upgrades HTTP URIs to HTTPS", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "http://example.ghe.com",
+      ConfigurationTarget.Global,
+    );
+    expect(getEnterpriseUri()?.toString()).toBe("https://example.ghe.com/");
+  });
+});

extensions/ql-vscode/test/vscode-tests/minimal-workspace/variant-analysis/ghec-dr.test.ts

@@ -0,0 +1,52 @@
+import { ConfigurationTarget } from "vscode";
+import {
+  VARIANT_ANALYSIS_ENABLE_GHEC_DR,
+  VSCODE_GITHUB_ENTERPRISE_URI_SETTING,
+} from "../../../../src/config";
+import { isVariantAnalysisEnabledForGitHubHost } from "../../../../src/variant-analysis/ghec-dr";
+
+describe("checkVariantAnalysisEnabled", () => {
+  it("returns cleanly when no enterprise URI is set", async () => {
+    expect(isVariantAnalysisEnabledForGitHubHost()).toBe(true);
+  });
+
+  it("returns false when GHES enterprise URI is set and variant analysis feature flag is not set", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://github.example.com",
+      ConfigurationTarget.Global,
+    );
+    expect(isVariantAnalysisEnabledForGitHubHost()).toBe(false);
+  });
+
+  it("returns false when GHES enterprise URI is set and variant analysis feature flag is set", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://github.example.com",
+      ConfigurationTarget.Global,
+    );
+    await VARIANT_ANALYSIS_ENABLE_GHEC_DR.updateValue(
+      "true",
+      ConfigurationTarget.Global,
+    );
+    expect(isVariantAnalysisEnabledForGitHubHost()).toBe(false);
+  });
+
+  it("returns false when GHEC-DR URI is set and variant analysis feature flag is not set", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://example.ghe.com",
+      ConfigurationTarget.Global,
+    );
+    expect(isVariantAnalysisEnabledForGitHubHost()).toBe(false);
+  });
+
+  it("returns true when GHEC-DR URI is set and variant analysis feature flag is set", async () => {
+    await VSCODE_GITHUB_ENTERPRISE_URI_SETTING.updateValue(
+      "https://example.ghe.com",
+      ConfigurationTarget.Global,
+    );
+    await VARIANT_ANALYSIS_ENABLE_GHEC_DR.updateValue(
+      "true",
+      ConfigurationTarget.Global,
+    );
+    expect(isVariantAnalysisEnabledForGitHubHost()).toBe(true);
+  });
+});