Fix: Stabilize unit tests by JessTello · Pull Request #1298 · EOS-Contrib/eos_plugin_for_unity

JessTello · 2026-06-11T21:40:17Z

Fix EOS test crashes and stabilize test setup
Fix config path resolution and copy test config to build
Fix prefabs and performance stress test for missing scripts.
Fix asmdef for correct platforms

-Introduced a new CallbackHelper class to centralize notification callback lifecycle management and prevent stale callback collisions when the EOS Platform is recreated. -Updated EOSManager and FriendTest to correctly integrate with the new callback lifecycle behavior, ensuring callbacks are cleared at the proper time during test teardown and platform shutdown. -These changes fix failures encountered when running the full unit test suite by ensuring isolation between tests and preventing leftover EOS notification state from leaking across test runs.

…ssionsManagerTests.cs

…lback disposal Uncommented EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN to prevent unloading the EOS SDK in the Unity Editor, in line with the official EOS documentation. This change resolves the unit test failures by avoiding PlatformInterface.Shutdown() during editor test runs, which was corrupting internal SDK state across multiple test suites.

The shutdown/unload logic is now Editor‑only, runtime behavior is protected, the hardcoded define was removed, and Windows Editor behavior is aligned with macOS/Linux and Epic documentation.

…ssionsManagerTests.cs

Fix prefabs and performance stress test for missing scripts. Fix asmdef for correct platforms

…s' into unitTest-eosu1037-and-eosu1013

- Replaced Directory.GetCurrentDirectory-based logic with a path derived from Application.dataPathto correctly resolve the project root in both Editor and Player. - Updated TestPlayerModeSetup to persist the build output directory and copy the test config file into the player build. - Build no longer fails if the config file is missing; a warning is logged instead.

- Prevent multiple EOS initializations when running full test suite - Make EOS static to ensure single initialization per session - Avoid teardown issues caused by test-specific EOSManager instances - Ignore tests that require a second machine instead of crashing - Add null check in lobby and session cleanup to prevent NPE

