kraken-mobile 1.0.4 → 1.0.5

data/lib/kraken-mobile/hooks/mobile_kraken_hooks.rb

@@ -0,0 +1,15 @@
+require 'calabash-android/management/adb'
+require 'calabash-android/operations'
+
+Before do |scenario|
+  # install_app_with_calabash
+  @scenario_tags = scenario.source_tag_names
+end
+
+After do |scenario|
+  @scenario_tags = scenario.source_tag_names
+end
+
+AfterStep do |_scenario|
+  screenshot_embed
+end

data/lib/kraken-mobile/hooks/mobile_operations.rb

@@ -0,0 +1,36 @@
+require 'calabash-android/management/adb'
+require 'calabash-android/operations'
+require 'kraken-mobile/test_scenario'
+
+def start_test_kraken_server_in_background
+  start_test_server_in_background
+
+  DeviceProcess.notify_process_state(
+    process_id: process_id,
+    state: K::PROCESS_STATES[:ready_to_start]
+  )
+
+  Timeout.timeout(K::DEFAULT_START_TIMEOUT_SECONDS, RuntimeError) do
+    sleep(1) until TestScenario.ready_to_start?
+  end
+end
+
+def shutdown_test_kraken_server
+  DeviceProcess.notify_process_state(
+    process_id: process_id,
+    state: K::PROCESS_STATES[:ready_to_finish]
+  )
+
+  Timeout.timeout(K::DEFAULT_FINISH_TIMEOUT_SECONDS, RuntimeError) do
+    sleep(1) until TestScenario.ready_to_finish?
+  end
+
+  shutdown_test_server
+end
+
+private
+
+def process_id
+  tag_process_id = @scenario_tags.grep(/@user/).first
+  tag_process_id.delete_prefix('@user')
+end

data/lib/kraken-mobile/hooks/web_operations.rb

@@ -0,0 +1,33 @@
+require 'kraken-mobile/test_scenario'
+
+def start_test_kraken_server_in_background(scenario:)
+  @scenario_tags = scenario.source_tag_names
+  DeviceProcess.notify_process_state(
+    process_id: process_id(scenario: scenario),
+    state: K::PROCESS_STATES[:ready_to_start]
+  )
+
+  Timeout.timeout(K::DEFAULT_START_TIMEOUT_SECONDS, RuntimeError) do
+    sleep(1) until TestScenario.ready_to_start?
+  end
+end
+
+def shutdown_test_kraken_server(scenario:)
+  @scenario_tags = scenario.source_tag_names
+  DeviceProcess.notify_process_state(
+    process_id: process_id(scenario: scenario),
+    state: K::PROCESS_STATES[:ready_to_finish]
+  )
+
+  Timeout.timeout(K::DEFAULT_FINISH_TIMEOUT_SECONDS, RuntimeError) do
+    sleep(1) until TestScenario.ready_to_finish?
+  end
+end
+
+private
+
+def process_id(scenario:)
+  scenario_tags = scenario.source_tag_names
+  tag_process_id = scenario_tags.grep(/@user/).first
+  tag_process_id.delete_prefix('@user')
+end

data/lib/kraken-mobile/mobile/adb.rb

@@ -0,0 +1,66 @@
+require 'kraken-mobile/models/android_device'
+require 'kraken-mobile/constants'
+require 'kraken-mobile/mobile/android_commands.rb'
+
+class ADB
+  class << self
+    include Android::Commands
+
+    def connected_devices
+      devices = []
+      adb_devices_l.split("\n").each do |line|
+        id = extract_device_id(line)
+        model = extract_device_model(line)
+        next if id.nil? || model.nil?
+
+        devices << AndroidDevice.new(id: id, model: model)
+      end
+      devices
+    rescue StandardError => _e
+      raise 'ERROR: Can\'t read Android devices connected.'
+    end
+
+    def device_screen_size(device_id:)
+      adb_size = screen_size_for_device_with_id(device_id: device_id)
+      extract_device_screen_size_info(adb_size)
+    rescue StandardError => _e
+      raise "ERROR: Can\'t read Android device #{device_id} screen size."
+    end
+
+    def save_snapshot_for_device_with_id_in_file_path(device_id:, file_path:)
+      save_snapshot_for_device_with_id_in_path(
+        device_id: device_id,
+        file_path: file_path
+      )
+    rescue StandardError => _e
+      raise "ERROR: Can\'t save snapshot for device #{device_id}."
+    end
+
+    def device_sdk_version(device_id:)
+      version = sdk_version_for_device_with_id(device_id: device_id)
+      version.strip
+    rescue StandardError => _e
+      raise "ERROR: Can\'t get SDK version for device #{device_id}."
+    end
+
+    private
+
+    def extract_device_id(line)
+      return line.split(' ').first if line.match(/device(?!s)/)
+    end
+
+    def extract_device_model(line)
+      return unless line.match(/device(?!s)/)
+
+      line.scan(/model:(.*) device/).flatten.first
+    end
+
+    def extract_device_screen_size_info(line)
+      parts = line.strip!.split(' ')
+      size = parts[parts.count - 1]
+      return [0, 0] unless size.include?('x')
+
+      size.split('x').map(&:to_i)
+    end
+  end
+end

data/lib/kraken-mobile/mobile/android_commands.rb

@@ -0,0 +1,43 @@
+module Android
+  module Commands
+    # List of connected devices/emulators
+    def adb_devices_l
+      `adb devices -l`
+    end
+
+    def file_content(device_id:, file_name:)
+      `adb -s #{device_id} shell "cat /sdcard/#{file_name} 2> /dev/null"`
+    end
+
+    def write_content_to_file_with_name_in_device(
+      content:, device_id:, file_name:
+    )
+      `adb -s #{device_id} shell "echo "#{content}" > /sdcard/#{file_name}"`
+    end
+
+    def create_file_with_name_in_device(device_id:, file_name:)
+      `adb -s #{device_id} shell "> /sdcard/#{file_name}"`
+    end
+
+    def delete_file_with_name_in_device(device_id:, file_name:)
+      `adb -s #{device_id} shell "rm -rf /sdcard/#{file_name}"`
+    end
+
+    def device_orientation(device_id:)
+      `adb -s #{device_id} shell dumpsys input | grep 'SurfaceOrientation' \
+      | awk '{ print $2 }'`
+    end
+
+    def screen_size_for_device_with_id(device_id:)
+      `adb -s #{device_id} shell wm size`
+    end
+
+    def save_snapshot_for_device_with_id_in_path(device_id:, file_path:)
+      `adb -s #{device_id} shell cat /sdcard/window_dump.xml > #{file_path}`
+    end
+
+    def sdk_version_for_device_with_id(device_id:)
+      `adb -s #{device_id} shell getprop ro.build.version.sdk`
+    end
+  end
+end

data/lib/kraken-mobile/mobile/mobile_process.rb

@@ -0,0 +1,82 @@
+require 'kraken-mobile/device_process.rb'
+require 'kraken-mobile/utils/k'
+
+class MobileProcess < DeviceProcess
+  #-------------------------------
+  # Required methods
+  #-------------------------------
+  def before_execute
+    register_process_to_directory
+    device.create_inbox
+  end
+
+  def after_execute
+    device.delete_inbox
+  end
+
+  def execute
+    open(execution_command, 'r') do |output|
+      loop do
+        $stdout.print output.readline.to_s
+        $stdout.flush
+      end
+    end
+    $CHILD_STATUS.exitstatus
+  rescue EOFError
+    nil
+  end
+
+  #-------------------------------
+  # Methods
+  #-------------------------------
+
+  def apk_path
+    return config_apk_path if @test_scenario.requires_predefined_devices?
+
+    path = @test_scenario&.kraken_app&.apk_path
+    raise 'ERROR: Invalid APK file path' if path.nil?
+
+    path
+  end
+
+  private
+
+  def execution_command
+    feature_path = test_scenario.feature_file.file_path
+    raise 'ERROR: Invalid feature file path' if feature_path.nil?
+
+    process_apk_path = apk_path
+    raise 'ERROR: Invalid APK file path' if process_apk_path.nil?
+
+    "|ADB_DEVICE_ARG=#{device.id} calabash-android run #{process_apk_path} "\
+    "#{feature_path} --tags @user#{id} --format pretty --format json -o "\
+    "#{K::REPORT_PATH}/#{@test_scenario.execution_id}/#{device.id}/#{K::FILE_REPORT_NAME}" # TODO, folder to save all things
+  end
+
+  #-------------------------------
+  # Helpers
+  #-------------------------------
+
+  def config_json
+    config_absolute_path = File.expand_path(ENV[K::CONFIG_PATH])
+    file = open(config_absolute_path)
+    content = file.read
+    JSON.parse(content)[@id.to_s] || {}
+  end
+
+  def config_apk_path
+    device_config_json = config_json
+    return if device_config_json['config'].nil?
+    return if device_config_json['config']['apk_path'].nil?
+
+    absolute_config_apk_path = File.expand_path(
+      device_config_json['config']['apk_path']
+    )
+
+    raise 'ERROR: Invalid config apk path' unless File.file?(
+      absolute_config_apk_path
+    )
+
+    absolute_config_apk_path
+  end
+end

