feat: Add JSON, YAML, and Toon output options for zpm test results #979
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -189,18 +189,41 @@ Method OnPhase( | |
| zkill ^UnitTestRoot | ||
| $$$ThrowOnError(tSC) | ||
|
|
||
| if $data(pParams("UnitTest"))>1 { | ||
| set outputType="" | ||
| for { | ||
| set outputType = $order(pParams("UnitTest",outputType),1,fileName) | ||
| quit:outputType="" | ||
| set tPostfix = "-"_$$$lcase(pPhase)_"-" | ||
| if (..Package '= "") { | ||
| set tPostfix = tPostfix_$replace(..Package,".","-")_"-PKG" | ||
| } elseif (..Class '= "") { | ||
| set tPostfix = tPostfix_$replace(..Class,".","-")_"-CLS" | ||
| } | ||
| set outputClass = "%IPM.Test."_outputType | ||
| if '$$$defClassDefined(outputClass) { | ||
| $$$ThrowOnError($$$ERROR($$$GeneralError,"The requested "_outputType_" output format does not exist.")) | ||
| } | ||
| set extension = $select(outputType="JsonOutput":".json",outputType="ToonOutput":".toon",outputType="YamlOutput":".yaml",1:".xml") | ||
| set fileName = $piece(fileName,".",1,*-1)_tPostfix_extension | ||
| set tSC = $classmethod(outputClass,"ToFile",fileName) | ||
| $$$ThrowOnError(tSC) | ||
| } | ||
| } | ||
| write ! | ||
| if $data(pParams("outputformat"),outputFormat)||('tVerbose) { | ||
| write !,"Test result summary",! | ||
| // TODO: Move this default format to ^IPM.Config.Test("outputFormat") rather than keeping it hardcoded. | ||
|
||
| set:$get(outputFormat)="" outputFormat="Toon" | ||
| set outputClass = "%IPM.Test."_$zconvert(outputFormat,"w")_"Output" | ||
| if '$$$defClassDefined(outputClass) { | ||
| $$$ThrowOnError($$$ERROR($$$GeneralError,"The requested "_outputType_" output format does not exist.")) | ||
| } | ||
| set defaultTestStatus = "failed" | ||
| set tSC = $classmethod(outputClass,"OutputToDevice",,defaultTestStatus) | ||
| $$$ThrowOnError(tSC) | ||
| write ! | ||
| } | ||
| // By default, detect and report unit test failures as an error from this phase | ||
| if $get(pParams("UnitTest","FailuresAreFatal"),1) { | ||
| do ##class(%IPM.Test.Manager).OutputFailures() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /// The class serves as the base class for all the unit test result formatting. | ||
| Class %IPM.Test.Abstract Extends %RegisteredObject | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| pFileName As %String, | ||
| pCaseStatus As %String = "", | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status [ Abstract ] | ||
| { | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| pTestStatus As %String = "") [ Abstract ] | ||
| { | ||
| } | ||
|
|
||
| Query FilteredTestResults( | ||
| pInstance As %Integer, | ||
| pTestStatus) As %SQLQuery(ROWSPEC = "TotalCounts:%Integer,namespace:%String,duration:%String,testDateTime:%String,suiteName:%String,testcaseName:%String,methodName:%String,testMethod:%String,assertAction:%String,assertCounter:%Integer,assertDescription:%String,assertLocation:%String", SELECTMODE = "DISPLAY") | ||
| { | ||
| SELECT | ||
| count(*) as TotalCounts, | ||
| tinstance.Namespace AS namespace, | ||
| tinstance.Duration AS duration, | ||
| tinstance.DateTime AS testDateTime, | ||
| tsuite.Name AS suiteName, | ||
| tcase.Name AS testcaseName, | ||
| tmethod.Name AS methodName, | ||
| tassert.TestMethod AS testMethod, | ||
| tassert.Action AS assertAction, | ||
| tassert.Counter AS assertCounter, | ||
| tassert.Description AS assertDescription, | ||
| tassert.Location AS assertLocation | ||
| FROM | ||
| %UnitTest_Result.TestInstance tinstance | ||
| JOIN %UnitTest_Result.TestSuite tsuite ON tsuite.TestInstance=tinstance.ID | ||
| JOIN %UnitTest_Result.TestCase tcase ON tcase.TestSuite=tsuite.ID | ||
| JOIN %UnitTest_Result.TestMethod tmethod ON tmethod.TestCase=tcase.ID | ||
| JOIN %UnitTest_Result.TestAssert tassert ON tassert.TestMethod=tmethod.ID | ||
| WHERE tinstance.ID=:pInstance AND tassert.Status=:pTestStatus | ||
| } | ||
|
|
||
| Query GetAllTestResults(pInstance As %Integer) As %SQLQuery(ROWSPEC = "TotalCounts:%String,namespace:%String,duration:%String,testDateTime:%String,suiteName:%String,testcaseName:%String,methodName:%String,testMethod:%String,assertAction:%String,assertCounter:%Integer,assertDescription:%String,assertLocation:%String", SELECTMODE = "DISPLAY") | ||
| { | ||
| SELECT | ||
| count(*) as TotalCounts, | ||
| tinstance.Namespace AS namespace, | ||
| tinstance.Duration AS duration, | ||
| tinstance.DateTime AS testDateTime, | ||
| tsuite.Name AS suiteName, | ||
| tcase.Name AS testcaseName, | ||
| tmethod.Name AS methodName, | ||
| tassert.TestMethod AS testMethod, | ||
| tassert.Action AS assertAction, | ||
| tassert.Counter AS assertCounter, | ||
| tassert.Description AS assertDescription, | ||
| tassert.Location AS assertLocation | ||
| FROM | ||
| %UnitTest_Result.TestInstance tinstance | ||
| JOIN %UnitTest_Result.TestSuite tsuite ON tsuite.TestInstance=tinstance.ID | ||
| JOIN %UnitTest_Result.TestCase tcase ON tcase.TestSuite=tsuite.ID | ||
| JOIN %UnitTest_Result.TestMethod tmethod ON tmethod.TestCase=tcase.ID | ||
| JOIN %UnitTest_Result.TestAssert tassert ON tassert.TestMethod=tmethod.ID | ||
| WHERE tinstance.ID=:pInstance | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| Class %IPM.Test.JsonOutput Extends %IPM.Test.Abstract | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| pFileName As %String, | ||
| pTestStatus As %String = "", | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status | ||
| { | ||
| set tSC = $$$OK | ||
|
||
| try { | ||
| set fileStream = ##class(%Stream.FileCharacter).%New() | ||
| set fileStream.TranslateTable="UTF8" | ||
| do fileStream.LinkToFile(pFileName) | ||
| set responseJson = ..JSON(pTestIndex, pTestStatus) | ||
| do fileStream.Write(responseJson.%ToJSON()) | ||
|
||
| $$$ThrowOnError(fileStream.%Save()) | ||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| pCaseStatus As %String = "") As %Status | ||
|
Collaborator
There was a problem hiding this comment. Nit: remove p- prefix and change to camelCase |
||
| { | ||
| set tSC = $$$OK | ||
| try { | ||
| set responseJson= ..JSON(pTestIndex, pCaseStatus) | ||
| write ! | ||
| do responseJson.%ToJSON() | ||
|
||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| ClassMethod JSON( | ||
| pTestIndex, | ||
| pTestStatus) As %DynamicObject | ||
| { | ||
| if pTestStatus'=""{ | ||
| set tResult = ..FilteredTestResultsFunc(pTestIndex,pTestStatus) | ||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(pTestIndex) | ||
| } | ||
| set unitTest = {} | ||
| set unitTest.results = [] | ||
| set (previousID,currentSuite,currentTestcase,suiteObj,testcaseObj) = "" | ||
|
|
||
| while tResult.%Next() { | ||
| if previousID = "" { | ||
| set unitTest.id = pTestIndex | ||
| set unitTest.namespace = tResult.namespace | ||
| set unitTest.duration = tResult.duration | ||
| set unitTest.testDateTime = tResult.testDateTime | ||
| } | ||
| set previousID = pTestIndex | ||
| if tResult.suiteName '= currentSuite { | ||
| set currentSuite = tResult.suiteName | ||
| set suiteObj = { | ||
| "suiteName": (currentSuite), | ||
| "testcases": [] | ||
| } | ||
| do unitTest.results.%Push(suiteObj) | ||
| set currentTestcase = "" | ||
| } | ||
| if tResult.testcaseName '= currentTestcase { | ||
| set currentTestcase = tResult.testcaseName | ||
| set testcaseObj = { | ||
| "testcaseName": (currentTestcase), | ||
| "methods": [] | ||
| } | ||
| do suiteObj.testcases.%Push(testcaseObj) | ||
| } | ||
| set methodObj = { | ||
| "methodName": (tResult.methodName), | ||
| "testMethod": (tResult.testMethod), | ||
| "assertAction": (tResult.assertAction), | ||
| "assertCounter": (tResult.assertCounter), | ||
| "assertDescription": (tResult.assertDescription), | ||
| "assertLocation": (tResult.assertLocation) | ||
| } | ||
| do testcaseObj.methods.%Push(methodObj) | ||
| } | ||
| return unitTest | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| Class %IPM.Test.ToonOutput Extends %IPM.Test.Abstract | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| pFileName As %String, | ||
| pTestStatus As %String = "", | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status | ||
| { | ||
| set tSC = $$$OK | ||
| try { | ||
| set fileStream = ##class(%Stream.FileCharacter).%New() | ||
| set fileStream.TranslateTable="UTF8" | ||
| do fileStream.LinkToFile(pFileName) | ||
| if pTestStatus'=""{ | ||
| set tResult = ..FilteredTestResultsFunc(pTestIndex, pTestStatus) | ||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(pTestIndex) | ||
| } | ||
| set currentID="" | ||
| while tResult.%Next() { | ||
| if currentID = "" { | ||
| set currentID = pTestIndex | ||
| do fileStream.WriteLine("unitTest:") | ||
|
Collaborator
There was a problem hiding this comment. Lots of statuses that need checking here
Contributor
Author
There was a problem hiding this comment. Thank you. Updated the code!
Collaborator
There was a problem hiding this comment. Still need to check the %Status returned by the WriteLine() calls |
||
| do fileStream.WriteLine(" id: "_pTestIndex) | ||
| do fileStream.WriteLine(" namespace: "_tResult.namespace) | ||
| do fileStream.WriteLine(" duration: "_tResult.duration) | ||
| do fileStream.WriteLine(" testDateTime: "_tResult.testDateTime) | ||
| do fileStream.WriteLine() | ||
| do fileStream.WriteLine("results["_tResult.TotalCounts_"]{suiteName,testcaseName,methodName,status,assertAction,assertCounter,assertDescription,assertLocation}:") | ||
| } | ||
| set data = " "_tResult.suiteName_","_tResult.testcaseName_","_tResult.methodName_","_pTestIndex_","_ | ||
| tResult.assertAction_","_tResult.assertCounter_","""_$translate(tResult.assertDescription,"""")_""","""_tResult.assertLocation_"""" | ||
| do fileStream.WriteLine(data) | ||
| } | ||
| $$$ThrowOnError(fileStream.%Save()) | ||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| pTestStatus As %String = "") As %Status | ||
| { | ||
| set tSC = $$$OK | ||
| try { | ||
| if pTestStatus'=""{ | ||
| set tResult = ..FilteredTestResultsFunc(pTestIndex, pTestStatus) | ||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(pTestIndex) | ||
| } | ||
| set currentID="" | ||
| while tResult.%Next() { | ||
| if currentID = "" { | ||
| set currentID = pTestIndex | ||
| write !,"unitTest:" | ||
| write !," id: "_pTestIndex | ||
| write !," namespace: "_tResult.namespace | ||
| write !," duration: "_tResult.duration | ||
| write !," testDateTime: "_tResult.testDateTime | ||
| write ! | ||
| write !,"results["_tResult.TotalCounts_"]{suiteName,testcaseName,methodName,status,assertAction,assertCounter,assertDescription,assertLocation}:" | ||
| } | ||
| set data = " "_tResult.suiteName_","_tResult.testcaseName_","_tResult.methodName_","_pTestIndex_","_ | ||
| tResult.assertAction_","_tResult.assertCounter_","""_$translate(tResult.assertDescription,"""")_""","""_tResult.assertLocation_"""" | ||
| write !,data | ||
| } | ||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| Class %IPM.Test.YamlOutput Extends %IPM.Test.Abstract | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| pFileName As %String, | ||
| pTestStatus As %String = "", | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status | ||
| { | ||
| set tSC = $$$OK | ||
| try { | ||
| set fileStream = ##class(%Stream.FileCharacter).%New() | ||
| set fileStream.TranslateTable="UTF8" | ||
| do fileStream.LinkToFile(pFileName) | ||
| do fileStream.CopyFrom(..YAML(pTestIndex, pTestStatus)) | ||
| $$$ThrowOnError(fileStream.%Save()) | ||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| pTestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| pTestStatus As %String = "") As %Status | ||
| { | ||
| set tSC = $$$OK | ||
| try { | ||
| set yamlStream = ..YAML(pTestIndex, pTestStatus) | ||
| write ! | ||
| while 'yamlStream.AtEnd { | ||
| write yamlStream.Read() | ||
| } | ||
| } catch e { | ||
| set tSC = e.AsStatus() | ||
| } | ||
| return tSC | ||
| } | ||
|
|
||
| ClassMethod YAML( | ||
| pTestIndex = {$order(^UnitTest.Result(""),-1)}, | ||
| pTestStatus As %String = "") As %Stream.TmpCharacter | ||
| { | ||
| if pTestStatus'=""{ | ||
| set tResult= ..FilteredTestResultsFunc(pTestIndex, pTestStatus) | ||
| } else { | ||
| set tResult= ..GetAllTestResultsFunc(pTestIndex) | ||
| } | ||
| set yamlStream = ##class(%Stream.TmpCharacter).%New() | ||
| set (yaml,currentID,currentSuite,currentTestcase) = "" | ||
| while tResult.%Next() { | ||
| if currentID = "" { | ||
| set currentID = pTestIndex | ||
| do yamlStream.WriteLine("unitTest:") | ||
| do yamlStream.WriteLine(" id: "_pTestIndex) | ||
| do yamlStream.WriteLine(" namespace: """_tResult.namespace_"""") | ||
| do yamlStream.WriteLine(" duration: "_tResult.duration) | ||
| do yamlStream.WriteLine(" testDateTime: """_tResult.testDateTime_"""") | ||
| do yamlStream.WriteLine( "") | ||
|
||
| do yamlStream.WriteLine(" results:") | ||
| } | ||
| if tResult.suiteName '= currentSuite { | ||
| set currentSuite = tResult.suiteName | ||
| set currentTestcase = "" | ||
| do yamlStream.WriteLine(" - suiteName: """_tResult.suiteName_"""") | ||
| do yamlStream.WriteLine(" testcases:") | ||
| } | ||
| if tResult.testcaseName '= currentTestcase { | ||
| set currentTestcase = tResult.testcaseName | ||
| do yamlStream.WriteLine(" - testcaseName: """_tResult.testcaseName_"""") | ||
| do yamlStream.WriteLine(" methods:") | ||
| } | ||
| do yamlStream.WriteLine(" - methodName: """_tResult.methodName_"""") | ||
| //do yamlStream.WriteLine(" testMethod: """_tResult.testMethod_"""") | ||
|
||
| do yamlStream.WriteLine(" assertAction: """_tResult.assertAction_"""") | ||
| do yamlStream.WriteLine(" assertCounter: "_tResult.assertCounter) | ||
| //do yamlStream.WriteLine(" assertDescription: |") | ||
| //do yamlStream.WriteLine(" "_$replace(tResult.assertDescription, $c(10), $c(10)_" ")) | ||
| do yamlStream.WriteLine(" assertLocation: """_tResult.assertLocation_"""") | ||
| } | ||
| return yamlStream | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move this to 0.10.7 please
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moved to
0.10.7thank you!