Targets #420 - Error reporting - WIP

BHoM · Mar 8, 2023 · c7b7e6e · c7b7e6e
1 parent b6a10ee
commit c7b7e6e
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/.ci/unit-tests/NUnit_Engine_UnloadableAssembliesTests/NUnitTestSampleClass.cs b/.ci/unit-tests/NUnit_Engine_UnloadableAssembliesTests/NUnitTestSampleClass.cs
@@ -41,5 +41,27 @@ public void LoadAssembliesShouldThrowException()
 
             Should.Throw(() => testClass.LoadReferencedAssemblies(), typeof(FileLoadException));
         }
+
+        [Test]
+        public void ErrorReportingPassingTest()
+        {
+            BH.Engine.Base.Compute.RecordError($"Some error logged via BH.Engine.Base.Compute.{nameof(Compute.RecordError)}");
+            Assert.Pass(); // Make it pass intentionally here; the recorded error should still make the test report failure on TearDown
+        }
+
+        [Test]
+        public void WarningReportingPassingTest()
+        {
+            BH.Engine.Base.Compute.RecordWarning($"Some warning logged via BH.Engine.Base.Compute.{nameof(Compute.RecordWarning)}");
+            Assert.Pass();
+        }
+
+
+        [Test]
+        public void NoteReportingPassingTest()
+        {
+            BH.Engine.Base.Compute.RecordNote($"Some note logged via BH.Engine.Base.Compute.{nameof(Compute.RecordNote)}");
+            Assert.Pass();
+        }
     }
 }
diff --git a/NUnit_Engine/NUnitTest.cs b/NUnit_Engine/NUnitTest.cs
@@ -91,5 +91,25 @@ public void LoadReferencedAssemblies()
                     $"\nMake sure that Copy Local is set to true for them in the test project {Path.GetFileNameWithoutExtension(projectFullPath)}." +
                     $"\nAlternatively, this could be because some of their dependencies were not referenced in the project.");
         }
+
+        [TearDown]
+        public void LogRecordedEvents()
+        {
+            // This should check whether the test passed or not before dispatching to Warn/TextContext.
+
+            var events = BH.Engine.Base.Query.CurrentEvents();
+            if (events.Any())
+            {
+                foreach (var ev in events)
+                {
+                    if (ev.Type == oM.Base.Debugging.EventType.Warning || ev.Type == oM.Base.Debugging.EventType.Error)
+                        Assert.Warn($"{ev.Type}: {ev.Message}");
+                    else
+                        TestContext.Out.Write($"{ev.Type}: {ev.Message}");
+                }
+            }
+
+            BH.Engine.Base.Compute.ClearCurrentEvents();
+        }
     }
 }