matt-clarke · 2026-06-12T09:30:42Z

            "eos_automated_test_config.json",
            FileSystemUtility.CombinePaths(
-                FileSystemUtility.GetProjectPath(),
+                Path.GetFullPath(Path.Combine(Application.dataPath, "..")),


This should be functionally equivalent shouldn't it? The GetProjectPath function will find the Assets folder and step up one directory too

matt-clarke · 2026-06-12T09:31:39Z

        {
+            Assert.Ignore(
+                "This test requires a second machine running as a server. " +
+                "Run only the 'Client' category when a server player is available.");


If you run the 'Client' category this test will still be ignored though right?

I'm not sure of an ideal resolution right now, but this seems passable for now:

Add a new bool to the test config ("RunLobbyTestsThatRequireHost")

Update this code to check that and use Assert.Ignore if it's not enabled

Update the Assert.Ignore to refer to using both the category and the option in the test config

matt-clarke · 2026-06-12T09:31:43Z

        {
+            Assert.Ignore(
+                "This test requires a second machine running as a server. " +
+                "Run only the 'Client' category when a server player is available.");


If you run the 'Client' category this test will still be ignored though right?

I'm not sure of an ideal resolution right now, but this seems passable for now:

Add a new bool to the test config ("RunLobbyTestsThatRequireHost")

Update this code to check that and use Assert.Ignore if it's not enabled

Update the Assert.Ignore to refer to using both the category and the option in the test config

matt-clarke · 2026-06-12T09:33:29Z


-// This define controls if the EOS SDK should be unloaded in the editor at shutdown to work around DLL unload errors.
-//#define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN



I've copied the pending questions from the original PR here. @OswaldoApexSystems can you respond to these?

matt-clarke · 2026-06-12T09:34:04Z

+            string resolvedPath = Path.GetFullPath(playerOptions.locationPathName);
+            s_TestBuildDirectory = Path.HasExtension(resolvedPath)
+                ? Path.GetDirectoryName(resolvedPath)
+                : resolvedPath;


FileSystemUtility seems designed to wrap Path and I assume is recommended for consistency.
There's quite a bit of this in this file

matt-clarke · 2026-06-12T09:36:37Z

        /// </summary>
-        /// <returns></returns>
        [UnityTest]
+        [Category(TestCategories.SoloCategory)]


Not suggesting we change this here, but I'm thinking we should get rid of this unless you know why it exists. It isn't going to be attached to every single test that isn't a "Client" one, so it'll result in people not running all the tests they expect. Perhaps there are also some tests that are neither "Solo" or "Client" though, but it would likely make sense to just tag those separately

matt-clarke · 2026-06-12T09:36:47Z

-        /// <returns></returns>
        [UnityTest]
+        [Category(TestCategories.SoloCategory)]
        public IEnumerator ConnectLogin_WhileAlreadyLoggedIn_ReturnsExpectedResult()


Can you update the function name to include "DevAuthTool"?

matt-clarke · 2026-06-12T09:38:34Z

-        /// <returns></returns>
        [UnityTest]
+        [Category(TestCategories.SoloCategory)]
        public IEnumerator AuthLogin_WhileAlreadyLoggedIn_ReturnsExpectedResult()


Can you update the function name to include "DevAuthTool"?

matt-clarke · 2026-06-12T09:44:20Z

+#if UNITY_EDITOR && (!UNITY_EDITOR_WIN || !EOS_UNLOAD_SDK_ON_SHUTDOWN_IN_WIN_EDITOR)
+// This define controls if the EOS SDK should be unloaded in the editor at shutdown to work around DLL unload errors.
+#define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN_IN_EDITOR
 #endif


This docs file covers a couple of points which are a bit of a concern:

"It is not the default because if it were, then any edits to the EOSConfig file would require a reboot of the Unity Editor"

Can you check if this is accurate?

If it is then we would need to think of a solution to this, perhaps when you save the EOSConfig it prompts you to restart the Editor (after checking the new define mentioned in the comment below)

I suspect we also need a Unity hook to check if the file was modified outside of Unity (user could've edited it by hand, or pulled latest changes from their repo)

"In the past, not unloading the EOS SDK could also cause issues with state from the previous Unity run not being properly cleaned up."

This is the opposite of what we're seeing right? I'm wary that there's some edge case issues that we haven't seen with this initial testing. It could definitely be a misunderstanding though

The commit message where it was added also says the same, so it doesn't appear to just be a mistake in the docs (It also carries with it the potential for "leaked" EOS State to carry over between play in editor runs.)

Jess' reply from the original PR (link):

I agree the current wording in c_sharp_defines.md is too absolute and also a bit outdated relative to the current config model. The real concern here is not simply that the config file changes, but that EOSManager now conditionally skips full SDK shutdown/unload in the Editor, which means some initialization related SDK state may persist across play sessions. Because of that, I don’t think we should claim that any config edit requires an Editor restart, a more accurate statement is that config changes which affect EOS SDK initialization may require restarting the Editor when the SDK is not fully unloaded. I also agree that the doc should stop referring to EOSConfig here and instead reflect the current ProductConfig / PlatformConfig flow. If we want better UX around this later, we can consider a targeted restart prompt or external change detection as a follow up, but I think the immediate fix is to make the documentation more precise and aligned with the current EOSManager behavior.

matt-clarke · 2026-06-12T09:44:37Z

+// This define controls if the EOS SDK should be unloaded in the editor at shutdown to work around DLL unload errors.
+#define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN_IN_EDITOR
 #endif



With this change to always define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN in Editor this means that this docs file is out of date.

The change above also removes the ability for developers to control whether it's enabled in Editor or not for Windows.

One option would be to change the above code to this, and update the docs to refer to this define instead:

#if UNITY_EDITOR && (!UNITY_EDITOR_WIN || !EOS_UNLOAD_SDK_ON_SHUTDOWN) #define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN #endif

ricardoamores-epic · 2026-06-12T09:56:27Z

+                UnityEngine.Object.DontDestroyOnLoad(s_EOSObject);
+                var eosManager = s_EOSObject.AddComponent<EOSManager>();
+                EOSManager.Instance.Init(eosManager);
+                s_EOSSessionActive = true;


Seem like s_EOSSessionActive is never set to false during the test suite and also s_EOSObject is never null after being initialised. They are also private, so no class can change them.
What do we need the s_EOSSessionActive variable for?

matt-clarke · 2026-06-12T10:04:10Z

-            EOSManager.Instance?.OnShutdown();
-            UnityEngine.Object.Destroy(eosObject);
-        }
+        public void ShutdownEOS() { }


Should we still be calling EOSManager.Instance?.OnShutdown() once all tests finish?

matt-clarke · 2026-06-12T10:08:31Z

+                s_EOSObject = new GameObject("EOSManager");
+                UnityEngine.Object.DontDestroyOnLoad(s_EOSObject);
+                var eosManager = s_EOSObject.AddComponent<EOSManager>();
+                EOSManager.Instance.Init(eosManager);


This calls EOSManager.Instance.Init and a comment in the restricted PR says not to because it's already called automatically. Awake does call Init, so it seems that the restricted version is correct

OswaldoApexSystems and others added 21 commits April 21, 2026 12:27

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

a8b762d

…ssionsManagerTests.cs

Update EOSManager.cs

ef7bdbd

The shutdown/unload logic is now Editor‑only, runtime behavior is protected, the hardcoded define was removed, and Windows Editor behavior is aligned with macOS/Linux and Epic documentation.

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

e599483

…ssionsManagerTests.cs

Update EOSManager.cs

40a298f

Update EOSManager.cs

d76ef5f

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

40cf5b9

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

7e8d129

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

580cec9

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

024764b

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

c139b1e

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

393b8bc

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

9d59e06

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

2cb7cb2

…ssionsManagerTests.cs

Merge branch 'release-6.1.0' into Fix/EOSU-1013-Update-Services/EOSSe…

d02fd3c

…ssionsManagerTests.cs

Fix play mode test

e31f1db

Fix Play mode unit test

cc462ca

Fix prefabs and performance stress test for missing scripts. Fix asmdef for correct platforms

Merge branch 'Fix/EOSU-1013-Update-Services/EOSSessionsManagerTests.c…

e19ed96

…s' into unitTest-eosu1037-and-eosu1013

JessTello requested a review from a team June 11, 2026 21:40

matt-clarke requested changes Jun 12, 2026

View reviewed changes

ricardoamores-epic reviewed Jun 12, 2026

View reviewed changes

matt-clarke reviewed Jun 12, 2026

View reviewed changes


		// This define controls if the EOS SDK should be unloaded in the editor at shutdown to work around DLL unload errors.
		//#define EOS_DO_NOT_UNLOAD_SDK_ON_SHUTDOWN

Conversation

JessTello commented Jun 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants