mirror of
https://gitlab.com/TECHNOFAB/nixtest.git
synced 2026-02-02 11:25:10 +01:00
refactor: split into packages and add tests
This commit is contained in:
parent
fd58344ca7
commit
11117e0c0e
28 changed files with 2736 additions and 636 deletions
158
internal/report/junit/junit.go
Normal file
158
internal/report/junit/junit.go
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
package junit
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitlab.com/technofab/nixtest/internal/types"
|
||||
"gitlab.com/technofab/nixtest/internal/util"
|
||||
)
|
||||
|
||||
type JUnitReport struct {
|
||||
XMLName xml.Name `xml:"testsuites"`
|
||||
Name string `xml:"name,attr,omitempty"`
|
||||
Tests int `xml:"tests,attr"`
|
||||
Failures int `xml:"failures,attr"`
|
||||
Errors int `xml:"errors,attr"`
|
||||
Skipped int `xml:"skipped,attr"`
|
||||
Time string `xml:"time,attr"`
|
||||
Suites []JUnitTestSuite `xml:"testsuite"`
|
||||
}
|
||||
|
||||
type JUnitTestSuite struct {
|
||||
XMLName xml.Name `xml:"testsuite"`
|
||||
Name string `xml:"name,attr"`
|
||||
Tests int `xml:"tests,attr"`
|
||||
Failures int `xml:"failures,attr"`
|
||||
Errors int `xml:"errors,attr"`
|
||||
Skipped int `xml:"skipped,attr"`
|
||||
Time string `xml:"time,attr"`
|
||||
TestCases []JUnitCase `xml:"testcase"`
|
||||
}
|
||||
|
||||
type JUnitCase struct {
|
||||
XMLName xml.Name `xml:"testcase"`
|
||||
Name string `xml:"name,attr"`
|
||||
Classname string `xml:"classname,attr"`
|
||||
Time string `xml:"time,attr"`
|
||||
File string `xml:"file,attr,omitempty"`
|
||||
Line string `xml:"line,attr,omitempty"`
|
||||
Failure *JUnitFailure `xml:"failure,omitempty"`
|
||||
Error *JUnitError `xml:"error,omitempty"`
|
||||
Skipped *JUnitSkipped `xml:"skipped,omitempty"`
|
||||
}
|
||||
|
||||
type JUnitFailure struct {
|
||||
XMLName xml.Name `xml:"failure"`
|
||||
Message string `xml:"message,attr,omitempty"`
|
||||
Data string `xml:",cdata"`
|
||||
}
|
||||
|
||||
type JUnitError struct {
|
||||
XMLName xml.Name `xml:"error"`
|
||||
Message string `xml:"message,attr,omitempty"`
|
||||
Data string `xml:",cdata"`
|
||||
}
|
||||
|
||||
type JUnitSkipped struct {
|
||||
XMLName xml.Name `xml:"skipped"`
|
||||
Message string `xml:"message,attr,omitempty"`
|
||||
}
|
||||
|
||||
// GenerateReport generates the Junit XML content as a string
|
||||
func GenerateReport(reportName string, results types.Results) (string, error) {
|
||||
report := JUnitReport{
|
||||
Name: reportName,
|
||||
Suites: []JUnitTestSuite{},
|
||||
}
|
||||
totalDuration := time.Duration(0)
|
||||
|
||||
for suiteName, suiteResults := range results {
|
||||
suite := JUnitTestSuite{
|
||||
Name: suiteName,
|
||||
Tests: len(suiteResults),
|
||||
TestCases: []JUnitCase{},
|
||||
}
|
||||
suiteDuration := time.Duration(0)
|
||||
|
||||
for _, result := range suiteResults {
|
||||
durationSeconds := fmt.Sprintf("%.3f", result.Duration.Seconds())
|
||||
totalDuration += result.Duration
|
||||
suiteDuration += result.Duration
|
||||
|
||||
testCase := JUnitCase{
|
||||
Name: result.Spec.Name,
|
||||
Classname: suiteName,
|
||||
Time: durationSeconds,
|
||||
}
|
||||
|
||||
if result.Spec.Pos != "" {
|
||||
parts := strings.SplitN(result.Spec.Pos, ":", 2)
|
||||
testCase.File = parts[0]
|
||||
if len(parts) > 1 {
|
||||
testCase.Line = parts[1]
|
||||
}
|
||||
}
|
||||
|
||||
switch result.Status {
|
||||
case types.StatusFailure:
|
||||
suite.Failures++
|
||||
report.Failures++
|
||||
var failureContent string
|
||||
if result.ErrorMessage != "" {
|
||||
failureContent = result.ErrorMessage
|
||||
} else {
|
||||
var err error
|
||||
failureContent, err = util.ComputeDiff(result.Expected, result.Actual)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to compute diff")
|
||||
}
|
||||
}
|
||||
testCase.Failure = &JUnitFailure{Message: "Test failed", Data: failureContent}
|
||||
case types.StatusError:
|
||||
suite.Errors++
|
||||
report.Errors++
|
||||
testCase.Error = &JUnitError{Message: "Test errored", Data: result.ErrorMessage}
|
||||
case types.StatusSkipped:
|
||||
suite.Skipped++
|
||||
report.Skipped++
|
||||
testCase.Skipped = &JUnitSkipped{Message: "Test skipped"}
|
||||
}
|
||||
report.Tests++
|
||||
suite.TestCases = append(suite.TestCases, testCase)
|
||||
}
|
||||
suite.Time = fmt.Sprintf("%.3f", suiteDuration.Seconds())
|
||||
report.Suites = append(report.Suites, suite)
|
||||
}
|
||||
|
||||
report.Time = fmt.Sprintf("%.3f", totalDuration.Seconds())
|
||||
|
||||
output, err := xml.MarshalIndent(report, "", " ")
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to marshal XML: %w", err)
|
||||
}
|
||||
return xml.Header + string(output), nil
|
||||
}
|
||||
|
||||
// WriteFile generates a Junit report and writes it to the specified path
|
||||
func WriteFile(filePath string, reportName string, results types.Results) error {
|
||||
xmlContent, err := GenerateReport(reportName, results)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to generate junit report content: %w", err)
|
||||
}
|
||||
|
||||
file, err := os.Create(filePath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create junit file %s: %w", filePath, err)
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
_, err = file.WriteString(xmlContent)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to write junit report to %s: %w", filePath, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
116
internal/report/junit/junit_test.go
Normal file
116
internal/report/junit/junit_test.go
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
package junit
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"gitlab.com/technofab/nixtest/internal/types"
|
||||
)
|
||||
|
||||
func formatDurationSeconds(d time.Duration) string {
|
||||
return fmt.Sprintf("%.3f", d.Seconds())
|
||||
}
|
||||
|
||||
func TestGenerateReport(t *testing.T) {
|
||||
results := types.Results{
|
||||
"Suite1": []types.TestResult{
|
||||
{
|
||||
Spec: types.TestSpec{Name: "Test1_Success", Suite: "Suite1", Pos: "file1.nix:10"},
|
||||
Status: types.StatusSuccess,
|
||||
Duration: 123 * time.Millisecond,
|
||||
},
|
||||
{
|
||||
Spec: types.TestSpec{Name: "Test2_Failure", Suite: "Suite1", Pos: "file1.nix:20"},
|
||||
Status: types.StatusFailure,
|
||||
Duration: 234 * time.Millisecond,
|
||||
Expected: "hello",
|
||||
Actual: "world",
|
||||
},
|
||||
},
|
||||
"Suite2": []types.TestResult{
|
||||
{
|
||||
Spec: types.TestSpec{Name: "Test3_Error", Suite: "Suite2"},
|
||||
Status: types.StatusError,
|
||||
Duration: 345 * time.Millisecond,
|
||||
ErrorMessage: "Something went very wrong",
|
||||
},
|
||||
{
|
||||
Spec: types.TestSpec{Name: "Test4_Failure_Message", Suite: "Suite2"},
|
||||
Status: types.StatusFailure,
|
||||
Duration: 456 * time.Millisecond,
|
||||
ErrorMessage: "hello world",
|
||||
},
|
||||
{
|
||||
Spec: types.TestSpec{Name: "Test5_Skipped", Suite: "Suite2"},
|
||||
Status: types.StatusSkipped,
|
||||
Duration: 567 * time.Millisecond,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
totalDuration := (123 + 234 + 345 + 456 + 567) * time.Millisecond
|
||||
reportName := "MyNixtestReport"
|
||||
xmlString, err := GenerateReport(reportName, results)
|
||||
if err != nil {
|
||||
t.Fatalf("GenerateReport() failed: %v", err)
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(xmlString, xml.Header) {
|
||||
t.Error("GenerateReport() output missing XML header")
|
||||
}
|
||||
if !strings.Contains(xmlString, "<testsuites name=\"MyNixtestReport\"") {
|
||||
t.Errorf("GenerateReport() missing root <testsuites>. Got: %s", xmlString)
|
||||
}
|
||||
if !strings.Contains(xmlString, "tests=\"5\"") {
|
||||
t.Errorf("GenerateReport() incorrect total tests count. Got: %s", xmlString)
|
||||
}
|
||||
if !strings.Contains(xmlString, "failures=\"2\"") {
|
||||
t.Errorf("GenerateReport() incorrect total failures count. Got: %s", xmlString)
|
||||
}
|
||||
if !strings.Contains(xmlString, "errors=\"1\"") {
|
||||
t.Errorf("GenerateReport() incorrect total errors count. Got: %s", xmlString)
|
||||
}
|
||||
if !strings.Contains(xmlString, "time=\""+formatDurationSeconds(totalDuration)+"\"") {
|
||||
t.Errorf("GenerateReport() incorrect total time. Expected %s. Got part: %s", formatDurationSeconds(totalDuration), xmlString)
|
||||
}
|
||||
|
||||
var report JUnitReport
|
||||
if err := xml.Unmarshal([]byte(strings.TrimPrefix(xmlString, xml.Header)), &report); err != nil {
|
||||
t.Fatalf("Failed to unmarshal generated XML: %v\nXML:\n%s", err, xmlString)
|
||||
}
|
||||
|
||||
if report.Name != reportName {
|
||||
t.Errorf("Report.Name = %q, want %q", report.Name, reportName)
|
||||
}
|
||||
if len(report.Suites) != 2 {
|
||||
t.Fatalf("Report.Suites length = %d, want 2", len(report.Suites))
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteFile(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
filePath := filepath.Join(tempDir, "junit_report.xml")
|
||||
results := types.Results{
|
||||
"SuiteSimple": []types.TestResult{
|
||||
{Spec: types.TestSpec{Name: "SimpleTest", Suite: "SuiteSimple"}, Status: types.StatusSuccess, Duration: 1 * time.Second},
|
||||
},
|
||||
}
|
||||
|
||||
err := WriteFile(filePath, "TestReport", results)
|
||||
if err != nil {
|
||||
t.Fatalf("WriteFile() failed: %v", err)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(filePath)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to read written JUnit file: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(content), "<testsuites name=\"TestReport\"") {
|
||||
t.Error("Written JUnit file content seems incorrect.")
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue