kraken-mobile 1.0.1 → 1.0.8

data/lib/kraken-mobile/runners/calabash/monkey/monkey_runner.rb

@@ -3,7 +3,7 @@ require 'kraken-mobile/helpers/feature_grouper'
 require 'kraken-mobile/runners/runner'
 require 'kraken-mobile/constants'
 require 'kraken-mobile/runners/calabash/android/apk_signer.rb'
-require 'kraken-mobile/runners/calabash/android/Operations'
+require 'kraken-mobile/runners/calabash/android/operations'
 require 'kraken-mobile/runners/calabash/android/monkey_helper'
 require 'kraken-mobile/protocols/file_protocol'
 require 'parallel'
@@ -72,7 +72,7 @@ module KrakenMobile
         default_device = operations_module::Device.new(operations_module, ENV["ADB_DEVICE_ARG"], ENV["TEST_SERVER_PORT"], ENV["APP_PATH"], ENV["TEST_APP_PATH"])
         install_app_with_calabash
         default_device.start_test_server_in_background
-        run_intelligent_monkey "#@user#{process_number}", 20
+        run_kraken_monkey "#@user#{process_number}", 20
         default_device.shutdown_test_server
         uninstall_app_with_calabash
 				puts "\n****** PROCESS #{process_number} COMPLETED ******\n\n"

data/lib/kraken-mobile/steps/general_steps.rb

