10000 GitHub - bicyclering/xctool: A replacement for Apple's xcodebuild that makes it easier to build and test iOS or OSX apps.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bicyclering/xctool

BranchesTags
 
 

Repository files navigation

# xctool __xctool__ is a replacement for Apple's __xcodebuild__ that makes it easier to test iOS and Mac products. It's especially helpful for continuous integration. [![Build Status](https://travis-ci.org/facebook/xctool.png?branch=master)](https://travis-ci.org/facebook/xctool) [ [Features](#features) • [Requirements](#requirements) • [Usage](#usage) • [Continuous Integration](#continuous-integration) • [Reporters](#reporters) • [Configuration](#configuration-xctool-args) • [Contributing](#contributing) • [Known Issues & Tips](#known-issues--tips) • [License](#license) ] ## Features __xctool__ is drop-in replacement for `xcodebuild test` that adds a few extra features: * **Faster, parallelized test runs.** _xctool_ can optionally run all of your test bundles in parallel, speeding up your test runs significantly. At Facebook, we've seen 2x and 3x speed ups by parallelizing our runs. Use the `-parallelize` option with _run-tests_ or _test_ to enable. See [Parallelizing Test Runs](#parallelizing-test-runs) for more info. * **Structured output of test results.** _xctool_ captures all test results as structured JSON objects. If you're building a continuous integration system, this means you don't have to regex parse _xcodebuild_ output anymore. Try one of the [Reporters](#reporters) to customize the output or get the full event stream with the `-reporter json-stream` option. * **Human-friendly, ANSI-colored output.** _xcodebuild_ is incredibly verbose, printing the full compile command and output for every source file. By default, _xctool_ is only verbose if something goes wrong, making it much easier to identify where the problems are. Example: ![pretty output](https://fpotter_public.s3.amazonaws.com/xctool-uicatalog.gif) * **Written in Objective-C.** _xctool_ is written in Objective-C. Mac OS X and iOS developers can easily submit new features and fix any bugs they may encounter without learning a new language. We very much welcome pull requests! **Note:** Support for building projects with xctool is deprecated and will not be updated to support future versions of Xcode. We suggest moving to `xcodebuild` (with [xcpretty](https://github.com/supermarin/xcpretty)) for simple needs, or [xcbuild](https://github.com/facebook/xcbuild) for more involved requirements. xctool will continue to support testing (see above). ## Requirements * Xcode 6 or higher * You'll need Xcode's Command Line Tools installed. From Xcode, install via _Xcode → Preferences → Downloads_. ## Installation xctool can be installed from homebrew via ```bash brew install xctool ``` or can be downloaded and run via the xctool.sh command. ## Usage xctool's commands and options are mostly a superset of xcodebuild's. In most cases, you can just swap __xcodebuild__ with __xctool__ and things will run as expected but with more attractive output. You can always get help and a full list of options with: ```bash path/to/xctool.sh -help ``` ### Testing _xctool_ has a __test__ action which knows how to build and run the tests in your scheme. You can optionally limit what tests are run or change the SDK they're run against. To build and run all tests in your scheme, you would use: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test ``` To build and run just the tests in a specific target, use the `-only` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -only SomeTestTarget ``` You can go further and just run a specific test class: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -only SomeTestTarget:SomeTestClass ``` Or, even further and run just a single test method: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -only SomeTestTarget:SomeTestClass/testSomeMethod ``` You can also specify prefix matching for classes or test methods: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -only SomeTestTarget:SomeTestClassPrefix*,SomeTestClass/testSomeMethodPrefix* ``` Alternatively, you can omit a specific item by prefix matching for classes or test methods: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -omit SomeTestTarget:SomeTestClass/testSomeMethodPrefix* ``` You can also run tests against a different SDK: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ test -test-sdk iphonesimulator5.1 ``` #### Building Tests While __test__ will build and run your tests, sometimes you want to build them without running them. For that, use __build-tests__. For example: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ build-tests ``` You can optionally just build a single test target with the `-only` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ build-tests -only SomeTestTarget ``` #### Running Tests If you've already built tests with __build-tests__, you can use __run-tests__ to run them. This is helpful if you want to build tests once but run them against multiple SDKs. To run all tests, you would use: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ run-tests ``` Just as with the __test__ action, you can limit which tests are run with the `-only`. And, you can change which SDK they're run against with the `-test-sdk`. Optionally you can specify `-testTimeout` when running tests. When an individual test hits this timeout, it is considered a failure rather than waiting indefinitely. This can prevent your test run from deadlocking forever due to misbehaving tests. By default application tests will wait at most 30 seconds for the simulator to launch. If you need to change this timeout, use the `-launch-timeout` option. #### Parallelizing Test Runs _xctool_ can optionally run unit tests in parallel, making better use of otherwise idle CPU cores. At Facebook, we've seen 2x and 3x gains by parallelizing our test runs. To allow test bundles to run concurrently, use the `-parallelize` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ run-tests -parallelize ``` The above gives you parallelism, but you're bounded by your slowest test bundle. For example, if you had two test bundles ('A' and 'B'), but 'B' took 10 times as long to run because it contained 10 times as many tests, then the above parallelism won't help much. You can get further gains by breaking your test execution into buckets using the `-logicTestBucketSize` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ run-tests -parallelize -logicTestBucketSize 20 ``` The above will break your test execution into buckets of _20_ test cases each, and those bundles will be run concurrently. If some of your test bundles are much larger than others, this will help even things out and speed up the overall test run. ### Building **Note:** Support for building projects with xctool is deprecated and will not be updated to support future versions of Xcode. We suggest moving to `xcodebuild` (with [xcpretty](https://github.com/supermarin/xcpretty)) for simple needs, or [xcbuild](https://github.com/facebook/xcbuild) for more involved requirements. xctool will continue to support testing (see above). Building products with _xctool_ is the same as building them with _xcodebuild_. If you use workspaces and schemes: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ build ``` If you use projects and schemes: ```bash path/to/xctool.sh \ -project YourProject.xcodeproj \ -scheme YourScheme \ build ``` All of the common options like `-configuration`, `-sdk`, `-arch` work just as they do with _xcodebuild_. NOTE: _xctool_ doesn't support directly building targets using `-target`; you must use schemes. ## Continuous Integration xctool is an excellent choice for running your tests under a continuous integration server such as [Travis CI](https://travis-ci.org/) or [Jenkins](http://jenkins-ci.org/). In order to your run your tests within a continuous integration environment, you must create **Shared Schemes** for your application target and ensure that all dependencies (such as CocoaPods) are added explicitly to the Scheme. To do so: 1. Open up the **Manage Schemes** sheet by selecting the **Product** menu > **Schemes** > **Manage Schemes...** 1. Locate your application target in the list. Ensure that the **Shared** checkbox in far right hand column of the sheet is checked. 1. If your application or test targets include cross-project dependencies such as CocoaPods, then you will need to ensure that they have been configured as explicit dependencies. To do so: 1. Highlight your application target and hit the **Edit...** button to open the Scheme editing sheet. 1. Click the **Build** tab in the left-hand panel of the Scheme editor. 1. Click the **+** button and add each dependency to the project. CocoaPods will appear as a static library named **Pods**. 1. Drag the dependency above your application target so that it is built first. You will now have a new file in the **xcshareddata/xcschemes** directory underneath your Xcode project. This is the shared Scheme that you just configured. Check this file into your repository and xctool will be able to find and execute your tests on the next CI build. ### Example Travis CI Configuration [Travis CI](https://travis-ci.org/) is a very popular continuous integration system offered for free to Open Source projects. It integrates well with Github, and it now uses _xctool_ as the default build and test tool for Objective-C projects. Once you have set up your shared Scheme for use with xctool, you will need to configure a `.travis.yml` file. If you're using workspaces, your `.travis.yml` might be: ```yaml language: objective-c xcode_workspace: path/to/YourApp.xcworkspace xcode_scheme: YourApp ``` If you're using projects, your `.travis.yml` might be: ```yaml language: objective-c xcode_project: path/to/YourApp.xcodeproj xcode_scheme: YourApp ``` For more flexibility, you can also control how Travis installs and invokes xctool: ```yaml language: objective-c before_install: - brew update - brew install xctool script: xctool -workspace MyApp.xcworkspace -scheme MyApp test ``` You can learn more about the Travis CI environment for iOS and OS X application by referring to the [About OS X Travis CI Environment](http://about.travis-ci.org/docs/user/osx-ci-environment/) document and find in-depth documentation for configuring your project by consulting the [Getting Started](http://about.travis-ci.org/docs/user/getting-started/) page. ## Reporters xctool has reporters that output build and test results in different formats. If you do not specify any reporters yourself, xctool uses the `pretty` and `user-notifications` reporters by default. xctool also has these special rules: * Overwrite is disabled on the `pretty` reporter when xctool does not detect a TTY. This can be overridden by setting `XCTOOL_FORCE_TTY` in the environment. * The `user-notifications` reporter will not be used if xctool detects that the build is being run by Travis CI, CircleCI, TeamCity, or Jenkins (i.e. `TRAVIS=true`, `CIRCLECI=true`, `TEAMCITY_VERSION`, or `JENKINS_URL` in the environment). You can choose your own reporters with the `-reporter` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ -reporter plain \ build ``` By default, reporters output to standard out, but you can also direct the output to a file by adding `:OUTPUT_PATH` after the reporter name: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ -reporter plain:/path/to/plain-output.txt \ build ``` You can use as many reporters as you like; just use the `-reporter` option multiple times. ### Included Reporters * __pretty__: a text-based reporter that uses ANSI colors and unicode symbols for pretty output (the default). * __plain__: like _pretty_, but with no colors or unicode. * __phabricator__: outputs a JSON array of build/test results which can be fed into the [Phabricator](http://phabricator.org/) code-review tool. * __junit__: produces a JUnit/xUnit compatible XML file with test results. * __json-stream__: a stream of build/test events as JSON dictionaries, one per line [(example output)](https://gist.github.com/fpotter/82ffcc3d9a49d10ee41b). * __json-compilation-database__: outputs a [JSON Compilation Database](http://clang.llvm.org/docs/JSONCompilationDatabase.html) of build events which can be used by [Clang Tooling](http://clang.llvm.org/docs/LibTooling.html) based tools, e.g. [OCLint](http://oclint.org). * __user-notifications__: sends notification to Notification Center when action is completed [(example notifications)](https://cloud.githubusercontent.com/assets/1044236/2771974/a2715306-ca74-11e3-9889-fa50607cc412.png). * __teamcity__: sends service messages to [TeamCity](http://www.jetbrains.com/teamcity/) Continuous Integration Server ### Implementing Your Own Reporters You can also implement your own reporters using whatever language you like. Reporters in xctool are separate executables that read JSON objects from STDIN and write formatted results to STDOUT. You can invoke reporters by passing their full path via the `-reporter` option: ```bash path/to/xctool.sh \ -workspace YourWorkspace.xcworkspace \ -scheme YourScheme \ -reporter /path/to/your/reporter \ test ``` For example, here's a simple reporter in Python that outputs a _period_ for every passing test and an _exclamation mark_ for every failing test: ```python #!/usr/bin/python import fileinput import json import sys for line in fileinput.input(): obj = json.loads(line) if obj['event'] == 'end-test': if obj['succeeded']: sys.stdout.write('.') else: sys.stdout.write('!') sys.stdout.write('\n') ``` If you're writing a reporter in Objective-C, you'll find the `Reporter` class helpful - see [Reporter.h](https://github.com/facebook/xctool/blob/master/Common/Reporter.h). ## Configuration (.xctool-args) If you routinely need to pass many arguments to _xctool_ on the command-line, you can use an __.xctool-args__ file to speed up your workflow. If _xctool_ finds an __.xctool-args__ file in the current directory, it will automatically pre-populate its arguments from there. The format is just a JSON array of arguments: ```json [ "-workspace", "YourWorkspace.xcworkspace", "-scheme", "YourScheme", "-configuration", "Debug", "-sdk", "iphonesimulator", "-arch", "i386" ] ``` Any extra arguments you pass on the command-line will take precedence over those in the _.xctool-args_ file. ## Contributing Bug fixes, improvements, and especially new [Reporter](#reporters) implementations are welcome. Before submitting a [pull request](https://help.github.com/articles/using-pull-requests), please be sure to sign the [Facebook Contributor License Agreement](https://developers.facebook.com/opensource/cla). We can't accept pull requests unless it's been signed. #### Workflow 1. Fork. 2. Make a feature branch: __git checkout -b my-feature__ 3. Make your feature. Keep things tidy so you have one commit per self-contained change (squashing can help). 3. Push your branch to your fork: __git push -u origin my-feature__ 4. Open GitHub, under "Your recently pushed branches", click __Pull Request__ for _my-feature_. Be sure to use a separate feature branch and pull request for every self-contained feature. If you need to make changes from feedback, make the changes in place rather than layering on commits (use interactive rebase to edit your earlier commits). Then use __git push --force origin my-feature__ to update your pull request. #### Workflow (for Facebook people, other committers) Mostly the same, but use branches in the main xctool repo if you prefer. It's a nice way to keep things together. 1. Make a feature branch: __git checkout -b myusername/my-feature__ 2. Push your branch: __git push -u origin myusername/my-feature__ 3. Open GitHub to [facebook/xctool](https://github.com/facebook/xctool), under "Your recently pushed branches", click __Pull Request__ for _myusername/my-feature_. ## Known Issues & Tips * __Use shared schemes and disable the Autocreate Schemes feature.__ Xcode has two kinds of schemes: shared, and user. User schemes are the default, and they're stored under a folder called `USERNAME.xcuserdatad`, which most people correctly add to their _.gitignore_. Use shared schemes instead, and commit them to your repo. This way everyone on your team (and your build server) are working from the same information, and are building in the same way. ![example](https://fpotter_public.s3.amazonaws.com/xctool-shared-schemes.png) * __Make sure simulators run in a GUI context__. If you are running `xctool` in continuous integration, the user account calling `xctool` **must** have an active GUI context. If not, the simulator will fail to start with cryptic warnings like: ``` Tried to install the test host app 'com.myapp.test' but failed. Preparing test environment failed. -[TEST_BUNDLE FAILED_TO_START] There was a problem starting the test bundle: Simulator 'iPhone 6' was not prepared: Failed for unknown reason. Test did not run: Simulator 'iPhone 6' was not prepared: Failed for unknown reason. 2015-01-21 12:02:19.296 xcodebuild[35135:875297] iPhoneSimulator: Timed out waiting 120 seconds for simulator to boot, current state is 1. Testing failed: Test target MyProjectTests encountered an error (Timed out waiting 120 seconds for simulator to boot, current state is 1. ``` Note that the same holds true with `xcodebuild`...this is not `xctool` specific. For more information, see [this post by Jason Jarrett](http://staxmanade.com/2015/01/setting-jenkins-up-to-run-xctool-and-xcode-simulator-tests/). ## License Copyright 2014-present Facebook Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at: http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # bicyclering.github.io

About

A replacement for Apple's xcodebuild that makes it easier to build and test iOS or OSX apps.

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

27 tags

Packages

No packages published

Languages

  • Objective-C 95.0%
  • Shell 2.0%
  • Objective-C++ 1.3%
  • Python 0.7%
  • C++ 0.5%
  • C 0.5%
0