test

Adding a project verification test that can be triggered by typing "apiupdater" as a comment.
The project added verifies that the entire public API within the unity.netcode.editor namespace is auto-upgraded without compilation errors.

Author: NoelStephensUnity

.yamato/_run-all.yml

@@ -444,3 +444,17 @@ run_all_project_tests_cmb_service_default:
 {% endfor -%}
 {% endfor -%}
 {% endfor -%}
+
+
+# Runs the NGO 2.x -> 3.x editor script upgrade validation (see api-updater-test.yml)
+# Manual only today. Add this to develop_nightly or develop_weekly_trunk in _triggers.yml to schedule it.
+run_all_api_updater_tests:
+  name: Run All API Updater Tests
+  dependencies:
+{% for platform in test_platforms.desktop -%}
+{% if platform.name == "win" -%}
+{% for editor in validation_editors.default -%}
+    - .yamato/api-updater-test.yml#api_updater_test_{{ platform.name }}_{{ editor }}
+{% endfor -%}
+{% endif -%}
+{% endfor -%}

.yamato/_triggers.yml

@@ -134,6 +134,22 @@ unified_pr_checks:
     cancel_old_ci: true
 
 
+# NGO 2.x -> 3.x editor script upgrade validation, on demand.
+# This job allows the API updater test to be kicked off by commenting "/ci apiupdater".
+# It is deliberately not part of the PR gate: what it protects only changes when a public editor type
+# is added, moved or removed, so paying a full editor import on every PR is not worth it.
+# To put it on a schedule, add .yamato/_run-all.yml#run_all_api_updater_tests to develop_nightly or
+# develop_weekly_trunk below.
+api_updater_pr_checks:
+  name: API Updater checks [on demand]
+  dependencies:
+    - .yamato/_run-all.yml#run_all_api_updater_tests
+  triggers:
+    expression: |-
+      pull_request.comment eq "apiupdater"
+    cancel_old_ci: true
+
+
 # Run all tests on nightly basis.
 # Same subset as pull_request_trigger with addition of mobile/desktop/console tests and webgl builds
 # Those tests are all running on trunk and the default editor (since it's daily and running all of them would add a lot of overhead)

.yamato/api-updater-test.yml

@@ -0,0 +1,65 @@
+{% metadata_file .yamato/project.metafile %} # All configuration that is used to create different configurations (used in for loops) is taken from this file.
+---
+
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job validates the NGO 2.x -> 3.x upgrade path for editor scripts.
+  # NGO 3.0 renamed the editor assembly and its namespaces (Unity.Netcode.Editor ->
+  # Unity.Netcode.GameObjects.Editor), and every relocated public type carries a [MovedFrom] so that
+  # Unity's API updater rewrites a 2.x project's editor scripts automatically on upgrade.
+  # apiupdaterproject holds editor code written against the 2.x API; the job imports it with
+  # -accept-apiupdate and asserts that every 2.x type reference was rewritten and none survived.
+  # See apiupdaterproject/README.md.
+
+# WHY THIS JOB IS MANUAL ONLY-----------------------------------------------------------
+  # It is deliberately not wired into pr_minimal_required_checks or pr_code_changes_checks. The thing
+  # it protects only changes when a public editor type is added, moved or removed, so paying a full
+  # editor import on every PR is not worth it. Kick it off with "/ci apiupdater" in a PR comment
+  # (see api_updater_pr_checks in _triggers.yml), or from the Yamato UI.
+  # If it should also run on a schedule, add .yamato/_run-all.yml#run_all_api_updater_tests to
+  # 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).
+  # 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.
+
+# TECHNICAL CONSIDERATIONS---------------------------------------------------------------
+  # apiupdaterproject/Packages/manifest.json references the package by relative path
+  # (file:../../com.unity.netcode.gameobjects), so the job tests the package as it sits in the repo
+  # 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
+  # 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
+  # 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 editor in validation_editors.default -%}
+api_updater_test_{{ platform.name }}_{{ editor }}:
+  name : API Updater Test - NGO 2.x editor scripts upgrade [{{ platform.name }}, {{ editor }}]
+  agent:
+    type: {{ platform.type }}
+    image: {{ platform.image }}
+    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
+  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/.gitignore

