update

Correction... making a single PYTHON script that stays in alignment with our CI scripting language usage.

Author: NoelStephensUnity

.yamato/_run-all.yml

@@ -451,10 +451,8 @@ run_all_project_tests_cmb_service_default:
 run_all_api_updater_tests:
   name: Run All API Updater Tests
   dependencies:
-{% for platform in test_platforms.desktop -%}
-{% if platform.name == "win" -%}
+{% for platform in test_platforms.default -%}
 {% for editor in validation_editors.default -%}
     - .yamato/api-updater-test.yml#api_updater_test_{{ platform.name }}_{{ editor }}
 {% endfor -%}
-{% endif -%}
 {% endfor -%}

.yamato/api-updater-test.yml

@@ -19,8 +19,9 @@
   # develop_nightly or develop_weekly_trunk in _triggers.yml.
 
 # CONFIGURATION STRUCTURE--------------------------------------------------------------
-  # Windows only, and not looped over test_platforms: run-upgrade-test.ps1 is PowerShell and uses
-  # robocopy to purge Library (paths there exceed MAX_PATH, which Remove-Item cannot delete).
+  # Runs on the default platform (Ubuntu) like every other basic job. run_upgrade_test.py is Python, so
+  # there is no platform constraint - the earlier PowerShell version forced a Windows agent because it
+  # needed robocopy to purge Library past MAX_PATH.
   # A single editor is enough - the job is asserting on the editor's API updater, not on NGO
   # behaviour across editor versions. Widen to validation_editors.all if that stops being true.
 
@@ -30,20 +31,19 @@
   # and needs no package-pack dependency.
   # The script restores the 2.x sources when it finishes, so the checkout is left unmodified and the
   # job is safe to re-run on the same agent.
-  # -Clean purges Library first: the assertion is meaningless against a warm Library that already
+  # --clean purges Library first: the assertion is meaningless against a warm Library that already
   # holds rewritten sources from a previous run.
 
 # QUALITY CONSIDERATIONS--------------------------------------------------------------------
-  # The expected type list in run-upgrade-test.ps1 is inline and hand-written. That is fine because
+  # The expected type list in run_upgrade_test.py is inline and hand-written. That is fine because
   # its input is frozen: it enumerates the 2.x public editor API, and develop-2.0.0 is released.
   # TODO: the list does not extend itself. A later relocation within 3.x, or a back port into 2.x,
   #       has to be added by hand or this job silently stops covering it. Deriving the list from the
   #       [MovedFrom] attributes in the package source would close that.
 
 #------------------------------------------------------------------------------------
 
-{% for platform in test_platforms.desktop -%}
-{% if platform.name == "win" -%}
+{% for platform in test_platforms.default -%}
 {% for editor in validation_editors.default -%}
 api_updater_test_{{ platform.name }}_{{ editor }}:
   name : API Updater Test - NGO 2.x editor scripts upgrade [{{ platform.name }}, {{ editor }}]
@@ -53,13 +53,12 @@ api_updater_test_{{ platform.name }}_{{ editor }}:
     flavor: {{ platform.flavor }}
   commands:
     - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor # Installing basic editor for the import
-    - powershell -NoProfile -ExecutionPolicy Bypass -File apiupdaterproject/run-upgrade-test.ps1 -UnityExe .Editor/Editor/Unity.exe -Clean
+    - python apiupdaterproject/run_upgrade_test.py --unity .Editor/Editor/Unity --clean
   artifacts:
     logs:
       paths:
         - "apiupdaterproject/upgrade-test.log"
   dependencies:
     - .yamato/_run-all.yml#run_quick_checks # initial checks to perform fast validation of common errors
 {% endfor -%}
-{% endif -%}
 {% endfor -%}

apiupdaterproject/AGENTS.md

@@ -13,7 +13,7 @@ what it is and how to run it; this file covers why it is built this way and what
   `com.unity.netcode.gameobjects/Editor/**`. This project only consumes them.
 * **Do not "fix" the sources under `Assets/Editor`.** They are deliberately written against the 2.x
   API and are the input to the test. A helpful cleanup there silently guts it.
-* The expected-type list in the run scripts is frozen: it enumerates the public editor API of
+* The expected-type list in `run_upgrade_test.py` is frozen: it enumerates the public editor API of
   `develop-2.0.0`, which is released and cannot change. It only needs extending if a public editor
   type is relocated again within 3.x.
 * CI runs it on demand only — comment `/ci apiupdater` on a PR. See `.yamato/api-updater-test.yml`.

apiupdaterproject/README.md

@@ -39,35 +39,28 @@ resolved transport version.
 
 ## Running it locally
 
-The script imports the project in batch mode with `-accept-apiupdate`, then asserts that every 2.x
-type reference under `Assets/Editor` was rewritten and that none survived. It restores the 2.x
-sources when it finishes, so it can be re-run.
-
-| Option | |
-| --- | --- |
-| editor path | Omit it if `UNITY_EDITOR_PATH` is set, or if the hub has the version named in `ProjectSettings/ProjectVersion.txt`. |
-| keep updated sources | Leaves the rewritten sources in place so `git diff` shows exactly what the updater produced. |
-| clean | Purges `Library` and `Temp` first for a cold import. |
-
-### Windows
-
-```powershell
-.\run-upgrade-test.ps1 -UnityExe "C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -KeepUpdatedSources -Clean
-```
-
-### macOS
-
-The editor binary lives inside the `.app` bundle, not next to it.
+`run_upgrade_test.py` imports the project in batch mode with `-accept-apiupdate`, then asserts that
+every 2.x type reference under `Assets/Editor` was rewritten and that none survived. It restores the
+2.x sources when it finishes, so it can be re-run. Windows, macOS and Linux.
 
 ```sh
-./run-upgrade-test.sh --unity "/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity" --keep-updated-sources --clean
+python run_upgrade_test.py --unity <editor> --clean --keep-updated-sources
 ```
 
-### Linux
+| Option | |
+| --- | --- |
+| `--unity` | Omit it if `UNITY_EDITOR_PATH` is set, or if the hub has the version named in `ProjectSettings/ProjectVersion.txt`. |
+| `--clean` | Purges `Library` and `Temp` first for a cold import. |
+| `--keep-updated-sources` | Leaves the rewritten sources in place so `git diff` shows exactly what the updater produced. |
 
-```sh
-./run-upgrade-test.sh --unity "$HOME/Unity/Hub/Editor/<version>/Editor/Unity" --keep-updated-sources --clean
-```
+Default hub locations, if you need to pass `--unity` explicitly — note that on macOS the binary is
+inside the `.app` bundle rather than beside it:
+
+| | |
+| --- | --- |
+| Windows | `C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe` |
+| macOS | `/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity` |
+| Linux | `$HOME/Unity/Hub/Editor/<version>/Editor/Unity` |
 
 
 ## How the migration works