-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Backport of Add more details to JUnit
terraform test output to desc…
…ribe why a test was skipped into v1.11 (#36347) * Add ability for TestJUnitXMLFile to access data about whether the test runner was Stopped * Add details to XML describing why a Run was skipped * Fix wording * Code consistency changes * Move all JUnit-related code down to where it's used Away from the Views section of the code where it was relevant before * Move JUnit-related error and warning diags to above where cancellable contexts are created * Fix wording of user feedback * Fix test to match updated skipped message text * Fix test * Add missing changes from a1716b8 --------- Co-authored-by: Sarah French <[email protected]>
- Loading branch information
1 parent
07c1138
commit 96387bb
Showing
7 changed files
with
280 additions
and
156 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| package junit | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/terraform/internal/moduletest" | ||
| ) | ||
|
|
||
| func Test_TestJUnitXMLFile_save(t *testing.T) { | ||
|
|
||
| cases := map[string]struct { | ||
| filename string | ||
| expectError bool | ||
| }{ | ||
| "can save output to the specified filename": { | ||
| filename: func() string { | ||
| td := t.TempDir() | ||
| return fmt.Sprintf("%s/output.xml", td) | ||
| }(), | ||
| }, | ||
| "returns an error when given a filename that isn't absolute or relative": { | ||
| filename: "~/output.xml", | ||
| expectError: true, | ||
| }, | ||
| } | ||
|
|
||
| for tn, tc := range cases { | ||
| t.Run(tn, func(t *testing.T) { | ||
| j := TestJUnitXMLFile{ | ||
| filename: tc.filename, | ||
| } | ||
|
|
||
| xml := []byte(`<?xml version="1.0" encoding="UTF-8"?><testsuites> | ||
| <testsuite name="example_1.tftest.hcl" tests="1" skipped="0" failures="0" errors="0"> | ||
| <testcase name="true_is_true" classname="example_1.tftest.hcl" time="0.005381209"></testcase> | ||
| </testsuite> | ||
| </testsuites>`) | ||
|
|
||
| diags := j.save(xml) | ||
|
|
||
| if diags.HasErrors() { | ||
| if !tc.expectError { | ||
| t.Fatalf("got unexpected error: %s", diags.Err()) | ||
| } | ||
| // return early if testing error case | ||
| return | ||
| } | ||
|
|
||
| if !diags.HasErrors() && tc.expectError { | ||
| t.Fatalf("expected an error but got none") | ||
| } | ||
|
|
||
| fileContent, err := os.ReadFile(tc.filename) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error opening file") | ||
| } | ||
|
|
||
| if !bytes.Equal(fileContent, xml) { | ||
| t.Fatalf("wanted XML:\n%s\n got XML:\n%s\n", string(xml), string(fileContent)) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func Test_suiteFilesAsSortedList(t *testing.T) { | ||
| cases := map[string]struct { | ||
| Suite *moduletest.Suite | ||
| ExpectedNames map[int]string | ||
| }{ | ||
| "no test files": { | ||
| Suite: &moduletest.Suite{}, | ||
| }, | ||
| "3 test files ordered in map": { | ||
| Suite: &moduletest.Suite{ | ||
| Status: moduletest.Skip, | ||
| Files: map[string]*moduletest.File{ | ||
| "test_file_1.tftest.hcl": { | ||
| Name: "test_file_1.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| "test_file_2.tftest.hcl": { | ||
| Name: "test_file_2.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| "test_file_3.tftest.hcl": { | ||
| Name: "test_file_3.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| }, | ||
| }, | ||
| ExpectedNames: map[int]string{ | ||
| 0: "test_file_1.tftest.hcl", | ||
| 1: "test_file_2.tftest.hcl", | ||
| 2: "test_file_3.tftest.hcl", | ||
| }, | ||
| }, | ||
| "3 test files unordered in map": { | ||
| Suite: &moduletest.Suite{ | ||
| Status: moduletest.Skip, | ||
| Files: map[string]*moduletest.File{ | ||
| "test_file_3.tftest.hcl": { | ||
| Name: "test_file_3.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| "test_file_1.tftest.hcl": { | ||
| Name: "test_file_1.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| "test_file_2.tftest.hcl": { | ||
| Name: "test_file_2.tftest.hcl", | ||
| Status: moduletest.Skip, | ||
| Runs: []*moduletest.Run{}, | ||
| }, | ||
| }, | ||
| }, | ||
| ExpectedNames: map[int]string{ | ||
| 0: "test_file_1.tftest.hcl", | ||
| 1: "test_file_2.tftest.hcl", | ||
| 2: "test_file_3.tftest.hcl", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for tn, tc := range cases { | ||
| t.Run(tn, func(t *testing.T) { | ||
| list := suiteFilesAsSortedList(tc.Suite.Files) | ||
|
|
||
| if len(tc.ExpectedNames) != len(tc.Suite.Files) { | ||
| t.Fatalf("expected there to be %d items, got %d", len(tc.ExpectedNames), len(tc.Suite.Files)) | ||
| } | ||
|
|
||
| if len(tc.ExpectedNames) == 0 { | ||
| return | ||
| } | ||
|
|
||
| for k, v := range tc.ExpectedNames { | ||
| if list[k].Name != v { | ||
| t.Fatalf("expected element %d in sorted list to be named %s, got %s", k, v, list[k].Name) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.