Status	versioning	license	contributing

The Calabash iOS Server

The companion of the calabash-ios gem: https://github.com/calabash/calabash-ios

Building

Building dylibs now requires a Developer Team.

Requires Xcode 10.3 - 12.x

Requires ruby >= 2.3.*

$ git clone --recursive git@github.com:calabash/calabash-ios-server.git
$ cd calabash-ios-server
$ bundle

To build with an alternative Xcode:

$ DEVELOPER_DIR=/Xcode/10.1/Xcode-beta.app make < rule >

If you have build errors, see the xcpretty section below.

Maintainers must install the calabash/calabash-resign private repo. Details are below.

Non-maintainers will see code signing errors like:

No certificate matching 'Mac Developer: Karl Krukow (YTTN6Y2QS9)' for
team 'FYD86LA7RE': Select a different signing certificate for
CODE_SIGN_IDENTITY, a team that matches your selected certificate, or
switch to automatic provisioning.

when building - you must edit the code signing settings in the Xcode project for the target you are trying to build. Turning on automatic provisioning is usually the easiest solution.

Building the Framework

make framework

if you add this framework to your project, you should also add this lines to other linker flags: -force_load $(PROJECT_DIR)/calabash.framework/calabash

Building the XCFramework

make xcframework

if you add this xcframework to your project, you should also add this lines to other linker flags: if you use an iOS simulator then: -force_load $(PROJECT_DIR)/calabash.xcframework/ios-arm64_x86_64-simulator/libcalabash.a

if you use a physical iOS device then: -force_load $(PROJECT_DIR)/calabash.xcframework/ios-arm64_armv7/libcalabash.a

Building the dylibs

make dylibs

NOTE

If you are a maintainer, you must install the codesign tool if you are planning on making a Calabash iOS gem release.

• https://github.com/calabash/calabash-codesign

Building to embed in Calabash gem

See the calabash-ios/calabash-cucumber/Rakefile for more details.

$ cd path/to/calabash-ios/calabash-cucumber
$ bundle update
$ rake build_server

Testing

# Objective-C Unit tests.
$ make xct

# Building libraries.
$ make all

# Integration tests
$ make framework
$ make app-cal
$ bin/test/cucumber.sh

If you are running the XCTests from Xcode, you might see failures in LPJSONUtilsTest. If you do, clean (Shift + Option + Command + K) and rerun.

If you want to test the LPTestTarget on device and are having problems in Xcode or the command line with messages like this:

iPhone Developer: ambiguous matches

then you must either:

1. $ CODE_SIGN_IDENTITY="< cert name >" make ipa-cal (preferred)
2. Update the Xcode project with a specific Code Signing entity. DO NOT CHECK THESE CHANGES INTO GIT.

Maintainers should be using the Calabash.keychain (calabash/calabash-codesign).

Contributing

• The Calabash iOS Toolchain uses git-flow.
• Contributors should not bump the version.
• See the CONTRIBUTING.md guide.
• There is a style guide: STYLE_GUIDE.md.
• Pull-requests with unit tests will be merged faster.
• Pull-requests with Cucumber integration tests will be merged even faster.

Releasing

See the CONTRIBUTING.md document for instructions.

xcpretty

https://github.com/supermarin/xcpretty

We use xcpretty to make builds faster and to reduce the amount of logging. Travis CI, for example, has a limit on the number of lines of logging that can be generated; xcodebuild breaks this limit.

The only problem with xcpretty is that it does not report build errors very well. If you encounter an issue with any of the make rules, run without xcpretty:

$ XCPRETTY=0 make ipa

Licenses

Calabash iOS Server uses several third-party sources. You can find the licenses for these sources in the third-party-licenses directory.