repository·main·Indexed 40 days ago
https://github.com/a7ex/xcresultparserA tool for parsing binary Xcode .xcresult bundles to generate human-readable or machine-readable summaries of test results and code coverage. It supports multiple output formats including JUnit, Cobertura, HTML, Markdown, and SonarQube XML, and provides options for filtering failed tests, excluding paths, and specifying project roots for path resolution.
A flaky test (failed on first attempt, passed on retry) is detected from per-repetition results.
txt, cli, html, md): Displayed with a distinct flaky icon (🟠 in markdown, ⚠︎ otherwise).<testcase> retains its <failure> children but gains a flaky="true" attribute and a [FLAKY] prefix in the failure message.--failed-tests-only flag.The representation of expected failures depends on the output format:
txt, cli, html, md: Expected failures are represented as a distinct test state.junit and xml (Sonar generic): Expected failures are emitted as regular passing test cases to maintain schema compatibility.When using xcresultparser to generate SonarQube generic test execution reports from Xcode 26 result bundles, ensure the following requirements are met to maintain a valid contract:
<file path="..."> must identify the actual test source file. Do not use Swift Testing suite display names as identifiers, as this can cause collisions with production source files.<testCase> must include an integer duration attribute representing milliseconds. If Xcode omits the duration, the parser should emit 0 rather than omitting the attribute..xcresult bundles typically identify test containers rather than direct source-file paths, you must continue to provide the --project-root flag to allow the parser to resolve test types to their corresponding source files.The tool outputs results to stdout. To save the output to a file, use shell redirection.
Example: Save text output to a file
xcresultparser -o txt test.xcresult > ~/Desktop/output.txtExample: Print colored output to the terminal
xcresultparser -o cli test.xcresultIf you are not using Homebrew, you can install the tool manually:
xcresultparser.zip from the latest releases.xcresultparser to your Desktop.chmod +x ~/Desktop/xcresultparser/usr/local/bin/) to use it globally:cp ~/Desktop/xcresultparser /usr/local/bin/xcresultparser in your terminal.chmod +x ~/Desktop/xcresultparser
cp ~/Desktop/xcresultparser /usr/local/bin/
xcresultparserWhen using SonarQube, xcresultparser yields absolute paths. To ensure SonarQube can map test classes to actual file paths, you must follow these requirements:
--project-root: The .xcresult bundle only lists tests by class name, not by file. Providing --project-root allows xcresultparser to map class names to file names by searching the directory.sonar.sources: The sonar.sources parameter in your sonar-scanner configuration must be an absolute path that matches the directory where xcodebuild ran.If the .xcresult was created on a different machine, you can use --project-root to convert absolute paths into relative paths. xcresultparser will strip the provided string from the beginning of the pathnames.
Example:
If the path in the xcresult is */Users/alex/work/myApp/Sources/myApp/SomeClass.swift and you run:
xcresultparser -c -o xml --project-root "work/myApp/" test.xcresult > sonar.xmlThe output path will be converted to Sources/myApp/SomeClass.swift. You can then run sonar-scanner from your project root using Sources as the sonar.sources parameter.
./xcresultparser -c -o xml --project-root "work/myApp/" test.xcresult > sonar.xmlThe easiest way to install xcresultparser is using Homebrew.
brew install xcresultparserYou can build the executable using the Swift Package Manager.
swift build -c release
# The executable will be located in .build/release/The xcresultparser command-line tool interprets binary .xcresult files and generates summaries in various formats such as txt, xml, html, md, github, junit, cobertura, warnings, and errors.
To use it, provide the path to your .xcresult file as a positional argument. You can then use various flags and options to customize the output format, coverage reporting, and filtering.
# Basic usage
xcresultparser path/to/your.xcresult
# Example: Generate Cobertura coverage report
xcresultparser path/to/your.xcresult --output-format cobertura --coverage
# Example: Generate GitHub compatible markdown
xcresultparser path/to/your.xcresult --output-format githubIf you are experiencing issues where JUnit or Sonar failure texts are missing their trailing source location (e.g., failed - message instead of failed - message (File.swift:109)), you may be running on Xcode 27.
To check if your xcresulttool is emitting the new format (which lacks the file/line prefix in the node name), run the following command against an .xcresult bundle:
xcrun xcresulttool get test-results tests --path <PATH_TO_YOUR_XCRESULT> \
| grep -o '"name" : "[^"]*failed[^"]*"' | head -3Interpretation:
"name" : "File.swift:109: failed - ..."."name" : "failed - ...".xcrun xcresulttool get test-results tests --path Tests/XcresultparserTests/TestAssets/test.xcresult \
| grep -o '"name" : "[^"]*failed[^"]*"' | head -3Generate a JSON file describing errors found in the result bundle.
xcresultparser -o errors test.xcresult > errors.jsonGenerate JSON output for Code Climate checks using the warnings output type.
xcresultparser -o warnings test.xcresult > climate.json