mirror of
https://github.com/jstemmer/go-junit-report.git
synced 2025-04-05 21:18:08 -05:00
6087bd544c
When `go test` is run on multiple packages and with coverage collection enabled, it appends coverage information to the final result line for each package. With this change, properly handle this additional information and add it into the JUnit XML report as a property of the test suite.
428 lines
8.0 KiB
Go
428 lines
8.0 KiB
Go
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"runtime"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
type TestCase struct {
|
|
name string
|
|
reportName string
|
|
report *Report
|
|
noXMLHeader bool
|
|
packageName string
|
|
}
|
|
|
|
var testCases = []TestCase{
|
|
{
|
|
name: "01-pass.txt",
|
|
reportName: "01-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestZ",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestA",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "02-fail.txt",
|
|
reportName: "02-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 151,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 20,
|
|
Result: FAIL,
|
|
Output: []string{
|
|
"file_test.go:11: Error message",
|
|
"file_test.go:11: Longer",
|
|
"\terror",
|
|
"\tmessage.",
|
|
},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 130,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "03-skip.txt",
|
|
reportName: "03-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 150,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 20,
|
|
Result: SKIP,
|
|
Output: []string{
|
|
"file_test.go:11: Skip message",
|
|
},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 130,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "04-go_1_4.txt",
|
|
reportName: "04-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "05-no_xml_header.txt",
|
|
reportName: "05-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
noXMLHeader: true,
|
|
},
|
|
{
|
|
name: "06-mixed.txt",
|
|
reportName: "06-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name1",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Name: "package/name2",
|
|
Time: 151,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 20,
|
|
Result: FAIL,
|
|
Output: []string{
|
|
"file_test.go:11: Error message",
|
|
"file_test.go:11: Longer",
|
|
"\terror",
|
|
"\tmessage.",
|
|
},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 130,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
noXMLHeader: true,
|
|
},
|
|
{
|
|
name: "07-compiled_test.txt",
|
|
reportName: "07-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "test/package",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestOne",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestTwo",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
packageName: "test/package",
|
|
},
|
|
{
|
|
name: "08-parallel.txt",
|
|
reportName: "08-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "github.com/dmitris/test-go-junit-report",
|
|
Time: 440,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestDoFoo",
|
|
Time: 270,
|
|
Result: PASS,
|
|
Output: []string{"cov_test.go:10: DoFoo log 1", "cov_test.go:10: DoFoo log 2"},
|
|
},
|
|
{
|
|
Name: "TestDoFoo2",
|
|
Time: 160,
|
|
Result: PASS,
|
|
Output: []string{"cov_test.go:21: DoFoo2 log 1", "cov_test.go:21: DoFoo2 log 2"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "09-coverage.txt",
|
|
reportName: "09-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package/name",
|
|
Time: 160,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestZ",
|
|
Time: 60,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestA",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
CoveragePct: "13.37",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "10-multipkg-coverage.txt",
|
|
reportName: "10-report.xml",
|
|
report: &Report{
|
|
Packages: []Package{
|
|
{
|
|
Name: "package1/foo",
|
|
Time: 400,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestA",
|
|
Time: 100,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
{
|
|
Name: "TestB",
|
|
Time: 300,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
CoveragePct: "10.0",
|
|
},
|
|
{
|
|
Name: "package2/bar",
|
|
Time: 4200,
|
|
Tests: []*Test{
|
|
{
|
|
Name: "TestC",
|
|
Time: 4200,
|
|
Result: PASS,
|
|
Output: []string{},
|
|
},
|
|
},
|
|
CoveragePct: "99.8",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
func TestParser(t *testing.T) {
|
|
for _, testCase := range testCases {
|
|
t.Logf("Running: %s", testCase.name)
|
|
|
|
file, err := os.Open("tests/" + testCase.name)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
report, err := Parse(file, testCase.packageName)
|
|
if err != nil {
|
|
t.Fatalf("error parsing: %s", err)
|
|
}
|
|
|
|
if report == nil {
|
|
t.Fatalf("Report == nil")
|
|
}
|
|
|
|
expected := testCase.report
|
|
if len(report.Packages) != len(expected.Packages) {
|
|
t.Fatalf("Report packages == %d, want %d", len(report.Packages), len(expected.Packages))
|
|
}
|
|
|
|
for i, pkg := range report.Packages {
|
|
expPkg := expected.Packages[i]
|
|
|
|
if pkg.Name != expPkg.Name {
|
|
t.Errorf("Package.Name == %s, want %s", pkg.Name, expPkg.Name)
|
|
}
|
|
|
|
if pkg.Time != expPkg.Time {
|
|
t.Errorf("Package.Time == %d, want %d", pkg.Time, expPkg.Time)
|
|
}
|
|
|
|
if len(pkg.Tests) != len(expPkg.Tests) {
|
|
t.Fatalf("Package Tests == %d, want %d", len(pkg.Tests), len(expPkg.Tests))
|
|
}
|
|
|
|
for j, test := range pkg.Tests {
|
|
expTest := expPkg.Tests[j]
|
|
|
|
if test.Name != expTest.Name {
|
|
t.Errorf("Test.Name == %s, want %s", test.Name, expTest.Name)
|
|
}
|
|
|
|
if test.Time != expTest.Time {
|
|
t.Errorf("Test.Time == %d, want %d", test.Time, expTest.Time)
|
|
}
|
|
|
|
if test.Result != expTest.Result {
|
|
t.Errorf("Test.Result == %d, want %d", test.Result, expTest.Result)
|
|
}
|
|
|
|
testOutput := strings.Join(test.Output, "\n")
|
|
expTestOutput := strings.Join(expTest.Output, "\n")
|
|
if testOutput != expTestOutput {
|
|
t.Errorf("Test.Output ==\n%s\n, want\n%s", testOutput, expTestOutput)
|
|
}
|
|
}
|
|
if pkg.CoveragePct != expPkg.CoveragePct {
|
|
t.Errorf("Package.CoveragePct == %s, want %s", pkg.CoveragePct, expPkg.CoveragePct)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestJUnitFormatter(t *testing.T) {
|
|
for _, testCase := range testCases {
|
|
report, err := loadTestReport(testCase.reportName)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
var junitReport bytes.Buffer
|
|
|
|
if err = JUnitReportXML(testCase.report, testCase.noXMLHeader, &junitReport); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if string(junitReport.Bytes()) != report {
|
|
t.Fatalf("Fail: %s Report xml ==\n%s, want\n%s", testCase.name, string(junitReport.Bytes()), report)
|
|
}
|
|
}
|
|
}
|
|
|
|
func loadTestReport(name string) (string, error) {
|
|
contents, err := ioutil.ReadFile("tests/" + name)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
// replace value="1.0" With actual version
|
|
report := strings.Replace(string(contents), `value="1.0"`, fmt.Sprintf(`value="%s"`, runtime.Version()), -1)
|
|
|
|
return report, nil
|
|
}
|