import { existsSync, mkdirSync, readFileSync, rmSync } from 'fs'; import LicensingServerSetup from './licensing-server-setup'; import type { RunnerContext } from './action'; import { exec } from '@actions/exec'; import path from 'path'; /** * Build a path for a docker --cidfile parameter. Docker will store the the created container. * This path is stable for the whole execution of the action, so it can be executed with the same parameters * multiple times and get the same result. */ const containerIdFilePath = parameters => { const { runnerTemporaryPath, githubAction } = parameters; return path.join(runnerTemporaryPath, `container_${githubAction}`); }; const Docker = { /** * Remove a possible leftover container created by `Docker.run`. */ async ensureContainerRemoval(parameters: RunnerContext) { const cidfile = containerIdFilePath(parameters); if (!existsSync(cidfile)) { return; } const container = readFileSync(cidfile, 'ascii').trim(); await exec(`docker`, ['rm', '--force', '--volumes', container], { silent: true }); rmSync(cidfile); }, async run(image, parameters, silent = false) { let runCommand = ''; if (parameters.unityLicensingServer !== '') { LicensingServerSetup.Setup(parameters.unityLicensingServer, parameters.actionFolder); } switch (process.platform) { case 'linux': runCommand = this.getLinuxCommand(image, parameters); break; case 'win32': runCommand = this.getWindowsCommand(image, parameters); break; default: throw new Error(`Operation system, ${process.platform}, is not supported yet.`); } await exec(runCommand, undefined, { silent }); }, getLinuxCommand(image, parameters): string { const { actionFolder, editorVersion, workspace, projectPath, customParameters, testMode, coverageOptions, artifactsPath, useHostNetwork, sshAgent, sshPublicKeysDirectoryPath, packageMode, packageName, gitPrivateToken, githubToken, runnerTemporaryPath, chownFilesTo, dockerCpuLimit, dockerMemoryLimit, unityLicensingServer, } = parameters; const githubHome = path.join(runnerTemporaryPath, '_github_home'); if (!existsSync(githubHome)) mkdirSync(githubHome); const githubWorkflow = path.join(runnerTemporaryPath, '_github_workflow'); if (!existsSync(githubWorkflow)) mkdirSync(githubWorkflow); const cidfile = containerIdFilePath(parameters); const testPlatforms = ( testMode === 'all' ? ['playmode', 'editmode', 'COMBINE_RESULTS'] : [testMode] ).join(';'); return `docker run \ --workdir /github/workspace \ --cidfile "${cidfile}" \ --rm \ --env UNITY_LICENSE \ --env UNITY_LICENSE_FILE \ --env UNITY_EMAIL \ --env UNITY_PASSWORD \ --env UNITY_SERIAL \ --env UNITY_LICENSING_SERVER="${unityLicensingServer}" \ --env UNITY_VERSION="${editorVersion}" \ --env PROJECT_PATH="${projectPath}" \ --env CUSTOM_PARAMETERS="${customParameters}" \ --env TEST_PLATFORMS="${testPlatforms}" \ --env COVERAGE_OPTIONS="${coverageOptions}" \ --env COVERAGE_RESULTS_PATH="CodeCoverage" \ --env ARTIFACTS_PATH="${artifactsPath}" \ --env PACKAGE_MODE="${packageMode}" \ --env PACKAGE_NAME="${packageName}" \ --env GITHUB_REF \ --env GITHUB_SHA \ --env GITHUB_REPOSITORY \ --env GITHUB_ACTOR \ --env GITHUB_WORKFLOW \ --env GITHUB_HEAD_REF \ --env GITHUB_BASE_REF \ --env GITHUB_EVENT_NAME \ --env GITHUB_WORKSPACE="/github/workspace" \ --env GITHUB_ACTION \ --env GITHUB_EVENT_PATH \ --env RUNNER_OS \ --env RUNNER_TOOL_CACHE \ --env RUNNER_TEMP \ --env RUNNER_WORKSPACE \ --env GIT_PRIVATE_TOKEN="${gitPrivateToken}" \ --env CHOWN_FILES_TO="${chownFilesTo}" \ --env GIT_CONFIG_EXTENSIONS \ ${sshAgent ? '--env SSH_AUTH_SOCK=/ssh-agent' : ''} \ --volume "${githubHome}:/root:z" \ --volume "${githubWorkflow}:/github/workflow:z" \ --volume "${workspace}:/github/workspace:z" \ --volume "${actionFolder}/test-standalone-scripts:/UnityStandaloneScripts:z" \ --volume "${actionFolder}/steps:/steps:z" \ --volume "${actionFolder}/entrypoint.sh:/entrypoint.sh:z" \ --volume "${actionFolder}/unity-config:/usr/share/unity3d/config/:z" \ --cpus=${dockerCpuLimit} \ --memory=${dockerMemoryLimit} \ ${sshAgent ? `--volume ${sshAgent}:/ssh-agent` : ''} \ ${ sshAgent && !sshPublicKeysDirectoryPath ? `--volume /home/runner/.ssh/known_hosts:/root/.ssh/known_hosts:ro` : '' } \ ${ sshPublicKeysDirectoryPath ? `--volume ${sshPublicKeysDirectoryPath}:/root/.ssh:ro` : '' } \ ${useHostNetwork ? '--net=host' : ''} \ ${githubToken ? '--env USE_EXIT_CODE=false' : '--env USE_EXIT_CODE=true'} \ ${image} \ /bin/bash -c /entrypoint.sh`; }, getWindowsCommand(image, parameters): string { const { actionFolder, editorVersion, workspace, projectPath, customParameters, testMode, coverageOptions, artifactsPath, useHostNetwork, sshAgent, packageMode, packageName, gitPrivateToken, githubToken, runnerTemporaryPath, chownFilesTo, dockerCpuLimit, dockerMemoryLimit, dockerIsolationMode, unityLicensingServer, } = parameters; const githubHome = path.join(runnerTemporaryPath, '_github_home'); if (!existsSync(githubHome)) mkdirSync(githubHome); const cidfile = containerIdFilePath(parameters); const githubWorkflow = path.join(runnerTemporaryPath, '_github_workflow'); if (!existsSync(githubWorkflow)) mkdirSync(githubWorkflow); const testPlatforms = ( testMode === 'all' ? ['playmode', 'editmode', 'COMBINE_RESULTS'] : [testMode] ).join(';'); return `docker run \ --workdir /github/workspace \ --cidfile "${cidfile}" \ --rm \ --env UNITY_LICENSE \ --env UNITY_LICENSE_FILE \ --env UNITY_EMAIL \ --env UNITY_PASSWORD \ --env UNITY_SERIAL \ --env UNITY_LICENSING_SERVER="${unityLicensingServer}" \ --env UNITY_VERSION="${editorVersion}" \ --env PROJECT_PATH="${projectPath}" \ --env CUSTOM_PARAMETERS="${customParameters}" \ --env TEST_PLATFORMS="${testPlatforms}" \ --env COVERAGE_OPTIONS="${coverageOptions}" \ --env COVERAGE_RESULTS_PATH="CodeCoverage" \ --env ARTIFACTS_PATH="${artifactsPath}" \ --env PACKAGE_MODE="${packageMode}" \ --env PACKAGE_NAME="${packageName}" \ --env GITHUB_REF \ --env GITHUB_SHA \ --env GITHUB_REPOSITORY \ --env GITHUB_ACTOR \ --env GITHUB_WORKFLOW \ --env GITHUB_HEAD_REF \ --env GITHUB_BASE_REF \ --env GITHUB_EVENT_NAME \ --env GITHUB_WORKSPACE="/github/workspace" \ --env GITHUB_ACTION \ --env GITHUB_EVENT_PATH \ --env RUNNER_OS \ --env RUNNER_TOOL_CACHE \ --env RUNNER_TEMP \ --env RUNNER_WORKSPACE \ --env GIT_PRIVATE_TOKEN="${gitPrivateToken}" \ --env CHOWN_FILES_TO="${chownFilesTo}" \ ${sshAgent ? '--env SSH_AUTH_SOCK=c:/ssh-agent' : ''} \ --volume "${actionFolder}/test-standalone-scripts":"c:/UnityStandaloneScripts" \ --volume "${githubHome}":"c:/root" \ --volume "${githubWorkflow}":"c:/github/workflow" \ --volume "${workspace}":"c:/github/workspace" \ --volume "${actionFolder}/steps":"c:/steps" \ --volume "${actionFolder}":"c:/dist" \ ${sshAgent ? `--volume ${sshAgent}:c:/ssh-agent` : ''} \ ${ sshAgent ? `--volume c:/Users/Administrator/.ssh/known_hosts:c:/root/.ssh/known_hosts` : '' } \ --cpus=${dockerCpuLimit} \ --memory=${dockerMemoryLimit} \ --isolation=${dockerIsolationMode} \ ${useHostNetwork ? '--net=host' : ''} \ ${githubToken ? '--env USE_EXIT_CODE=false' : '--env USE_EXIT_CODE=true'} \ ${image} \ powershell c:/dist/entrypoint.ps1`; }, }; export default Docker;