feat: Add a test to validate registration of metric types (#1072)

Author: bendoyon

com.unity.netcode.gameobjects/Runtime/Metrics/NetworkMetrics.cs

@@ -4,7 +4,6 @@
 using Unity.Multiplayer.NetStats.Dispatch;
 using Unity.Multiplayer.NetStats.Metrics;
 using Unity.Multiplayer.NetStatsReporting;
-using UnityEngine.Profiling;
 
 namespace Unity.Netcode
 {

com.unity.netcode.gameobjects/Tests/Editor/Metrics.meta

@@ -0,0 +1,43 @@
+#if MULTIPLAYER_TOOLS
+
+using System;
+using System.Linq;
+using System.Reflection;
+using NUnit.Framework;
+using Unity.Multiplayer.MetricTypes;
+using Unity.Multiplayer.NetStats.Dispatch;
+using Unity.Multiplayer.NetStats.Metrics;
+
+namespace Unity.Netcode.EditorTests.Metrics
+{
+    public class NetworkMetricsRegistrationTests
+    {
+        static Type[] s_MetricTypes = AppDomain.CurrentDomain.GetAssemblies()
+            .SelectMany(x => x.GetTypes())
+            .Where(x => x.GetInterfaces().Contains(typeof(INetworkMetricEvent)))
+            .ToArray();
+        
+        [TestCaseSource(nameof(s_MetricTypes))]
+        public void ValidateThatAllMetricTypesAreRegistered(Type metricType)
+        {
+            var dispatcher = new NetworkMetrics().Dispatcher as MetricDispatcher;
+            Assert.NotNull(dispatcher);
+
+            var collection = typeof(MetricDispatcher)
+                .GetField("m_Collection", BindingFlags.NonPublic | BindingFlags.Instance)?
+                .GetValue(dispatcher) as MetricCollection;
+            Assert.NotNull(collection);
+
+            Assert.That(
+                collection.Metrics,
+                Has.Exactly(2).Matches<IEventMetric>(
+                    eventMetric =>
+                    {
+                        var eventType = eventMetric.GetType().GetGenericArguments()?.FirstOrDefault();
+                        return eventType == metricType;
+                    }));
+        }
+    }
+}
+
+#endif

com.unity.netcode.gameobjects/Tests/Editor/Metrics/NetworkMetricsRegistrationTests.cs

@@ -3,12 +3,21 @@
     "rootNamespace": "Unity.Netcode.EditorTests",
     "references": [
         "Unity.Netcode.Runtime",
-        "Unity.Netcode.Editor"
+        "Unity.Netcode.Editor",
+        "Unity.Multiplayer.MetricTypes",
+        "Unity.Multiplayer.NetStats"
     ],
     "optionalUnityReferences": [
         "TestAssemblies"
     ],
     "includePlatforms": [
         "Editor"
+    ],
+	"versionDefines": [
+        {
+            "name": "com.unity.multiplayer.tools",
+            "expression": "",
+            "define": "MULTIPLAYER_TOOLS"
+        }
     ]
 }

com.unity.netcode.gameobjects/Tests/Editor/Metrics/NetworkMetricsRegistrationTests.cs.meta

@@ -3,7 +3,7 @@
   "dependencies": {
     "com.unity.ide.rider": "3.0.7",
     "com.unity.netcode.gameobjects": "file:../../com.unity.netcode.gameobjects",
-    "com.unity.multiplayer.tools": "0.0.1-preview.2",
+    "com.unity.multiplayer.tools": "0.0.1-preview.3",
     "com.unity.multiplayer.transport.utp": "file:../../com.unity.multiplayer.transport.utp",
     "com.unity.test-framework": "1.1.26",
     "com.unity.modules.ai": "1.0.0",