[HOUSEKEEPING] move functions and remove files

Author: dennisseah

bedrock.yaml

@@ -1,5 +1,5 @@
 import * as config from "../../config";
-import * as azdo from "../../lib/azdoClient";
+import * as azureGit from "../../lib/git/azure";
 import { BUILD_SCRIPT_URL } from "../../lib/constants";
 import { getRepositoryName } from "../../lib/gitutils";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
@@ -59,7 +59,7 @@ afterAll(() => {
   disableVerboseLogging();
 });
 
-jest.spyOn(azdo, "validateRepository").mockResolvedValue();
+jest.spyOn(azureGit, "validateRepository").mockResolvedValue();
 
 describe("test emptyStringIfUndefined function", () => {
   it("pass in undefined", () => {

src/commands/hld/pipeline.test.ts

@@ -5,7 +5,7 @@ import {
 } from "azure-devops-node-api/interfaces/BuildInterfaces";
 import commander from "commander";
 import { Config } from "../../config";
-import { validateRepository } from "../../lib/azdoClient";
+import { validateRepository } from "../../lib/git/azure";
 import {
   build as buildCmd,
   exit as exitCmd,

src/commands/hld/pipeline.ts

@@ -1,4 +1,4 @@
-import * as azdo from "../../lib/azdoClient";
+import * as azdoGit from "../../lib/git/azure";
 import { create as createBedrockYaml } from "../../lib/bedrockYaml";
 import { createTempDir } from "../../lib/ioUtil";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
@@ -41,7 +41,7 @@ const mockValues: ConfigValues = {
   yamlFileBranch: "master",
 };
 
-jest.spyOn(azdo, "validateRepository").mockResolvedValue();
+jest.spyOn(azdoGit, "validateRepository").mockResolvedValue();
 
 const mockMissingValues: CommandOptions = {
   buildScriptUrl: undefined,

src/commands/project/pipeline.test.ts

@@ -5,7 +5,7 @@ import {
 } from "azure-devops-node-api/interfaces/BuildInterfaces";
 import commander from "commander";
 import { Config } from "../../config";
-import { validateRepository } from "../../lib/azdoClient";
+import { validateRepository } from "../../lib/git/azure";
 import { fileInfo as bedrockFileInfo } from "../../lib/bedrockYaml";
 import {
   build as buildCmd,

src/commands/project/pipeline.ts

@@ -1,4 +1,4 @@
-import * as azdo from "../../lib/azdoClient";
+import * as azdoGit from "../../lib/git/azure";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
 
 jest.mock("../../lib/pipelines/pipelines");
@@ -46,7 +46,7 @@ const getMockedValues = (): CommandOptions => {
   return deepClone(MOCKED_VALUES);
 };
 
-jest.spyOn(azdo, "validateRepository").mockReturnValue(Promise.resolve());
+jest.spyOn(azdoGit, "validateRepository").mockReturnValue(Promise.resolve());
 
 describe("test fetchValues function", () => {
   it("with all values set", async () => {

src/commands/service/pipeline.test.ts

@@ -6,7 +6,7 @@ import {
 import commander from "commander";
 import path from "path";
 import { Config } from "../../config";
-import { validateRepository } from "../../lib/azdoClient";
+import { validateRepository } from "../../lib/git/azure";
 import { build as buildCmd, exit as exitCmd } from "../../lib/commandBuilder";
 import {
   BUILD_SCRIPT_URL,

src/commands/service/pipeline.ts

@@ -10,12 +10,8 @@ import {
   getTaskAgentApi,
   getWebApi,
   invalidateWebApi,
-  repositoryHasFile,
-  validateRepository,
 } from "./azdoClient";
 import * as azdoClient from "./azdoClient";
-import { AzureDevOpsOpts } from "./git";
-import * as azure from "./git/azure";
 
 describe("AzDo Pipeline utility functions", () => {
   test("azdo url is well formed", () => {
@@ -143,107 +139,3 @@ describe("test getBuildApi function", () => {
     expect(again).toBeDefined();
   });
 });
-
-describe("validateRepository", () => {
-  test("repository exists", async () => {
-    const getRepositoryFunc = jest.spyOn(azure, "GitAPI");
-    getRepositoryFunc.mockReturnValueOnce(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      Promise.resolve({ getRepository: () => ({ id: "3839fjfkj" }) } as any)
-    );
-    const getItemFunc = jest.spyOn(azure, "GitAPI");
-    getItemFunc.mockReturnValueOnce(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      Promise.resolve({ getItem: () => ({ commitId: "3839fjfkj" }) } as any)
-    );
-    const accessOpts: AzureDevOpsOpts = {
-      orgName: "testOrg",
-      personalAccessToken: "mytoken",
-      project: "testProject",
-    };
-
-    await expect(
-      validateRepository(
-        "my-project",
-        "myFile",
-        "master",
-        "my-repo",
-        accessOpts
-      )
-    ).resolves.not.toThrow();
-  });
-  test("repository does not exist", async () => {
-    const createPullRequestFunc = jest.spyOn(azure, "GitAPI");
-    createPullRequestFunc.mockReturnValueOnce(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      Promise.resolve({ getRepository: () => null } as any)
-    );
-    const accessOpts: AzureDevOpsOpts = {
-      orgName: "testOrg",
-      personalAccessToken: "mytoken",
-      project: "testProject",
-    };
-    await expect(
-      validateRepository(
-        "my-project",
-        "myFile",
-        "master",
-        "my-repo",
-        accessOpts
-      )
-    ).rejects.toThrow();
-  });
-});
-
-describe("repositoryHasFile", () => {
-  test("repository contains the given file", async () => {
-    const createPullRequestFunc = jest.spyOn(azure, "GitAPI");
-    createPullRequestFunc.mockReturnValueOnce(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      Promise.resolve({ getItem: () => ({ commitId: "3839fjfkj" }) } as any)
-    );
-    const accessOpts: AzureDevOpsOpts = {
-      orgName: "testOrg",
-      personalAccessToken: "mytoken",
-      project: "testProject",
-    };
-    let hasError = false;
-
-    try {
-      await repositoryHasFile(
-        "testFile.txt",
-        "master",
-        "test-repo",
-        accessOpts
-      );
-    } catch (err) {
-      hasError = true;
-    }
-    expect(hasError).toBe(false);
-  });
-  test("repository does not contain the given file", async () => {
-    const createPullRequestFunc = jest.spyOn(azure, "GitAPI");
-    createPullRequestFunc.mockReturnValueOnce(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      Promise.resolve({ getItem: () => null } as any)
-    );
-    const accessOpts: AzureDevOpsOpts = {
-      orgName: "testOrg",
-      personalAccessToken: "mytoken",
-      project: "testProject",
-    };
-    let hasError = false;
-
-    try {
-      await repositoryHasFile(
-        "testFile2.txt",
-        "master",
-        "test-repo",
-        accessOpts
-      );
-    } catch (err) {
-      hasError = true;
-    }
-    expect(hasError).toBe(true);
-  });
-});

src/lib/azdoClient.test.ts

@@ -6,7 +6,6 @@ import { RestClient } from "typed-rest-client";
 import { Config } from "../config";
 import { logger } from "../logger";
 import { AzureDevOpsOpts } from "./git";
-import { GitAPI } from "./git/azure";
 
 // Module state Variables
 let connection: WebApi | undefined;
@@ -121,66 +120,3 @@ export const getTaskAgentApi = async (
   taskAgentApi = await webApi.getTaskAgentApi();
   return taskAgentApi;
 };
-
-/**
- * Checks if the repository has a given file.
- * @param fileName The name of the file
- * @param branch The branch name
- * @param repoName The name of the repository
- * @accessOpts The Azure DevOps access options to the repository
- */
-export const repositoryHasFile = async (
-  fileName: string,
-  branch: string,
-  repoName: string,
-  accessOpts: AzureDevOpsOpts
-): Promise<void> => {
-  const gitApi = await GitAPI(accessOpts);
-  const versionDescriptor = { version: branch }; // change to branch
-  const gitItem = await gitApi.getItem(
-    repoName,
-    fileName, // Add path to service
-    accessOpts.project,
-    "",
-    undefined,
-    undefined,
-    undefined,
-    undefined,
-    versionDescriptor
-  );
-
-  if (gitItem === null) {
-    throw Error(
-      "Error installing build pipeline. Repository does not have a " +
-        fileName +
-        " file."
-    );
-  }
-};
-
-/**
- * Validates if a repository exists and if it contains the given file
- * @param project  The Azure DevOps project name
- * @param fileName The name of the file
- * @param branch The branch name
- * @param repoName The name of the repository
- * @param accessOpts The Azure DevOps access options to the repository
- */
-export const validateRepository = async (
-  project: string,
-  fileName: string,
-  branch: string,
-  repoName: string,
-  accessOpts: AzureDevOpsOpts
-): Promise<void> => {
-  const gitApi = await GitAPI(accessOpts);
-  const repo = await gitApi.getRepository(repoName, project);
-
-  if (!repo) {
-    throw Error(
-      `Project '${project}' does not contain repository '${repoName}'.`
-    );
-  }
-
-  await repositoryHasFile(fileName, branch, repoName, accessOpts);
-};

src/lib/azdoClient.ts

@@ -2,14 +2,17 @@ import { WebApi } from "azure-devops-node-api";
 import uuid from "uuid/v4";
 import { Config } from "../../config";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
+import { AzureDevOpsOpts } from "../git";
 import * as gitutils from "../gitutils";
 import {
   createPullRequest,
   generatePRUrl,
   getGitOrigin,
   GitAPI,
+  repositoryHasFile,
+  validateRepository,
 } from "./azure";
-
+import * as azure from "./azure";
 jest.mock("azure-devops-node-api");
 jest.mock("../../config");
 
@@ -205,3 +208,91 @@ describe("test generatePRUrl function", async () => {
     ).rejects.toThrow();
   });
 });
+
+describe("validateRepository", () => {
+  test("repository exists", async () => {
+    const getRepositoryFunc = jest.spyOn(azure, "GitAPI");
+    getRepositoryFunc.mockResolvedValueOnce(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      { getRepository: () => ({ id: "3839fjfkj" }) } as any
+    );
+
+    const getItemFunc = jest.spyOn(azure, "GitAPI");
+    getItemFunc.mockResolvedValueOnce(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      { getItem: () => ({ commitId: "3839fjfkj" }) } as any
+    );
+
+    const accessOpts: AzureDevOpsOpts = {
+      orgName: "testOrg",
+      personalAccessToken: "mytoken",
+      project: "testProject",
+    };
+
+    await expect(
+      validateRepository(
+        "my-project",
+        "myFile",
+        "master",
+        "my-repo",
+        accessOpts
+      )
+    ).resolves.not.toThrow();
+  });
+  test("repository does not exist", async () => {
+    const createPullRequestFunc = jest.spyOn(azure, "GitAPI");
+    createPullRequestFunc.mockResolvedValueOnce(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      { getRepository: () => null } as any
+    );
+
+    const accessOpts: AzureDevOpsOpts = {
+      orgName: "testOrg",
+      personalAccessToken: "mytoken",
+      project: "testProject",
+    };
+    await expect(
+      validateRepository(
+        "my-project",
+        "myFile",
+        "master",
+        "my-repo",
+        accessOpts
+      )
+    ).rejects.toThrow();
+  });
+});
+
+describe("repositoryHasFile", () => {
+  test("repository contains the given file", async () => {
+    const createPullRequestFunc = jest.spyOn(azure, "GitAPI");
+    createPullRequestFunc.mockResolvedValueOnce(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      { getItem: () => ({ commitId: "3839fjfkj" }) } as any
+    );
+
+    const accessOpts: AzureDevOpsOpts = {
+      orgName: "testOrg",
+      personalAccessToken: "mytoken",
+      project: "testProject",
+    };
+    await expect(
+      repositoryHasFile("testFile.txt", "master", "test-repo", accessOpts)
+    ).resolves.not.toThrow();
+  });
+  test("repository does not contain the given file", async () => {
+    jest.spyOn(azure, "GitAPI").mockResolvedValueOnce(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      { getItem: () => null } as any
+    );
+    const accessOpts: AzureDevOpsOpts = {
+      orgName: "testOrg",
+      personalAccessToken: "mytoken",
+      project: "testProject",
+    };
+
+    await expect(
+      repositoryHasFile("testFile2.txt", "master", "test-repo", accessOpts)
+    ).rejects.toThrow();
+  });
+});