2019-11-30 15:36:27 +00:00
name : 'Unity - Test runner'
author : Webber Takken <webber@takken.io>
description : 'Run tests for any Unity project.'
2020-01-29 20:49:35 +00:00
inputs :
unityVersion :
required : false
2020-12-28 11:02:31 +00:00
default : 'auto'
2023-07-03 15:09:20 +00:00
description : 'Version of unity to use for testing the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt. ⚠️ If testing a Unity Package, this field is required and cannot be set to "auto".'
2020-11-26 08:17:42 +00:00
customImage :
required : false
default : ''
2023-07-03 15:09:20 +00:00
description : 'Specific docker image that should be used for testing the project. If packageMode is true, this image must have jq installed.'
2020-11-10 17:02:23 +00:00
projectPath :
required : false
2023-07-03 15:09:20 +00:00
description : 'Path to the Unity project or package to be tested.'
2022-01-01 20:38:47 +00:00
customParameters :
required : false
description : 'Extra parameters to configure the Unity editor run.'
2020-11-10 17:02:23 +00:00
testMode :
required : false
default : 'all'
description : 'The type of tests to be run by the test runner.'
2022-04-21 08:50:37 +00:00
coverageOptions :
required : false
2022-12-04 00:21:13 +00:00
default : 'generateAdditionalMetrics;generateHtmlReport;generateBadgeReport;dontClear'
2023-07-03 15:09:20 +00:00
description : 'Optional coverage parameters for the -coverageOptions argument. To get coverage in Package Mode, pass assemblies from the package you want covered to the assemblyFilters option.'
2020-11-10 17:02:23 +00:00
artifactsPath :
required : false
default : 'artifacts'
2020-11-10 17:18:00 +00:00
description : 'Path where test artifacts should be stored.'
2021-08-21 13:06:06 +00:00
useHostNetwork :
2020-11-10 17:02:23 +00:00
required : false
default : false
2022-01-01 20:38:47 +00:00
description : 'Initialises Docker using the host network.'
2021-05-28 21:55:58 +00:00
sshAgent :
required : false
default : ''
2022-01-01 20:38:47 +00:00
description : 'SSH Agent path to forward to the container.'
2023-09-06 21:35:36 +00:00
sshPublicKeysDirectoryPath :
required : false
default : ''
description : 'Path to a directory containing SSH public keys to forward to the container.'
2021-11-03 09:25:06 +00:00
gitPrivateToken :
required : false
default : ''
2022-01-01 20:38:47 +00:00
description : 'GitHub Private Access Token (PAT) to pull from GitHub.'
2021-02-28 06:44:56 +00:00
githubToken :
2021-02-27 18:13:19 +00:00
required : false
2021-02-28 06:44:56 +00:00
default : ''
description : 'Token to authorize access to the GitHub REST API. If provided, a check run will be created with the test results.'
2021-02-27 18:13:19 +00:00
checkName :
required : false
default : 'Test Results'
2021-02-28 06:44:56 +00:00
description : 'Name for the check run that is created when a github token is provided.'
2023-07-03 15:09:20 +00:00
packageMode :
required : false
default : false
description: 'Whether the tests are being run for a Unity package instead of a Unity project. If true, the action can only be run on Linux runners, and any custom docker image passed to this action must have `jq` installed. NOTE : may not work properly for packages with dependencies outside of the Unity Registry.'
2022-06-24 10:59:01 +00:00
chownFilesTo :
required : false
default : ''
description : 'User and optionally group (user or user:group or uid:gid) to give ownership of the resulting build artifacts'
2022-11-29 11:03:21 +00:00
unityLicensingServer :
required : false
default : ''
description : 'Url to a unity license server for acquiring floating licenses.'
2019-11-30 15:36:27 +00:00
outputs :
artifactsPath :
2022-04-21 08:50:37 +00:00
description : 'Path where the artifacts are stored.'
coveragePath :
description : 'Path where the code coverage results are stored.'
2019-11-30 15:36:27 +00:00
branding :
icon : 'box'
color : 'gray-dark'
2020-01-29 20:49:35 +00:00
runs :
2022-10-13 21:19:52 +00:00
using : 'node16'
feat: ensure cleanup of docker containers (#198)
Cancelled or timeouted workflow would keep the docker container running.
Closes game-ci/unity-test-runner#197
This has two parts:
Part one. The entrypoints.
`runs.post`: GitHub Action metadata allow running something after the
action (regardless of a failure, crash, timeout, ...).
https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runspost
However, it needs to be a `.js` file and it can't be configured to pass
any arguments.
There already was `index.js` used as the main entrypoint.
The build process of this file uses typescript compiler and ncc to pack
all dependencies into one .js file. And ncc has no way of generating
multiple files in one go, so the only solution would be to run ncc twice
and generate two independent files.
That would be quite unfortunate, wasting time and storage. So I rather
came up with a new entrypoint that symlinked from two locations.
And this new entrypoint understands how it was executed, so it can run
the correct behaviour. This makes it easy to add `runs.pre` if needed.
This new entrypoint is in `index.ts`. The original `index.ts` is now in
`main.ts`.
Part two.
The signals. I've tried:
* try/catch/finally around the `await Docker.run`. Catch and finally are
not executed when process receives SIGINT. See the discussion in: https://github.com/nodejs/node/discussions/29480
* New AbortController and AbortSignal. Great concept, but the
action.exec does not support it. So it can't be aborted.
* Doing cleanup on `process.on('exit')`. Unfortunately you can't really
do async stuff from there, so can't really run the docker rm command
to delete the container.
* Using `process.on('SIGINT')`. For some reason that wasn't really
executing for me. I'd not put my hand in fire for this, but I assume
because it was in the signal handler it does something special, or would
heed to be scheduled for later with `setTimeout(0)`.
Evaluating all these I came to a conclusion that it is fragile and just
relying on a `runs.post` is much better and safer.
`
2022-11-03 18:14:51 +00:00
main : 'dist/main.js'
post : 'dist/post.js'
