facebook/xctoolArchived
Xctool
xctool is a command line wrapper for xcodebuild designed for iOS and macOS continuous integration. It functions as a parallel test runner, build log processor, and report generator to automate the build and test pipeline for Apple platforms.
The tool distributes test bundles across multiple CPU cores to reduce execution time and provides the ability to run targeted subsets of tests by filtering for specific schemes, classes, or methods. It simplifies build management by allowing command line arguments to be persisted and loaded from JSON configuration files.
It transforms verbose build logs into structured JSON event streams, which can be converted into JUnit XML for compatibility with external reporting tools. To improve observability, it uses a log-suppression buffer that hides output until an error is detected, providing human-readable and colored console text.
Features
- Command Wrappers - Acts as a command line wrapper for xcodebuild to modify its behavior and process its output.
- Continuous Integration Pipelines - Provides a comprehensive tool for automating the build, test, and validation pipeline for Apple platforms within CI environments.
- CI Test Report Translators - Converts internal JSON event streams into standardized JUnit XML format for compatibility with CI reporting tools.
- iOS Build Pipelines - Automates the compilation and testing process for Apple platforms within CI pipelines using xcodebuild.
- xcodebuild Wrappers - Wraps the xcodebuild tool to simplify command execution and process real-time build output for iOS and macOS.
- Multi-Core Parallelization - Provides the ability to distribute test bundles across multiple processor cores to reduce overall execution time.
- Test Report Exporters - Captures test events as structured JSON and exports them via JUnit XML or JSON streams.
- Test Result Reporters - Transforms raw xcodebuild output into structured JSON or JUnit XML for integration with reporting tools.
- Parallel Test Execution - Distributes test bundles across multiple CPU cores and splits tests into buckets to optimize execution time.
- Test Execution Filtering - Allows running specific subsets of tests by filtering for schemes, targets, classes, or methods.
- Error-Triggered Log Flushes - Holds build output in a temporary buffer and only prints to the console when an error is detected.
- Argument Persistence - Persists predefined command-line flags in JSON files to eliminate repetitive manual input.
- Log Stream Processors - Functions as a buffer that suppresses verbose output and formats build events into human-readable or machine-parsable JSON streams.
- Xcode Build Automation - Simplifies the management of complex xcodebuild arguments through configuration files and filtered output.
- Configuration File Loading - Allows loading of build flags and settings from persisted JSON configuration files to automate repetitive arguments.
- Log Stream Parsers - Transforms verbose text build logs into structured JSON event streams for programmatic reporting.
- Log Buffering and Pausing - Implements a memory buffer that halts log emission and flushes the output only upon error detection.
- Log Output Formatting - Converts verbose build logs into human-friendly, colored text and suppresses noise until errors occur.
- Test Result Exporters - Transforms verbose build logs into structured JSON and standardized JUnit XML for compatibility with external reporting tools.
- Testing & Debugging - Automated build and test tool.
- Command Line Utilities - Extension for Apple's xcodebuild to ease testing.
- Developer Tools - Command-line tool for building and testing iOS applications.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
