Behavior driven development with calabash for android

Behavior Driven
Development with
Calabash for Android
Teresa Holfeld | Ubilabs

Credits
Teresa Holfeld
Head of Mobile @ Ubilabs
@TeresaHolfeld
Selim Salman
Android Evangelist Engineer
@A_SelimS

Behavior Driven Development
We want to do Scrum.
We have a Product Owner who can’t code.
This Product Owner has to write Acceptance Criteria for our tickets.
We have to show them that the Acceptance Criteria are met.
Can we agree on some format that makes it easier for both of us?

Ruby: Cucumber
Language: Gherkin

Ruby: Cucumber
Language: Gherkin Given <some precondition>
When <some action by the actor>
Then <some testable outcome is achieved>

Ruby: Cucumber
Language: Gherkin
Mobile: Calabash
● Implements Cucumber
● Uses Gherkin
Given <some precondition>

Ruby: Cucumber
Language: Gherkin
Mobile: Calabash
● Implements Cucumber
● Uses Gherkin
Android: Calabash-android

Gherkin
● Simple Domain Specific Language (DSL) with
natural language constructs

Gherkin

Gherkin
Scenario: Multiple Givens
Given one thing
Given another thing
Given yet another thing
When I open my eyes
Then I see something
Then I don't see something else

Gherkin
Scenario: Multiple Givens
Given one thing
And another thing
And yet another thing
When I open my eyes
Then I see something
But I don't see something else

Cucumber
Cucumber:
● Software tool for writing automated acceptance tests in BDD
● Gherkin: Given - When - Then
● Origin: Ruby

Cucumber
Cucumber:
● Software tool for writing automated acceptance tests in BDD
● Gherkin: Given - When - Then
● Origin: Ruby
● Java, JavaScript, C#, PHP

Cucumber
Keywords:
● Feature
● Scenario
● Given, When, Then, And, But
● Background
● Scenario Outline
● Examples

Cucumber Feature, Scenario
Feature: Load tracks of the releases of a record label.
Scenario: As a user I want to load all tracks for all records of a given record label.
Given I see the record label “Rivulet Records”
And I see the record “Closed Sessions”
And I see the artist “Various”
When I press “Show all tracks”
And I wait for 3 seconds
Then I see “Sigil Magic, How To Lose Orientation, This Is The Game We Play, So Fi Trance,
Closed Session”

Cucumber Background
Feature: Load tracks of the releases of a record label.
Background:
Given I see a search field
When I type “Rivulet Records” into the search field
And I wait for 3 seconds
Then I see “Rivulet Records” # this is the record label
And I see “Closed Sessions” # this is the album
And I see the artist “Various”
[...]

Cucumber Scenario Outline, Examples
Scenario: As a user I want to load all tracks for the record “Closed Sessions” of the label
“Rivulet Records”.
Then I see “Sigil Magic, How To Lose Orientation, This Is The Game We Play, So Fi Trance,
Closed Session”
Scenario: As a user I want to load all tracks for the record “Floating Woven” of the label
“Paradise Now”.
Given I see the record label “Paradise Now”
And I see the record “Floating Woven”
Then I see “Gerold Dub, Meridia 02509, Floating Woven”

Cucumber Step Definitions
Given(/I see the record label “([^”]*)”$/) do |label|
puts “Record label: #{label}”
end

Calabash
Calabash:
● Framework for automated acceptance tests for iOS and Android
● By Xamarin
Calabash-android:
● Calabash testing framework for Android
● Uses Cucumber + Gherkin
● Ruby

Calabash
How does it work?
Android app wrapper around Robotium
Exposes view hierarchy as HTML server
Calabash Ruby framework talks to this HTML server

Calabash
Image source: https://anadea.info/blog/introduction-to-calabash

Behavior driven development with calabash for android

Calabash
Canned steps:
steps the framework already implemented for you
Step Definitions:
how to define your own steps
Ruby API:
what you can use for implementing your own steps

Calabash - Canned Steps
Check if text is there:
Then /^I see "([^"]*)"$/
Then /^I should see "([^"]*)"$/

Check if text is there:
Then /Î see "([^"]*)"$/
Then /Î should see "([^"]*)"$/
Check if text is not there:
Then /Î should not see "([^"]*)"$/
Then /Î don't see "([^"]*)"$/

Input actions:
Then /^I toggle checkbox number (d+)$/ do |index|
Then /^I enter "([^"]*)" into input field number (d+)$/ do |text, index|

Input actions:
Touching:
Then /^I press the "([^"]*)" button$/ do |text|
Then /^I click on screen (d+)% from the left and (d+)% from the top$/ do |x, y|

Input actions:
Touching:
Then /Î press the "([^"]*)" button$/ do |text|
Then /Î click on screen (d+)% from the left and (d+)% from the top$/ do |x, y|
Buttons:
Then /Î go back$/
Then /Î press the menu key$/

Gestures:
Then /^I swipe left$/
Then /^I scroll down$/

Gestures:
Waiting:
Then /^I wait for (d+) seconds$/ do |seconds|
Then /^I wait up to (d+) seconds for "([^"]*)" to appear$/ do |timeout, text|