@@ -0,0 +1,78 @@
+# This .gitignore file should be placed at the root of your Unity project directory
+#
+# Get latest from https://github.com/github/gitignore/blob/master/Unity.gitignore
+#
+/[Ll]ibrary/
+/[Tt]emp/
+/[Oo]bj/
+/[Bb]uild/
+/[Bb]uilds/
+/[Ll]ogs/
+/[Uu]ser[Ss]ettings/
+
+# MemoryCaptures can get excessive in size.
+# They also could contain extremely sensitive data
+/[Mm]emoryCaptures/
+
+# Asset meta data should only be ignored when the corresponding asset is also ignored
+!/[Aa]ssets/**/*.meta
+
+# Uncomment this line if you wish to ignore the asset store tools plugin
+# /[Aa]ssets/AssetStoreTools*
+
+# Autogenerated Jetbrains Rider plugin
+/[Aa]ssets/Plugins/Editor/JetBrains*
+
+# Visual Studio cache directory
+.vs/
+
+# Gradle cache directory
+.gradle/
+
+# Autogenerated VS/MD/Consulo solution and project files
+ExportedObj/
+.consulo/
+*.csproj
+*.unityproj
+*.sln
+*.suo
+*.tmp
+*.user
+*.userprefs
+*.pidb
+*.booproj
+*.svd
+*.pdb
+*.mdb
+*.opendb
+*.VC.db
+
+# Unity3D generated meta files
+*.pidb.meta
+*.pdb.meta
+*.mdb.meta
+
+# Unity3D generated file on crash reports
+sysinfo.txt
+
+# Builds
+*.apk
+*.aab
+*.unitypackage
+
+# Crashlytics generated file
+crashlytics-build.properties
+
+# Packed Addressables
+/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin*
+
+# Temporary auto-generated Android Assets
+/[Aa]ssets/[Ss]treamingAssets/aa.meta
+/[Aa]ssets/[Ss]treamingAssets/aa/*
+/[Aa]ssets/[Ss]treamingAssets/BuildInfo.json
+/[Aa]ssets/[Ss]treamingAssets/BuildInfo.json.meta
+
+InitTestScene*
+
+# API updater test run log
+upgrade-test.log

apiupdaterproject/Assets/DefaultNetworkPrefabs.asset

@@ -0,0 +1,16 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: e651dbb3fbac04af2b8f5abf007ddc23, type: 3}
+  m_Name: DefaultNetworkPrefabs
+  m_EditorClassIdentifier: Unity.Netcode.Runtime::Unity.Netcode.NetworkPrefabsList
+  IsDefault: 1
+  List: []

apiupdaterproject/Assets/DefaultNetworkPrefabs.asset.meta

@@ -0,0 +1,33 @@
+// NGO 2.x-era editor code. Every type reference below must be rewritten by Unity's API updater to
+// its `Unity.Netcode.GameObjects.Editor` equivalent. Do not "fix" this file - it is the input to
+// the upgrade test. See ../../README.md.
+#pragma warning disable 169 // field is never used
+
+using ApiUpdaterProject;
+using Unity.Netcode.Editor;
+using Unity.Netcode.Editor.Configuration;
+
+namespace ApiUpdaterProject.Editor
+{
+    internal class DeprecatedApiUsage
+    {
+        // Unity.Netcode.Editor -> Unity.Netcode.GameObjects.Editor
+        private NetworkPrefabsEditor m_NetworkPrefabsEditor;
+        private HiddenScriptEditor m_HiddenScriptEditor;
+        private UnityTransportEditor m_UnityTransportEditor;
+        private NetworkAnimatorEditor m_NetworkAnimatorEditor;
+        private NetworkRigidbodyEditor m_NetworkRigidbodyEditor;
+        private NetworkRigidbody2DEditor m_NetworkRigidbody2DEditor;
+        private NetcodeEditorBase<UpgradeProbeBehaviour> m_NetcodeEditorBase;
+        private NetworkBehaviourEditor m_NetworkBehaviourEditor;
+        private NetworkManagerEditor m_NetworkManagerEditor;
+        private NetworkManagerHelper m_NetworkManagerHelper;
+        private NetworkObjectEditor m_NetworkObjectEditor;
+        private NetworkRigidbodyBaseEditor m_NetworkRigidbodyBaseEditor;
+        private NetworkTransformEditor m_NetworkTransformEditor;
+
+        // Unity.Netcode.Editor.Configuration -> Unity.Netcode.GameObjects.Editor.Configuration
+        private NetcodeForGameObjectsProjectSettings m_ProjectSettings;
+        private NetworkPrefabProcessor m_NetworkPrefabProcessor;
+    }
+}

apiupdaterproject/Assets/Editor.meta

@@ -0,0 +1,25 @@
+// The same 2.x API reached through the reference forms the updater has to handle separately from a
+// plain `using` + simple name: fully qualified names, a namespace alias, a type alias, a base type
+// and a typeof. Do not "fix" this file - it is the input to the upgrade test.
+#pragma warning disable 169 // field is never used
+
+using System;
+using Cfg = Unity.Netcode.Editor.Configuration;
+using ManagerEditor = Unity.Netcode.Editor.NetworkManagerEditor;
+
+namespace ApiUpdaterProject.Editor
+{
+    internal class DeprecatedApiUsageQualified
+    {
+        private Unity.Netcode.Editor.NetworkObjectEditor m_FullyQualified;
+        private Unity.Netcode.Editor.NetcodeEditorBase<ApiUpdaterProject.UpgradeProbeBehaviour> m_FullyQualifiedGeneric;
+        private Cfg.NetworkPrefabProcessor m_ThroughNamespaceAlias;
+        private ManagerEditor m_ThroughTypeAlias;
+
+        private Type TransformEditorType => typeof(Unity.Netcode.Editor.NetworkTransformEditor);
+    }
+
+    internal class DerivesFromDeprecatedBase : Unity.Netcode.Editor.HiddenScriptEditor
+    {
+    }
+}