data/lib/kraken-mobile/models/android_device.rb

@@ -0,0 +1,121 @@
+require 'kraken-mobile/models/device'
+require 'kraken-mobile/mobile/adb'
+require 'kraken-mobile/monkeys/mobile/kraken_android_monkey'
+require 'kraken-mobile/monkeys/mobile/android_monkey'
+
+class AndroidDevice < Device
+  include KrakenAndroidMonkey
+  include AndroidMonkey
+
+  #-------------------------------
+  # Signaling
+  #-------------------------------
+  def create_inbox
+    raise 'ERROR: Device is disconnected.' unless connected?
+
+    ADB.create_file_with_name_in_device(
+      device_id: @id,
+      file_name: K::INBOX_FILE_NAME
+    )
+  end
+
+  def delete_inbox
+    raise 'ERROR: Device is disconnected.' unless connected?
+
+    ADB.delete_file_with_name_in_device(
+      device_id: @id,
+      file_name: K::INBOX_FILE_NAME
+    )
+  end
+
+  def write_signal(signal)
+    ADB.write_content_to_file_with_name_in_device(
+      content: signal,
+      device_id: @id,
+      file_name: K::INBOX_FILE_NAME
+    )
+  end
+
+  def read_signal(signal, timeout = K::DEFAULT_TIMEOUT_SECONDS)
+    Timeout.timeout(timeout, RuntimeError) do
+      sleep(1) until inbox_last_signal == signal
+    end
+  end
+
+  #-------------------------------
+  # More interface methods
+  #-------------------------------
+  def connected?
+    ADB.connected_devices.any? do |device|
+      device.id == @id
+    end
+  end
+
+  def orientation
+    ADB.device_orientation(
+      device_id: @id
+    ).strip!.to_i
+  rescue StandardError => _e
+    K::ANDROID_PORTRAIT
+  end
+
+  def screen_size
+    size = ADB.device_screen_size(device_id: @id)
+
+    height = orientation == K::ANDROID_PORTRAIT ? size[1] : size[0]
+    width = orientation == K::ANDROID_PORTRAIT ? size[0] : size[1]
+
+    [height, width]
+  end
+
+  def sdk_version
+    ADB.device_sdk_version(device_id: @id)
+  end
+
+  def type
+    K::ANDROID_DEVICE
+  end
+
+  def save_snapshot_in_file_path(file_path)
+    raise 'ERROR: Invalid snapshot file path' if file_path.nil?
+
+    absolute_path = File.expand_path(file_path)
+    raise 'ERROR: File already exists' if File.file?(absolute_path)
+
+    ADB.save_snapshot_for_device_with_id_in_file_path(
+      device_id: @id,
+      file_path: absolute_path
+    )
+  end
+
+  #-------------------------------
+  # Random testing
+  #-------------------------------
+  def run_monkey_with_number_of_events(number_of_events)
+    execute_monkey(number_of_events)
+  end
+
+  def run_kraken_monkey_with_number_of_events(number_of_events)
+    execute_kraken_monkey(number_of_events)
+  end
+
+  #-------------------------------
+  # Helprs
+  #-------------------------------
+  def calabash_default_device
+    operations_module = Calabash::Android::Operations
+    operations_module::Device.new(
+      operations_module,
+      ENV['ADB_DEVICE_ARG'],
+      ENV['TEST_SERVER_PORT'],
+      ENV['APP_PATH'],
+      ENV['TEST_APP_PATH']
+    )
+  end
+
+  private
+
+  def inbox_last_signal
+    ADB.file_content(device_id: @id, file_name: K::INBOX_FILE_NAME).strip
+  end
+end