@@ -0,0 +1,83 @@
+require 'kraken-mobile/helpers/kraken_faker'
+
+ParameterType(
+  name: 'property',
+  regexp: /[^\"]*/,
+  type: String,
+  transformer: lambda do |string|
+    if string_is_a_property?(string)
+      string.slice!('<')
+      string.slice!('>')
+      handle_property(string)
+    elsif string_is_a_faker_reuse?(string)
+      handle_faker_reuse(string)
+    elsif string_is_a_faker?(string)
+      handle_faker(string)
+    else
+      return string
+    end
+  end
+)
+
+private
+
+def current_process_id
+  tag_process_id = @scenario_tags.grep(/@user/).first
+  process_id = tag_process_id.delete_prefix('@user')
+  return 'ERROR: User not foud for scenario' if process_id.nil?
+
+  process_id
+end
+
+def string_is_a_property?(string)
+  string.start_with?('<') &&
+    string.end_with?('>')
+end
+
+def string_is_a_faker?(string)
+  string.start_with?('$')
+end
+
+def string_is_a_faker_reuse?(string)
+  string.start_with?('$$')
+end
+
+def handle_property(property)
+  properties = all_user_properties_as_json
+  process_id = current_process_id
+  user_id = "@user#{process_id}"
+
+  if !properties[user_id] || !properties[user_id][property]
+    raise "Property <#{property}> not found for @user#{current_process_id}"
+  end
+
+  properties[user_id][property]
+end
+
+def all_user_properties_as_json
+  raise 'ERROR: No properties file found' if ENV[K::PROPERTIES_PATH].nil?
+
+  properties_absolute_path = File.expand_path(ENV[K::PROPERTIES_PATH])
+  raise 'ERROR: Properties file not found' unless File.file?(
+    properties_absolute_path
+  )
+
+  file = open(properties_absolute_path)
+  content = file.read
+  file.close
+  JSON.parse(content)
+end
+
+def handle_faker(key)
+  faker = KrakenFaker.new(process_id: current_process_id)
+  faker.generate_value_for_key(
+    key: key
+  )
+end
+
+def handle_faker_reuse(key)
+  faker = KrakenFaker.new(process_id: current_process_id)
+  faker.reuse_value_for_key(
+    key: key
+  )
+end

data/lib/kraken-mobile/steps/mobile/kraken_steps.rb

@@ -0,0 +1,72 @@
+require 'calabash-android/calabash_steps'
+require 'kraken-mobile/utils/k.rb'
+require 'kraken-mobile/models/android_device'
+require 'kraken-mobile/steps/general_steps'
+
+Then(
+  /^I send a signal to user (\d+) containing "([^\"]*)"$/
+) do |process_id, signal|
+  device = Device.find_by_process_id(process_id)
+  raise 'ERROR: Device not found' if device.nil?
+  if process_id.to_s == current_process_id.to_s
+    raise 'ERROR: Can\'t send signal to same device'
+  end
+
+  device.write_signal(signal)
+end
+
+Then(/^I wait for a signal containing "([^\"]*)"$/) do |signal|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.read_signal(signal)
+end
+
+Then(
+  /^I wait for a signal containing "([^\"]*)" for (\d+) seconds$/
+) do |signal, seconds|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.read_signal(signal, seconds)
+end
+
+Then(/^I start a monkey with (\d+) events$/) do |number_of_events|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.run_monkey_with_number_of_events(number_of_events)
+end
+
+Then(/^I start kraken monkey with (\d+) events$/) do |number_of_events|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.run_kraken_monkey_with_number_of_events(number_of_events)
+end
+
+Then(/^I save device snapshot in file with path "([^\"]*)"$/) do |file_path|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.save_snapshot_in_file_path(file_path)
+end
+
+Then(/^I enter text "([^\"]*)"$/) do |text|
+  keyboard_enter_text(text, {})
+end

data/lib/kraken-mobile/steps/web/kraken_steps.rb

@@ -0,0 +1,91 @@
+require 'kraken-mobile/monkeys/web/web_monkey'
+require 'kraken-mobile/steps/general_steps'
+require 'kraken-mobile/utils/k.rb'
+require 'selenium-webdriver'
+require 'uri'
+
+Before do
+  @driver = Selenium::WebDriver.for((ENV['BROWSER'] || 'chrome').to_sym)
+end
+
+Given(/^I navigate to page "([^\"]*)"$/) do |web_url|
+  raise 'ERROR: Invalid URL' if web_url.nil?
+  raise 'ERROR: Invalid URL' unless web_url =~ URI::DEFAULT_PARSER.make_regexp
+
+  @driver.navigate.to web_url
+  sleep 2
+end
+
+Then(/^I enter "([^\"]*)" into input field having id "([^\"]*)"$/) do |text, id|
+  @driver.find_element(:id, id).send_keys(text)
+  sleep 2
+end
+
+Then(
+  /^I enter "([^\"]*)" into input field having css selector "([^\"]*)"$/
+) do |text, selector|
+  @driver.find_element(:css, selector).send_keys(text)
+  sleep 2
+end
+
+Then(/^I click on element having id "(.*?)"$/) do |id|
+  @driver.find_element(:id, id).click
+  sleep 2
+end
+
+Then(/^I wait for (\d+) seconds$/) do |seconds|
+  return if seconds.nil?
+
+  sleep seconds.to_i
+end
+
+Then(/^I should see text "(.*?)"$/) do |text|
+  @driver.page_source.include?(text)
+end
+
+# Kraken Steps
+Then(
+  /^I send a signal to user (\d+) containing "([^\"]*)"$/
+) do |process_id, signal|
+  device = Device.find_by_process_id(process_id)
+  raise 'ERROR: Device not found' if device.nil?
+  if process_id.to_s == current_process_id.to_s
+    raise 'ERROR: Can\'t send signal to same device'
+  end
+
+  device.write_signal(signal)
+end
+
+Then(/^I wait for a signal containing "([^\"]*)"$/) do |signal|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.read_signal(signal)
+end
+
+Then(
+  /^I wait for a signal containing "([^\"]*)" for (\d+) seconds$/
+) do |signal, seconds|
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.nil?
+  raise 'ERROR: Invalid scenario tag' if @scenario_tags.grep(/@user/).none?
+
+  device = Device.find_by_process_id(current_process_id)
+  raise 'ERROR: Device not found' if device.nil?
+
+  device.read_signal(signal, seconds)
+end
+
+Then(/^I start a monkey with (\d+) events$/) do |number_of_events|
+  monkey = WebMonkey.new(driver: @driver)
+  monkey.execute_kraken_monkey(number_of_events)
+end
+
+# Hooks
+AfterStep do |_scenario|
+  path = "#{ENV[K::SCREENSHOT_PATH]}/#{SecureRandom.hex(12)}.png"
+  @driver.save_screenshot(path)
+  embed(path, 'image/png', File.basename(path))
+end

data/lib/kraken-mobile/test_scenario.rb

@@ -0,0 +1,227 @@
+require 'kraken-mobile/helpers/feature_analyzer'
+require 'kraken-mobile/mobile/mobile_process'
+require 'kraken-mobile/models/feature_file'
+require 'kraken-mobile/models/web_device'
+require 'kraken-mobile/web/web_process'
+require 'kraken-mobile/utils/reporter'
+require 'kraken-mobile/mobile/adb'
+require 'kraken-mobile/utils/k.rb'
+require 'parallel'
+
+class TestScenario
+  #-------------------------------
+  # Fields
+  #-------------------------------
+  attr_accessor :devices
+  attr_accessor :kraken_app
+  attr_accessor :feature_file
+  attr_accessor :execution_id
+  attr_accessor :reporter
+
+  #-------------------------------
+  # Constructors
+  #-------------------------------
+  def initialize(kraken_app:, feature_file_path:)
+    @feature_file = FeatureFile.new(file_path: feature_file_path)
+    @devices = sample_devices
+    @kraken_app = kraken_app
+    @execution_id = Digest::SHA256.hexdigest(Time.now.to_f.to_s)
+    @reporter = Reporter.new(test_scenario: self)
+
+    ensure_apk_specified_if_necessary
+    setup_scenario_environment_variables
+  end
+
+  #-------------------------------
+  # Lifecycle
+  #-------------------------------
+  def before_execution
+    delete_all_web_inboxes
+    File.delete(K::DIRECTORY_PATH) if File.exist?(K::DIRECTORY_PATH)
+    File.delete(K::DICTIONARY_PATH) if File.exist?(K::DICTIONARY_PATH)
+    K::PROCESS_STATE_FILE_PATH.each do |_state, file_path|
+      File.delete(file_path) if File.exist?(file_path)
+    end
+    @reporter.create_report_folder_requirements
+  end
+
+  def run
+    unless @feature_file.right_syntax?
+      raise "ERROR: Verify feature file #{@file_path} has one unique @user tag"\
+      ' for each scenario'
+    end
+
+    before_execution
+    execute
+    after_execution
+  end
+
+  def after_execution
+    File.delete(K::DIRECTORY_PATH) if File.exist?(K::DIRECTORY_PATH)
+    File.delete(K::DICTIONARY_PATH) if File.exist?(K::DICTIONARY_PATH)
+    K::PROCESS_STATE_FILE_PATH.each do |_state, file_path|
+      File.delete(file_path) if File.exist?(file_path)
+    end
+    @reporter.save_report
+    notify_scenario_finished
+  end
+
+  #-------------------------------
+  # Methods
+  #-------------------------------
+  def execute
+    Parallel.map_with_index(
+      @devices, in_threads: @devices.count
+    ) do |device, index|
+      unless device.nil?
+        user_id = index + 1
+        start_process_for_user_id_in_device(
+          user_id, device
+        )
+      end
+    end
+  end
+
+  def self.ready_to_start?
+    process_ids = DeviceProcess.registered_process_ids
+    processes_ready = DeviceProcess.processes_in_state(
+      K::PROCESS_STATES[:ready_to_start]
+    )
+    process_ids.all? do |process_id|
+      processes_ready.include?(process_id) ||
+        Device.find_by_process_id(process_id)&.connected? == false
+    end
+  end
+
+  def self.ready_to_finish?
+    process_ids = DeviceProcess.registered_process_ids
+    processes_finished = DeviceProcess.processes_in_state(
+      K::PROCESS_STATES[:ready_to_finish]
+    )
+    process_ids.all? do |process_id|
+      processes_finished.include?(process_id) ||
+        Device.find_by_process_id(process_id)&.connected? == false
+    end
+  end
+
+  def requires_predefined_devices?
+    !ENV[K::CONFIG_PATH].nil?
+  end
+
+  private
+
+  def start_process_for_user_id_in_device(user_id, device)
+    if device.is_a? AndroidDevice
+      start_mobile_process_for_user_id_in_device(user_id, device)
+    elsif device.is_a? WebDevice
+      start_web_process_for_user_id_in_device(user_id, device)
+    else
+      raise 'ERROR: Platform not supported'
+    end
+  end
+
+  def start_mobile_process_for_user_id_in_device(user_id, device)
+    MobileProcess.new(
+      id: user_id,
+      device: device,
+      test_scenario: self
+    ).run
+  end
+
+  def start_web_process_for_user_id_in_device(user_id, device)
+    WebProcess.new(
+      id: user_id,
+      device: device,
+      test_scenario: self
+    ).run
+  end
+
+  def sample_devices
+    return predefined_devices if requires_predefined_devices?
+
+    mobile = sample_mobile_devices
+    web = sample_web_devices
+    @feature_file.sorted_required_devices.map do |device|
+      device[:system_type] == '@web' ? web.shift : mobile.shift
+    end
+  end
+
+  def sample_mobile_devices
+    android_devices = ADB.connected_devices
+    android_devices.sample(
+      @feature_file.number_of_required_mobile_devices
+    )
+  end
+
+  def sample_web_devices
+    web_devices = []
+    @feature_file.number_of_required_web_devices.times do
+      web_devices << WebDevice.factory_create
+    end
+    web_devices
+  end
+
+  def notify_scenario_finished
+    @kraken_app.on_test_scenario_finished
+  end
+
+  def user_id_is_mobile?(user_id)
+    complement_tags = @feature_file.tags_for_user_id(user_id).map(
+      &:downcase
+    )
+    complement_tags.include?('@mobile')
+  end
+
+  def user_id_is_web?(user_id)
+    complement_tags = @feature_file.tags_for_user_id(user_id).map(
+      &:downcase
+    )
+    complement_tags.include?('@web')
+  end
+
+  def delete_all_web_inboxes
+    Dir.glob(".*_#{K::INBOX_FILE_NAME}").each do |file|
+      File.delete(file)
+    end
+  end
+
+  def predefined_devices
+    config_absolute_path = File.expand_path(ENV[K::CONFIG_PATH])
+    file = open(config_absolute_path)
+    content = file.read
+    file.close
+    devices_json = JSON.parse(content).values
+    devices_json.map do |device_json|
+      if device_json['type'] == K::ANDROID_DEVICE
+        AndroidDevice.new(
+          id: device_json['id'], model: device_json['model']
+        )
+      elsif device_json['type'] == K::WEB_DEVICE
+        WebDevice.new(
+          id: device_json['id'], model: device_json['model']
+        )
+      else
+        raise 'ERROR: Platform not supported'
+      end
+    end
+  end
+
+  def apk_required?
+    sample_mobile_devices.any? && ENV[K::CONFIG_PATH].nil?
+  end
+
+  def ensure_apk_specified_if_necessary
+    return unless apk_required?
+    return unless @kraken_app&.apk_path.nil?
+
+    raise 'ERROR: Invalid APK file path'
+  end
+
+  def setup_scenario_environment_variables
+    return if @kraken_app.nil? || @reporter.nil?
+
+    @kraken_app.save_value_in_environment_variable_with_name(
+      name: K::SCREENSHOT_PATH, value: @reporter.screenshot_path
+    )
+  end
+end