A simple gem to generate all files needed in a project that will support calabash for both Android and iOS.
Calabash uses cucumber to support functional tests in Android and iOS and has one gem for each Platform:
calabash-android (for Android) (link)
calabash-cucumber (for iOS) (link)
The project structure is based on this site. The structure is based on three layers: features, steps and screens.
- Features: Contains all the features of the project, this features are Platform independent and will run for Android and iOS tests;
- Steps: Contains all the steps implementations. This steps are Platform independent and will run for Android and iOS tests;
- Screens: Contains all the Android and iOS screens. A screen must contain an identification, the declaration of all the elements of the screen and the declaration of its actions. This layer is Platform dependent. This occurs because, in almost every project, the identification of the elements varies between the Platforms. One example is that in Android almost all elements have an id, but in iOS the most common is to identify the elements by accessibility label. The Platform dependent screens must have the same name and same methods signatures. This will allow your steps to be unique between platforms
One example of this structure can be found in the generated files (see Usage) on the file base_steps.rb. This file implements some common steps to help you start your tests and show you how to uses the Platform dependent screens
In my experience with tests I saw some cases that we will need to test features that are Platform dependent, like screens that send SMS which will only apper in Android apps. When this happen, the generated structure has Features and Steps that are Platform dependent and can be found inside the folder
features/androidandfeatures/iosof the generated project.
Install it as:
$ gem install cs-bdd
In the terminal, type for help:
cs-bdd
cs-bdd generate
To see the gem version type:
cs-bdd version
To generate a project that support both Android and iOS features type:
cs-bdd new ProjectName
This command will create a folder named ProjectName in the current directory and will create all the needed files. This gem support localizations. To create a localized project, in Portuguese, type:
cs-bdd new ProjectName --lang=pt
The default language is English ('en'). The elements of Gherkin such as Given, When, Than, And, Scenario will be translated to all Gherkin supported languages, but this gem has a little quantity of translation files (see than in folder:
lib/cs/bdd/locales).
CS-BDD doesn't support your mother language? No problem. Fork it, create your yml translation file, uses the en.yml file as a template. Translate it and make a pull request. There are only 15 lines to be translated, this will take no time.
Don't you know how to name your translation yml file? See the Gherkin supported languages here for reference.
Once the project is created, open its folder (cd ProjectName) and run bundle install
This project supports both Android and iOS, so if you are on a PC you will not need the gems that are only for Macs, so you can run the command
bundle install --without mac_os
Remember to fix a calabash-cucumber version on the Gemfile. When updating the calabash-cucumber gem version you need to update the Calabash framework that was embeded on your iOS code. So I suggest doing the update manually. In this page you can find more informations on how to update the Calabash framework.
There are nine generators that are responsible to create the templates for Features, Step definitions and Screens.
The generators commands ONLY WORK in the ROOT FOLDER of the project.
####Features
cs-bdd generate feature FeatureName
The feature generator will create a Platform independent feature and its files. So this command will create the FeatureName.feature file inside the folder feature, the file FeatureName_steps.rb inside the folder features/step_definitions, the files FeatureName_screen.rb inside the folders features/android/screens and features/ios/screens.
cs-bdd generate aFeature AndroidFeatureName
cs-bdd generate iFeature iOSFeatureName
The aFeature and iFeature generator will create an Platform dependent feature. For example, the aFeature generator will create the AndroidFeatureName.feature file inside the folder features/android/features, the file AndroidFeatureName_steps.rb inside the folder features/androd/step_definitions and the screen file AndroidFeatureName_screen.rb inside the folder features/android/screens.
Don't forget about internationalization. All the generators accept the option --lang=pt or with some other language.
####Steps
cs-bdd generate step StepName
The step generator will create a Platform independent step file named StepName_steps.rb in the folder features/step_definitions
cs-bdd generate aStep AndroidStepName
The aStep generator will create an Android step file named AndroidStepName_steps.rb in the folder features/android/step_definitions
cs-bdd generate iStep iOSStepName
The iStep generator will create an iOS step file name iOSStepName_steps.rb in the folder features/ios/step_definitions
####Screens
cs-bdd generate screen ScreenName
The screen generator will create both Platform dependent screens in the folders features/android/screens and features/ios/screens.
cs-bdd generate aScreen AndroidScreenName
cs-bdd generate iScreen iOSScreenName
The aScreen and iScreen will create only the Android and iOS dependent screens respectively.
The project contains a lot of scripts that will help you to configure you CI server.
Documentation under development.
- Fork it ( https://github.com/CSOscarTanner/cs-bdd/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request