feat: added a property LineIsPython that stores if each line of code is a python line or not

Author: isc-cge

cls/TestCoverage/Data/CodeUnit.cls

@@ -38,9 +38,13 @@ Property MethodEndMap As array Of %Integer;
 /// For routines, map of labels to associated line numbers
 Property LineToMethodMap As array Of %Dictionary.CacheIdentifier [ Private ];
 
+/// For each line, whether or not it belongs to a python method, only populated for .cls CodeUnits
+Property LineIsPython As array Of %Boolean;
+
 /// Set to true if this class/routine is generated
 Property Generated As %Boolean [ InitialExpression = 0 ];
 
+/// 
 /// Methods, branches, etc. within this unit of code.
 Relationship SubUnits As TestCoverage.Data.CodeSubUnit [ Cardinality = children, Inverse = Parent ];
 
@@ -129,6 +133,7 @@ ClassMethod GetCurrentByName(pInternalName As %String, pSourceNamespace As %Stri
 
 		If (tType = "CLS") {
 			Set pCodeUnit.Generated = ($$$comClassKeyGet(tName,$$$cCLASSgeneratedby) '= "")
+
 		}
 
 
@@ -170,6 +175,9 @@ ClassMethod GetCurrentByName(pInternalName As %String, pSourceNamespace As %Stri
 				Do pCodeUnit.Lines.Insert(tLine)
 
 				If (tType = "CLS") {
+					// initialize each line to not python (we'll update this later)
+					Do pCodeUnit.LineIsPython.SetAt(0, tLineNumber)
+
 					// Extract line offset of methods in classes
 					Set tStart = $Piece(tLine," ")
 					If (tStart = "ClassMethod") || (tStart = "Method") {
@@ -236,6 +244,54 @@ ClassMethod GetCurrentByName(pInternalName As %String, pSourceNamespace As %Stri
 	Quit tSC
 }
 
+/// Fill in the LineIsPython property of .cls files 
+Method UpdatePythonLines(pName As %String, ByRef pPyCodeUnit) As %Status
+{
+	
+	Set tSC = $$$OK
+	Set tOriginalNamespace = $Namespace
+	Set tInitTLevel = $TLevel
+	
+	Try {
+		TSTART
+		
+		If (##class(TestCoverage.Manager).HasPython(pName)) {
+
+			Set tFromHash = pPyCodeUnit.Hash
+			Set tToHash = ..Hash 
+			set sql = "SELECT map.ToLine FROM TestCoverage_Data.CodeUnitMap map " _ 
+			"JOIN TestCoverage_Data.CodeUnit fromCodeUnit " _ 
+			"ON fromCodeUnit.Hash = map.FromHash " _ 
+			"WHERE map.FromHash =  ? " _ 
+			"AND map.ToHash = ? " 	
+			set resultSet = ##class(%SQL.Statement).%ExecDirect(, sql, tFromHash, tToHash)
+			If (resultSet.%SQLCODE < 0) {
+				Throw ##class(%Exception.SQL).CreateFromSQLCODE(resultSet.%SQLCODE, resultSet.%Message)
+			}
+			while resultSet.%Next(.tSC) {
+				$$$ThrowOnError(tSC)
+				Set hToLine = resultSet.%GetData(1)
+				set ^IRIS.TempCG($i(^IRIS.TempCG)) = hToLine
+				do ..LineIsPython.SetAt(1, hToLine)
+			}
+			If (resultSet.%SQLCODE < 0) {
+				Throw ##class(%Exception.SQL).CreateFromSQLCODE(resultSet.%SQLCODE, resultSet.%Message)
+			}
+		}
+		Set tSC = ..%Save()
+		$$$ThrowOnError(tSC)
+		
+		TCOMMIT
+	} Catch e {
+		Set pCodeUnit = $$$NULLOREF
+		Set tSC = e.AsStatus()
+	}
+	While ($TLevel > tInitTLevel) {
+		TROLLBACK 1
+	}
+	Quit tSC
+}
+
 /// Get the executable lines of code in python over to the .cls CodeUnit
 Method UpdatePyExecutableLines(pName As %String, ByRef pPyCodeUnit) As %Status
 {
@@ -636,6 +692,11 @@ Storage Default
 <Value>Generated</Value>
 </Value>
 </Data>
+<Data name="LineIsPython">
+<Attribute>LineIsPython</Attribute>
+<Structure>subnode</Structure>
+<Subscript>"LineIsPython"</Subscript>
+</Data>
 <Data name="LineToMethodMap">
 <Attribute>LineToMethodMap</Attribute>
 <Structure>subnode</Structure>

cls/TestCoverage/Utils.cls

@@ -120,6 +120,9 @@ ClassMethod Snapshot(pIntRoutines As %List, pPyRoutines As %List, Output pReleva
 					// update the executable lines for the .cls file's python
 					$$$ThrowOnError(tCodeUnit.UpdatePyExecutableLines(tName, .tPyCodeUnit))
 
+					// update the pythonicity of the lines for the .cls file
+					$$$ThrowOnError(tCodeUnit.UpdatePythonLines(tName, .tPyCodeUnit))
+
 					// update the relevant python routines
 					If ($BitCount(tPyCodeUnit.ExecutableLines, 1)) {
 						set pPyRelevantRoutines = pPyRelevantRoutines _ $ListBuild(tName)
@@ -144,6 +147,7 @@ ClassMethod Snapshot(pIntRoutines As %List, pPyRoutines As %List, Output pReleva
 				$$$ThrowOnError(##class(TestCoverage.Data.CodeUnit).GetCurrentByName(tPyRoutine_".CLS",,.tCodeUnit))
 				$$$ThrowOnError(##class(TestCoverage.Data.CodeUnit).GetCurrentByName(tPyRoutine_".PY",,.tPyCodeUnit))
 				$$$ThrowOnError(tCodeUnit.UpdatePyExecutableLines(tPyRoutine, .tPyCodeUnit))
+				$$$ThrowOnError(tCodeUnit.UpdatePythonLines(tPyRoutine, .tPyCodeUnit))
 
 				If ($BitCount(tPyCodeUnit.ExecutableLines, 1)) {
 					set pPyRelevantRoutines = pPyRelevantRoutines _ $ListBuild(tPyRoutine)

internal/testing/unit_tests/UnitTest/TestCoverage/Unit/CodeUnit.cls

@@ -42,6 +42,9 @@ Method TestCodeUnitCreation()
 		Set tSC = tClsCodeUnit.UpdatePyExecutableLines($classname(),.tPyCodeUnit)
 		Do $$$AssertStatusOK(tSC,"Found updated executable line data for "_tClsName)
 
+		Set tSC = tClsCodeUnit.UpdatePythonLines($classname(),.tPyCodeUnit)
+		Do $$$AssertStatusOK(tSC,"Found updated pythonicity line data for "_tClsName)
+
 		Set tConstantReturnValueLine = tClsCodeUnit.MethodMap.GetAt("SampleConstantReturnValue")
 		Set tCodeGeneratorLine = tClsCodeUnit.MethodMap.GetAt("SampleCodeGenerator")
 		Set tNormalMethodLine = tClsCodeUnit.MethodMap.GetAt("SampleNormalMethod")
@@ -51,6 +54,10 @@ Method TestCodeUnitCreation()
 		Do $$$AssertNotEquals(tCodeGeneratorLine,"")
 		Do $$$AssertNotEquals(tNormalMethodLine,"")
 		Do $$$AssertNotEquals(tPythonMethodLine,"")
+
+		// test if LineIsPython is working properly
+		Do $$$AssertEquals(tClsCodeUnit.LineIsPython.GetAt(tPythonMethodLine+2), 1)
+		Do $$$AssertEquals(tClsCodeUnit.LineIsPython.GetAt(tNormalMethodLine+2), 0)
 
 		// tTestLines(line number) = $ListBuild(description, executable (default 1), mapped (default 1), mapped from hash (if relevant), mapped from line (if relevant))
 		Set tTestLines(tConstantReturnValueLine+2) = $ListBuild("SampleConstantReturnValue+1",0,0)