Test iOS applications on OS X
CircleCI now offers support for building and testing iOS and OS X projects. You can select an OS X project you would like to build on the Add Projects page.
If you’re unable to find your project in the “OS X” tab, it may be listed as a “Linux” project. After adding your project as a “Linux” build, you can change it to an OS X build by enabling the “Build OS X project” option under the “Project Settings” > “Build Environment” page.
The OS X container that CircleCI uses to build has the following software versions installed:
- OS X 10.11.6 (15G1004)
- 7.0 Build version 7A220
- 7.1 Build version 7B91b
- 7.2 Build version 7C68
- 7.3 Build version 7D175
- 8.0 Build version 8A218a
- 8.1 Build version 8B62
- 8.2 Build version 8C1002
- Facebook xctool 0.2.9
- CocoaPods 1.1.1
- xcpretty 0.2.4
- fastlane 1.110.0
- carthage 0.18.1
- shenzhen 0.14.2
We pre-install the simulators with the following device names and OS versions in the OS X build image:
- Apple TV 1080p (9.2, 10.0)
- Apple Watch - 38mm (3.0, 3.1)
- Apple Watch - 42mm (3.0, 3.1)
- iPad 2 (8.4, 9.0, 9.2, 9.3)
- iPad Air (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPad Retina (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPad Pro (9.7 inch) (10.0, 10.1, 10.2)
- iPad Pro (12.9 inch) (10.0, 10.1, 10.2)
- iPhone 4s (8.4, 9.0, 9.2, 9.3)
- iPhone 5 (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 5s (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 6 (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 6 Plus (8.4, 9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 6s (9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 6s Plus (9.0, 9.2, 9.3, 10.0, 10.1, 10.2)
- iPhone 7 (10.0, 10.1, 10.2)
- iPhone 7 Plus (10.0, 10.1, 10.2)
- iPhone SE (10.0, 10.1, 10.2)
- Device pairs:
- iPhone 7 (10.0) + Apple Watch Series 2 - 38mm (3.0)
- iPhone 7 Plus (10.0) + Apple Watch Series 2 - 42mm (3.0)
- iPhone 7 (10.2) + Apple Watch Series 2 - 38mm (3.1)
- iPhone 7 Plus (10.2) + Apple Watch Series 2 - 42mm (3.1)
Please note that the simulators will only be available if the selected Xcode version supports them. For example, simulators with iOS 10.2 can only be used with Xcode 8.2 and above.
After enabling the OS X builds for your project, you will need to share the scheme that is going to be built on CircleCI so that we run the correct build actions. Here is how to share an existing scheme in Xcode:
- Choose Product > Scheme > Manage Schemes.
- Select the Shared option for the scheme to share, and click Close.
- Choose Source Control > Commit.
- Select the Shared Data folder.
- Enter your commit message in the text field.
- Select the “Push to remote” option (if your project is managed with Git).
- Click the Commit Files button.
After doing this you will have a new
.xcscheme file located in the
xcshareddata/xcschemes folder under your Xcode project. You will need to
commit this file to your git repository so that CircleCI can access it.
Simple projects should run with minimal or no configuration.
By default, CircleCI will:
- Install any Ruby gems specified in a Gemfile - we will run
bundle installand cache the installed gems.
- Install any dependencies managed by CocoaPods - if a Podfile is
present, we will run
pod install, or
bundle exec pod installif both a Podfile and a Gemfile are present, and also cache the installed pods.
- Run the “test” build action for detected workspace (or project) and scheme
from the command line - We will use
xctoolto build either the workspace we find in your repo, or the project, if there is no workspace.
See customizing your build for more information about customization options.
By default, CircleCI will build your project with Xcode 7.0. You can select 7.2, 7.3 or 8.0. by specifying the version in a circle.yml file in the root of your repo. For example, for 8.0, add the following:
machine: xcode: version: 8.0
CircleCI will automatically detect if your project is using CocoaPods to manage dependencies. If you are using CocoaPods, then we recommend that you check your Pods directory into source control. This will ensure that you have a deterministic, reproducable build.
If CircleCI finds a
Podfile and the
Pods directory is not present (or empty)
then we will run
pod install to install the necessary dependencies in the
dependencies step of your build.
We cannot handle all setups automatically, so for some projects you might need
to invoke CocoaPods manually with some custom configuration. To do this you will
need to override the
dependencies section of your
See our documentation on overriding build phases for more information on this..
If you need more help please reach out to our support team who are always happy
to help out.
Supported build and test tools
CircleCI’s automatic commands cover a lot of common test patterns, and you can customize your build as needed to satisfy almost any iOS build and test strategy.
In addition to standard
XCTestCase tests, CircleCI will automatically run tests
written in any other tool that builds on top of XCTest and is configured to run
via the “test” build action. The following test tools are known to work well on CircleCI
(though many others should work just fine):
The fastest way to get code signing working on CircleCI is to follow these steps:
- Upload your
.P12file in Project Settings > iOS Code Signing.
- Add your provisioning profile (
.mobileprovision) file to your repo.
GYM_CODE_SIGNING_IDENTITYenvironment variable to match your code-signing identity, ie
"iPhone Distribution: Acme Inc.".
- Build with
gymand deploy with
Customizing your build
While CircleCI’s inferred commands will handle many common testing patterns, you also have a lot of flexibility to customize what happens in your build.
CircleCI runs tests from the command line with the
command by default. This is a tool developed by Apple, and we find it to be the most
stable and functional option for building and testing your OS X project.
CircleCI will try to automatically build your iOS project by infering the workspace, project and scheme. In some cases, you may need to override the inferred test commands. The following command is representative of how CircleCI will build an iOS project:
test: override: - set -o pipefail && xcodebuild CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= -sdk iphonesimulator -destination 'platform=iOS Simulator,OS=9.0,name=iPhone 6' -workspace MyWorkspace.xcworkspace -scheme "My Scheme" clean build test | tee $CIRCLE_ARTIFACTS/xcode_raw.log | xcpretty --color --report junit --output $CIRCLE_TEST_REPORTS/xcode/results.xml
The destination can be selected from the simulators pre-installed in our build image.
In some situations you might also want to build with
an alternative build tool. Please mind that some of the
xcodebuild functionality might not be
xctool. Here is an example of an
xctool build command:
test: override: - xctool -reporter pretty -reporter junit:$CIRCLE_TEST_REPORTS/xcode/results.xml -reporter plain:$CIRCLE_ARTIFACTS/xctool.log CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= -destination 'platform=iOS Simulator,name=iPhone 6,OS=latest' -sdk iphonesimulator -workspace MyWorkspace.xcworkspace -scheme "My Scheme" build build-tests run-tests
You can customize the behavior of CircleCI’s automatic build commands by setting
the following environment variables in a
circle.yml file or at
Project Settings > Environment Variables (see here for more info
about environment variables):
XCODE_WORKSPACE- The path to your
.xcworkspacefile relative to the git repository root
XCODE_PROJECT- The path to your
.xcodeprojfile relative to the repository root
XCODE_SCHEME- The name of the scheme you would like to use to run the “test” build action
Note: Only one of
XCODE_PROJECT will be used, with workspace taking
precedence over project.
If more than one scheme is present, then you should specify the
XCODE_SCHEME environment variable.
Otherwise a scheme will be chosen arbitrarily.
You can also use the Environment Variables section to add all the secrets that your build needs, as the content of the variables is stored securely.
The most flexible means to customize your build is to add a
circle.yml file to your project,
which allows you to run arbitrary bash commands instead of or in addition to the inferred commands
at various points in the build process. See the configuration doc for
a detailed discussion of the structure of the
circle.yml file. Note, however, that
a number of options discussed in that doc will not work for OS X builds.
Please see the the Constraints section for the
exact commands that are not supported.
Homebrew is pre-installed on CircleCI, so you can simply use
to add nearly any dependency required in your build VM. Here’s an example:
dependencies: pre: - brew install cowsay test: override: - cowsay Hi!
You can also use the
sudo command if necessary to perform customizations outside of Homebrew.
Using custom versions of CocoaPods and other Ruby gems
To make sure the version of CocoaPods that you use locally is also used in your CircleCI builds, we suggest creating a Gemfile in your iOS project and adding the CocoaPods version to it:
source 'https://rubygems.org' gem 'cocoapods', '= 0.39.0'
If we detect a Gemfile in your project we’ll run
bundle install and
will then invoke CocoaPods with
bundle exec prepended to the command.
Please mind that, if overriding the
dependencies step, you will need
to manually add the
bundle install step to your config.
If you have any other gems specified in your Gemfile, we will
automatically install and cache those as well during the
Once you have a signed app you are on the homeward stretch. Distributing
the app is easy. One popular way to distribute your app is using
Shenzhen supports many distribution services, including:
Log in to Hockey app and create a new API token on the Tokens page. Your token will need at
least upload permission to upload new builds to Hockey App. Give your
new API token a name specific to CircleCI such as “CircleCI
Distribution”. Copy the token, and log into CircleCI and visit the
Project Settings for your app. Create a new Environment Variable with
HOCKEY_APP_TOKEN and paste the token as the value. You can now
access this token during the build.
Modify the deployment section of your
circle.yml as follows:
deployment: beta_distribution: branch: master commands: - gym - ipa distribute:hockeyapp --file /Users/distiller/<yourprojectname>/<yourappname>.ipa --token "$HOCKEY_APP_TOKEN" --notes "CircleCI build $CIRCLE_BUILD_NUM" --commit-sha "$CIRCLE_SHA1" --build-server-url "$CIRCLE_BUILD_URL" --repository-url "$CIRCLE_REPOSITORY_URL"
Beta By Crashlytics
First, we need to get some credentials. Log in to Fabric.io and visit your organization’s settings page.
Click on your organisation (CircleCI in the image above), and click on the API key and Build Secret links to reveal the items.
On CircleCI, navigate to your App’s Project Settings page, and under
Environment Variables add 2 new items named
CRASHLYTICS_SECRET, with the values you find on Crashlytics website.
You can then modify the deployment section of your circle.yml as follows:
deployment: beta_distribution: branch: master commands: - gym - ipa distribute:crashlytics --crashlytics_path Crashlytics.framework --api_token "$CRASHLYTICS_API_KEY" --build_secret "$CRASHLYTICS_SECRET"
To set up your app on TestFairy first visit the preferences page in the
TestFairy dashboard and navigate to the API Key section. Copy your API
key and go to your App’s Project settings on CircleCI. Add a new
Environment Variable named
TESTFAIRY_API_KEY and paste in the API key
from the TestFairy dashboard.
Next, you need to edit your
circle.yml as follows:
deployment: beta_distribution: branch: master commands: - gym - ipa distribute:testfairy --key "$TESTFAIRY_API_KEY" --comment "CircleCI build $CIRCLE_BUILD_URL"
A series of simulator-related issues are known to happen on some projects. Here are the most frequent of those:
Xcode version is not available. We install a few different versions of Xcode in the build image and keep those updated with the latest point releases. Therefore to use the latest Xcode 7.3, for example, which is
7.3.1, it is sufficient to specify
circle.yml. If a newer point release of 7.3 comes out, we will make that one available under the same
7.3version on CircleCI.
Dependency version mismatches. If you see that the version of the dependencies used in the build are not the expected ones, please try rebuilding without cache — chances are an older dependency got stuck in the cache and is not allowing for the newer version to get installed.
Cryptic compilation errors. If you see compile-time errors that do not really make sense, please check if the version of Xcode you are using in your build is the same one you are using locally. When the
circle.ymlof the project does not specify an Xcode version, we default to an older Xcode which might not support the necessary features.
Timeout waiting for simulator. If you see your test command failing with errors similar to this:
Can’t add my project as OS X build. If you are trying to add an OS X project from the “add-project” page, but you don’t see your project under the “OS X” tab, you can first add your project as a “Linux” build — and then switch it to an “OS X” build by going to the “Project Settings” page, then on the “Build Environment” page you will see the “Build OS X project” option.
iPhoneSimulator: Timed out waiting 120 seconds for simulator to boot, current state is 1
Then the version of the simulator you are trying to use on CircleCI might not be present in the build machines. In addition to the default version of simulator for every Xcode installation, we also make simulators of the following iOS versions available for all Xcode versions:
Please try using any of the versions of simulator that are present on the machines — the error might disappear.
Ruby segfaults. We have seen cases where some of the Ruby gems used during the build would produce a segmentation fault in Ruby. This might happen because of the mismatch of Ruby version used to build the gem and the Ruby version used to run it. Please make sure that the Ruby version used locally is the same as the one used on CircleCI. You can install a newer version Ruby in the container by following this guide.
Inconsistent timeouts during test runs. If you are seeing your UI tests time out in some of the builds, please try using both the raw
xcodebuildcommand and the
xctoolcommand command we suggest here. Sometimes the issue would only be present with one of these tools but not the other.
Errors while installing code signing certificates. Please check out the Troubleshooting section of the code signing doc.
A note on code-generating tools
Many iOS app developers use tools that generate substantial amounts of code. In such cases CircleCI’s inference may not correctly detect the Xcode workspace, project, or scheme. Instead, you can specify these through environment variables.
Constraints on OS X-based builds
There are a few features normally available on CircleCI’s standard Linux containers that are not available for OS X builds at the moment:
- Parallelism is not supported
- While the general
circle.ymlfile structure will be honored in OS X-based builds configuration options, the following sections of
circle.ymlwill not work correctly:
machine: <language>, where
<language>is any language mentioned in the Configuration doc
Please see the customizing your build section for alternatives.
The following configuration will use all the default dependency steps
but will override the test steps with the specified commands.
The code signing will be performed with our built-in mechanism,
and all successful builds of the app on the
will be distributed to Crashlytics:
general: # if the application is *not* in the root of the repo but # in the sub-directory called "ios-app" build_dir: ios-app machine: xcode: version: "7.3" environment: # please specify your code signing identity name here GYM_CODE_SIGNING_IDENTITY: "iPhone Distribution: Acme Inc. (GL31ZZ3256)" test: override: - set -o pipefail && xcodebuild CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= -sdk iphonesimulator -destination 'platform=iOS Simulator,OS=9.0,name=iPhone 6' -workspace MyWorkspace.xcworkspace -scheme "My Scheme" clean build test | tee $CIRCLE_ARTIFACTS/xcode_raw.log | xcpretty --color --report junit --output $CIRCLE_TEST_REPORTS/xcode/results.xml deployment: beta_distribution: # just a label, can be anything branch: master commands: # this will build the ipa file - gym --scheme "App" --workspace "App.xcworkspace" - ipa distribute:crashlytics --crashlytics_path Crashlytics.framework --api_token "$CRASHLYTICS_API_KEY" --build_secret "$CRASHLYTICS_SECRET"