Add SensorShapeValidator unit

com.unity.ml-agents/Runtime/Sensor/SensorShapeValidator.cs

@@ -27,12 +27,12 @@ public void ValidateSensors(List<ISensor> sensors)
                 // Check for compatibility with the other Agents' Sensors
                 // TODO make sure this only checks once per agent
                 Debug.Assert(m_SensorShapes.Count == sensors.Count, $"Number of Sensors must match. {m_SensorShapes.Count} != {sensors.Count}");
-                for (var i = 0; i < m_SensorShapes.Count; i++)
+                for (var i = 0; i < Mathf.Min(m_SensorShapes.Count, sensors.Count); i++)
                 {
                     var cachedShape = m_SensorShapes[i];
                     var sensorShape = sensors[i].GetObservationShape();
                     Debug.Assert(cachedShape.Length == sensorShape.Length, "Sensor dimensions must match.");
-                    for (var j = 0; j < cachedShape.Length; j++)
+                    for (var j = 0; j < Mathf.Min(cachedShape.Length, sensorShape.Length); j++)
                     {
                         Debug.Assert(cachedShape[j] == sensorShape[j], "Sensor sizes much match.");
                     }

com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs

@@ -0,0 +1,145 @@
+using System.Collections.Generic;
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace MLAgents.Tests
+{
+    public class DummySensor : ISensor
+    {
+        string m_Name = "DummySensor";
+        int[] m_Shape;
+
+        public DummySensor(int dim1)
+        {
+            m_Shape = new[] { dim1 };
+        }
+
+        public DummySensor(int dim1, int dim2)
+        {
+            m_Shape = new[] { dim1, dim2, };
+        }
+
+        public DummySensor(int dim1, int dim2, int dim3)
+        {
+            m_Shape = new[] { dim1, dim2, dim3};
+        }
+
+        public string GetName()
+        {
+            return m_Name;
+        }
+
+        public int[] GetObservationShape()
+        {
+            return m_Shape;
+        }
+
+        public byte[] GetCompressedObservation()
+        {
+            return null;
+        }
+
+        public int Write(WriteAdapter adapter)
+        {
+            return this.ObservationSize();
+        }
+
+        public void Update() { }
+
+        public SensorCompressionType GetCompressionType()
+        {
+            return SensorCompressionType.None;
+        }
+    }
+
+    public class SensorShapeValidatorTests
+    {
+
+        [Test]
+        public void TestShapesAgree()
+        {
+            var validator = new SensorShapeValidator();
+            var sensorList1 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList1);
+
+            var sensorList2 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList2);
+        }
+
+        [Test]
+        public void TestNumSensorMismatch()
+        {
+            var validator = new SensorShapeValidator();
+            var sensorList1 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList1);
+
+            var sensorList2 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), };
+            LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 3 != 2");
+            validator.ValidateSensors(sensorList2);
+
+            // Add the sensors in the other order
+            validator = new SensorShapeValidator();
+            validator.ValidateSensors(sensorList2);
+            LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 2 != 3");
+            validator.ValidateSensors(sensorList1);
+        }
+        [Test]
+        public void TestDimensionMismatch()
+        {
+            var validator = new SensorShapeValidator();
+            var sensorList1 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList1);
+
+            var sensorList2 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5) };
+            LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
+            validator.ValidateSensors(sensorList2);
+
+            // Add the sensors in the other order
+            validator = new SensorShapeValidator();
+            validator.ValidateSensors(sensorList2);
+            LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
+            validator.ValidateSensors(sensorList1);
+        }
+
+        [Test]
+        public void TestSizeMismatch()
+        {
+            var validator = new SensorShapeValidator();
+            var sensorList1 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList1);
+
+            var sensorList2 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 7) };
+            LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
+            validator.ValidateSensors(sensorList2);
+
+            // Add the sensors in the other order
+            validator = new SensorShapeValidator();
+            validator.ValidateSensors(sensorList2);
+            LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
+            validator.ValidateSensors(sensorList1);
+        }
+
+        [Test]
+        public void TestEverythingMismatch()
+        {
+            var validator = new SensorShapeValidator();
+            var sensorList1 = new List<ISensor>() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 6) };
+            validator.ValidateSensors(sensorList1);
+
+            var sensorList2 = new List<ISensor>() { new DummySensor(1), new DummySensor(9) };
+            LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 3 != 2");
+            LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
+            LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
+            validator.ValidateSensors(sensorList2);
+
+            // Add the sensors in the other order
+            validator = new SensorShapeValidator();
+            validator.ValidateSensors(sensorList2);
+            LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 2 != 3");
+            LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
+            LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
+            validator.ValidateSensors(sensorList1);
+        }
+    }
+}