mu_plus icon indicating copy to clipboard operation
mu_plus copied to clipboard

[Feature]: Record tool versions in test results

Open trhpx opened this issue 3 months ago • 3 comments

Feature Overview

in XmlSupportPkg/Library/UnitTestResultReportJUnitFormatLib/UnitTestResultReportLib.c, The UnitTestFramework VersionString is not included in the JUNIT XML

Solution Overview

It would be useful to have the tool version recorded in the results log.

Alternatives Considered

No response

Urgency

Low

Are you going to implement the feature request?

I will not implement the feature

Do you need maintainer feedback?

No maintainer feedback needed

Anything else?

No response

trhpx avatar Nov 04 '25 19:11 trhpx

Thanks for feature request. Just so i understand what exactly do you mean by "UnitTestFramework VersionString".
Is this the UEFI unittest framework version listed here: https://github.com/microsoft/mu_basecore/blob/08b359878a681afd532e1606a37d5ac33111c65e/MdePkg/Include/Library/UnitTestLib.h#L192 ?

or is this the junit XML scheme version (is this even a thing)? or something else?

spbrogan avatar Dec 02 '25 23:12 spbrogan

sorry 1 more question. Where do you want the version reported? Since JunitXML is a "sudo" standard I found numerous projects that reported versions by adding properties to the suite or test. Is that what you would like to see?

https://github.com/testmoapp/junitxml?tab=readme-ov-file#properties

spbrogan avatar Dec 02 '25 23:12 spbrogan

My thought was a version associated with the unit test itself. For instance, MorLockFunctionalTestApp has a version specified:

https://github.com/microsoft/mu_plus/blob/d0d305b620baced42adf16b2387af9412fdc0ef9/UefiTestingPkg/FunctionalSystemTests/MorLockTestApp/MorLockTestApp.c#L24

https://github.com/microsoft/mu_plus/blob/d0d305b620baced42adf16b2387af9412fdc0ef9/UefiTestingPkg/FunctionalSystemTests/MorLockTestApp/MorLockTestApp.c#L1244

If the application is updated (and I'm hoping that the version string would be as well), it would be beneficial to know what version of the tool produced a given output.

I am OK with the version in a property, as you mentioned, i.e. <property name="version" value="0.1" />

trhpx avatar Dec 03 '25 00:12 trhpx