Merge branch 'master' of https://github.com/ravelinx22/KrakenMobile

Author: ravelinx22

README.md

@@ -6,11 +6,14 @@ Kraken is an open source automated android E2E testing tool that supports and va
 
 Kraken uses [calabash-android](https://github.com/calabash/calabash-android) for running automated E2E tests in each device or emulator and [cucumber](https://github.com/cucumber/cucumber-ruby) for running your feature files written with Gherkin sintax. 
 
-**Requires Ruby ~ 2.3**
-
 ## Installation
 
-Installing and managing a Gem is done through the gem command. To Kraken's gem run the following command
+### Prerequisites
+
+Kraken requires Ruby 2.20 or higher but we recommend using ~2.3 version. We use calabash-android as runner, you can check their prerequisites at this [link](https://github.com/calabash/calabash-android/blob/master/documentation/installation.md)
+
+
+Installing and managing a Gem is done through the gem command. To install Kraken's gem run the following command
 
     $ gem install kraken-mobile
 
@@ -21,8 +24,129 @@ Signaling is a protocol used for the communication of two or more devices runnin
 
 ## Writing your first test
 
+### Generate cucumber feature skeleton
+
+First you need to generate the cucumber feature skeleton where your tests are going to be saved. To achieve this you should run `kraken-mobile gen`. It will create the skeleton in your current folder like this:
+
+    features
+    |_support
+    | |_app_installation_hooks.rb
+    | |_app_life_cycle_hooks.rb
+    | |_env.rb
+    |_step_definitions
+    | |_kraken_steps.rb
+    |_my_first.feature
+
+### Write a test
+
+The features goes in the features foler and should have the ".feature" extension.
+
+You can start out by looking at features/my_first.feature. You should also check calabash [predefined steps](https://github.com/calabash/calabash-android/blob/master/ruby-gem/lib/calabash-android/canned_steps.md).
+
+### Syntax
+
+In Kraken each feature is a test and each scenario within a feature is a test case that is run in a device. Each device is identified as an user and numbered from 1 to N. Ex: @user1, @user2, @user3. To check what is the number of a given device you should run `kraken-mobile devices`
+
+    List of devices attached
+    user1 - emulator-5554 - Android_SDK_built_for_x86
+    user2 - emulator-5556 - Android_SDK_built_for_x86
+
+After identifying what number each device has, you can write your test case giving each scenario the tag of a given device like so:
+
+    Feature: Example feature
+
+      @user1
+      Scenario: As a first user I say hi to a second user
+        Given I wait
+        Then I send a signal to user 2 containing "hi"
+
+      @user2
+      Scenario: As a second user I wait for user 1 to say hi
+        Given I wait for a signal containing "hi"
+        Then I wait
+
+## Kraken steps
+
+Kraken offers two main steps to help synchronizing your devices.
+
+### Signaling steps
+
+To wait for a signal coming from another device for 10 seconds that is Kraken default timeout use the following step.
+
+    Then /^I wait for a signal containing "([^\"]*)"$/
+
+To wait for a signal coming from another device for an specified number of seconds use the following step
+
+    Then /^I wait for a signal containing "([^\"]*)" for (\d+) seconds$/
+
+To send a signal to another specified device use the following step
+
+    Then /^I send a signal to user (\d+) containing "([^\"]*)"$/
+
+### Signaling functions
+
+Kraken internal implementation of the signaling steps use the following functions.
+
+#### readSignal(channel, content, timeout)
+
+Waits for a signal with the specified content in the channel passed by parameter. This functions waits for the specified number of seconds in the timeout parameter before throwing an exception.
+
+**Note: The channel parameter has to be the number of a device such as @user1, @user2, @userN**
+
+#### writeSignal(channel, content)
+
+Writes content to a channel passed by parameter.
+
+**Note: The channel parameter has to be the number of a device such as @user1, @user2, @userN**
+
 ## Running your tests
 
+To run your test:
+
+    kraken-mobile run <apk>
+
+Kraken with the help of Calabash-Android will install an instrumentation along with your app and will start your tests in all devices connected (Check Kraken Settings section in order to learn how to specify in what devices your tests should be run).
+
 ## Kraken Settings
 
+Kraken uses kraken_mobile_settings.json to specify in what devices the tests should be run.
+
+### Generate settings file
+
+The following command will show you the available connected devices or emulators and let you choose which ones you want to use.
+
+    kraken-mobile setup
+
+### Run tests with settings file
+
+    kraken-mobile run <apk> --configuration=<kraken_mobile_settings_path>
+
 ## Properties file
+
+Kraken uses properties files to store sensitive data such as passwords or api keys that should be used in your test cases.
+
+### Generate properties file
+
+The properties files should be a manually created json file with the following structure.
+
+    {
+      "@user1": {
+        "PASSWORD": "test"
+      },
+      "@user2": {
+        "PASSWORD": "test2"
+      }
+    }
+    
+### Use properties file in your test
+
+You can use the specified properties using the following sintax.
+
+    @user1
+    Scenario: As a kjkhdkjds
+        Given I wait
+        Then I see the text "<PASSWORD>"
+
+### Run tests with settings file
+
+    kraken-mobile run <apk> --properties=<kraken_mobile_properties_path>