Add support for Scoped Registries (#261)

* add: new inputs and method params

* feat: add scoped registry to manifest

* feat: setup test job

* fix(workflow): revert change from license to serial

* feat: support private scoped registries

* fix: multiple scopes

.github/workflows/main.yml

@@ -653,3 +653,103 @@ jobs:
  name: Package test results (combined)
  path: packageArtifacts/
  retention-days: 14
+
+ testPackageRunnerWithScopeRegistry:
+ name: Test package mode in all modes with Scoped Registry 📦✨
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ projectPath:
+ - unity-package-with-correct-tests/com.dependencyexample.testpackage
+ unityVersion:
+ - 2022.3.13f1
+ - 2023.1.19f1
+ - 2023.2.2f1
+ steps:
+ ###########################
+ # Checkout #
+ ###########################
+ - uses: actions/checkout@v4
+ with:
+ lfs: true
+
+ # Configure test runner
+ - name: Run tests
+ id: packageAllTests
+ uses: ./
+ with:
+ projectPath: ${{ matrix.projectPath }}
+ unityVersion: ${{ matrix.unityVersion }}
+ testMode: all
+ coverageOptions: 'generateAdditionalMetrics;generateHtmlReport;generateBadgeReport;assemblyFilters:+dependencyexample.testpackage.*,-*Tests*'
+ packageMode: true
+ scopedRegistryUrl: https://package.openupm.com
+ registryScopes: 'com.cysharp.unitask'
+ # Test implicit artifactsPath, by not setting it
+
+ # Upload artifacts
+ - name: Upload test results
+ uses: actions/upload-artifact@v3
+ with:
+ name: Package test results (all)
+ path: ${{ steps.packageAllTests.outputs.artifactsPath }}
+ retention-days: 14
+
+ # Upload coverage
+ - name: Upload coverage results
+ uses: actions/upload-artifact@v3
+ with:
+ name: Package Coverage results (all)
+ path: ${{ steps.packageAllTests.outputs.coveragePath }}
+ retention-days: 14
+
+ testPackageRunnerWithScopeRegistryAndMultipleScopes:
+ name: Test package mode in all modes with Scoped Registry and Multiple Scopes 🔎📦✨
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ projectPath:
+ - unity-package-with-correct-tests/com.dependencyexample.testpackage
+ unityVersion:
+ - 2022.3.13f1
+ - 2023.1.19f1
+ - 2023.2.2f1
+ steps:
+ ###########################
+ # Checkout #
+ ###########################
+ - uses: actions/checkout@v4
+ with:
+ lfs: true
+
+ # Configure test runner
+ - name: Run tests
+ id: packageAllTests
+ uses: ./
+ with:
+ projectPath: ${{ matrix.projectPath }}
+ unityVersion: ${{ matrix.unityVersion }}
+ testMode: all
+ coverageOptions: 'generateAdditionalMetrics;generateHtmlReport;generateBadgeReport;assemblyFilters:+dependencyexample.testpackage.*,-*Tests*'
+ packageMode: true
+ scopedRegistryUrl: https://package.openupm.com
+ registryScopes: 'com.cysharp, com.cysharp.unitask'
+ # Test implicit artifactsPath, by not setting it
+
+ # Upload artifacts
+ - name: Upload test results
+ uses: actions/upload-artifact@v3
+ with:
+ name: Package test results (all)
+ path: ${{ steps.packageAllTests.outputs.artifactsPath }}
+ retention-days: 14
+
+ # Upload coverage
+ - name: Upload coverage results
+ uses: actions/upload-artifact@v3
+ with:
+ name: Package Coverage results (all)
+ path: ${{ steps.packageAllTests.outputs.coveragePath }}
+ retention-days: 14

action.yml

@@ -56,6 +56,14 @@ inputs:
  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.'
+ scopedRegistryUrl:
+ required: false
+ default: ''
+ description: 'Scoped registry to use for resolving package dependencies. Only applicable if packageMode is true.'
+ registryScopes:
+ required: false
+ default: ''
+ description: 'Registry scopes to use for resolving package dependencies. Only applicable if packageMode is true. Required if scopedRegistry is set.'
  chownFilesTo:
  required: false
  default: ''

dist/platforms/ubuntu/run_tests.sh

@@ -96,13 +96,34 @@ if [ "$PACKAGE_MODE" = "true" ]; then
 
  PACKAGE_MANIFEST_JSON=$(cat "$PACKAGE_MANIFEST_PATH")
  echo "$PACKAGE_MANIFEST_JSON" | \
- jq \
- --arg packageName "$PACKAGE_NAME" \
- --arg projectPath "$UNITY_PROJECT_PATH" \
- '.dependencies += {"com.unity.testtools.codecoverage": "1.1.1"} | .dependencies += {"\($packageName)": "file:\($projectPath)"} | . += {testables: ["\($packageName)"]}' \
- > "$PACKAGE_MANIFEST_PATH"
+ jq \
+ --arg packageName "$PACKAGE_NAME" \
+ --arg projectPath "$UNITY_PROJECT_PATH" \
+ --arg scopedRegistryUrl "$SCOPED_REGISTRY_URL" \
+ --argjson registryScopes "$(echo "[\"$REGISTRY_SCOPES\"]" | sed 's/,/","/g')" \
+ '.dependencies += {"com.unity.testtools.codecoverage": "1.1.1"} |
+ .dependencies += {"\($packageName)": "file:\($projectPath)"} |
+ . += {testables: ["\($packageName)"]} |
+ . += {scopedRegistries: [{"name":"dependency", "url":"\($scopedRegistryUrl)", scopes: $registryScopes}] }' \
+ > "$PACKAGE_MANIFEST_PATH"
 
  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
 
 

src/main.ts

@@ -22,6 +22,8 @@ export async function run() {
  checkName,
  packageMode,
  packageName,
+ scopedRegistryUrl,
+ registryScopes,
  chownFilesTo,
  dockerCpuLimit,
  dockerMemoryLimit,
@@ -55,6 +57,8 @@ export async function run() {
  sshPublicKeysDirectoryPath,
  packageMode,
  packageName,
+ scopedRegistryUrl,
+ registryScopes,
  gitPrivateToken,
  githubToken,
  chownFilesTo,

src/model/image-environment-factory.ts

@@ -38,6 +38,9 @@ class ImageEnvironmentFactory {
  { name: 'ARTIFACTS_PATH', value: parameters.artifactsPath },
  { name: 'PACKAGE_MODE', value: parameters.packageMode },
  { name: 'PACKAGE_NAME', value: parameters.packageName },
+ { name: 'SCOPED_REGISTRY_URL', value: parameters.scopedRegistryUrl },
+ { name: 'REGISTRY_SCOPES', value: parameters.registryScopes },
+ { name: 'PRIVATE_REGISTRY_TOKEN', value: process.env.UPM_REGISTRY_TOKEN },
  { name: 'GIT_PRIVATE_TOKEN', value: parameters.gitPrivateToken },
  { name: 'VERSION', value: parameters.buildVersion },
  { name: 'CUSTOM_PARAMETERS', value: parameters.customParameters },

src/model/input.ts

@@ -101,6 +101,9 @@ class Input {
  const checkName = getInput('checkName') || 'Test Results';
  const rawPackageMode = getInput('packageMode') || 'false';
  let packageName = '';
+ const scopedRegistryUrl = getInput('scopedRegistryUrl') || '';
+ const rawScopes = getInput('registryScopes') || '';
+ let registryScopes: string[] = [];
  const chownFilesTo = getInput('chownFilesTo') || '';
  const dockerCpuLimit = getInput('dockerCpuLimit') || os.cpus().length.toString();
  const bytesInMegabyte = 1024 * 1024;
@@ -171,6 +174,16 @@ class Input {
 
  packageName = this.getPackageNameFromPackageJson(projectPath);
  this.verifyTestsFolderIsPresent(projectPath);
+
+ if (scopedRegistryUrl !== '') {
+ if (rawScopes === '') {
+ throw new Error(
+ 'Scoped registry is set, but registryScopes is not set. registryScopes is required when using scopedRegistryUrl.',
+ );
+ }
+
+ registryScopes = rawScopes.split(',').map(scope => scope.trim());
+ }
  }
 
  if (runAsHostUser !== 'true' && runAsHostUser !== 'false') {
@@ -219,6 +232,8 @@ class Input {
  checkName,
  packageMode,
  packageName,
+ scopedRegistryUrl,
+ registryScopes,
  chownFilesTo,
  dockerCpuLimit,
  dockerMemoryLimit,

unity-package-with-correct-tests/com.dependencyexample.testpackage/Editor/TimerFeature/TimerComponentEditor.cs

@@ -0,0 +1,15 @@
+using UnityEngine;
+using System.Collections;
+using UnityEditor;
+
+[CustomEditor(typeof(TimerComponent))]
+public class LevelScriptEditor : Editor
+{
+ public override void OnInspectorGUI()
+ {
+ TimerComponent myTarget = (TimerComponent)target;
+
+ EditorGUILayout.LabelField("Timer", myTarget.Timer.ToString());
+ }
+}
+

unity-package-with-correct-tests/com.dependencyexample.testpackage/Editor/example.testpackage.Editor.asmdef

@@ -0,0 +1,16 @@
+{
+ "name": "example.testpackage.Editor",
+ "rootNamespace": "",
+ "references": [
+ "example.testpackage.Runtime"
+ ],
+ "includePlatforms": [],
+ "excludePlatforms": [],
+ "allowUnsafeCode": false,
+ "overrideReferences": false,
+ "precompiledReferences": [],
+ "autoReferenced": true,
+ "defineConstraints": [],
+ "versionDefines": [],
+ "noEngineReferences": false
+}