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
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 |
|---|---|---|
| @@ -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( | ||
| FileName As %String, | ||
|
Collaborator
There was a problem hiding this comment. Nit: method parameters should be in camelCase, not PascalCase |
||
| CaseStatus As %String = "", | ||
| TestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status [ Abstract ] | ||
| { | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| TestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| TestStatus As %String = "") [ Abstract ] | ||
| { | ||
| } | ||
|
|
||
| Query FilteredTestResults( | ||
| Instance As %Integer, | ||
| TestStatus) 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, | ||
|
Collaborator
There was a problem hiding this comment. Nit: no need for t- prefixes here either |
||
| 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=:Instance AND tassert.Status=:TestStatus | ||
| } | ||
|
|
||
| Query GetAllTestResults(Instance 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=:Instance | ||
| } | ||
|
|
||
| } | ||
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,93 @@ | ||
| Class %IPM.Test.JsonOutput Extends %IPM.Test.Abstract | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| FileName As %String, | ||
| TestStatus As %String = "", | ||
| TestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| set fileStream = ##class(%Stream.FileCharacter).%New() | ||
| set fileStream.TranslateTable = "UTF8" | ||
| $$$ThrowOnError(fileStream.LinkToFile(FileName)) | ||
| set responseJson = ..JSON(TestIndex, TestStatus) | ||
| if $isobject(responseJson) { | ||
| do fileStream.Write(responseJson.%ToJSON()) | ||
| } | ||
| $$$ThrowOnError(fileStream.%Save()) | ||
| } catch ex { | ||
| set sc = ex.AsStatus() | ||
| } | ||
| return sc | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| TestIndex 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 sc = $$$OK | ||
| try { | ||
| set responseJson = ..JSON(TestIndex, pCaseStatus) | ||
| write ! | ||
| if $isobject(responseJson) { | ||
| do responseJson.%ToJSON() | ||
| } | ||
| } catch ex { | ||
| set sc = ex.AsStatus() | ||
| } | ||
| return sc | ||
| } | ||
|
|
||
| ClassMethod JSON( | ||
| TestIndex As %Integer, | ||
| TestStatus As %String) As %DynamicObject | ||
| { | ||
| if TestStatus'="" { | ||
| set tResult = ..FilteredTestResultsFunc(TestIndex, TestStatus) | ||
|
Collaborator
There was a problem hiding this comment. Nit: remove the t-prefixes |
||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(TestIndex) | ||
| } | ||
| set unitTest = {} | ||
| set unitTest.results = [] | ||
| set (previousID,currentSuite,currentTestcase,suiteObj,testcaseObj) = "" | ||
|
|
||
| while tResult.%Next() { | ||
| if previousID = "" { | ||
| set unitTest.id = TestIndex | ||
| set unitTest.namespace = tResult.namespace | ||
| set unitTest.duration = tResult.duration | ||
| set unitTest.testDateTime = tResult.testDateTime | ||
| } | ||
| set previousID = TestIndex | ||
| 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,77 @@ | ||
| Class %IPM.Test.ToonOutput Extends %IPM.Test.Abstract | ||
| { | ||
|
|
||
| ClassMethod ToFile( | ||
| FileName As %String, | ||
| TestStatus As %String = "", | ||
| TestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}) As %Status | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| set fileStream = ##class(%Stream.FileCharacter).%New() | ||
| set fileStream.TranslateTable = "UTF8" | ||
| $$$ThrowOnError(fileStream.LinkToFile(FileName)) | ||
|
|
||
| if TestStatus'="" { | ||
| set tResult = ..FilteredTestResultsFunc(TestIndex, TestStatus) | ||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(TestIndex) | ||
| } | ||
|
|
||
| set currentID="" | ||
| while tResult.%Next() { | ||
| if currentID = "" { | ||
| set currentID = TestIndex | ||
| 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: "_TestIndex) | ||
| 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_","_TestIndex_","_ | ||
| tResult.assertAction_","_tResult.assertCounter_","""_$translate(tResult.assertDescription,"""")_""","""_tResult.assertLocation_"""" | ||
| do fileStream.WriteLine(data) | ||
| } | ||
| $$$ThrowOnError(fileStream.%Save()) | ||
| } catch ex { | ||
| set sc = ex.AsStatus() | ||
| } | ||
| return sc | ||
| } | ||
|
|
||
| ClassMethod OutputToDevice( | ||
| TestIndex As %Integer = {$order(^UnitTest.Result(""),-1)}, | ||
| TestStatus As %String = "") As %Status | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| if TestStatus'="" { | ||
| set tResult = ..FilteredTestResultsFunc(TestIndex, TestStatus) | ||
| } else { | ||
| set tResult = ..GetAllTestResultsFunc(TestIndex) | ||
| } | ||
| set currentID="" | ||
| while tResult.%Next() { | ||
| if currentID = "" { | ||
| set currentID = TestIndex | ||
| write !,"unitTest:" | ||
| write !," id: "_TestIndex | ||
| 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_","_TestIndex_","_ | ||
| tResult.assertAction_","_tResult.assertCounter_","""_$translate(tResult.assertDescription,"""")_""","""_tResult.assertLocation_"""" | ||
| write !,data | ||
| } | ||
| } catch ex { | ||
| set sc = ex.AsStatus() | ||
| } | ||
| return sc | ||
| } | ||
|
|
||
| } | ||
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.
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.
Nit: should be one line, i.e.
} else {