Refactor JUnit XML output of terraform test into a new junit package
#36304
+711
−347
Conversation
This file contains 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
Previously TestJUnitXMLFile implemented the View interface, which cannot return errors. Now it's not a View any more we can simplify things.
…e instead of a map, add test
…es in the XML We need to ensure that artifact.NewTestJUnitXMLFile is called once the config Loader is available as a non-nil pointer
SarahFrench
commented
Jan 10, 2025
Comment on lines
103
to
+105
| view := views.NewTest(args.ViewType, c.View) | ||
| var junitXMLView *views.TestJUnitXMLFile | ||
|
|
||
| // The specified testing directory must be a relative path, and it must |
There was a problem hiding this comment.
This diff is being rendered in a confusing way. The change I made was to move the JUnit-related block (checking experimental status, setting up vars etc) to go underneath the block starting config, configDiags := c.loadConfigWithTests(".", args.TestDirectory). This is due to needing c.configLoader to be a non-nil pointer when we call NewTestJUnitXMLFile.
SarahFrench
commented
Jan 10, 2025
SarahFrench
force-pushed
the
junit-output-as-artifact
branch
from
d8f69c7 to
872e950
Compare
SarahFrench
force-pushed
the
junit-output-as-artifact
branch
from
4bbe97f to
168df6a
Compare
SarahFrench
commented
Jan 10, 2025
|
Opening for review- I've left some comments via self-review and I've re-done this work so that the commits are clean and show the changes 'building up' over time instead of a big-bang refactor. |
SarahFrench
changed the title
terraform test into a new artifact packageterraform test into a new junit package
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR refactors code that allows users to create a JUnit XML output file describing the outcome of a
terraform testcommand.Previously this feature was implemented as a Test View (i.e. the struct that managed reporting test outcomes to the terminal), see original comment here for context. This wasn't a good fit; the Test interface has several methods to allow continuous printing of updates to a terminal, whereas creating a JUnit output file requires waiting until all the tests are complete before preparing and saving the file.
This PR introduces the new interface
JUnitwhich is a means through which a test run may create a file locally that summarises a test suite, after it's finished sending output to aView. The JUnit output feature has been refactored to use this interface.Also, I've updated the JUnit output so that sources are available when creating parts of the XML file from diagnostics.
Future work not in this PR:
junitXMLTestReportTarget Release
1.11.x
CHANGELOG entry
This change is user-facing and I added a changelog entry.This change is not user-facing.This change is user-facing but is part of an experimental feature, so changelogs are not required