[REG-2230, REG-2231] Implement Validations Within Segments

src/gg.regression.unity.bots/Editor/Scripts/Validation/RGValidationPane.cs

@@ -0,0 +1,97 @@
+using RegressionGames.Validation;
+using StateRecorder.BotSegments.Models.SegmentValidations;
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace RegressionGames.Editor.Validation
+{
+    public class RGValidationPane : EditorWindow
+    {
+        private ScrollView _mainScrollPane;
+
+        [MenuItem("Regression Games/Validation Results")]
+        public static void ShowMyEditor()
+        {
+            // This method is called when the user selects the menu item in the Editor
+            EditorWindow wnd = GetWindow<RGValidationPane>();
+            wnd.titleContent = new GUIContent("RG Validation Results");
+            wnd.Focus();
+        }
+
+        void CreateGUI()
+        {
+
+            _mainScrollPane = new ScrollView(ScrollViewMode.VerticalAndHorizontal);
+            rootVisualElement.Add(_mainScrollPane);
+
+            UpdateGUI();
+
+        }
+
+        void UpdateGUI()
+        {
+
+            _mainScrollPane.Clear();
+            UnsubscribeFromValidationEvents();
+
+            var validationScripts = FindObjectsOfType<RGValidateBehaviour>();
+
+            foreach (var validationScript in validationScripts)
+            {
+                var scriptContainer = new VisualElement();
+                scriptContainer.Add(new Label("Suite: " + validationScript.GetType().Name));
+                _mainScrollPane.Add(scriptContainer);
+
+                validationScript.OnValidationsUpdated += UpdateGUI;
+
+                foreach (var validator in validationScript.Validators)
+                {
+                    var validatorContainer = new VisualElement();
+                    validatorContainer.style.paddingLeft = 20;
+
+                    scriptContainer.Add(validatorContainer);
+
+                    var testText = "";
+                    Color? color = null;
+
+                    switch (validator.Status)
+                    {
+                        case SegmentValidationStatus.UNKNOWN:
+                            testText += "? ";
+                            break;
+                        case SegmentValidationStatus.PASSED:
+                            // If pass, show a green checkmark
+                            testText += "PASS ";
+                            color = Color.green;
+                            break;
+                        case SegmentValidationStatus.FAILED:
+                            testText += "FAIL ";
+                            color = Color.red;
+                            break;
+                    }
+
+                    testText += validator.Method.Name;
+                    var testLabel = new Label(testText);
+                    if (color != null)
+                    {
+                        testLabel.style.color = color.Value;
+                    }
+
+                    validatorContainer.Add(testLabel);
+                }
+            }
+
+        }
+
+        private void UnsubscribeFromValidationEvents()
+        {
+            var validationScripts = FindObjectsOfType<RGValidateBehaviour>();
+            foreach (var validationScript in validationScripts)
+            {
+                validationScript.OnValidationsUpdated -= UpdateGUI;
+            }
+        }
+
+    }
+}

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/AndKeyFrameCriteriaEvaluator.cs

@@ -6,13 +6,13 @@ namespace RegressionGames.StateRecorder.BotSegments
 {
     public static class AndKeyFrameCriteriaEvaluator
     {
-        public static bool Matched(bool firstSegment, int segmentNumber, bool botActionCompleted, KeyFrameCriteria criteria)
+        public static bool Matched(bool firstSegment, int segmentNumber, bool botActionCompleted, bool validationsCompleted, KeyFrameCriteria criteria)
         {
             if (criteria.data is AndKeyFrameCriteriaData { criteriaList: not null } andCriteria)
             {
                 try
                 {
-                    return KeyFrameEvaluator.Evaluator.MatchedHelper(firstSegment, segmentNumber, botActionCompleted, BooleanCriteria.And, andCriteria.criteriaList);
+                    return KeyFrameEvaluator.Evaluator.MatchedHelper(firstSegment, segmentNumber, botActionCompleted, validationsCompleted, BooleanCriteria.And, andCriteria.criteriaList);
                 }
                 catch (Exception)
                 {

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/BotSegmentsPlaybackController.cs

@@ -42,7 +42,7 @@ public class BotSegmentsPlaybackController : MonoBehaviour
 
         private Action<int> _loopCountCallback;
 
-        private string _lastSegmentPlaybackWarning = null;
+        private string _lastSegmentPlaybackWarning = null;  
 
         // We track this as a list instead of a single entry to allow the UI and game object conditions to evaluate separately
         // We still only unlock the input sequences for a key frame once both UI and game object conditions are met
@@ -201,6 +201,7 @@ public void Pause()
                     foreach (var nextBotSegment in _nextBotSegments)
                     {
                         nextBotSegment.PauseAction();
+                        nextBotSegment.PauseValidations();
                     }
                 }
             }
@@ -225,6 +226,7 @@ public void Play()
                     foreach (var nextBotSegment in _nextBotSegments)
                     {
                         nextBotSegment.UnPauseAction();
+                        nextBotSegment.UnPauseValidations();
                     }
                 }
             }
@@ -253,6 +255,7 @@ public void UnloadSegmentsAndReset()
                 {
                     // stop any action
                     nextBotSegment.AbortAction();
+                    nextBotSegment.StopValidations();
                 }
             }
 
