github-pages-deploy-action/__tests__/git.test.ts

// Initial env variable setup for tests.
process.env["INPUT_FOLDER"] = "build";
process.env["GITHUB_SHA"] = "123";

import { action } from "../src/constants";
import { deploy, generateBranch, init, switchToBaseBranch } from "../src/git";
import { execute } from "../src/execute";
import { setFailed } from "@actions/core";

const originalAction = JSON.stringify(action);

jest.mock("@actions/core", () => ({
  setFailed: jest.fn(),
  getInput: jest.fn()
}));

jest.mock("../src/execute", () => ({
  execute: jest.fn()
}));

describe("git", () => {
  afterEach(() => {
    Object.assign(action, JSON.parse(originalAction));
  });

  describe("init", () => {
    it("should execute three commands if a GitHub token is provided", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        gitHubToken: "123",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await init();
      expect(execute).toBeCalledTimes(6);
      expect(call).toBe("Initialization step complete...");
    });

    it("should execute three commands if a Access token is provided", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        accessToken: "123",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await init();

      expect(execute).toBeCalledTimes(6);
      expect(call).toBe("Initialization step complete...");
    });

    it("should fail if there is no provided GitHub Token or Access Token", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        pusher: {
          name: "asd",
          email: "as@cat"
        },
        gitHubToken: null,
        accessToken: null,
        ssh: null
      });

      const call = await init();
      expect(setFailed).toBeCalledTimes(1);
      expect(execute).toBeCalledTimes(0);
      expect(call).toBe("Initialization step complete...");
    });

    it("should fail if the build folder begins with a /", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: "branch",
        build: "/",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await init();

      expect(setFailed).toBeCalledTimes(1);
      expect(execute).toBeCalledTimes(0);
      expect(call).toBe("Initialization step complete...");
    });

    it("should fail if the build folder begins with a ./", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: "branch",
        build: "./",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await init();
      expect(setFailed).toBeCalledTimes(1);
      expect(execute).toBeCalledTimes(0);
      expect(call).toBe("Initialization step complete...");
    });

    it("should not fail if root is used", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: "branch",
        build: ".",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await init();

      expect(execute).toBeCalledTimes(6);
      expect(call).toBe("Initialization step complete...");
    });
  });

  describe("generateBranch", () => {
    it("should execute six commands", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: "branch",
        build: ".",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await generateBranch();
      expect(execute).toBeCalledTimes(6);
      expect(call).toBe("Deployment branch creation step complete... ✅");
    });

    it("should fail if there is no branch", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: null,
        build: ".",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await generateBranch();
      expect(execute).toBeCalledTimes(0);
      expect(setFailed).toBeCalledTimes(1);
      expect(call).toBe("Deployment branch creation step complete... ✅");
    });
  });

  describe("switchToBaseBranch", () => {
    it("should execute one command", async () => {
      Object.assign(action, {
        accessToken: "123",
        branch: "branch",
        build: ".",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await switchToBaseBranch();
      expect(execute).toBeCalledTimes(1);
      expect(call).toBe("Switched to the base branch...");
    });
  });

  describe("deploy", () => {
    it("should execute commands", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        gitHubToken: "123",
        pusher: {
          name: "asd",
          email: "as@cat"
        }
      });

      const call = await deploy();

      // Includes the call to generateBranch
      expect(execute).toBeCalledTimes(12);
      expect(call).toBe("Commit step complete...");
    });

    it("should execute commands with clean options", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        gitHubToken: "123",
        pusher: {
          name: "asd",
          email: "as@cat"
        },
        clean: true,
        cleanExclude: '["cat", "montezuma"]'
      });

      const call = await deploy();

      // Includes the call to generateBranch
      expect(execute).toBeCalledTimes(12);
      expect(call).toBe("Commit step complete...");
    });

    it("should gracefully handle incorrectly formatted clean exclude items", async () => {
      Object.assign(action, {
        build: ".",
        branch: "branch",
        gitHubToken: "123",
        pusher: {},
        clean: true,
        targetFolder: "new_folder",
        commitMessage: "Hello!",
        isTest: true,
        cleanExclude: '["cat, "montezuma"]' // There is a syntax errror in the string.
      });

      const call = await deploy();

      expect(execute).toBeCalledTimes(12);
      expect(call).toBe("Commit step complete...");
    });

    it("should stop early if there is nothing to commit", async () => {
      Object.assign(action, {
        build: "build",
        branch: "branch",
        gitHubToken: "123",
        pusher: {
          name: "asd",
          email: "as@cat"
        },
        isTest: false // Setting this env variable to false means there will never be anything to commit and the action will exit early.
      });

      await deploy();
      expect(execute).toBeCalledTimes(12);
    });
  });
});