Added dontClear coverage flag to default coverage options (#202)

* First take on adding support for sending in unity licensing server url on linux

* Forgot to build dist

* Moved services-config parsing to typescript

* Need to set licensing server env variable for activate.sh

* Forgot unused docker mount directory /resources

.github/FUNDING.yml

@@ -1,8 +1,8 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: game-ci
 patreon: # Replace with a single Patreon username
-open_collective: game-ci
+open_collective: # replace with a single OpenCollective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

.github/workflows/main.yml

@@ -105,7 +105,7 @@ jobs:
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           testMode: all
-          coverageOptions: 'enableCyclomaticComplexity;generateHtmlReport;generateBadgeReport;assemblyFilters:+MyScripts'
+          coverageOptions: 'generateAdditionalMetrics;generateHtmlReport;generateBadgeReport;assemblyFilters:+MyScripts;dontClear'
           # Test implicit artifactsPath, by not setting it
 
       # Upload artifacts

action.yml

@@ -22,7 +22,7 @@ inputs:
     description: 'The type of tests to be run by the test runner.'
   coverageOptions:
     required: false
-    default: 'enableCyclomaticComplexity;generateHtmlReport;generateBadgeReport'
+    default: 'generateAdditionalMetrics;generateHtmlReport;generateBadgeReport;dontClear'
     description: 'Optional coverage parameters for the -coverageOptions argument.'
   artifactsPath:
     required: false
@@ -48,6 +48,14 @@ inputs:
     required: false
     default: 'Test Results'
     description: 'Name for the check run that is created when a github token is provided.'
+  chownFilesTo:
+    required: false
+    default: ''
+    description: 'User and optionally group (user or user:group or uid:gid) to give ownership of the resulting build artifacts'
+  unityLicensingServer:
+    required: false
+    default: ''
+    description: 'Url to a unity license server for acquiring floating licenses.'
 outputs:
   artifactsPath:
     description: 'Path where the artifacts are stored.'
@@ -57,5 +65,6 @@ branding:
   icon: 'box'
   color: 'gray-dark'
 runs:
-  using: 'node12'
-  main: 'dist/index.js'
+  using: 'node16'
+  main: 'dist/main.js'
+  post: 'dist/post.js'

dist/entrypoint.ps1

@@ -0,0 +1,48 @@
+#
+# Create directory for license activation
+#
+
+$ACTIVATE_LICENSE_PATH = "${env:GITHUB_WORKSPACE}/_activate-license"
+New-Item -Path "$ACTIVATE_LICENSE_PATH" -ItemType Directory
+
+#
+# Run steps
+#
+
+& $PSScriptRoot\steps\activate.ps1
+& $PSScriptRoot\steps\set_gitcredential.ps1
+& $PSScriptRoot\steps\run_tests.ps1
+& $PSScriptRoot\steps\return_license.ps1
+
+#
+# Remove license activation directory
+#
+
+Remove-Item "$ACTIVATE_LICENSE_PATH" -Recurse -Force
+
+#
+# Instructions for debugging
+#
+
+if ($TEST_RUNNER_EXIT_CODE -gt 0)
+{
+    Write-Output ""
+    Write-Output "###########################"
+    Write-Output "#         Failure         #"
+    Write-Output "###########################"
+    Write-Output ""
+    Write-Output "Please note that the exit code is not very descriptive."
+    Write-Output "Most likely it will not help you solve the issue."
+    Write-Output ""
+    Write-Output "To find the reason for failure: please search for errors in the log above."
+    Write-Output ""
+}
+
+#
+# Exit with code from the build step.
+#
+
+if ( ($USE_EXIT_CODE -eq "true") -and ($TEST_RUNNER_EXIT_CODE -ne 2) )
+{
+    exit $TEST_RUNNER_EXIT_CODE
+}

dist/licenses.txt

@@ -686,6 +686,19 @@ Permission to use, copy, modify, and/or distribute this software for any purpose
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
 webidl-conversions
 BSD-2-Clause
 # The BSD 2-Clause License

dist/main.js

@@ -0,0 +1 @@
+index.js

dist/post.js

@@ -0,0 +1 @@
+index.js

dist/steps/activate.ps1

@@ -0,0 +1,110 @@
+# Run in ACTIVATE_LICENSE_PATH directory
+Write-Output "Changing to $ACTIVATE_LICENSE_PATH directory."
+Push-Location "$ACTIVATE_LICENSE_PATH"
+
+if ( ($null -ne ${env:UNITY_LICENSE}) -or ($null -ne ${env:UNITY_LICENSE_FILE}) )
+{
+    #
+    # PERSONAL LICENSE MODE
+    #
+    # This will activate Unity, using a license file
+    #
+    # Note that this is the ONLY WAY for PERSONAL LICENSES in 2020.
+    #   * See for more details: https://gitlab.com/gableroux/unity3d-gitlab-ci-example/issues/5#note_72815478
+    #
+    # The license file can be acquired using `game-ci/request-manual-activation-file` action.
+    Write-Output "Requesting activation (personal license)"
+
+    # Set the license file path
+    $FILE_PATH = "$ACTIVATE_LICENSE_PATH\UnityLicenseFile.ulf"
+
+    if ($null -ne ${env:UNITY_LICENSE})
+    {
+        # Copy license file from Github variables
+        Add-Content -Path $FILE_PATH -Value ${env:UNITY_LICENSE}
+    }
+    elseif ($null -ne ${env:UNITY_LICENSE_FILE})
+    {
+         # Copy license file from file system
+        Add-Content -Path $FILE_PATH -Value ${env:UNITY_LICENSE_FILE}
+    }
+    $convert = (Get-Content -Raw $FILE_PATH) -replace "`r`n","`n"
+    [io.file]::WriteAllText($FILE_PATH, $convert)
+    Get-ChildItem -Path $FILE_PATH
+
+    # Activate license
+    $ACTIVATION_OUTPUT = Start-Process -NoNewWindow -Wait -PassThru "C:\Program Files\Unity\Hub\Editor\${env:UNITY_VERSION}\editor\Unity.exe" -ArgumentList "-batchmode -nographics -logFile $ACTIVATE_LICENSE_PATH\activate.log -quit -manualLicenseFile $FILE_PATH"
+
+    # Store the exit code from the verify command
+    $UNITY_EXIT_CODE = $ACTIVATION_OUTPUT.ExitCode
+
+    # The exit code for personal activation is always 1;
+    # Determine whether activation was successful.
+    #
+    # Successful output should include the following:
+    #
+    #   "LICENSE SYSTEM [2020120 18:51:20] Next license update check is after 2019-11-25T18:23:38"
+    #
+    $ACTIVATION_SUCCESSFUL = (Get-Content $ACTIVATE_LICENSE_PATH\activate.log | Select-String 'Next license update check is after' | Measure-Object -line | Select-Object -Expand Lines)
+
+    # Set exit code to 0 if activation was successful
+    if ($ACTIVATION_SUCCESSFUL -eq 1)
+    {
+        $UNITY_EXIT_CODE = 0
+    }
+
+    # Remove license file
+    Remove-Item -Force $FILE_PATH
+}
+elseif ( ($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($null -ne ${env:UNITY_PASSWORD}) )
+{
+    #
+    # PROFESSIONAL (SERIAL) LICENSE MODE
+    #
+    # This will activate unity, using the activating process.
+    #
+    # Note: This is the preferred way for PROFESSIONAL LICENSES.
+    #
+    Write-Output "Requesting activation (professional license)"
+
+    # Activate license
+    $ACTIVATION_OUTPUT = Start-Process -NoNewWindow -Wait -PassThru "C:\Program Files\Unity\Hub\Editor\${env:UNITY_VERSION}\editor\Unity.exe" -ArgumentList "-batchmode -nographics -logFile $ACTIVATE_LICENSE_PATH\activate.log -quit -serial ${env:UNITY_SERIAL} -username ${env:UNITY_EMAIL} -password ${env:UNITY_PASSWORD}"
+
+    # Store the exit code from the verify command
+    $UNITY_EXIT_CODE = $ACTIVATION_OUTPUT.ExitCode
+}
+else
+{
+    #
+    # NO LICENSE ACTIVATION STRATEGY MATCHED
+    #
+    # This will exit since no activation strategies could be matched.
+    #
+    Write-Output "License activation strategy could not be determined."
+    Write-Output ""
+    Write-Output "Visit https://game.ci/docs/github/getting-started for more"
+    Write-Output "details on how to set up one of the possible activation strategies."
+
+    # Immediately exit as no UNITY_EXIT_CODE can be derived.
+    exit 1;
+}
+
+#
+# Display information about the result
+#
+Get-Content $ACTIVATE_LICENSE_PATH\activate.log
+if ($UNITY_EXIT_CODE -eq 0)
+{
+    # Activation was a success
+    Write-Output "Activation complete."
+}
+else
+{
+    # Activation failed so exit with the code from the license verification step
+    Write-Output "Unclassified error occured while trying to activate license."
+    Write-Output "Exit code was: $UNITY_EXIT_CODE"
+    exit $UNITY_EXIT_CODE
+}
+
+# Return to previous working directory
+Pop-Location

dist/steps/activate.sh

@@ -77,7 +77,21 @@ elif [[ -n "$UNITY_SERIAL" && -n "$UNITY_EMAIL" && -n "$UNITY_PASSWORD" ]]; then
 
   # Store the exit code from the verify command
   UNITY_EXIT_CODE=$?
+elif [[ -n "$UNITY_LICENSING_SERVER" ]]; then
+  #
+  # Custom Unity License Server
+  #
+  echo "Adding licensing server config"
 
+  /opt/unity/Editor/Data/Resources/Licensing/Client/Unity.Licensing.Client --acquire-floating > license.txt #is this accessible in a env variable?
+  UNITY_EXIT_CODE=$?
+  PARSEDFILE=$(grep -oP '\".*?\"' < license.txt | tr -d '"')
+  export FLOATING_LICENSE
+  FLOATING_LICENSE=$(sed -n 2p <<< "$PARSEDFILE")
+  FLOATING_LICENSE_TIMEOUT=$(sed -n 4p <<< "$PARSEDFILE")
+
+  echo "Acquired floating license: \"$FLOATING_LICENSE\" with timeout $FLOATING_LICENSE_TIMEOUT"
+  # Store the exit code from the verify command
 else
   #
   # NO LICENSE ACTIVATION STRATEGY MATCHED

dist/steps/return_license.ps1

@@ -0,0 +1,18 @@
+# Run in ACTIVATE_LICENSE_PATH directory
+Write-Output "Changing to $ACTIVATE_LICENSE_PATH directory."
+Push-Location "$ACTIVATE_LICENSE_PATH"
+
+if ($null -ne ${env:UNITY_SERIAL})
+{
+    #
+    # PROFESSIONAL (SERIAL) LICENSE MODE
+    #
+    # This will return the license that is currently in use.
+    #
+    $RETURN_OUTPUT = Start-Process -NoNewWindow -Wait -PassThru "C:\Program Files\Unity\Hub\Editor\${env:UNITY_VERSION}\editor\Unity.exe" -ArgumentList "-batchmode -nographics -logFile $FULL_ARTIFACTS_PATH\deactivate.log -quit -returnlicense"
+
+    Get-Content $FULL_ARTIFACTS_PATH\deactivate.log
+}
+
+# Return to previous working directory
+Pop-Location

dist/steps/return_license.sh

@@ -4,7 +4,13 @@
 echo "Changing to \"$ACTIVATE_LICENSE_PATH\" directory."
 pushd "$ACTIVATE_LICENSE_PATH"
 
-if [[ -n "$UNITY_SERIAL" ]]; then
+if [[ -n "$UNITY_LICENSING_SERVER" ]]; then  #
+  #
+  # Return any floating license used.
+  #
+  echo "Returning floating license: \"$FLOATING_LICENSE\""
+  /opt/unity/Editor/Data/Resources/Licensing/Client/Unity.Licensing.Client --return-floating "$FLOATING_LICENSE"
+elif [[ -n "$UNITY_SERIAL" ]]; then
   #
   # PROFESSIONAL (SERIAL) LICENSE MODE
   #
@@ -17,6 +23,5 @@ if [[ -n "$UNITY_SERIAL" ]]; then
     -quit \
     -returnlicense
 fi
-
 # Return to previous working directory
 popd

dist/steps/run_tests.ps1

@@ -0,0 +1,118 @@
+#
+# Set and display project path
+#
+
+$UNITY_PROJECT_PATH = "${env:GITHUB_WORKSPACE}/${env:PROJECT_PATH}"
+Write-Output "Using project path $UNITY_PROJECT_PATH"
+
+#
+# Set and display the artifacts path
+#
+
+Write-Output "Using artifacts path ${env:ARTIFACTS_PATH} to save test results."
+$FULL_ARTIFACTS_PATH = "${env:GITHUB_WORKSPACE}\${env:ARTIFACTS_PATH}"
+
+#
+# Set and display the coverage results path
+#
+
+Write-Output "Using coverage results path ${env:COVERAGE_RESULTS_PATH} to save test coverage results."
+$FULL_COVERAGE_RESULTS_PATH = "${env:GITHUB_WORKSPACE}\${env:COVERAGE_RESULTS_PATH}"
+
+#
+# Display custom parameters
+#
+
+Write-Output "Using custom parameters ${env:CUSTOM_PARAMETERS}"
+
+# The following tests are 2019 mode (requires Unity 2019.2.11f1 or later)
+# Reference: https://docs.unity3d.com/2019.3/Documentation/Manual/CommandLineArguments.html
+
+#
+# Display the unity version
+#
+
+Write-Output "Using Unity version ${env:UNITY_VERSION} to test."
+
+#
+# Overall info
+#
+
+Write-Output ""
+Write-Output "###########################"
+Write-Output "#    Artifacts folder     #"
+Write-Output "###########################"
+Write-Output ""
+Write-Output "Creating $FULL_ARTIFACTS_PATH if it does not exist."
+New-Item -Path "$FULL_ARTIFACTS_PATH" -ItemType Directory
+
+Write-Output ""
+Write-Output "###########################"
+Write-Output "#    Project directory    #"
+Write-Output "###########################"
+Write-Output ""
+Get-ChildItem -Hidden -Path $UNITY_PROJECT_PATH
+
+#
+# Testing for each platform
+#
+foreach ( $platform in ${env:TEST_PLATFORMS}.Split(";") )
+{
+    Write-Output ""
+    Write-Output "###########################"
+    Write-Output "#   Testing in $platform  #"
+    Write-Output "###########################"
+    Write-Output ""
+
+    if ( $platform -ne "COMBINE_RESULTS" )
+    {
+        $runTests = "-runTests -testPlatform $platform -testResults $FULL_ARTIFACTS_PATH/$platform-results.xml"
+    }
+    else
+    {
+        $runTests = "-quit"
+    }
+
+    $TEST_OUTPUT = Start-Process -NoNewWindow -Wait -PassThru "C:\Program Files\Unity\Hub\Editor\${env:UNITY_VERSION}\editor\Unity.exe" -ArgumentList "-batchmode -logFile $FULL_ARTIFACTS_PATH\$platform.log -projectPath $UNITY_PROJECT_PATH -coverageResultsPath $FULL_COVERAGE_RESULTS_PATH $runTests -enableCodeCoverage -debugCodeOptimization -coverageOptions ${env:COVERAGE_OPTIONS} ${env:CUSTOM_PARAMETERS}"
+
+    # Catch exit code
+    $TEST_EXIT_CODE = $TEST_OUTPUT.ExitCode
+
+    # Print unity log output
+    Get-Content "$FULL_ARTIFACTS_PATH/$platform.log"
+
+    # Display results
+    if ($TEST_EXIT_CODE -eq 0)
+    {
+        Write-Output "Run succeeded, no failures occurred";
+    }
+    elseif ($TEST_EXIT_CODE -eq 2)
+    {
+        Write-Output "Run succeeded, some tests failed";
+    }
+    elseif ($TEST_EXIT_CODE -eq 3)
+    {
+        Write-Output "Run failure (other failure)";
+    }
+    else
+    {
+        Write-Output "Unexpected exit code $TEST_EXIT_CODE";
+    }
+
+    if ( $TEST_EXIT_CODE -ne 0)
+    {
+        $TEST_RUNNER_EXIT_CODE = $TEST_EXIT_CODE
+    }
+
+    Write-Output ""
+    Write-Output "###########################"
+    Write-Output "#    $platform Results    #"
+    Write-Output "###########################"
+    Write-Output ""
+
+    if ($platform -ne "COMBINE_RESULTS")
+    {
+        Get-Content "$FULL_ARTIFACTS_PATH/$platform-results.xml"
+        Get-Content "$FULL_ARTIFACTS_PATH/$platform-results.xml" | Select-String "test-run" | Select-String "Passed"
+    }
+}

dist/steps/run_tests.sh

@@ -114,3 +114,19 @@ for platform in ${TEST_PLATFORMS//;/ }; do
     cat "$FULL_ARTIFACTS_PATH/$platform-results.xml" | grep test-run | grep Passed
   fi
 done
+
+#
+# Permissions
+#
+
+# Make a given user owner of all artifacts
+if [[ -n "$CHOWN_FILES_TO" ]]; then
+  chown -R "$CHOWN_FILES_TO" "$UNITY_PROJECT_PATH"
+  chown -R "$CHOWN_FILES_TO" "$FULL_ARTIFACTS_PATH"
+  chown -R "$CHOWN_FILES_TO" "$FULL_COVERAGE_RESULTS_PATH"
+fi
+
+# Add read permissions for everyone to all artifacts
+chmod -R a+r "$UNITY_PROJECT_PATH"
+chmod -R a+r "$FULL_ARTIFACTS_PATH"
+chmod -R a+r "$FULL_COVERAGE_RESULTS_PATH"

dist/steps/set_gitcredential.ps1

@@ -0,0 +1,22 @@
+if ($null -eq ${env:GIT_PRIVATE_TOKEN})
+{
+    Write-Output "GIT_PRIVATE_TOKEN unset skipping"
+}
+else
+{
+    Write-Output "GIT_PRIVATE_TOKEN is set configuring git credentials"
+
+    git config --global credential.helper store
+    git config --global --replace-all url.https://github.com/.insteadOf ssh://git@github.com/
+    git config --global --add url.https://github.com/.insteadOf git@github.com
+
+    git config --global url."https://token:${env:GIT_PRIVATE_TOKEN}@github.com/".insteadOf "https://github.com/"
+    git config --global url."https://ssh:${env:GIT_PRIVATE_TOKEN}@github.com/".insteadOf "ssh://git@github.com/"
+    git config --global url."https://git:${env:GIT_PRIVATE_TOKEN}@github.com/".insteadOf "git@github.com:"
+}
+
+Write-Output "---------- git config --list -------------"
+git config --list
+
+Write-Output "---------- git config --list --show-origin -------------"
+git config --list --show-origin

dist/unity-config/services-config.json.template

@@ -0,0 +1,7 @@
+{
+  "licensingServiceBaseUrl": "%URL%",
+  "enableEntitlementLicensing": true,
+  "enableFloatingApi": true,
+  "clientConnectTimeoutSec": 5,
+  "clientHandshakeTimeoutSec": 10
+}

package.json

@@ -8,14 +8,14 @@
   "license": "MIT",
   "scripts": {
     "prebuild": "yarn",
-    "build": "tsc && ncc build lib --source-map --license licenses.txt",
-    "lint": "prettier --check \"src/**/*.{js,ts}\" && eslint src/**/*.ts",
+    "build": "tsc && ncc build lib/index.js --source-map --license licenses.txt",
+    "lint": "prettier --check \"src/**/*.{js,ts}\" && eslint src --ext .js,.ts --max-warnings=0",
     "format": "prettier --write \"src/**/*.{js,ts}\"",
     "test": "jest",
     "prepare": "husky install"
   },
   "dependencies": {
-    "@actions/core": "^1.6.0",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.0",
     "@actions/github": "^5.0.0",
     "@octokit/openapi-types": "^11.2.0",

src/index.ts

@@ -1,58 +1,30 @@
-import * as core from '@actions/core';
-import { Action, Docker, ImageTag, Input, Output, ResultsCheck } from './model';
+import { run as main } from './main';
+import path from 'path';
+import { run as post } from './post';
 
-async function run() {
-  try {
-    Action.checkCompatibility();
+/*
+ * GitHub Action can provide multiple executable entrypoints (pre, main, post),
+ * but it is complicated process to generate multiple `.js` files with `ncc`.
+ * So we rather generate just one entrypoint, that is symlinked to multiple locations (main.js and post.js).
+ * Then when GitHub Action Runner executes it as `node path/to/main.js` and `node path/to/post.js`,
+ * it can read arguments it was executed with and decide which file to execute.
+ * The argv[0] is going to be a full path to `node` executable and
+ * the argv[1] is going to be the full path to the script.
+ * In case index.js would be marked executable and executed directly without the argv[1] it defaults to "main.js".
+ */
+async function run([, name = 'main.js']: string[]) {
+  const script = path.basename(name);
 
-    const { workspace, actionFolder } = Action;
-    const {
-      editorVersion,
-      customImage,
-      projectPath,
-      customParameters,
-      testMode,
-      coverageOptions,
-      artifactsPath,
-      useHostNetwork,
-      sshAgent,
-      gitPrivateToken,
-      githubToken,
-      checkName,
-    } = Input.getFromUser();
-    const baseImage = new ImageTag({ editorVersion, customImage });
-    const runnerTemporaryPath = process.env.RUNNER_TEMP;
-
-    try {
-      await Docker.run(baseImage, {
-        actionFolder,
-        editorVersion,
-        workspace,
-        projectPath,
-        customParameters,
-        testMode,
-        coverageOptions,
-        artifactsPath,
-        useHostNetwork,
-        sshAgent,
-        gitPrivateToken,
-        githubToken,
-        runnerTemporaryPath,
-      });
-    } finally {
-      await Output.setArtifactsPath(artifactsPath);
-      await Output.setCoveragePath('CodeCoverage');
-    }
-
-    if (githubToken) {
-      const failedTestCount = await ResultsCheck.createCheck(artifactsPath, githubToken, checkName);
-      if (failedTestCount >= 1) {
-        core.setFailed(`Test(s) Failed! Check '${checkName}' for details.`);
-      }
-    }
-  } catch (error: any) {
-    core.setFailed(error.message);
+  switch (script) {
+    case 'main.js':
+      await main();
+      break;
+    case 'post.js':
+      await post();
+      break;
+    default:
+      throw new Error(`Unknown script argument: '${script}'`);
   }
 }
 
-run();
+run(process.argv);

src/main.ts

@@ -0,0 +1,60 @@
+import * as core from '@actions/core';
+import { Action, Docker, ImageTag, Input, Output, ResultsCheck } from './model';
+
+export async function run() {
+  try {
+    Action.checkCompatibility();
+
+    const { workspace, actionFolder } = Action;
+    const {
+      editorVersion,
+      customImage,
+      projectPath,
+      customParameters,
+      testMode,
+      coverageOptions,
+      artifactsPath,
+      useHostNetwork,
+      sshAgent,
+      gitPrivateToken,
+      githubToken,
+      checkName,
+      chownFilesTo,
+      unityLicensingServer,
+    } = Input.getFromUser();
+    const baseImage = new ImageTag({ editorVersion, customImage });
+    const runnerContext = Action.runnerContext();
+
+    try {
+      await Docker.run(baseImage, {
+        actionFolder,
+        editorVersion,
+        workspace,
+        projectPath,
+        customParameters,
+        testMode,
+        coverageOptions,
+        artifactsPath,
+        useHostNetwork,
+        sshAgent,
+        gitPrivateToken,
+        githubToken,
+        chownFilesTo,
+        unityLicensingServer,
+        ...runnerContext,
+      });
+    } finally {
+      await Output.setArtifactsPath(artifactsPath);
+      await Output.setCoveragePath('CodeCoverage');
+    }
+
+    if (githubToken) {
+      const failedTestCount = await ResultsCheck.createCheck(artifactsPath, githubToken, checkName);
+      if (failedTestCount >= 1) {
+        core.setFailed(`Test(s) Failed! Check '${checkName}' for details.`);
+      }
+    }
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

src/model/action.test.ts

@@ -4,8 +4,8 @@ import path from 'path';
 
 describe('Action', () => {
   describe('compatibility check', () => {
-    it('throws for anything other than linux', () => {
-      if (process.platform !== 'linux') {
+    it('throws for anything other than linux or windows', () => {
+      if (process.platform !== 'linux' && process.platform !== 'win32') {
         expect(() => Action.checkCompatibility()).toThrow();
       } else {
         expect(() => Action.checkCompatibility()).not.toThrow();

src/model/action.ts

@@ -1,8 +1,13 @@
 import path from 'path';
 
+export interface RunnerContext {
+  runnerTemporaryPath: string;
+  githubAction: string;
+}
+
 const Action = {
   get supportedPlatforms() {
-    return ['linux'];
+    return ['linux', 'win32'];
   },
 
   get isRunningLocally() {
@@ -33,6 +38,16 @@ const Action = {
     return process.env.GITHUB_WORKSPACE;
   },
 
+  runnerContext(): RunnerContext {
+    const runnerTemporaryPath = process.env.RUNNER_TEMP ?? process.cwd();
+    const githubAction = process.env.GITHUB_ACTION ?? process.pid.toString();
+
+    return {
+      runnerTemporaryPath,
+      githubAction,
+    };
+  },
+
   checkCompatibility() {
     const currentPlatform = process.platform;
     if (!Action.supportedPlatforms.includes(currentPlatform)) {

src/model/docker.ts

@@ -1,9 +1,56 @@
-import { existsSync, mkdirSync } from 'fs';
+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,
@@ -18,61 +65,148 @@ const Docker = {
       gitPrivateToken,
       githubToken,
       runnerTemporaryPath,
+      chownFilesTo,
+      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(';');
 
-    const command = `docker run \
-        --workdir /github/workspace \
-        --rm \
-        --env UNITY_LICENSE \
-        --env UNITY_LICENSE_FILE \
-        --env UNITY_EMAIL \
-        --env UNITY_PASSWORD \
-        --env UNITY_SERIAL \
-        --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 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}" \
-        ${sshAgent ? '--env SSH_AUTH_SOCK=/ssh-agent' : ''} \
-        --volume "${githubHome}":"/root:z" \
-        --volume "${githubWorkflow}":"/github/workflow:z" \
-        --volume "${workspace}":"/github/workspace:z" \
-        --volume "${actionFolder}/steps":"/steps:z" \
-        --volume "${actionFolder}/entrypoint.sh":"/entrypoint.sh:z" \
-        ${sshAgent ? `--volume ${sshAgent}:/ssh-agent` : ''} \
-        ${sshAgent ? '--volume /home/runner/.ssh/known_hosts:/root/.ssh/known_hosts:ro' : ''} \
-        ${useHostNetwork ? '--net=host' : ''} \
-        ${githubToken ? '--env USE_EXIT_CODE=false' : '--env USE_EXIT_CODE=true'} \
-        ${image} \
-        /bin/bash /entrypoint.sh`;
+    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 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=/ssh-agent' : ''} \
+                --volume "${githubHome}:/root:z" \
+                --volume "${githubWorkflow}:/github/workflow:z" \
+                --volume "${workspace}:/github/workspace:z" \
+                --volume "${actionFolder}/steps:/steps:z" \
+                --volume "${actionFolder}/entrypoint.sh:/entrypoint.sh:z" \
+                --volume "${actionFolder}/unity-config:/usr/share/unity3d/config/:z" \
+                ${sshAgent ? `--volume ${sshAgent}:/ssh-agent` : ''} \
+                ${
+                  sshAgent ? `--volume /home/runner/.ssh/known_hosts:/root/.ssh/known_hosts:ro` : ''
+                } \
+                ${useHostNetwork ? '--net=host' : ''} \
+                ${githubToken ? '--env USE_EXIT_CODE=false' : '--env USE_EXIT_CODE=true'} \
+                ${image} \
+                /bin/bash -c /entrypoint.sh`;
+  },
 
-    await exec(command, undefined, { silent });
+  getWindowsCommand(image, parameters): string {
+    const {
+      actionFolder,
+      editorVersion,
+      workspace,
+      projectPath,
+      customParameters,
+      testMode,
+      coverageOptions,
+      artifactsPath,
+      useHostNetwork,
+      sshAgent,
+      gitPrivateToken,
+      githubToken,
+      runnerTemporaryPath,
+      chownFilesTo,
+      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 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 "${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`
+                    : ''
+                } \
+                ${useHostNetwork ? '--net=host' : ''} \
+                ${githubToken ? '--env USE_EXIT_CODE=false' : '--env USE_EXIT_CODE=true'} \
+                ${image} \
+                powershell c:/dist/entrypoint.ps1`;
   },
 };
 

src/model/image-tag.ts

@@ -13,7 +13,7 @@ class ImageTag {
   constructor(imageProperties) {
     const {
       editorVersion = '2019.2.11f1',
-      targetPlatform = Platform.types.StandaloneLinux64,
+      targetPlatform = ImageTag.getImagePlatformType(process.platform),
       customImage,
     } = imageProperties;
 
@@ -43,7 +43,7 @@ class ImageTag {
       generic: '',
       webgl: 'webgl',
       mac: 'mac-mono',
-      windows: 'windows-mono',
+      windows: 'windows-il2cpp',
       linux: 'base',
       linuxIl2cpp: 'linux-il2cpp',
       android: 'android',
@@ -56,8 +56,25 @@ class ImageTag {
     switch (platform) {
       case 'linux':
         return 'ubuntu';
+      case 'win32':
+        return 'windows';
       default:
-        throw new Error('The Operating System of this runner is not yet supported.');
+        throw new Error(
+          `The Operating System of this runner, "${platform}", is not yet supported.`,
+        );
+    }
+  }
+
+  static getImagePlatformType(platform) {
+    switch (platform) {
+      case 'linux':
+        return Platform.types.StandaloneLinux64;
+      case 'win32':
+        return Platform.types.StandaloneWindows;
+      default:
+        throw new Error(
+          `The Operating System of this runner, "${platform}", is not yet supported.`,
+        );
     }
   }
 

src/model/input.ts

@@ -17,6 +17,7 @@ const Input = {
     const unityVersion = getInput('unityVersion') || 'auto';
     const customImage = getInput('customImage') || '';
     const rawProjectPath = getInput('projectPath') || '.';
+    const unityLicensingServer = getInput('unityLicensingServer') || '';
     const customParameters = getInput('customParameters') || '';
     const testMode = (getInput('testMode') || 'all').toLowerCase();
     const coverageOptions = getInput('coverageOptions') || '';
@@ -26,6 +27,7 @@ const Input = {
     const gitPrivateToken = getInput('gitPrivateToken') || '';
     const githubToken = getInput('githubToken') || '';
     const checkName = getInput('checkName') || 'Test Results';
+    const chownFilesTo = getInput('chownFilesTo') || '';
 
     // Validate input
     if (!this.testModes.includes(testMode)) {
@@ -65,6 +67,8 @@ const Input = {
       gitPrivateToken,
       githubToken,
       checkName,
+      chownFilesTo,
+      unityLicensingServer,
     };
   },
 };

src/model/licensing-server-setup.ts

@@ -0,0 +1,20 @@
+import * as core from '@actions/core';
+import fs from 'fs';
+
+class LicensingServerSetup {
+  public static Setup(unityLicensingServer, actionFolder: string) {
+    const servicesConfigPath = `${actionFolder}/unity-config/services-config.json`;
+    const servicesConfigPathTemplate = `${servicesConfigPath}.template`;
+    if (!fs.existsSync(servicesConfigPathTemplate)) {
+      core.error(`Missing services config ${servicesConfigPathTemplate}`);
+
+      return;
+    }
+
+    let servicesConfig = fs.readFileSync(servicesConfigPathTemplate).toString();
+    servicesConfig = servicesConfig.replace('%URL%', unityLicensingServer);
+    fs.writeFileSync(servicesConfigPath, servicesConfig);
+  }
+}
+
+export default LicensingServerSetup;

src/model/results-parser.test.ts

@@ -114,6 +114,24 @@ describe('ResultsParser', () => {
       expect(result.annotation).toBeUndefined();
     });
 
+    test('no cdata in stack trace', () => {
+      const result = ResultsParser.convertTestCase('Test Suite', {
+        _attributes: {
+          name: 'Test Name',
+          duration: '3.14',
+        },
+        failure: {
+          message: { _cdata: 'Message CDATA' },
+          'stack-trace': {},
+        },
+      });
+
+      expect(result.suite).toBe('Test Suite');
+      expect(result.title).toBe('Test Name');
+      expect(result.duration).toBe(3.14);
+      expect(result.annotation).toBeUndefined();
+    });
+
     test('no annotation path', () => {
       const result = ResultsParser.convertTestCase('Test Suite', {
         _attributes: {

src/model/results-parser.ts

@@ -90,6 +90,10 @@ const ResultsParser = {
     }
 
     const trace = failure['stack-trace']._cdata;
+    if (trace === undefined) {
+      core.warning(`No cdata in stack trace for test case: ${fullname}`);
+      return testMeta;
+    }
     const point = ResultsParser.findAnnotationPoint(trace);
     if (!point.path || !point.line) {
       core.warning(`Not able to find annotation point for failed test! Test trace: ${trace}`);

src/post.ts

@@ -0,0 +1,12 @@
+import * as core from '@actions/core';
+import Action from './model/action';
+import { Docker } from './model';
+
+export async function run() {
+  try {
+    const parameters = Action.runnerContext();
+    await Docker.ensureContainerRemoval(parameters);
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

unity-project-with-correct-tests/Packages/manifest.json

@@ -6,7 +6,7 @@
     "com.unity.ide.vscode": "1.1.2",
     "com.unity.package-manager-ui": "2.2.0",
     "com.unity.test-framework": "1.0.13",
-    "com.unity.testtools.codecoverage": "1.0.1",
+    "com.unity.testtools.codecoverage": "1.1.1",
     "com.unity.textmeshpro": "2.0.1",
     "com.unity.timeline": "1.1.0",
     "com.unity.ugui": "1.0.0",

yarn.lock

@@ -2,12 +2,13 @@
 # yarn lockfile v1
 
 
-"@actions/core@^1.6.0":
-  version "1.6.0"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.6.0.tgz#0568e47039bfb6a9170393a73f3b7eb3b22462cb"
-  integrity sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==
+"@actions/core@^1.10.0":
+  version "1.10.0"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.10.0.tgz#44551c3c71163949a2f06e94d9ca2157a0cfac4f"
+  integrity sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==
   dependencies:
-    "@actions/http-client" "^1.0.11"
+    "@actions/http-client" "^2.0.1"
+    uuid "^8.3.2"
 
 "@actions/exec@^1.1.0":
   version "1.1.0"
@@ -33,6 +34,13 @@
   dependencies:
     tunnel "0.0.6"
 
+"@actions/http-client@^2.0.1":
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-2.0.1.tgz#873f4ca98fe32f6839462a6f046332677322f99c"
+  integrity sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==
+  dependencies:
+    tunnel "^0.0.6"
+
 "@actions/io@^1.0.1":
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/@actions/io/-/io-1.1.1.tgz#4a157406309e212ab27ed3ae30e8c1d641686a66"
@@ -4746,7 +4754,7 @@ tsutils@^3.21.0:
   dependencies:
     tslib "^1.8.1"
 
-tunnel@0.0.6:
+tunnel@0.0.6, tunnel@^0.0.6:
   version "0.0.6"
   resolved "https://registry.yarnpkg.com/tunnel/-/tunnel-0.0.6.tgz#72f1314b34a5b192db012324df2cc587ca47f92c"
   integrity sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==
@@ -4862,7 +4870,7 @@ use@^3.1.0:
   resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f"
   integrity sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==
 
-uuid@^8.3.0:
+uuid@^8.3.0, uuid@^8.3.2:
   version "8.3.2"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
   integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==