@@ -455,6 +458,7 @@ private void EvaluateBotSegments()
                         BotSegment firstActionSegment = _nextBotSegments[0];
                         try
                         {
+                            firstActionSegment.ProcessValidation();
                             var didAction = firstActionSegment.ProcessAction(transformStatuses, entityStatuses, out var error);
                             // only log this if we're really stuck on it
                             if (error == null && didAction)
@@ -486,6 +490,7 @@ private void EvaluateBotSegments()
                         nextBotSegmentIndex == 0,
                         nextBotSegment.Replay_SegmentNumber,
                         nextBotSegment.Replay_ActionCompleted,
+                        nextBotSegment.Replay_ValidationsCompleted,
                         nextBotSegment.endCriteria
                     );
 

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/JsonConverters/BotSegmentJsonConverter.cs

@@ -4,6 +4,7 @@
 using Newtonsoft.Json.Linq;
 using RegressionGames.StateRecorder.BotSegments.Models;
 using RegressionGames.StateRecorder.BotSegments.Models.BotCriteria;
+using StateRecorder.BotSegments.Models;
 
 namespace RegressionGames.StateRecorder.BotSegments.JsonConverters
 {
@@ -48,6 +49,18 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                 botSegment.endCriteria = new List<KeyFrameCriteria>();
             }
 
+            if (jObject.ContainsKey("validations"))
+            {
+                botSegment.validations =
+                    new List<SegmentValidation>(jObject.GetValue("validations")
+                        .ToObject<SegmentValidation[]>(serializer));
+            }
+            else
+            {
+                // default value of validation is an empty list if not present
+                botSegment.validations = new List<SegmentValidation>();
+            }
+
             return botSegment;
         }
 

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/JsonConverters/KeyFrameCriteriaJsonConverter.cs

@@ -43,6 +43,9 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                 case KeyFrameCriteriaType.ActionComplete:
                     data = jObject["data"].ToObject<ActionCompleteKeyFrameCriteriaData>(serializer);
                     break;
+                case KeyFrameCriteriaType.ValidationsComplete:
+                    data = jObject["data"].ToObject<ValidationsCompleteKeyFrameCriteriaData>(serializer);
+                    break;
                 case KeyFrameCriteriaType.CVObjectDetection:
                     data = jObject["data"].ToObject<CVObjectDetectionKeyFrameCriteriaData>(serializer);
                     break;

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/JsonConverters/ScriptSegmentValidationDataJsonConverter.cs

