Skip to content
This repository has been archived by the owner on Mar 2, 2023. It is now read-only.

Latest commit

 

History

History
235 lines (149 loc) · 9.17 KB

calabash_ios_installation.md

File metadata and controls

235 lines (149 loc) · 9.17 KB

(the original README guide is located here. This is an adjusted fork and mostly includes the most important bits for this Guru Session)

Calabash for iOS

The rest of this guide was writting using XCode 5, but should also work for XCode versions >= 4.3.

NOTE about Xcode 4.3 after upgrading to Xcode 4.3, also install the command line tools if you have not already, from the preferences pane under "Downloads" in Xcode. Type

sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer

Installation

Prerequisites

You need to have Ruby installed. This is installed by default on MacOSX.

Verify by running ruby -v in a terminal - it should print "ruby 1.8.7" (or higher). We do recommend using Ruby 2.0+.

Fast track

Note: Fast track is EXPERIMENTAL, but in our experience it works for most iOS projects. But there are some project setups where it does not.

If it doesn't work in your project, you should read the section "Manual setup with Xcode" below.

For automatic setup:

  1. In a terminal, go to your iOS project

    • cd path-to-my-ios-project (i.e. directory containing .xcodeproj file)

  2. Install calabash-cucumber gem (this make take some time because of dependencies)

    • gem install calabash-cucumber
    • Note you may need to run sudo gem install calabash-cucumber if you see ERROR: While executing gem ... (Gem::FilePermissionError)).

  3. Setup your project for Calabash-iOS.

    • calabash-ios setup Answer the questions and read the output :)

  4. Generate a skeleton features folder for your tests

    • calabash-ios gen

  5. In Xcode, build your project using the -cal scheme

    • -cal scheme

  6. Run the generated test!

    • cucumber

If all goes well, you are now ready to write your first test. Start by editing the file features/my_first.feature.

Cocoapods

At the time of writing Cocoapods are not yet supported.

Until then, please se this nice article http://angelolloqui.com/blog/25-Acceptance-testing-with-Calabash-and-CocoaPods by @angelolloqui.

Manual setup with Xcode

Background

To use Calabash for iOS in your app, you must do two things: link with our framework: calabash.framework, and install a ruby gem as described below. You also need to link with Apple's CFNetwork framework if you are not already using this.

For functional testing with Calabash iOS, you should create a whole separate target by duplicating your production target in Xcode (explained below).

Ruby and calabash-cucumber gem.

  • Install the calabash-cucumber gem. (You may need to do sudo gem install calabash-cucumber)

    m2mobi:~$ gem install calabash-cucumber
Successfully installed calabash-cucumber-0.9.47
1 gem installed
Installing ri documentation for calabash-cucumber-0.9.47...
Installing RDoc documentation for calabash-cucumber-0.9.47...

Setting up Xcode project

Instructions:

  • Step 1/3 is to duplicate your primary/production target.
  • Select your project in XCode and select your production target for your app.
  • Right click (or two-finger tap) your target and select "Duplicate target"
  • Select "Duplicate only" (not transition to iPad)
  • Rename your new target from ".. copy" to "..-cal"
  • From the menu select Edit Scheme and select manage schemes.
  • Rename the new scheme from ".. copy" to "..-cal"
  • Optionally, set the Product name to ..-cal in Build settings for the new target.

  • Step 2/3: Link with framework.

    • Download the latest version of calabash.framework with calabash-ios gem command:

    • calabash-ios download

    • Use Finder to open the folder that contains calabash.framework.

    • Drag calabash.framework from Finder into your project's Frameworks folder in Xcode.

      • Make sure that
        1. Copy items into destination group's folder (if needed) is checked and
        2. only your "-cal " target is checked in Add to targets.

      Linking with calabash.framework

    • You must also link you -cal target with CFNetwork.framework (unless your production target is already linking with CFNetwork). To do this click on your -cal target in XCode. Click on Build Phases, expand Link Binary with Libraries, click + to add CFNetwork.framework.

  • Step 3/3: cal-Target Build Settings

  • Click on your project and select your new "-cal" target.
  • Select "Build Settings".
  • Ensure that "All" and not "Basic" settings are selected in "build settings".
  • Find "Other Linker Flags" (you can type "other link" in the search field).
  • Ensure that "Other linker flags" contains: -force_load "$(SRCROOT)/calabash.framework/calabash" -lstdc++

Note: Now that you have created a separate target, new files that you add to your project are not automatically added to your -LP target. Make sure that any new files you add to your production target are also added to your -LP target.

This screenshot is a reference for you build settings.

Build settings

Test that calabash.framework is loaded.

Make sure you select your "..-cal" scheme and then run you app on 4.x/5 simulator.

Verify that you see console output like

2012-01-19 LPSimpleExample[4318:11603] Creating the server: <HTTPServer: 0x7958d70>
2012-01-19 LPSimpleExample[4318:11603] HTTPServer: Started HTTP server on port 37265
2012-01-19 LPSimpleExample[4318:13903] Bonjour Service Published: domain(local.) type(_http._tcp.) name(Calabash Server)

Troubleshooting Installation

On Mountain Lion with Ruby 1.8.x, you may see an error like this:

~$ sudo gem install calabash-cucumber
Password:
Building native extensions.  This could take a while...
ERROR:  Error installing calabash-android:
ERROR: Failed to build gem native extension.

/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby extconf.rb
mkmf.rb can't find header files for ruby at /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/ruby.h

One possible cause can be not having the correct Command Line Tools (compiler tool chain) for your OS X release. For example, for OS X 10.8 "Mountain Lion" you need the "Mountain Lion" version of these. You can install them from Xcode Preferences pane (in the Download tab).

Important notice

The Calabash framework uses private Apple APIs to synthesize touch events. This means that you should double check that calabash.framework is not included in the .ipa file you submit to App Store. This is usually done by creating a separate build configuration or target for the version of your app running calabash tests.

An experimental check can be done by the calabash-ios tool

calabash-ios check PATH_TO_IPA_OR_APP

This is not guaranteed to work; it is your responsibility to ensure that the framework is properly installed.

Installation details

If you're interested in what's going on you can read the installation details here.

How does automated setup work?

Verify that you have installed calabash-cucumber correctly by running calabash-ios from the command line:

$ calabash-ios
Usage: calabash-ios <command-name> [parameters]
<command-name> can be one of
    help
     prints more detailed help information.
    gen
     generate a features folder structure.
    setup (EXPERIMENTAL) [opt path]?
     setup your XCode project for calabash-ios
  ...

When you run calabash-ios setup and answer any questions it might ask the following happens:

Note that calabash-ios will backup your project file:

$ calabash-ios setup
Checking if Xcode is running...
----------Info----------
Making backup of project file: ~/sample/sample.xcodeproj/project.pbxproj
...

The project file is copied to project.pbxproj.bak. In case something goes wrong you can move this file back to project.pbxproj (in your .xcodeproj) folder.

Setup will modify your xcode project file to use Calabash iOs. You should now have a new Scheme named [target]-cal in Xcode:

-cal scheme

calabash-ios setup does the following:

  • creates a new -cal target as a copy of your primary target
  • add the calabash.framework to your Frameworks folder
  • add $(SRCROOT) to framework search path (for that target)
  • link with calabash.framework (for that target)
  • link with Apple's CFNetwork.framework (for that target)
  • set the special -force_load and -lstdc++ linker flags (for that target)

License

calabash-cucumber Copyright (c) LessPainful APS. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.