Provide descriptive activation information on error (#296)

When trying to activate using Unity.Licensing.Client, any errors will
provide no output. This change makes sure to provide context as to why
the Unity.Licensing.Client has failed to retrieve a license.

Signed-off-by: J. Renner <joao.renner@virtualisurg.com>

README.md

@@ -45,7 +45,7 @@ GameCI is free for everyone forever.
 
 You can support us at [OpenCollective](https://opencollective.com/game-ci).
 
-## Licence
+## License
 
 This repository is [MIT](./LICENSE) licensed.
 

dist/platforms/ubuntu/activate.sh

@@ -65,7 +65,14 @@ elif [[ -n "$UNITY_LICENSING_SERVER" ]]; then
   FLOATING_LICENSE=$(sed -n 2p <<< "$PARSEDFILE")
   FLOATING_LICENSE_TIMEOUT=$(sed -n 4p <<< "$PARSEDFILE")
 
-  echo "Acquired floating license: \"$FLOATING_LICENSE\" with timeout $FLOATING_LICENSE_TIMEOUT"
+  if [[ -z "$FLOATING_LICENSE" || -z "$FLOATING_LICENSE_TIMEOUT" ]]; then
+    echo "::error ::Failed to acquire floating license from Unity Licensing Server."
+    echo "Check the activation log below for more details."
+    cat license.txt
+  else
+    echo "Acquired floating license: \"$FLOATING_LICENSE\" with timeout $FLOATING_LICENSE_TIMEOUT"
+  fi
+
   # Store the exit code from the verify command
 else
   #

dist/platforms/ubuntu/run_tests.sh

@@ -36,6 +36,25 @@ echo "Using custom parameters $CUSTOM_PARAMETERS."
 
 echo "Using Unity version \"$UNITY_VERSION\" to test."
 
+#
+# Setup token for private package registry.
+#
+
+if [ -n "$PRIVATE_REGISTRY_TOKEN" ]; then
+  echo "Private registry token detected, creating .upmconfig.toml"
+
+  UPM_CONFIG_TOML_PATH="$HOME/.upmconfig.toml"
+  echo "Creating toml at path: $UPM_CONFIG_TOML_PATH"
+
+  touch $UPM_CONFIG_TOML_PATH
+
+  cat > "$UPM_CONFIG_TOML_PATH" <<EOF
+  [npmAuth."$SCOPED_REGISTRY_URL"]
+  token = "$PRIVATE_REGISTRY_TOKEN"
+  alwaysAuth = true
+EOF
+fi
+
 #
 # Create an empty project for testing if in package mode
 #
@@ -120,20 +139,6 @@ if [ "$PACKAGE_MODE" = "true" ]; then
 
   UNITY_PROJECT_PATH="$TEMP_PROJECT_PATH"
 
-  if [ -n "$PRIVATE_REGISTRY_TOKEN" ]; then
-    echo "Private registry token detected, creating .upmconfig.toml"
-
-    UPM_CONFIG_TOML_PATH="$HOME/.upmconfig.toml"
-    echo "Creating toml at path: $UPM_CONFIG_TOML_PATH"
-
-    touch $UPM_CONFIG_TOML_PATH
-
-    cat > "$UPM_CONFIG_TOML_PATH" <<EOF
-    [npmAuth."$SCOPED_REGISTRY_URL"]
-    token = "$PRIVATE_REGISTRY_TOKEN"
-    alwaysAuth = true
-EOF
-  fi
 
 fi
 
@@ -280,4 +285,4 @@ if [ -d "$FULL_COVERAGE_RESULTS_PATH" ]; then
   chmod -R a+r "$FULL_COVERAGE_RESULTS_PATH"
 else
   echo "Coverage results directory does not exist. If you are expecting coverage results, please make sure the Code Coverage package is installed in your unity project and that it is set up correctly."
-fi
+fi

src/model/results-check.ts

@@ -22,9 +22,18 @@ const ResultsCheck = {
       files.map(async filepath => {
         if (!filepath.endsWith('.xml')) return;
         core.info(`Processing file ${filepath}...`);
-        const fileData = await ResultsParser.parseResults(path.join(artifactsPath, filepath));
-        core.info(fileData.summary);
-        runs.push(fileData);
+        try {
+          const content = fs.readFileSync(path.join(artifactsPath, filepath), 'utf8');
+          if (!content.includes('<test-run')) {
+            // noinspection ExceptionCaughtLocallyJS
+            throw new Error('File does not appear to be a NUnit XML file');
+          }
+          const fileData = await ResultsParser.parseResults(path.join(artifactsPath, filepath));
+          core.info(fileData.summary);
+          runs.push(fileData);
+        } catch (error: any) {
+          core.warning(`Failed to parse ${filepath}: ${error.message}`);
+        }
       }),
     );
 
@@ -76,10 +85,12 @@ const ResultsCheck = {
     const pullRequest = github.context.payload.pull_request;
     const headSha = (pullRequest && pullRequest.head.sha) || github.context.sha;
 
+    // Check max length for https://github.com/game-ci/unity-test-runner/issues/214
     const maxLength = 65_534;
-    if (output.length > maxLength) {
-      core.warning(`Output too long (${output.length}) truncating to ${maxLength}`);
-      output = output.slice(0, maxLength);
+    if (output.text.length > maxLength) {
+      core.warning(`Test details of ${output.text.length} surpass limit of ${maxLength}`);
+      output.text =
+        'Test details omitted from GitHub UI due to length. See console logs for details.';
     }
 
     core.info(`Posting results for ${headSha}`);

src/model/results-parser.test.ts

@@ -248,5 +248,13 @@ at Tests.SetupFailedTest.SetUp () [0x00000] in /github/workspace/unity-project/A
       expect(result.path).toBe('/github/workspace/unity-project/Assets/Tests/SetupFailedTest.cs');
       expect(result.line).toBe(10);
     });
+
+    test('Debug.LogError annotation point', () => {
+      const result = ResultsParser.findAnnotationPoint(
+        `FMODUnity.RuntimeUtils:DebugLogError (string) (at Assets/Plugins/FMOD/src/RuntimeUtils.cs:580)`,
+      );
+      expect(result.path).toBe('Assets/Plugins/FMOD/src/RuntimeUtils.cs');
+      expect(result.line).toBe(580);
+    });
   });
 });

src/model/results-parser.ts

@@ -127,12 +127,13 @@ const ResultsParser = {
   },
 
   findAnnotationPoint(trace) {
+    const regex = /at(?: .* in)? ((?<path>[^:]+):(?<line>\d+))/;
     // Find first entry with non-zero line number in stack trace
-    const items = trace.match(/at .* in ((?<path>[^:]+):(?<line>\d+))/g);
+    const items = trace.match(new RegExp(regex, 'g'));
     if (Array.isArray(items)) {
       const result: { path: any; line: number }[] = [];
       for (const item of items) {
-        const match = item.match(/at .* in ((?<path>[^:]+):(?<line>\d+))/);
+        const match = item.match(regex);
         const point = {
           path: match ? match.groups.path : '',
           line: match ? Number(match.groups.line) : 0,
@@ -146,7 +147,7 @@ const ResultsParser = {
       }
     }
     // If all entries have zero line number match fallback pattern
-    const match = trace.match(/at .* in ((?<path>[^:]+):(?<line>\d+))/);
+    const match = trace.match(regex);
     return {
       path: match ? match.groups.path : '',
       line: match ? Number(match.groups.line) : 0,