chore: enable unified hybrid tests - #4122
Conversation
Adding an additional unified hybrid spawning test pass.
Fixed: - Issue with NetworkObject throwing an exception during hybrid integration test. - Issue with setting the active world prior to spawning a hybrid prefab during integration tests. - Issue with UnifiedNetcodeUpdateSystem not overriding the OnCreate method along with checks for a valid NetworkManager and/or transport within OnUpdate. - Issues (minor) with the original UnifiedNetworkTransformTest. - Adjustments to the NetcodeIntegrationTest that assures the correct active world is assigned when spawning.
There was a problem hiding this comment.
This "pins" the NGO version of the unified NetcodeConfig to avoid having one auto-created.
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop-3.x.x #4122 +/- ##
==============================================
Coverage 78.01% 78.01%
==============================================
Files 153 153
Lines 26254 26254
==============================================
Hits 20483 20483
Misses 5771 5771
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Co-authored-by: Emma <emma.mcmillan@unity3d.com>
| # Unified (NGO + N4E) validation, on demand. | ||
| # This job allows the Unified tests to be kicked off by commenting "/ci unified". | ||
| # This is useful for PRs where pr_code_changes_checks doesn't trigger. | ||
| unified_pr_checks: |
There was a problem hiding this comment.
I'm not sure if we really need this part if those tests will run on each PR anyway (part of pr_code_changes_checks)
| # alpha (unified_editors in project.metafile) rather than a supported editor, because it needs an | ||
| # editor that bundles a com.unity.netcode with the unified API. Expect it to need a pin bump | ||
| # whenever N4E lands breaking changes in trunk. See .yamato/unified-tests.yml. | ||
| - .yamato/_run-all.yml#run_all_unified_tests |
There was a problem hiding this comment.
So those tests are not included by default in any other job? Like usual package tests?
There was a problem hiding this comment.
| commands: | ||
| # Swap in the manifest that pulls in com.unity.netcode (N4E). This is what causes UNIFIED_NETCODE | ||
| # to be defined and therefore what makes the unified tests compile at all. | ||
| - cp {{ project.path }}/Packages/manifest-unified.json {{ project.path }}/Packages/manifest.json |
There was a problem hiding this comment.
Why we can't update our current manifest already? Would it require to move completely to testing on 6000.7?
There was a problem hiding this comment.
Yeah... it would require us to remove all of the earlier editor versions.
We can do that, but we might wait until after all of the initial unified testing is done before switching over completely.
But based on yesterday's conversation we might hold off in case we decide to support 6000.3.
| # to be defined and therefore what makes the unified tests compile at all. | ||
| - cp {{ project.path }}/Packages/manifest-unified.json {{ project.path }}/Packages/manifest.json | ||
| # The committed lock was resolved against a supported editor, not the unified alpha. | ||
| - rm -f {{ project.path }}/Packages/packages-lock.json |
There was a problem hiding this comment.
I think we already got rid of all package-lock.json so maybe we can remove this line?
| - rm -f {{ project.path }}/Packages/packages-lock.json | ||
|
|
||
| - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor # Installing basic editor for tests execution | ||
| - UnifiedTestRunner --testproject={{ project.path }} --suite=playmode --artifacts-path=test-results --editor-location=.Editor --testfilter="{{ unified_test_filter }}" --rerun-strategy=Test --retry={{ num_test_retries }} --clean-library-on-rerun --timeout={{ test_timeout }} |
There was a problem hiding this comment.
Do we only support PlayMode tests? (otherwise it would be --suite=editor --suite=playmode)
Co-authored-by: Emma <emma.mcmillan@unity3d.com>
Removed command to delete packages-lock.json from unified tests.
Purpose of this PR
Stands up a dedicated CI job that runs the unified (NGO + N4E) hybrid-prefab integration tests, and
fixes the three bugs that were preventing
UnifiedNetworkTransformTestfrom passing.This is the first part of 3 PRs:
UniversalNetworkTransformTestis the only opt-in for 4137 ). 4137 also removes a bunch of the YAML comment verbosity along with other script file comments.Additional unified netcode hybrid testing details
The pin for unified testing is 6000.7.0a5, not 6000.7.0a2 due to conflicts between the two.
The original plan was to pin a2 (breakpoints are more reliable there). a2 turns out to be unusable —
it cannot compile the unified code at all. Both alphas bundle
com.unity.netcode6.7.0, so thepackage version does not distinguish them; only the trunk snapshot does. Verified by reading the
sources bundled in each editor:
IOutOfBandRpcCommandOutgoingOutOfBandRpcDataStreamBufferUnifiedNetcodeTransportis gated on#if UNIFIED_NETCODE && OUT_OF_BAND_RPCand needs both.Separately, a2 still names the component
GhostAdapter; a5 renamed it toGhostObject, which is whatthe test helpers call. Two independent blockers, so a2 is off the table regardless of debugger quality.
Runtime fixes
UnifiedNetcodeUpdateSystem.OnCreateused theISystemsignatureOnCreate(ref SystemState)on aSystemBase. Withoutoverridethat is a new method Entities never calls, so neitherRequireForUpdatetook effect andOnUpdateran from the first world tick — beforeStartClient/StartServerassignTransportandNetworkManager.CreateSingleWorldHostcallsAppendWorldToCurrentPlayerLoop, so the world is live immediately and any tick in that window was aNullReferenceException. Corrected to the parameterless override, plus a null guard inOnUpdate.NetcodeIntegrationTest.SpawnObjectsetNetcode.Instance.m_ActiveWorldafterObject.Instantiate. The hybrid prefab is active, so the clone'sGhostObject.Awakerunssynchronously inside
Instantiate; the clone is not a prefab, so Awake acquires an entity referenceand resolves the target world from that singleton. N4E's rate managers reassign it on every world
update, so it pointed at whichever client world updated last and the spawn was rejected with
"You can only spawn a ghost on a server or during prediction on a client." Assignment hoisted above
Instantiate.NetworkObject.InitGhostthrew when a hybrid prefab was created before anyNetworkManagerexists,which is the normal ordering in integration tests. Now returns early on a null
NetworkManager.CreateHybridPrefabalso now callsGhostObject.InitializeAsPrefab()instead of hand-rolling theGhostPrefabReferencesetup, which picks up N4E'stry/finallyreset ofs_IsPostProcessing.UnifiedNetworkTransformTestwas hardened: position is validated on initial spawn as well as afterthe move, and the fixed
WaitForSeconds(1)is replaced withWaitForConditionOrTimeOutreportingwhich client diverged and by how much.
Tradeoffs worth reviewer attention
manifest-unified.jsonis a full copy ofmanifest.json. It differs by morethan the N4E entry:
manifest.jsonpins the builtin versions that exist on 6000.6(
addressables 2.11.1,timeline 6.6.0,ugui 2.6.0), which do not resolve on 6000.7.0a5. Thatmeans hand-syncing two manifests until N4E becomes a hard NGO dependency, at which point this goes
away. I could not find a way to avoid the duplication without dropping 6000.6 support.
unified_test_filter: "*Unified*"matches the NUnit full testname, which covers the dedicated fixtures and is intended to also cover shared fixtures
parameterized with
HostOrServer.UnifiedHost/UnifiedServer. An NUnit[Category]would be lessfragile once more fixtures gain unified variants; there is no
[Category]usage in the package todayand
UnifiedTestRunner's--categorysupport is unconfirmed, so this is deliberately deferred.run_all_unified_testsis a dependency ofpr_code_changes_checks,wired the same way as the CMB service tests. That puts an unsupported alpha editor into the mandatory
gate: when N4E lands breaking changes in trunk this goes red and the pin has to be bumped before any
PR can go green. Chosen deliberately over an opt-in trigger so unified breakage is noticed
immediately.
unified_pr_checks(/ci unified) remains for PRs the main gate does not cover.unified_editors.default,unified_netcode_version, and thecom.unity.netcodeversion inmanifest-unified.json.Known gap: the CI job runs editor playmode; verification so far is a standalone player run.
See Testing & QA below.
Jira ticket
MTT-XXXX
Documentation
All changes are either CI configuration, test helpers, or runtime code behind
#if UNIFIED_NETCODE,which cannot be defined without
com.unity.netcodeinstalled. There is no public API surface changeand no behaviour change for any current NGO user.
Testing & QA (How your changes can be verified during release Playtest)
Functional Testing
Manual testing :
Manual testing doneA standalone player build containing only
UnifiedNetworkTransformTestruns green locally(Windows, Mono, 6000.7.0a5). Before the three fixes above this failed with
SetUp : Failed to start instancesplus aNullReferenceExceptionimmediately after"Starting a world for Host".
Also unverified: that
com.unity.netcode: 6.7.0resolves to the builtin copy frommanifest-unified.jsonon a clean checkout (locally it was added by hand tomanifest.json), and thatYamato accepts the new YAML.
Automated tests:
Covered by existing automated testsUnifiedNetworkTransformTestalready existed; this PR fixes what it was failing on and strengthens itsassertions. The new coverage is at the CI level — the test now actually runs in CI, which it never did
before, since
UNIFIED_NETCODEwas never defined in any existing job.Does the change require QA team to:
Review automated tests?Execute manual tests?Provide feedback about the PR?No QA involvement requested: this is CI infrastructure plus an experimental code path that is compiled
out of every shipping configuration.
Up-port
Not needed. This PR targets
develop-3.x.xdirectly. The unified API does not exist in NGO v2.x, andall runtime changes are behind
UNIFIED_NETCODE, which cannot be defined there.Backports
Not needed, for the same reason — this is specific to the NGOv3.X unified work.