vscode-codeql/extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-database-prompt.test.ts

import { faker } from "@faker-js/faker";
import { Octokit } from "@octokit/rest";
import { mockedObject } from "../../utils/mocking.helpers";
import {
  CodeqlDatabase,
  promptAndDownloadGitHubDatabase,
} from "../../../../src/databases/github-database-prompt";
import { DatabaseManager } from "../../../../src/databases/local-databases";
import { GitHubDatabaseConfig } from "../../../../src/config";
import { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
import { createMockCommandManager } from "../../../__mocks__/commandsMock";
import * as databaseFetcher from "../../../../src/databases/database-fetcher";
import * as dialog from "../../../../src/common/vscode/dialog";

describe("promptAndDownloadGitHubDatabase", () => {
  let octokit: Octokit;
  const owner = "github";
  const repo = "codeql";
  let databaseManager: DatabaseManager;
  const setDownload = jest.fn();
  let config: GitHubDatabaseConfig;
  const storagePath = "/a/b/c/d";
  let cliServer: CodeQLCliServer;
  const commandManager = createMockCommandManager();

  let databases = [
    mockedObject<CodeqlDatabase>({
      id: faker.number.int(),
      created_at: faker.date.past().toISOString(),
      commit_oid: faker.git.commitSha(),
      language: "swift",
      url: faker.internet.url({
        protocol: "https",
      }),
    }),
  ];

  let showNeverAskAgainDialogSpy: jest.SpiedFunction<
    typeof dialog.showNeverAskAgainDialog
  >;
  let promptForLanguageSpy: jest.SpiedFunction<
    typeof databaseFetcher.promptForLanguage
  >;
  let downloadGitHubDatabaseFromUrlSpy: jest.SpiedFunction<
    typeof databaseFetcher.downloadGitHubDatabaseFromUrl
  >;

  beforeEach(() => {
    octokit = mockedObject<Octokit>({});
    databaseManager = mockedObject<DatabaseManager>({});
    config = mockedObject<GitHubDatabaseConfig>({
      setDownload,
    });
    cliServer = mockedObject<CodeQLCliServer>({});

    showNeverAskAgainDialogSpy = jest
      .spyOn(dialog, "showNeverAskAgainDialog")
      .mockResolvedValue("Connect");
    promptForLanguageSpy = jest
      .spyOn(databaseFetcher, "promptForLanguage")
      .mockResolvedValue(databases[0].language);
    downloadGitHubDatabaseFromUrlSpy = jest
      .spyOn(databaseFetcher, "downloadGitHubDatabaseFromUrl")
      .mockResolvedValue(undefined);
  });

  it("downloads the database", async () => {
    await promptAndDownloadGitHubDatabase(
      octokit,
      owner,
      repo,
      databases,
      config,
      databaseManager,
      storagePath,
      cliServer,
      commandManager,
    );

    expect(downloadGitHubDatabaseFromUrlSpy).toHaveBeenCalledTimes(1);
    expect(downloadGitHubDatabaseFromUrlSpy).toHaveBeenCalledWith(
      databases[0].url,
      databases[0].id,
      databases[0].created_at,
      databases[0].commit_oid,
      owner,
      repo,
      octokit,
      expect.anything(),
      databaseManager,
      storagePath,
      cliServer,
      true,
      false,
    );
    expect(promptForLanguageSpy).toHaveBeenCalledWith(["swift"], undefined);
    expect(config.setDownload).not.toHaveBeenCalled();
  });

  describe("when answering not now to prompt", () => {
    beforeEach(() => {
      showNeverAskAgainDialogSpy.mockResolvedValue("Not now");
    });

    it("does not download the database", async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(downloadGitHubDatabaseFromUrlSpy).not.toHaveBeenCalled();
    });
  });

  describe("when cancelling prompt", () => {
    beforeEach(() => {
      showNeverAskAgainDialogSpy.mockResolvedValue(undefined);
    });

    it("does not download the database", async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(downloadGitHubDatabaseFromUrlSpy).not.toHaveBeenCalled();
    });
  });

  describe("when answering never to prompt", () => {
    beforeEach(() => {
      showNeverAskAgainDialogSpy.mockResolvedValue("Never");
    });

    it("does not download the database", async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(downloadGitHubDatabaseFromUrlSpy).not.toHaveBeenCalled();
    });

    it('sets the config to "never"', async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(config.setDownload).toHaveBeenCalledTimes(1);
      expect(config.setDownload).toHaveBeenCalledWith("never");
    });
  });

  describe("when not selecting language", () => {
    beforeEach(() => {
      promptForLanguageSpy.mockResolvedValue(undefined);
    });

    it("does not download the database", async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(downloadGitHubDatabaseFromUrlSpy).not.toHaveBeenCalled();
    });
  });

  describe("when there are multiple languages", () => {
    beforeEach(() => {
      databases = [
        mockedObject<CodeqlDatabase>({
          id: faker.number.int(),
          created_at: faker.date.past().toISOString(),
          commit_oid: faker.git.commitSha(),
          language: "swift",
          url: faker.internet.url({
            protocol: "https",
          }),
        }),
        mockedObject<CodeqlDatabase>({
          id: faker.number.int(),
          created_at: faker.date.past().toISOString(),
          commit_oid: null,
          language: "go",
          url: faker.internet.url({
            protocol: "https",
          }),
        }),
      ];

      promptForLanguageSpy.mockResolvedValue(databases[1].language);
    });

    it("downloads the correct database", async () => {
      await promptAndDownloadGitHubDatabase(
        octokit,
        owner,
        repo,
        databases,
        config,
        databaseManager,
        storagePath,
        cliServer,
        commandManager,
      );

      expect(downloadGitHubDatabaseFromUrlSpy).toHaveBeenCalledTimes(1);
      expect(downloadGitHubDatabaseFromUrlSpy).toHaveBeenCalledWith(
        databases[1].url,
        databases[1].id,
        databases[1].created_at,
        databases[1].commit_oid,
        owner,
        repo,
        octokit,
        expect.anything(),
        databaseManager,
        storagePath,
        cliServer,
        true,
        false,
      );
      expect(promptForLanguageSpy).toHaveBeenCalledWith(
        ["swift", "go"],
        undefined,
      );
      expect(config.setDownload).not.toHaveBeenCalled();
    });
  });
});