Awesome

🌵 Cachi

Cachi is a swift tool to parse and visualize test results contained in Xcode's .xcresult files on a web interface. It additionally offers a set of APIs that can be queried to extract information in json format from previously parsed test results.

Automatic screen recording (Xcode 15) and screenshot based xcresults are supported.

Installation

brew install Subito-it/made/cachi

Or you can build manually using swift build.

Usage

Cachi can be launched by passing the port for the web interface and the location where it should search for the .xcresult bundles.

You can optionally pass:

• --search_depth to specify how deep Cachi should traverse the location path. Default is 2, larger values may impact parsing speed.
• --merge to merge multiple xcresults in the same folder as if they belong to the same test run. This can be used in advanced scenarios like for example test sharding on on multiple machines.

$ cachi --port number [--search_depth level] [--merge] path

Endpoint documentation

http://local.host:port/v1/help will return a list of available endpoint with a short overview.

Test result customization

The following keys can be added to the Info.plist in the .xcresult bundle which will be used when showing results:

• branchName
• commitHash
• commitMessage
• githubBaseUrl: used to generate links to specific code lines within GitHub repositories. This allows to easily navigate to specific code segments associated to test failures. Example: https://github.com/Subito-it/Cachi
• sourceBasePath: used to cleanup file paths removing compilation base paths from source code locations. Example: /Users/someuser/path/to/repository will convert locations such as /Users/someuser/path/to/repository/modules/Somefile.swift into /modules/Somefile.swift.

Contributions

Contributions are welcome! If you have a bug to report, feel free to help out by opening a new issue or sending a pull request.

Authors

Tomas Camin (@tomascamin)

License

Cachi is available under the Apache License, Version 2.0. See the LICENSE file for more info.