facebook/xctoolArchived
Xctool
xctool ist ein Kommandozeilen-Wrapper für xcodebuild, der für die Continuous Integration von iOS und macOS entwickelt wurde. Er fungiert als paralleler Test-Runner, Build-Log-Prozessor und Berichtsgenerator, um die Build- und Test-Pipeline für Apple-Plattformen zu automatisieren.
Das Tool verteilt Test-Bundles auf mehrere CPU-Kerne, um die Ausführungszeit zu reduzieren, und bietet die Möglichkeit, gezielte Teilmengen von Tests durch Filtern nach spezifischen Schemas, Klassen oder Methoden auszuführen. Es vereinfacht das Build-Management, indem es ermöglicht, Kommandozeilenargumente zu persistieren und aus JSON-Konfigurationsdateien zu laden.
Es transformiert ausführliche Build-Logs in strukturierte JSON-Event-Streams, die für die Kompatibilität mit externen Reporting-Tools in JUnit-XML konvertiert werden können. Zur Verbesserung der Observability verwendet es einen Log-Suppression-Buffer, der die Ausgabe verbirgt, bis ein Fehler erkannt wird, und bietet menschenlesbaren und farbigen Konsolentext.
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.
