kraken-mobile 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a48ddcdc40dc988342ab4cd94ffa1e34abb22a93587c9c6f2f8ef31e6e85a757
-  data.tar.gz: c5a11c855e05688d304f3e2c79b2a95c928fd92cfedf035c8891b0d1c746ab6f
+  metadata.gz: 8a62f2fa104aef33dbd29eeb781a1af75ebeac4306038023d6fc1abd51235a5c
+  data.tar.gz: 9d3b50a9fa14ccb8e411ff760733be78f91b856e0f99805b24f67c837b0e03c4
 SHA512:
-  metadata.gz: d86f8f4bb10ebcd523afbfbd567922159596ec67765d2ed17b6b55203013ac88e680c123b4bab68561aca682cedd1c634eee75088aa114d1b077a1b153c0bef5
-  data.tar.gz: d8e5fb18604ab6778b1c79d0eab28686196b4eb4b86311a3d0682ebb6ab62d3c833d9be964d1ccf4c631cf762c99ac7b108dd74f1d6b0e4053d104c6db63fb31
+  metadata.gz: 0ef9c9887cdd96ea1fd702c93c1ca7ebaf98a889328927f8834e76a0f47a6f36a40d6d46617e765db1b7f51f1a38792db8d2796d6dd4a1157539236dbe7e38f9
+  data.tar.gz: 0a91cd009596a0adc065b72eafaff018e65797ad79bcdcadf03ba41bc530e871a7de736b00c4572d1cd0f776386e3be1b00a245c44773122d4dfc5a795c8e020

data/README.md

@@ -176,7 +176,7 @@ You can use the specified properties using the following sintax.
 
 ```Gherkin
 @user1
-Scenario: As a kjkhdkjds
+Scenario: As a user
     Given I wait
     Then I see the text "<PASSWORD>"
 ```
