ファイル構造のリファクタリング + unitテストの追加

openci-runner/firebase/functions/package.json

@@ -3,13 +3,13 @@
 		"@octokit/rest": "^22.0.0",
 		"firebase-admin": "^13.5.0",
 		"firebase-functions": "^6.5.0",
-		"nock": "^15.0.0",
 		"node-ssh": "^13.2.1",
 		"probot": "^14.1.0"
 	},
 	"devDependencies": {
 		"@vitest/coverage-v8": "^3.2.4",
 		"firebase-functions-test": "^3.1.0",
+		"msw": "^2.11.5",
 		"smee-client": "^4.3.1",
 		"supertest": "^7.0.0",
 		"typescript": "^5.9.3",
@@ -18,7 +18,7 @@
 	"engines": {
 		"node": "22"
 	},
-	"main": "lib/src/index.js",
+	"main": "lib/index.js",
 	"name": "functions",
 	"private": true,
 	"scripts": {

openci-runner/firebase/functions/src/index.ts

@@ -2,7 +2,7 @@ import { onRequest } from "firebase-functions/https";
 import { log } from "firebase-functions/logger";
 import { defineSecret } from "firebase-functions/params";
 import { createNodeMiddleware, createProbot } from "probot";
-import { appFn } from "../probot/index.js";
+import { appFn } from "./probot/index.js";
 
 const githubAppId = defineSecret("GITHUB_APP_ID");
 const githubPrivateKey = defineSecret("GITHUB_PRIVATE_KEY");

openci-runner/firebase/functions/src/probot/github.ts

@@ -0,0 +1,99 @@
+import type { Octokit } from "@octokit/rest";
+
+const runnerName = "openci-runner-beta";
+
+// biome-ignore lint/suspicious/noExplicitAny: <Fill the type later>
+export function isJobRequired(context: any): boolean {
+	return context.payload.workflow_job.labels.includes(runnerName);
+}
+
+const generateJitConfigPath =
+	"/repos/{owner}/{repo}/actions/runners/generate-jitconfig";
+
+type JitConfigRequest = {
+	headers: Record<string, string>;
+	labels: string[];
+	name: string;
+	owner: string;
+	repo: string;
+	runner_group_id: number;
+	work_folder: string;
+};
+
+export function jitConfigRequestBody(
+	owner: string,
+	repo: string,
+	serverId: number,
+): JitConfigRequest {
+	return {
+		headers: {
+			"X-GitHub-Api-Version": "2022-11-28",
+		},
+		labels: ["openci-runner-beta"],
+		name: `OpenCI ランナー ${serverId}`,
+		owner: `${owner}`,
+		repo: `${repo}`,
+		runner_group_id: 1,
+		work_folder: "_work",
+	};
+}
+
+export async function getJitConfig(
+	octokit: Octokit,
+	owner: string,
+	repo: string,
+	serverId: number,
+): Promise<string> {
+	const body = jitConfigRequestBody(owner, repo, serverId);
+	const jitConfigRes = await octokit.request(
+		`POST ${generateJitConfigPath}`,
+		body,
+	);
+
+	return jitConfigRes.data.encoded_jit_config;
+}
+
+export enum ActionsRunnerOS {
+	osx = "osx",
+	linux = "linux",
+}
+
+export enum ActionsRunnerArchitecture {
+	x64 = "x64",
+	arm64 = "arm64",
+}
+
+const mkdir = "mkdir actions-runner";
+
+const cdActionRunner = "cd actions-runner";
+
+function downloadRunnerScriptAndUnZip(
+	scriptVersion: string,
+	os: ActionsRunnerOS,
+	architecture: ActionsRunnerArchitecture,
+) {
+	const fileName = `actions-runner-${os}-${architecture}-${scriptVersion}.tar.gz`;
+	return `curl -o ${fileName} -L https://github.com/actions/runner/releases/download/v${scriptVersion}/${fileName} && tar xzf ./${fileName}`;
+}
+
+function runGHAScript(runnerConfig: string) {
+	return `tmux new -d -s runner "RUNNER_ALLOW_RUNASROOT=true ./run.sh --jitconfig ${runnerConfig}"`;
+}
+
+export function initRunner(
+	scriptVersion: string,
+	os: ActionsRunnerOS,
+	architecture: ActionsRunnerArchitecture,
+): string {
+	const command = [
+		mkdir,
+		cdActionRunner,
+		downloadRunnerScriptAndUnZip(scriptVersion, os, architecture),
+	];
+	return command.join("&&");
+}
+
+export function startRunner(runnerConfig: string) {
+	const command = [cdActionRunner, runGHAScript(runnerConfig)];
+	return command.join("&&");
+}

openci-runner/firebase/functions/probot/hetzner.ts → openci-runner/firebase/functions/src/probot/hetzner.ts

@@ -4,6 +4,19 @@
 	token: string;
 }
 
+export interface HetznerResponse {
+	serverId: number;
+	ipv4: string;
+}
+
+export interface HetznerServerSpec {
+	image: string;
+	location: string;
+	name: string;
+	server_type: string;
+	ssh_keys: [string];
+}
+
 export async function deleteServer(id: string, apiKey: string) {
 	await fetch(`${baseUrl}/${id}`, {
 		headers: {
@@ -13,22 +26,28 @@
 	});
 }
 
-export type HetznerResponse = {
-	serverId: number;
-	ipv4: string;
-};
-
-export async function createServer(apiKey: string): Promise<HetznerResponse> {
-	const body = {
-		image: "ubuntu-24.04",
-		location: "fsn1",
-		name: crypto.randomUUID(),
-		server_type: "cpx41",
-		ssh_keys: ["openci-runner-probot"],
+export function createServerSpec(
+	image: string = "ubuntu-24.04",
+	location: string = "fsn1",
+	name: string = crypto.randomUUID(),
+	serverType: string = "cpx41",
+	sshKeyName: string = "openci-runner-probot",
+): HetznerServerSpec {
+	return {
+		image: image,
+		location: location,
+		name: name,
+		server_type: serverType,
+		ssh_keys: [sshKeyName],
 	};
+}
 
+export async function createServer(
+	apiKey: string,
+	serverSpec: HetznerServerSpec,
+): Promise<HetznerResponse> {
 	const response = await fetch(baseUrl, {
-		body: JSON.stringify(body),
+		body: JSON.stringify(serverSpec),
 		headers: {
 			Authorization: `Bearer ${apiKey}`,
 		},
@@ -58,16 +77,5 @@
 		},
 	});
 	const jsonRes = await _response.json();
 	return jsonRes.server.status;
 }
-
-export function initRunner(runnerConfig: string): string {
-	const command = `
-mkdir actions-runner
-cd actions-runner
-curl -o actions-runner-linux-x64-2.328.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.328.0/actions-runner-linux-x64-2.328.0.tar.gz
-tar xzf ./actions-runner-linux-x64-2.328.0.tar.gz
-tmux new -d -s runner "RUNNER_ALLOW_RUNASROOT=true ./run.sh --jitconfig ${runnerConfig}"
-`;
-	return command;
-}

openci-runner/firebase/functions/probot/index.ts → openci-runner/firebase/functions/src/probot/index.ts

@@ -2,12 +2,19 @@ import { setTimeout } from "node:timers/promises";
 import { Octokit } from "@octokit/rest";
 import { NodeSSH } from "node-ssh";
 import type { ApplicationFunction, Context, Probot } from "probot";
-import { getJitConfig, isJobRequired } from "./github.js";
+import {
+	ActionsRunnerArchitecture,
+	ActionsRunnerOS,
+	getJitConfig,
+	initRunner,
+	isJobRequired,
+	startRunner,
+} from "./github.js";
 import {
 	createServer,
+	createServerSpec,
 	deleteServer,
 	getServerStatusById,
-	initRunner,
 	type OctokitToken,
 } from "./hetzner.js";
 
@@ -47,7 +54,11 @@ export const appFn: ApplicationFunction = (app: Probot) => {
 		const owner = repository.owner.login;
 		const repo = repository.name;
 
-		const hetznerResponse = await createServer(process.env.HETZNER_API_KEY);
+		const serverSpec = createServerSpec();
+		const hetznerResponse = await createServer(
+			process.env.HETZNER_API_KEY,
+			serverSpec,
+		);
 		console.info("Runner server has been created");
 		while (true) {
 			const status = await getServerStatusById(
@@ -84,9 +95,35 @@ export const appFn: ApplicationFunction = (app: Probot) => {
 					repo,
 					hetznerResponse.serverId,
 				);
-				await sshResult.execCommand("apt install tmux");
-				await sshResult.execCommand(initRunner(encodedJitConfig));
-				console.info("Successfully start openci runner");
+
+				const resTmux = await sshResult.execCommand("apt install tmux");
+				if (resTmux.code === 0) {
+					console.log("Successfully installed tmux");
+				} else {
+					throw Error("Failed to install tmux");
+				}
+
+				const resInitRunner = await sshResult.execCommand(
+					initRunner(
+						"2.328.0",
+						ActionsRunnerOS.linux,
+						ActionsRunnerArchitecture.x64,
+					),
+				);
+				if (resInitRunner.code === 0) {
+					console.log("Successfully initiated GHA Runner");
+				} else {
+					throw Error("Failed to initiate GHA Runner");
+				}
+
+				const startRunnerRes = await sshResult.execCommand(
+					startRunner(encodedJitConfig),
+				);
+				if (startRunnerRes.code === 0) {
+					console.log("Successfully start GHA Runner");
+				} else {
+					throw Error("Failed to start GHA Runner");
+				}
 				break;
 			} catch (e) {
 				console.log("error, will try again in 1 second", e);