Even more:
https://github.com/calabash/calabash-android/blob/master/ruby-gem/lib/calabash-
android/canned_steps.md

Calabash - Step Definitions
Then(/^I see a map$/) do
map_view = element_exists("MapView")
if not map_view
screenshot_and_raise "No map view found!"
end
end

Calabash - Step Definitions
Setting a geolocation:
Then(/^I set my location to (d+).(d+), (d+).(d+)$/) do |arg1, arg2, arg3, arg4|
lat = "#{arg1}.#{arg2}"
long = "#{arg3}.#{arg4}"
set_gps_coordinates(lat, long)
end

Calabash - Advanced Stuff
Referencing steps:
Given(/^I checked if notes are empty$/) do
steps %Q{
Given I see the "Notes" button
When I press the "Notes" button
Then I see "No notes."
}
end

Repeating steps:
Given(/^I entered (d+) note(?:s)?$/) do |n|
for i in 1..n.to_i
steps %Q{
Given I see "New Note"
When I press "New Note"
And I enter "Note #{i}" into the note field
And I press "Save"
Then I see "Note #{i}"
}
end
end

Calabash - Ruby API
> query("FrameLayout index:0")
[
[0] {
"id" => "content",
"enabled" => true,
"contentDescription" => nil,
"class" => "android.widget.FrameLayout",
"rect" => {
"center_y" => 617.0,
"center_x" => 384.0,
"height" => 1134,
"y" => 50,
"width" => 768,
"x" => 0
},
"description" => "android.widget.FrameLayout{41f40dc0 V.E..... ........ 0,50-768,1184 #1020002
android:id/content}"
}
]

Calabash - Ruby API
element_exists(uiquery)
element_does_not_exist(uiquery)

Calabash - Ruby API
element_exists(uiquery)
element_does_not_exist(uiquery)
wait_for_elements_exist(elements_arr, options={})
wait_for_elements_exist( ["button marked:'OK'", "* marked:'Cancel'"], :timeout => 2)

Calabash - Ruby API
fail(msg)
fail(msg="Error. Check log for details.")

Calabash - Ruby API
fail(msg)
screenshot(options={:prefix=>nil, :name=>nil})
screenshot({:prefix => "/tmp", :name => "my.png"})

Calabash - Ruby API
fail(msg)
screenshot(options={:prefix=>nil, :name=>nil})
screenshot({:prefix => "/tmp", :name => "my.png"})
screenshot_and_raise(msg, options)
screenshot_and_raise(msg="Error. Check log for details.",
options={:prefix => "/tmp", :name => "error.png"})

Calabash - Ruby API
And much more:
https://github.com/calabash/calabash-android/blob/master/documentation/ruby_ap
i.md

Calabash - Documentation and Tutorials
Calabash Android GitHub:
https://github.com/calabash/calabash-android
Calabash Ruby API:
https://github.com/calabash/calabash-android/blob/master/documentation/ruby_ap
i.md
Calabash Developer Site:
https://developer.xamarin.com/guides/testcloud/calabash/
Testmunk Documentation and Tutorials:
https://testmunk.readthedocs.io/en/latest/

Alternatives
● Cucumber-android + Espresso
● Espresso and comments
● JBehave
● Concordion
● JDave
● Easyb

Yay or nay?
+ Serves as a technical documentation
+ Non-tech staff can understand
+ Enforces well-defined acceptance criteria
+ Easy to run, easy to learn
- Comes with overhead: have to develop steps in Ruby
- You have to implement certain things yourself
(e.g. scrolling in RecyclerView)
- You need to convince your Product Owner to write acceptance criteria m(

Teresa Holfeld
Head of Mobile @ Ubilabs
@TeresaHolfeld

www.ubilabs.net/jobs
And also thank you for listening.
Questions welcome!

Resuming an Activity:
Then(/^I resume the app$/) do
system("#{default_device.adb_command} shell am start -n
com.example.calabash.MainActivity")
end

Gestures:
Then /Î swipe right$/
Then /Î scroll up$/
Then /Î select "([^"]*)" from the menu$/ do |identifier|
Then /Î drag from (d+):(d+) to (d+):(d+) moving with (d+) steps$/ do
|from_x, from_y, to_x, to_y, steps|
x:y co-ordinates are expressed as percentages of the screen width:height.

Waiting:
Then /Î wait for 1 second$/ # 1 second
Then /Î wait for a second$/ # 1 second
Then /Î wait$/ # 2 seconds
Then /Î wait for (d+) seconds$/ do |seconds| # specified number of seconds

Waiting:
Then /Î wait for 1 second$/ # 1 second
Then /Î wait for a second$/ # 1 second
Then /Î wait$/ # 2 seconds
Then /Î wait for (d+) seconds$/ do |seconds| # specified number of seconds
Then /Î wait for "([^"]*)" to appear$/ do |text|
Then /Î wait up to (d+) seconds for "([^"]*)" to appear$/ do |timeout, text|
Then /Î wait up to (d+) seconds to see "([^"]*)"$/ do |timeout, †ext|

Behavior driven development with calabash for android

More Related Content

Viewers also liked (7)

Similar to Behavior driven development with calabash for android (20)

Recently uploaded (8)

Behavior driven development with calabash for android