Repository files navigation

A Go JSON test reporter to create test reports that follow the CTRF standard.

Common Test Report Format ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.

💚

CTRF tooling is open source and free to use

You can support the project with a follow and a star

Maintained byMatthew Thomas
Contributions are very welcome!
Explore moreintegrations

• Generate JSON test reports that areCTRF compliant
• Straightforward integration with Go

{"results": {"tool": {"name":"gotest"    },"summary": {"tests":1,"passed":1,"failed":0,"pending":0,"skipped":0,"other":0,"start":1706828654274,"stop":1706828655782    },"tests": [      {"name":"ctrf should generate the same report with any tool","status":"passed","duration":100      }    ],"environment": {"appName":"MyApp","buildName":"MyBuild","buildNumber":"1"    }  }}

To install go-ctrf-json-reporter, ensure you have Go installed on your system, then run:

go install github.com/ctrf-io/go-ctrf-json-reporter/cmd/go-ctrf-json-reporter@latest

This command will install the latest version of go-ctrf-json-reporter.

After installation, you can use go-ctrf-json-reporter by piping the output of go test -json into it:

gotest -json ./...| go-ctrf-json-reporter -output ctrf-report.json

gotest -json ./...| go-ctrf-json-reporter \-output custom-name.json \-verbose \-quiet \-appName"MyApp" \-appVersion"1.0.0" \-osPlatform"Linux" \-osRelease"18.04" \-osVersion"5.4.0" \-buildName"MyAppBuild" \-buildNumber"100"

go-ctrf-json-reporter can be used in conjunction with gotestsum

gotestsum --jsonfile gotestsum.json&& go-ctrf-json-reporter< gotestsum.json

If you are writting your own testing tool and wish to generate a CTRF JSON report, you can use thectrf package.

import ("github.com/ctrf-io/go-ctrf-json-reporter/ctrf")funcrunTests(destinationReportFilestring)error {env:= ctrf.Environment{// add your environment details here  }report:=ctrf.NewReport("my-awesome-testing-tool",&env)// run your tests and populate the report object herereturnreport.WriteFile(destinationReportFile)}

The test object in the report includes the followingCTRF properties:

When running go-ctrf-json-reporter results in a "command not found" error this usually means that the Go bin directory is not in your system's PATH.

Contributions are welcome! SeeContributing for more information.

go build -o go-ctrf-json-reporter ./cmd/go-ctrf-json-reporter

gotest ./...

gotest -json ./...| ./go-ctrf-json-reporter -output ctrf-report.jsoncat ctrf-report.json

1. Make changes to the code
2. Run tests:go test ./...
3. Test the reporter:go test -json ./... | ./go-ctrf-json-reporter -output test-results.json
4. Check the generated CTRF report:cat test-results.json

If you encounter issues with test execution, ensure your Go environment is set correctly for your platform:

# Check your Go environmentgo env GOOS GOARCH# Set for your platform if neededexport GOOS=darwin GOARCH=arm64# For macOS ARM64export GOOS=linux GOARCH=amd64# For Linux x86_64export GOOS=windows GOARCH=amd64# For Windows x86_64

Make sure the binary is executable:

chmod +x go-ctrf-json-reporter

CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.

Consistency Across Tools: Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.

Language and Framework Agnostic: It provides a universal reporting schema that works seamlessly with any programming language and testing framework.

Facilitates Better Analysis: With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.

If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.