@@ -187,17 +187,51 @@ Scenario: As a kjkhdkjds
 kraken-mobile run <apk> --properties=<kraken_mobile_properties_path>
 ```
 
+# Use fake strings in tests
+
+Kraken offers a Fake string generator thanks to the Ruby gem [Faker](https://github.com/faker-ruby/faker), the list of supported faker types are listed as follows:
+
+* Name
+* Number
+* Email
+* String
+* String Date
+
+### Use a faker in a test
+
+Kraken keeps a record of every Fake string generated, thats why each string will have an id associated. To generate a Faker string you need to follow the structure "$FAKERNAME_ID".
+
+```Gherkin
+@user1
+Scenario: As a user
+    Given I wait
+    Then I enter text "$name_1" into field with id "view"
+```
+
+### Reusing a fake string
+
+As mentioned before, Kraken keeps record of every string generated with an id given to each string, this gives you the possibility of reusing this string later in your scenario. To reuse a string you can you need to append a $ character to the fake string as follows:
+
+```Gherkin
+@user1
+Scenario: As a user
+    Given I wait
+    Then I enter text "$name_1" into field with id "view"
+    Then I press "add_button"
+    Then I should see "$$name_1"
+```
+
 # Examples
 
 | Application  | Video | Feature File | Properties file | Settings File | Report Link |
 |:-------------|:-------------|:------------------|:-------|:-------|:-------|
-| Infinite Words | [video](https://www.youtube.com/watch?v=4lX7mO80w-4&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=3&t=0s)|[.feature](/examples/infinite-words/infinite_words.feature) | ---  | ---  | [report](/examples/infinite-words/report/index.html) |
-| QuizUp | [video](https://www.youtube.com/watch?v=2mhZVTK0r6k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=4&t=1s) | [.feature](/examples/quizup/quizup.feature) | --- |  --- | [report](/examples/quizup/report/index.html)  |
-| Spotify/Shazam | [video](https://www.youtube.com/watch?v=7AKsfY1KFX0&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=5&t=0s) | [.feature](/examples/shazam/shazam.feature) | [.json](/examples/shazam/kraken_properties.json) |  [.json](/examples/shazam/kraken_mobile_settings.json) | [report](/examples/shazam/report/index.html)  |
-| Spunky | [video](https://www.youtube.com/watch?v=WOhRWkdFaVk&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=6&t=25s) | [.feature](/examples/spunky/spunky.feature) | --- |  --- | [report](/examples/spunky/report/index.html)  |
-| Picap | [video](https://www.youtube.com/watch?v=RozQrmH_Z5k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=7&t=3s) | [.feature](/examples/picap/picap.feature) | [.json](/examples/picap/kraken_properties.json) |  --- | [report](/examples/picap/report/index.html)  |
-| AskFM | [video](https://www.youtube.com/watch?v=d9Gbdx8kFX8&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=8&t=0s) | [.feature](/examples/askfm/askfm.feature) | --- |  --- | [report](/examples/askfm/report/index.html)  |
-| Stick Men Fight | [video](https://www.youtube.com/watch?v=36OJKNj0nSo&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=9&t=4s) | [.feature](/examples/stick/stick.feature) | --- |  --- | [report](/examples/stick/report/index.html)  |
-| Tic Tac Toe | [video](https://www.youtube.com/watch?v=F9pDJDYsL_w&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=10&t=2s) | [.feature](/examples/tictactoe/tictactoe.feature) | --- |  --- | [report](/examples/tictactoe/report/index.html)  |
-| Tumblr | [video](https://www.youtube.com/watch?v=eqFej2uJz4k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=11&t=3s) | [.feature](/examples/tumblr/tumblr.feature) | [.json](/examples/tumblr/kraken_properties.json) |  --- | [report](/examples/tumblr/report/index.html)  |
-| F3 | [video](https://www.youtube.com/watch?v=vESh6Jyp-so&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=12&t=0s) | [.feature](/examples/f3/f3.feature) | [.json](/examples/f3/kraken_properties.json) |  --- | [report](/examples/f3/report/index.html)  |
+| Infinite Words | [video](https://www.youtube.com/watch?v=4lX7mO80w-4&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=3&t=0s)|[.feature](../gh-pages/examples/infinite-words/infinite_words.feature) | ---  | ---  | [report](../gh-pages/examples/infinite-words/report/index.html) |
+| QuizUp | [video](https://www.youtube.com/watch?v=2mhZVTK0r6k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=4&t=1s) | [.feature](../gh-pages/examples/quizup/quizup.feature) | --- |  --- | [report](../gh-pages/examples/quizup/report/index.html)  |
+| Spotify/Shazam | [video](https://www.youtube.com/watch?v=7AKsfY1KFX0&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=5&t=0s) | [.feature](../gh-pages/examples/shazam/shazam.feature) | [.json](../gh-pages/examples/shazam/kraken_properties.json) |  [.json](../gh-pages/examples/shazam/kraken_mobile_settings.json) | [report](../gh-pages/examples/shazam/report/index.html)  |
+| Spunky | [video](https://www.youtube.com/watch?v=WOhRWkdFaVk&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=6&t=25s) | [.feature](../gh-pages/examples/spunky/spunky.feature) | --- |  --- | [report](../gh-pages/examples/spunky/report/index.html)  |
+| Picap | [video](https://www.youtube.com/watch?v=RozQrmH_Z5k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=7&t=3s) | [.feature](../gh-pages/examples/picap/picap.feature) | [.json](../gh-pages/examples/picap/kraken_properties.json) |  --- | [report](../gh-pages/examples/picap/report/index.html)  |
+| AskFM | [video](https://www.youtube.com/watch?v=d9Gbdx8kFX8&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=8&t=0s) | [.feature](../gh-pages/examples/askfm/askfm.feature) | --- |  --- | [report](../gh-pages/examples/askfm/report/index.html)  |
+| Stick Men Fight | [video](https://www.youtube.com/watch?v=36OJKNj0nSo&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=9&t=4s) | [.feature](../gh-pages/examples/stick/stick.feature) | --- |  --- | [report](../gh-pages/examples/stick/report/index.html)  |
+| Tic Tac Toe | [video](https://www.youtube.com/watch?v=F9pDJDYsL_w&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=10&t=2s) | [.feature](../gh-pages/examples/tictactoe/tictactoe.feature) | --- |  --- | [report](../gh-pages/examples/tictactoe/report/index.html)  |
+| Tumblr | [video](https://www.youtube.com/watch?v=eqFej2uJz4k&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=11&t=3s) | [.feature](../gh-pages/examples/tumblr/tumblr.feature) | [.json](../gh-pages/examples/tumblr/kraken_properties.json) |  --- | [report](../gh-pages/examples/tumblr/report/index.html)  |
+| F3 | [video](https://www.youtube.com/watch?v=vESh6Jyp-so&list=PLF5U8kfVgRcJ3RCHt7cWmwlqN93brbVW-&index=12&t=0s) | [.feature](../gh-pages/examples/f3/f3.feature) | [.json](../gh-pages/examples/f3/kraken_properties.json) |  --- | [report](../gh-pages/examples/f3/report/index.html)  |

data/bin/kraken-mobile

@@ -1,91 +1,79 @@
 #!/usr/bin/env ruby
 
-require File.join(File.dirname(__FILE__), "kraken-mobile-helpers")
-require File.join(File.dirname(__FILE__), "kraken-mobile-setup")
-require File.join(File.dirname(__FILE__), "kraken-mobile-calabash-android")
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-require 'kraken-mobile'
+require File.join(File.dirname(__FILE__), 'kraken_mobile_helpers')
+require File.join(File.dirname(__FILE__), 'kraken_mobile_setup')
+require File.join(File.dirname(__FILE__), 'kraken_mobile_calabash_android')
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+require 'kraken_mobile'
 require 'kraken-mobile/constants'
 
 #-------------------------------
 # AGV reader helper
 #-------------------------------
 
-def read_specified_runner
-  runner_command = ARGV.select { |arg| arg.include?("--runner=") }.first
-  if runner_command
-    formatted_runner_command = runner_command.strip.downcase
-    formatted_runner_command.slice!("--runner=")
-    formatted_runner_command
-  end
-end
+def read_configuration
+  configuration_command = ARGV.select do |arg|
+    arg.include?('--configuration=')
+  end.first
+  return if configuration_command.nil?
 
-def read_specified_protocol
-  protocol_command = ARGV.select { |arg| arg.include?("--protocol=") }.first
-  if protocol_command
-    formatted_protocol_command = protocol_command.strip.downcase
-    formatted_protocol_command.slice!("--protocol=")
-    if KrakenMobile::Constants::SUPPORTED_PROTOCOLS.include?(formatted_protocol_command)
-      formatted_protocol_command
-    else # Protocol not supported.
-      raise "Specified protocol not supported."
-    end
-  else # If protocol not specified use file based as default.
-    KrakenMobile::Constants::FILE_PROTOCOL
-  end
+  configuration_command = configuration_command.strip.downcase
+  configuration_command.slice!('--configuration=')
+  configuration_command
 end
 
-def read_configuration
-  configuration_command = ARGV.select { |arg| arg.include?("--configuration=") }.first
-  if configuration_command
-    configuration_command = configuration_command.strip.downcase
-    configuration_command.slice!("--configuration=")
-    configuration_command
-  end
+def read_user_entered_properties_path
+  properties_command = ARGV.select { |arg| arg.include?('--properties=') }.first
+  return if properties_command.nil?
+
+  properties_command = properties_command.strip.downcase
+  properties_command.slice!('--properties=')
+  properties_command
 end
 
-def read_properties
-  properties_command = ARGV.select { |arg| arg.include?("--properties=") }.first
-  if properties_command
-    properties_command = properties_command.strip.downcase
-    properties_command.slice!("--properties=")
-    properties_command
-  end
+#-------------------------------
+# Helpers
+#-------------------------------
+
+def user_entered_apk_path
+  return nil if ARGV.first.nil?
+
+  first_argument = ARGV.first
+  return nil if first_argument.start_with?('--') # Is argument parameter not apk
+
+  File.expand_path(first_argument)
 end
 
 #-------------------------------
 # Command reader
 #-------------------------------
 
-if ARGV.length == 0
-    print_usage
+if ARGV.length.zero?
+  print_usage
 else
   cmd = ARGV.shift
   case cmd
-    when 'version'
-      require 'kraken-mobile/version'
-      puts KrakenMobile::VERSION
-    when 'devices'
-      require 'kraken-mobile/helpers/devices_helper/manager'
-      print_devices
-    when 'setup'
-      kraken_setup
-    else
-      runner_command = read_specified_runner()
-      protocol = read_specified_protocol()
-      configuration = read_configuration()
-      properties = read_properties()
-      if runner_command
-          case runner_command
-            when KrakenMobile::Constants::CALABASH_ANDROID
-              require File.join(File.dirname(__FILE__), "kraken-mobile-calabash-android")
-              handle_calabash_android(cmd, protocol, configuration, properties)
-            else
-              raise "Specified runner not supported."
-          end
-      else # If runner not specified use calabash android as default.
-        require File.join(File.dirname(__FILE__), "kraken-mobile-calabash-android")
-        handle_calabash_android(cmd, protocol, configuration, properties)
-      end
+  when 'version'
+    require 'kraken-mobile/version'
+    puts KrakenMobile::VERSION
+  when 'devices'
+    require 'kraken-mobile/helpers/devices_helper/manager'
+    print_devices
+  when 'setup'
+    KrakenSetup.new.run
+  when 'gen'
+    scaffold_folder_structure
+  when 'resign'
+    require 'calabash-android/helpers'
+    puts 'Resigning APK with Calabash-Android'
+    ensure_apk_is_specified
+    resign_apk(user_entered_apk_path)
+  when 'run'
+    require File.join(File.dirname(__FILE__), 'kraken_mobile_calabash_android')
+    configuration = read_configuration
+    user_entered_properties_path = read_user_entered_properties_path
+    handle_calabash_android(configuration, user_entered_properties_path)
+  else
+    print_usage
   end
 end

data/bin/kraken_mobile_calabash_android.rb

@@ -0,0 +1,39 @@
+@features_dir = File.join(FileUtils.pwd, 'features')
+@support_dir = File.join(@features_dir, 'support')
+@source_dir = File.join(
+  File.dirname(__FILE__),
+  '..',
+  'calabash-android-features-skeleton'
+)
+
+def handle_calabash_android(config_path, properties_path)
+  require 'kraken-mobile/constants'
+  require 'calabash-android/helpers'
+
+  kraken = KrakenApp.new(
+    apk_path: user_entered_apk_path,
+    properties_path: format_properties(properties_path),
+    config_path: format_config(config_path)
+  )
+  kraken.start
+end
+
+private
+
+def format_properties(properties_path)
+  return if properties_path.nil?
+
+  properties_absolute_path = File.expand_path(properties_path)
+  ensure_properties_is_valid(properties_absolute_path)
+
+  properties_absolute_path
+end
+
+def format_config(config_path)
+  return if config_path.nil?
+
+  config_absolute_path = File.expand_path(config_path)
+  ensure_configuration_is_valid(config_absolute_path)
+
+  config_absolute_path
+end

data/bin/kraken_mobile_helpers.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'fileutils'
+
+#-------------------------------
+# Helpers
+#-------------------------------
+
+def print_usage
+  puts <<USAGE
+  Usage: kraken-mobile <command-name> [parameters] [options]
+  <command-name> can be one of
+    run <apk>
+      runs Cucumber in the current folder with the environment needed.
+    version
+      prints the gem version.
+    devices
+      prints the list of devices attached.
+    setup
+      creates kraken-settings file specifying in what devices the tests are going to be run.
+    gen
+      generate a features folder structure.
+    resign <apk>
+      resigns the app with the currently configured keystore.
+USAGE
+end
+
+def print_devices
+  puts 'List of devices attached'
+  ADB.connected_devices.each_with_index do |device, index|
+    puts "user#{index + 1} - #{device.to_s.split(K::SEPARATOR).join(' - ')}"
+  end
+end
+
+def apk_file?(file_path)
+  file_path.end_with?('.apk') && File.exist?(file_path)
+end
+
+def relative_to_full_path(file_path)
+  File.expand_path(file_path)
+end
+
+def msg(title, &block)
+  puts "\n" + '-' * 10 + title + '-' * 10
+  block.call
+  puts '-' * 10 + '-------' + '-' * 10 + "\n"
+end
+
+def scaffold_folder_structure
+  if File.exist?(@features_dir)
+    puts 'A features directory already exists. Stopping...'
+    exit 1
+  end
+
+  msg('Question') do
+    puts 'I\'m about to create a subdirectory called features.'
+    puts 'features will contain all your kraken tests.'
+    puts 'Please hit return to confirm that\'s what you want.'
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+
+  FileUtils.cp_r(@source_dir, @features_dir)
+
+  msg('Info') do
+    puts "features subdirectory created. \n"
+  end
+end
+
+def ensure_apk_is_specified
+  return if !ARGV.empty? && apk_file?(ARGV.first)
+
+  puts 'The first parameter must be the path to a valid apk file.'
+  exit 1
+end
+
+def ensure_configuration_is_valid(configuration)
+  return if File.exist?(configuration) &&
+            File.file?(configuration) &&
+            configuration.end_with?('.json')
+
+  puts 'The path of the configuration file is not valid.'
+  exit 1
+end
+
+def ensure_properties_is_valid(properties)
+  return if File.exist?(properties) &&
+            File.file?(properties) &&
+            properties.end_with?('.json')
+
+  puts 'The path of the properties file is not valid.'
+  exit 1
+end

data/bin/kraken_mobile_setup.rb

@@ -0,0 +1,134 @@
+require 'io/console'
+require 'tty-prompt'
+
+class KrakenSetup
+  WEB_IDENTIFIER = 'Web'.freeze
+  IS_WEB_AVAILABLE_FOR_SELECTION = false
+
+  attr_accessor :prompt
+  attr_accessor :devices_connected_id
+  attr_accessor :settings
+
+  def initialize
+    @prompt = TTY::Prompt.new
+    @available_devices_ids = available_devices_ids_for_select
+    @settings = {}
+  end
+
+  def run
+    number_of_devices_required.times do |index|
+      user_id = index + 1
+      selected_device_id = select_device_for_user_with_id(user_id)
+      if selected_device_id == WEB_IDENTIFIER
+        handle_web_setup_for_user_with_id(user_id)
+      else
+        handle_mobile_setup_for_user_with_id(user_id, selected_device_id)
+      end
+    end
+    save_user_settings_to_file
+  end
+
+  private
+
+  def handle_web_setup_for_user_with_id(user_id)
+    save_web_device_settings_for_user_with_id(user_id: user_id)
+  end
+
+  def handle_mobile_setup_for_user_with_id(user_id, device_id)
+    selected_apk = select_apk_for_user_with_id(user_id)
+    save_mobile_device_settings_for_user_with_id(
+      user_id: user_id, apk: selected_apk,
+      device_id: device_id
+    )
+    delete_selected_device_id_from_available_devices(device_id)
+  end
+
+  def save_user_settings_to_file
+    open('kraken_mobile_settings.json', 'w') do |f|
+      f.puts @settings.to_json
+    end
+
+    puts 'Saved your settings to .kraken_mobile_settings. You can edit '\
+    'the settings manually or run this setup script again'
+  end
+
+  def number_of_devices_required
+    number_of_devices = -1
+    max_devices = max_number_of_devices
+    while number_of_devices <= 0 || number_of_devices > max_number_of_devices
+      number_of_devices = @prompt.ask(
+        'How many devices do you want to use?', convert: :int
+      )
+
+      if number_of_devices.zero?
+        @prompt.error('Number of devices can\'t be less than 1.')
+      end
+
+      if number_of_devices > max_devices
+        @prompt.error(
+          "You can run Kraken only in #{max_devices} device" \
+          "#{max_devices > 1 ? 's' : ''}"
+        )
+      end
+    end
+    number_of_devices
+  end
+
+  def delete_selected_device_id_from_available_devices(device_id)
+    @available_devices_ids.delete(device_id)
+  end
+
+  def save_mobile_device_settings_for_user_with_id(
+    user_id:, apk:, device_id:
+  )
+    device = ADB.connected_devices.select { |d| d.id == device_id }.first
+    @settings[user_id] = {
+      id: device_id,
+      model: device.model,
+      config: {
+        apk_path: apk
+      }
+    }
+  end
+
+  def save_web_device_settings_for_user_with_id(user_id:)
+    device = WebDevice.factory_create
+    @settings[user_id] = {
+      id: device.id,
+      model: device.model,
+      config: {}
+    }
+  end
+
+  def select_apk_for_user_with_id(id)
+    valid_apk = false
+
+    until valid_apk
+      entered_text = @prompt.ask(
+        "What APK user #{id} is going to run?", required: true
+      )
+      entered_apk_path = File.expand_path(entered_text)
+      valid_apk = apk_file?(File.expand_path(entered_apk_path))
+      @prompt.error('APK path is not valid.') unless valid_apk
+    end
+    entered_apk_path
+  end
+
+  def select_device_for_user_with_id(id)
+    @prompt.select(
+      "Choose your user #{id}", @available_devices_ids
+    )
+  end
+
+  def available_devices_ids_for_select
+    devices_connected_id = ADB.connected_devices.map(&:id)
+    devices_connected_id << WEB_IDENTIFIER if IS_WEB_AVAILABLE_FOR_SELECTION
+    devices_connected_id
+  end
+
+  def max_number_of_devices
+    return 100 if IS_WEB_AVAILABLE_FOR_SELECTION
+
+    ADB.connected_devices.count
+  end
+end