feat: added listener interface and manager with broadcasting on test starts and finishes

Author: isc-cge

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - #39: Fixed bug where results viewer gave divide by zero error when there were 0 executed methods in the covered code 
 
+### Added
+- #42: Added a listener interface and manager with an associated user parameter, allowing the user to broadcast output on test method/case/suite completion. 
+
 ## [3.1.0] - 2024-07-05
 
 ### Added

cls/TestCoverage/Listeners/ListenerInterface.cls

@@ -0,0 +1,8 @@
+Class TestCoverage.Listeners.ListenerInterface Extends %RegisteredObject
+{
+
+Method Broadcast(pMessage As %String) As %Status [ Abstract ]
+{
+}
+
+}

cls/TestCoverage/Listeners/ListenerManager.cls

@@ -0,0 +1,48 @@
+Class TestCoverage.Listeners.ListenerManager Extends %RegisteredObject
+{
+
+Property listeners As list Of TestCoverage.Listeners.ListenerInterface;
+
+Method BroadCastToAll(pMessage As %String) As %Status
+{
+    set tSC = $$$OK 
+    try {
+        for i = 1:1:..listeners.Count() {
+            set tListener = ..listeners.GetAt(i)
+            $$$ThrowOnError(tListener.Broadcast(pMessage))
+        }
+    }
+    catch e {
+        Set tSC = e.AsStatus()
+    }
+    quit tSC
+}
+
+Method AddListener(pListener As TestCoverage.Listeners.ListenerInterface) As %Status
+{
+    set tSC = $$$OK 
+    try {
+        do ..listeners.Insert(pListener)
+    } catch e {
+        set tSC = e.AsStatus()
+    }
+    quit tSC
+}
+
+Method RemoveListener(pListener As TestCoverage.Listeners.ListenerInterface) As %Status
+{
+    set tSC = $$$OK 
+    try {
+        set tIndex = ..listeners.FindOref(pListener)
+        if (tIndex = "") {
+            Set tMsg = "Listener not found"
+	        $$$ThrowStatus($$$ERROR($$$GeneralError,tMsg))
+        }
+        do ..listeners.RemoveAt(tIndex)
+    } catch e {
+        set tSC = e.AsStatus()
+    }
+    quit tSC
+}
+
+}

cls/TestCoverage/Manager.cls

@@ -64,6 +64,9 @@ Property Hashes [ MultiDimensional ];
 
 Property Monitor As TestCoverage.Utils.LineByLineMonitor [ InitialExpression = {##class(TestCoverage.Utils.LineByLineMonitor).%New()}, Private ];
 
+/// keeps track of all the listeners that may need information broadcasted about the unit test progress
+Property ListenerManager As TestCoverage.Listeners.ListenerManager;
+
 /// Runs unit tests that have been loaded, with code coverage enabled. <br />
 /// Note that if coverage is to be tracked for lots of code, it may be necessary to increase the "gmheap" setting
 /// (under Configuration - Additional Settings - Advanced Memory in the Management Portal). <br />
@@ -563,6 +566,7 @@ ClassMethod OnBeforeAllTests(manager As TestCoverage.Manager, dir As %String, By
 		Set tCoverageRoutines = $Get(userparam("CoverageRoutines"))
 		Set tCoverageDetail = $Get(userparam("CoverageDetail"))
 		Set tSourceNamespace = $Get(userparam("SourceNamespace"),$Namespace)
+		Set tListenerManager = $Get(userparam("ListenerManager"))
 		Set tProcessIDs = $Get(userparam("ProcessIDs"),$ListBuild($Job))
 		If (tProcessIDs = "*") {
 			Set tProcessIDs = ""
@@ -584,6 +588,7 @@ ClassMethod OnBeforeAllTests(manager As TestCoverage.Manager, dir As %String, By
 		Set manager.ProcessIDs = tProcessIDs
 		Set manager.Timing = tTiming
 		Do manager.SetCoverageTargets(tCoverageClasses,tCoverageRoutines,1)
+		Set manager.ListenerManager = tListenerManager
 		If (tCoverageDetail '= "") {
 			If (tCoverageDetail '= +tCoverageDetail) {
 				// If we were passed a display value...
@@ -637,6 +642,9 @@ ClassMethod OnAfterAllTests(manager As TestCoverage.Manager, dir As %String, ByR
 	Try {
 		If (manager.CoverageDetail = 0) {
 			Set tSC = manager.EndCoverageTracking()
+			if (manager.ListenerManager) {
+				Do manager.ListenerManager.BroadCastToAll("All tests complete")
+			}
 		}
 		Do manager.Monitor.Stop()
 	} Catch e {
@@ -673,9 +681,13 @@ Method OnBeforeTestSuite(dir As %String, suite As %String, testspec As %String,
 		Set ..CurrentTestSuite = $Case(suite,"":"(root)",:suite)
 		Set ..CurrentTestClass = ""
 		Set ..CurrentTestMethod = ""
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Starting test suite: " _ suite )
+		}
 		If (..CoverageDetail = 1) {
 			Set tSC = ..StartCoverageTracking()
 		}
+		
 	} Catch e {
 		Set tSC = e.AsStatus()
 	}
@@ -688,9 +700,13 @@ Method OnAfterTestSuite(dir As %String, suite As %String, testspec As %String, B
 {
 	Set tSC = $$$OK
 	Try {
+		
 		If (..CoverageDetail = 1) {
 			Set tSC = ..EndCoverageTracking($Case(suite,"":"(root)",:suite))
 		}
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Finished test suite: " _ suite )
+		}
 	} Catch e {
 		Set tSC = e.AsStatus()
 	}
@@ -705,6 +721,9 @@ Method OnBeforeTestCase(suite As %String, class As %String) As %Status
 	Try {
 		Set ..CurrentTestClass = class
 		Set ..CurrentTestMethod = ""
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Starting test case: " _ suite _ "/" _ class )
+		}
 		If (..CoverageDetail = 2) {
 			Set tSC = ..StartCoverageTracking()
 		}
@@ -723,6 +742,9 @@ Method OnAfterTestCase(suite As %String, class As %String) As %Status
 		If (..CoverageDetail = 2) {
 			Set tSC = ..EndCoverageTracking(suite, class)
 		}
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Starting test case: " _ suite _ "/" _ class )
+		}
 	} Catch e {
 		Set tSC = e.AsStatus()
 	}
@@ -736,6 +758,9 @@ Method OnBeforeOneTest(suite As %String, class As %String, method As %String) As
 	Set tSC = $$$OK
 	Try {
 		Set ..CurrentTestMethod = method
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Starting test method: " _ suite _ "/" _ class _ "/" _ method )
+		}
 		If (..CoverageDetail = 3) {
 			Set tSC = ..StartCoverageTracking()
 		}
@@ -754,6 +779,9 @@ Method OnAfterOneTest(suite As %String, class As %String, method As %String) As
 		If (..CoverageDetail = 3) {
 			Set tSC = ..EndCoverageTracking(suite, class, method)
 		}
+		if (..ListenerManager) {
+			Do ..ListenerManager.BroadCastToAll("Finished test method: " _ suite _ "/" _ class _ "/" _ method )
+		}
 	} Catch e {
 		Set tSC = e.AsStatus()
 	}