data/lib/kraken-mobile/models/device.rb

@@ -1,32 +1,114 @@
-module KrakenMobile
-	module Models
-		class Device
-
-      #-------------------------------
-      # Fields
-      #-------------------------------
-			attr_accessor :id
-			attr_accessor :model
-      attr_accessor :position
-      attr_accessor :config
-
-      #-------------------------------
-      # Constructors
-      #-------------------------------
-			def initialize(id, model, position, config = {})
-				@id = id
-				@model = model
-        @position = position
-        @config = config
-			end
-
-      #-------------------------------
-      # Helpers
-      #-------------------------------
-			def screenshot_prefix
-				@id.gsub('.', '_').gsub(/:(.*)/, '').to_s + '_'
-			end
-
-		end
-	end
+require 'kraken-mobile/device_process'
+
+class Device
+  #-------------------------------
+  # Fields
+  #-------------------------------
+  attr_accessor :id
+  attr_accessor :model
+
+  #-------------------------------
+  # Constructors
+  #-------------------------------
+  def initialize(id:, model:)
+    @id = id
+    @model = model
+  end
+
+  #-------------------------------
+  # Signaling
+  #-------------------------------
+  def create_inbox
+    raise 'ERROR: create_inbox not implemented.'
+  end
+
+  def delete_inbox
+    raise 'ERROR: delete_inbox not implemented.'
+  end
+
+  def write_signal(_signal)
+    raise 'ERROR: write_signal not implemented.'
+  end
+
+  def read_signal(_signal, _timeout = K::DEFAULT_TIMEOUT_SECONDS)
+    raise 'ERROR: read_signal not implemented.'
+  end
+
+  #-------------------------------
+  # Random testing
+  #-------------------------------
+  def run_monkey_with_number_of_events(_number_of_events)
+    raise 'ERROR: run_monkey_with_number_of_events not implemented.'
+  end
+
+  def run_kraken_monkey_with_number_of_events(_number_of_events)
+    raise 'ERROR: run_kraken_monkey_with_number_of_events not implemented.'
+  end
+
+  #-------------------------------
+  # More interface methods
+  #-------------------------------
+  def connected?
+    raise 'ERROR: connected? not implemented.'
+  end
+
+  def orientation
+    raise 'ERROR: orientation not implemented.'
+  end
+
+  def screen_size
+    raise 'ERROR: screen_size not implemented.'
+  end
+
+  def sdk_version
+    raise 'ERROR: sdk_version not implemented.'
+  end
+
+  def type
+    raise 'ERROR: Unsupported device'
+  end
+
+  def save_snapshot_in_path(_file_path)
+    raise 'ERROR: save_snapshot_in_path not implemented.'
+  end
+
+  #-------------------------------
+  # Helpers
+  #-------------------------------
+  def to_s
+    @id + K::SEPARATOR + @model + K::SEPARATOR + type
+  end
+
+  def screenshot_prefix
+    @id.gsub('.', '_').gsub(/:(.*)/, '').to_s + '_'
+  end
+
+  def self.find_by_process_id(id)
+    DeviceProcess.directory.each do |process_info|
+      info = process_info.strip.split(K::SEPARATOR)
+      process_id = info[0]
+      next unless process_id.to_s == id.to_s
+
+      return device_from_type(
+        id: info[1], model: info[2],
+        device_type: info[3]
+      )
+    end
+
+    nil
+  end
+
+  def self.device_from_type(id:, model:, device_type:)
+    device_class = nil
+    if device_type == K::ANDROID_DEVICE
+      device_class = AndroidDevice
+    elsif device_type == K::WEB_DEVICE
+      device_class = WebDevice
+    end
+    raise 'ERROR: Unsupported device' if device_class.nil?
+
+    device_class.new(
+      id: id, model: model
+    )
+  end
 end