Refactor modules and use jest for tests (#6)

Author: s0

.github/workflows/ci.yaml

@@ -25,7 +25,7 @@ jobs:
       - run: pnpm build
       - run: pnpm lint
       - run: pnpm format:check
-      - run: pnpm test:ci
+      - run: pnpm test:integration
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           HEAD_OID: ${{ github.base_ref }}

jest.integration.config.cjs

@@ -0,0 +1,20 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.ts$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.json",
+      },
+    ],
+  },
+  /**
+   * Configure jest to be compatible with the node-js requirement
+   * of having `.js` extension in the import statement.
+   */
+  moduleNameMapper: {
+    "^(.+).js$": "$1",
+  },
+  testMatch: ["<rootDir>/src/test/integration/**/*.test.ts"],
+};

package.json

@@ -33,7 +33,7 @@
     "lint": "eslint . --max-warnings 0",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:ci": "ts-node src/test/ci"
+    "test:integration": "jest --config jest.integration.config.cjs"
   },
   "devDependencies": {
     "@actions/github": "^6.0.0",

src/local.ts src/fs.tssrc/local.ts renamed to src/fs.ts

@@ -1,6 +1,6 @@
 import { promises as fs } from "fs";
 import * as path from "path";
-import {
+import type {
   CommitMessage,
   FileAddition,
   FileDeletion,
@@ -11,8 +11,8 @@ import {
   getRepositoryMetadata,
   GitHubClient,
 } from "./github/graphql/queries";
-import { Logger } from "./logging";
-import { CreateCommitOnBranchMutationVariables } from "./github/graphql/generated/operations";
+import type { CreateCommitOnBranchMutationVariables } from "./github/graphql/generated/operations";
+import type { Logger } from "./logging";
 
 export const commitFilesFromDirectory = async (args: {
   octokit: GitHubClient;

src/github/graphql/queries.ts

@@ -1,12 +1,14 @@
-import { GitHub } from "@actions/github/lib/utils";
+import type { GitHub } from "@actions/github/lib/utils";
 
 export type GitHubClient = InstanceType<typeof GitHub>;
 
-import {
+import type {
   CreateCommitOnBranchMutation,
   CreateCommitOnBranchMutationVariables,
   CreateRefMutation,
   CreateRefMutationVariables,
+  DeleteRefMutation,
+  DeleteRefMutationVariables,
   GetRepositoryMetadataQuery,
   GetRepositoryMetadataQueryVariables,
 } from "./generated/operations";
@@ -16,6 +18,7 @@ const GET_REPOSITORY_METADATA = /* GraphQL */ `
     repository(owner: $owner, name: $name) {
       id
       ref(qualifiedName: $ref) {
+        id
         target {
           oid
         }
@@ -34,6 +37,14 @@ const CREATE_REF = /* GraphQL */ `
   }
 `;
 
+const DELETE_REF = /* GraphQL */ `
+  mutation deleteRef($input: DeleteRefInput!) {
+    deleteRef(input: $input) {
+      clientMutationId
+    }
+  }
+`;
+
 const CREATE_COMMIT_ON_BRANCH = /* GraphQL */ `
   mutation createCommitOnBranch($input: CreateCommitOnBranchInput!) {
     createCommitOnBranch(input: $input) {
@@ -44,12 +55,6 @@ const CREATE_COMMIT_ON_BRANCH = /* GraphQL */ `
   }
 `;
 
-export const createCommitOnBranchQuery = async (
-  o: GitHubClient,
-  v: CreateCommitOnBranchMutationVariables,
-): Promise<CreateCommitOnBranchMutation> =>
-  o.graphql<CreateCommitOnBranchMutation>(CREATE_COMMIT_ON_BRANCH, v);
-
 export const getRepositoryMetadata = async (
   o: GitHubClient,
   v: GetRepositoryMetadataQueryVariables,
@@ -66,3 +71,15 @@ export const createRefMutation = async (
   v: CreateRefMutationVariables,
 ): Promise<CreateRefMutation> =>
   await o.graphql<CreateRefMutation>(CREATE_REF, v);
+
+export const deleteRefMutation = async (
+  o: GitHubClient,
+  v: DeleteRefMutationVariables,
+): Promise<DeleteRefMutation> =>
+  await o.graphql<DeleteRefMutation>(DELETE_REF, v);
+
+export const createCommitOnBranchQuery = async (
+  o: GitHubClient,
+  v: CreateCommitOnBranchMutationVariables,
+): Promise<CreateCommitOnBranchMutation> =>
+  o.graphql<CreateCommitOnBranchMutation>(CREATE_COMMIT_ON_BRANCH, v);

src/index.ts

@@ -1 +1,2 @@
-export { createCommitOnBranchQuery } from "./github/graphql/queries";
+export * as queries from "./github/graphql/queries";
+export { commitFilesFromDirectory } from "./fs";

src/test/ci.ts

@@ -0,0 +1,103 @@
+/**
+ * This file includes tests that will be run in CI.
+ */
+import * as os from "os";
+import * as path from "path";
+import { promises as fs } from "fs";
+import { getOctokit } from "@actions/github/lib/github";
+import pino from "pino";
+import { configDotenv } from "dotenv";
+
+import { commitFilesFromDirectory } from "../../fs";
+import { randomBytes } from "crypto";
+import {
+  deleteRefMutation,
+  getRepositoryMetadata,
+} from "../../github/graphql/queries";
+
+configDotenv();
+
+const GITHUB_TOKEN = process.env.GITHUB_TOKEN;
+if (!GITHUB_TOKEN) {
+  throw new Error("GITHUB_TOKEN must be set");
+}
+
+const GITHUB_REPOSITORY = process.env.GITHUB_REPOSITORY;
+
+const [owner, repository] = GITHUB_REPOSITORY?.split("/") || [];
+if (!owner || !repository) {
+  throw new Error("GITHUB_REPOSITORY must be set");
+}
+
+const log = pino({
+  level: process.env.RUNNER_DEBUG === "1" ? "debug" : "info",
+  transport: {
+    target: "pino-pretty",
+  },
+});
+
+const octokit = getOctokit(GITHUB_TOKEN);
+
+const TEST_BRANCH_PREFIX = `test-${randomBytes(4).toString("hex")}`;
+
+const TEST_BRANCHES = {
+  COMMIT_FILE: `${TEST_BRANCH_PREFIX}-commit-file`,
+} as const;
+
+describe("fs", () => {
+  describe("commitFilesFromDirectory", () => {
+    it("should commit a file", async () => {
+      // Create test directory
+      const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "test-"));
+      await fs.writeFile(path.join(tmpDir, "foo.txt"), "Hello, world!");
+
+      await commitFilesFromDirectory({
+        octokit,
+        owner,
+        repository,
+        branch: TEST_BRANCHES.COMMIT_FILE,
+        baseBranch: "main",
+        message: {
+          headline: "Test commit",
+          body: "This is a test commit",
+        },
+        workingDirectory: tmpDir,
+        fileChanges: {
+          additions: ["foo.txt"],
+        },
+        log,
+      });
+    });
+  });
+
+  afterAll(async () => {
+    console.info("Cleaning up test branches");
+
+    await Promise.all(
+      Object.values(TEST_BRANCHES).map(async (branch) => {
+        console.debug(`Deleting branch ${branch}`);
+        // Get Ref
+        const ref = await getRepositoryMetadata(octokit, {
+          owner,
+          name: repository,
+          ref: `refs/heads/${branch}`,
+        });
+
+        const refId = ref?.ref?.id;
+
+        if (!refId) {
+          console.warn(`Branch ${branch} not found`);
+          return;
+        }
+
+        await deleteRefMutation(octokit, {
+          input: {
+            refId,
+          },
+        });
+
+        console.debug(`Deleted branch ${branch}`);
+      }),
+    );
+  });
+});

src/test/integration/fs.test.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ["src/index.ts"],
+  entry: ["src/index.ts", "src/fs.ts"],
   format: ["cjs", "esm"],
   dts: true,
 });