ssh-key-action/src/common.ts

import fs from "fs";
import path from "path";

import * as core from "@actions/core";

const STATE_PHASE = "phase";
const STATE_BACKUP_SUFFIX = "backup-suffix";

/**
 * current phase
 * @returns phase
 */
export function getPhase(): string {
    const phase = core.getState(STATE_PHASE);

    // next: post
    core.saveState(STATE_PHASE, "post");

    if (phase === "") {
        return "main";
    }
    return phase;
}

/**
 * generate backup suffix name
 * @returns backup suffix
 */
export function generateBackupSuffix(): string {
    const dirName = getSshDirectory();
    if (!fs.existsSync(dirName)) {
        // do nothing if .ssh does not exist
        return "";
    }

    const backupSuffix = `.bak-${Date.now()}`;
    core.saveState(STATE_BACKUP_SUFFIX, backupSuffix);
    return backupSuffix;
}

/**
 * get backup suffix name
 * @returns backup suffix (if not, empty string)
 */
export function getBackupSuffix(): string {
    return core.getState(STATE_BACKUP_SUFFIX);
}

/**
 * get SSH directory
 * @returns SSH directory name
 */
export function getSshDirectory(): string {
    return path.resolve(getHomeDirectory(), ".ssh");
}

/**
 * get home directory
 * @returns home directory name
 */
function getHomeDirectory(): string {
    const homeEnv = getHomeEnv();
    const home = process.env[homeEnv];
    if (home === undefined) {
        throw Error(`${homeEnv} is not defined`);
    }

    if (home === "/github/home") {
        // Docker container
        return "/root";
    }

    return home;
}

/**
 * get HOME environment name
 * @returns HOME environment name
 */
function getHomeEnv(): string {
    if (process.platform === "win32") {
        // Windows
        return "USERPROFILE";
    }

    // macOS / Linux
    return "HOME";
}