@@ -0,0 +1,35 @@
+using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using StateRecorder.BotSegments.Models.SegmentValidations;
+
+namespace RegressionGames.StateRecorder.BotSegments.JsonConverters
+{
+    public class ScriptSegmentValidationDataJsonConverter: JsonConverter
+    {
+        public override bool CanConvert(Type objectType)
+        {
+            return typeof(ScriptSegmentValidationData).IsAssignableFrom(objectType);
+        }
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            JObject jObject = JObject.Load(reader);
+            // ReSharper disable once UseObjectOrCollectionInitializer - easier to debug lines without this
+            ScriptSegmentValidationData data = new();
+            data.classFullName = jObject.GetValue("classFullName").ToObject<string>(serializer);
+            if (jObject.ContainsKey("apiVersion"))
+            {
+                data.apiVersion = jObject.GetValue("apiVersion").ToObject<int>(serializer);
+            }
+            return data;
+        }
+
+        public override bool CanWrite => false;
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/JsonConverters/SegmentValidationJsonConverter.cs

@@ -0,0 +1,48 @@
+using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using RegressionGames.StateRecorder.BotSegments.Models;
+using RegressionGames.StateRecorder.BotSegments.Models.BotCriteria;
+using StateRecorder.BotSegments.Models;
+using StateRecorder.BotSegments.Models.SegmentValidations;
+
+namespace RegressionGames.StateRecorder.BotSegments.JsonConverters
+{
+    public class SegmentValidationJsonConverter: JsonConverter
+    {
+        public override bool CanConvert(Type objectType)
+        {
+            return typeof(SegmentValidation).IsAssignableFrom(objectType);
+        }
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            JObject jObject = JObject.Load(reader);
+            SegmentValidation validation = new();
+            validation.type = jObject["type"].ToObject<SegmentValidationType>(serializer);
+            if (jObject.ContainsKey("apiVersion"))
+            {
+                validation.apiVersion = jObject["apiVersion"].ToObject<int>(serializer);
+            }
+            IRGSegmentValidationData data = null;
+            switch (validation.type)
+            {
+                case SegmentValidationType.Script:
+                    data = jObject["data"].ToObject<ScriptSegmentValidationData>(serializer);
+                    break;
+                default:
+                    throw new JsonSerializationException($"Unsupported SegmentValidation type: '{validation.type}'");
+            }
+
+            validation.data = data;
+            return validation;
+        }
+
+        public override bool CanWrite => false;
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/gg.regression.unity.bots/Runtime/Scripts/StateRecorder/BotSegments/KeyFrameEvaluator.cs

@@ -81,10 +81,10 @@ public void PersistPriorFrameStatus()
         /**
          * <summary>Publicly callable.. caches the statuses of the last passed key frame for computing delta counts from</summary>
          */
-        public bool Matched(bool firstSegment, int segmentNumber, bool botActionCompleted, List<KeyFrameCriteria> criteriaList)
+        public bool Matched(bool firstSegment, int segmentNumber, bool botActionCompleted, bool validationsCompleted, List<KeyFrameCriteria> criteriaList)
         {
             _newUnmatchedCriteria.Clear();
-            bool matched = MatchedHelper(firstSegment, segmentNumber, botActionCompleted, BooleanCriteria.And, criteriaList);
+            bool matched = MatchedHelper(firstSegment, segmentNumber, botActionCompleted, validationsCompleted, BooleanCriteria.And, criteriaList);
             if (matched)
             {
                 CVTextCriteriaEvaluator.Cleanup(segmentNumber);
@@ -106,7 +106,7 @@ public bool Matched(bool firstSegment, int segmentNumber, bool botActionComplete
         /**
          * <summary>Only to be called internally by KeyFrameEvaluator. firstSegment represents if this is the first segment in the current pass's list of segments to evaluate</summary>
          */
-        internal bool MatchedHelper(bool firstSegment, int segmentNumber, bool botActionCompleted, BooleanCriteria andOr, List<KeyFrameCriteria> criteriaList)
+        internal bool MatchedHelper(bool firstSegment, int segmentNumber, bool botActionCompleted, bool validationsCompleted, BooleanCriteria andOr, List<KeyFrameCriteria> criteriaList)
         {
             var objectFinders = Object.FindObjectsByType<ObjectFinder>(FindObjectsSortMode.None);
             var currentFrameCount = Time.frameCount;
@@ -194,6 +194,13 @@ internal bool MatchedHelper(bool firstSegment, int segmentNumber, bool botAction
                             return false;
                         }
                         break;
+                    case KeyFrameCriteriaType.ValidationsComplete:
+                        if (!validationsCompleted)
+                        {
+                            _newUnmatchedCriteria.Add("Waiting for validations to complete...");
+                            return false;
+                        }
+                        break;
                 }
             }
 
@@ -368,7 +375,7 @@ internal bool MatchedHelper(bool firstSegment, int segmentNumber, bool botAction
                 for (var j = 0; j < orCount; j++)
                 {
                     var orEntry = orsToMatch[j];
-                    var m = OrKeyFrameCriteriaEvaluator.Matched(firstSegment, segmentNumber, botActionCompleted, orEntry);
+                    var m = OrKeyFrameCriteriaEvaluator.Matched(firstSegment, segmentNumber, botActionCompleted, validationsCompleted, orEntry);
                     if (m)
                     {
                         if (andOr == BooleanCriteria.Or)
@@ -394,7 +401,7 @@ internal bool MatchedHelper(bool firstSegment, int segmentNumber, bool botAction
                 for (var j = 0; j < andCount; j++)
                 {
                     var andEntry = andsToMatch[j];
-                    var m = AndKeyFrameCriteriaEvaluator.Matched(firstSegment, segmentNumber, botActionCompleted, andEntry);
+                    var m = AndKeyFrameCriteriaEvaluator.Matched(firstSegment, segmentNumber, botActionCompleted, validationsCompleted, andEntry);
                     if (m)
                     {
                         if (andOr == BooleanCriteria.Or)