[Feature]: Record tool versions in test results

[trhpx]

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

[spbrogan]

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]

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

[trhpx]

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

mu_plus/UefiTestingPkg/FunctionalSystemTests/MorLockTestApp/MorLockTestApp.c

Line 24 in d0d305b

#define UNIT_TEST_APP_VERSION "0.1"

mu_plus/UefiTestingPkg/FunctionalSystemTests/MorLockTestApp/MorLockTestApp.c

Line 1244 in d0d305b

Status = InitUnitTestFramework (&Fw, UNIT_TEST_APP_NAME, gEfiCallerBaseName, UNIT_TEST_APP_VERSION);

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" />

[mu-automation]

This issue has been automatically marked as stale because it has not had activity in 45 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[makubacki]

@spbrogan - Removed the stale label to provide an opportunity for follow up.

[mu-automation]

This issue has been automatically marked as stale because it has not had activity in 45 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.