honeydew 0.1.4

data/android-server/src/main/java/com/uiautomator_cucumber/android_server/httpd/RemoteCommandReceiver.java

@@ -0,0 +1,64 @@
+package com.uiautomator_cucumber.android_server.httpd;
+
+import android.util.Log;
+import com.google.gson.Gson;
+import com.uiautomator_cucumber.android_server.ActionsExecutor;
+import com.uiautomator_cucumber.android_server.Command;
+import com.uiautomator_cucumber.android_server.Result;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Properties;
+
+public class RemoteCommandReceiver extends NanoHTTPD {
+    private static final String MIME_JSON = "application/json";
+    private static final String TAG = "RemoteCommandReceiver";
+    private final Gson gson;
+    private final ActionsExecutor actionsExecutor;
+    private boolean running = true;
+
+    public RemoteCommandReceiver(ActionsExecutor actionsExecutor) throws IOException, InterruptedException {
+        super(7120, new File("/"));
+        Log.d(TAG, "Listening on HTTP port 7120. Kill test to stop");
+        this.gson = new Gson();
+        this.actionsExecutor = actionsExecutor;
+        while (running) {
+            Thread.sleep(5000);
+        }
+    }
+
+    @Override
+    public Response serve(String uri, String method, Properties header, Properties params, Properties files) {
+        log(uri, method, params);
+
+        Result result = tryPerformingControlAction(method, uri);
+        if (result == null) {
+            result = performActionOnDevice(params);
+        }
+        return new Response(HTTP_OK, MIME_JSON, gson.toJson(result));
+    }
+
+    @Override
+    public void stop() {
+        super.stop();
+        this.running = false;
+    }
+
+    private Result performActionOnDevice(Properties params) {
+        return actionsExecutor.execute(gson.fromJson((String) params.get("command"), Command.class));
+    }
+
+    private Result tryPerformingControlAction(String method, String uri) {
+        if (uri.equalsIgnoreCase("/terminate")) {
+            stop();
+            return Result.OK;
+        } else if(method.equalsIgnoreCase("HEAD")) {
+            return Result.OK;
+        }
+        return null;
+    }
+
+    private void log(String uri, String method, Properties params) {
+        Log.d(TAG, String.format("Processing uri: %s, method: %s, params: %s", uri, method, params));
+    }
+}

data/example/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'honeydew', :path => File.join(File.dirname(__FILE__), '..')
+gem 'cucumber'
+gem 'rake'

data/example/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --color --format pretty"
+end

data/example/features/example.feature

@@ -0,0 +1,10 @@
+@honeydew
+Feature: Example demonstrating honeydew
+  Scenario: Perform addition using calculator
+    When I launch app "Calculator"
+    Then I long press the element with description "square root"
+    Then I press the "6" button
+    Then I press the "2" button
+    Then I press the "5" button
+    And I press the "=" button
+    Then I wait up to 2 seconds for "25" to appear in edit text

data/example/features/step_definitions/honeydew_steps.rb

@@ -0,0 +1 @@
+require 'honeydew/step_definitions'

data/example/features/support/hooks.rb

@@ -0,0 +1,4 @@
+require 'honeydew'
+Before("@honeydew") do |scenario|
+  Honeydew.start_uiautomator_server
+end

data/honeydew.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'honeydew/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "honeydew"
+  spec.version       = Honeydew::VERSION
+  spec.authors       = ["Selva", "Christopher Rex"]
+  spec.email         = ["scmp-team@amplify.com"]
+  spec.description   = %q{Automated functional testing on Android with uiautomator and cucumber}
+  spec.summary       = %q{Automated functional testing on Android with uiautomator and cucumber}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files`.split($/) + Dir['android-server/target/*.jar']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency("cucumber")
+  spec.add_dependency("json")
+  spec.add_dependency("rest-client")
+  spec.add_dependency("activesupport")
+end

data/honeydew.iml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/android-server/src" isTestSource="false" />
+    </content>
+    <orderEntry type="jdk" jdkName="RVM: jruby-1.7.3" jdkType="JRUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v3.2.13, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.0, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.3.5, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="cucumber (v1.3.1, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.4, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="gherkin (v2.12.0, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v0.6.1, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v1.7.7, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types (v1.23, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.7.3, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.0.4, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rest-client (v1.6.7, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v2.13.0, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v2.13.1, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v2.13.0, RVM: jruby-1.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v2.13.1, RVM: jruby-1.7.3) [gem]" level="application" />
+  </component>
+</module>
+

data/lib/honeydew/cucumber.rb

@@ -0,0 +1,4 @@
+require 'honeydew'
+require 'honeydew/dsl'
+
+World(Honeydew::DSL)

data/lib/honeydew/device.rb

@@ -0,0 +1,79 @@
+require "honeydew/device_matchers"
+require "honeydew/device_actions"
+
+module Honeydew
+  class Device
+    include Honeydew::DeviceActions
+    include Honeydew::DeviceMatchers
+
+    attr_reader :serial, :port
+
+    def initialize(serial)
+      if serial.to_s.empty?
+        raise ArgumentError, 'HoneyDew: Invalid serial or no device connected'
+      end
+      @port = Honeydew.config.obtain_new_port
+      @serial = serial
+      start_uiautomator_server
+    end
+
+    def contains_textview_text?(text, timeout = Honeydew.config.timeout)
+      response = has_textview_text? text, timeout
+      response['success']
+    rescue
+      false
+    end
+
+    def contains_element_with_description?(description, timeout = Honeydew.config.timeout)
+      response = has_element_with_description? description, timeout
+      response['success']
+    rescue
+      false
+    end
+
+    def contains_button?(text, timeout = Honeydew.config.timeout)
+      response = has_button? text, timeout
+      response['success']
+    rescue
+      false
+    end
+
+    def is_app_installed?(package_name)
+      has_app_installed?(package_name)
+    end
+
+    def clear_directory(directory)
+      all_files_in_directory_path = [directory.chomp('/'), '/*'].join
+      adb "shell rm -r #{all_files_in_directory_path}"
+    end
+    private
+
+    def ensure_tablet_ready
+      @device_ready ||= begin
+        wait_for_android_server
+        true
+      end
+    end
+
+    def wait_for_android_server
+      log 'Waiting for server to come up'
+      retriable :on => [RestClient::ServerBrokeConnection, Errno::ECONNRESET, Errno::ECONNREFUSED], :interval => 0.3, :tries => 30 do
+        RestClient.head device_endpoint
+      end
+    end
+
+    def retriable(options, &block)
+      tries = options[:tries]
+      yield
+    rescue *[*options[:on]]
+      tries -= 1
+      if tries > 0
+        sleep options[:interval]
+        retry
+      else
+        raise
+      end
+    end
+
+  end
+end

data/lib/honeydew/device_actions.rb

@@ -0,0 +1,151 @@
+require "honeydew/device_commands"
+
+module Honeydew
+  module DeviceActions
+    include Honeydew::DeviceCommands
+
+    def click_button(button_text)
+      perform_action :action => 'click', :arguments => {:text => button_text, :type => 'Button'}
+    end
+
+    def click_button_and_wait(button_text)
+      perform_action :action => 'click_and_wait_for_new_window', :arguments => {:text => button_text, :type => 'Button'}
+    end
+
+    def click_text(text)
+      perform_action :action => 'click', :arguments => {:text => text, :type => 'TextView'}
+    end
+
+    def click_text_and_wait(text)
+      perform_action :action => 'click_and_wait_for_new_window', :arguments => {:text => text, :type => 'TextView'}
+    end
+
+    def click_element(element_description)
+      perform_action :action => 'click', :arguments => {:description => element_description}
+    end
+
+    def click_element_and_wait(element_description)
+      perform_action :action => 'click_and_wait_for_new_window', :arguments => {:description => element_description}
+    end
+
+    def fill_in field_description, options = {with: ''}
+      perform_action :action => 'set_text', :arguments => {:description => field_description, :text => options[:with]}
+    end
+
+    def fill_in_by_label field_label, options = {with: ''}
+      perform_action :action => 'set_text_by_label', :arguments => {:label => field_label, :text => options[:with]}
+    end
+
+    def fill_in_by_index index, options = {with: ''}
+      perform_action :action => 'set_text_by_index', :arguments => {:index => index, :text => options[:with]}
+    end
+
+    def launch_home
+      perform_action :action => 'launch_home'
+    end
+
+    def launch_settings_app(app_name)
+      perform_action :action => 'select_from_apps_list', :arguments => {:appName => app_name}
+    end
+
+    def launch_application(application_name)
+      perform_action :action => 'launch_app', :arguments => {:appName => application_name}, :attempts => 3
+    end
+
+    def long_click_element(element_description)
+      perform_action :action => 'long_click', :arguments => {:description => element_description}
+    end
+
+    def launch_settings_item(item_name)
+      perform_action :action => 'select_menu_in_settings', :arguments => {:menuName => item_name}
+    end
+
+
+    def press_back
+      perform_action :action => 'press_back'
+    end
+
+    def press_enter
+      perform_action :action => 'press_enter'
+    end
+
+    def unlock
+      perform_action :action => 'unlock'
+    end
+
+    def wake_up
+      perform_action :action => 'wake_up'
+    end
+
+    def perform_action(options)
+      ensure_tablet_ready
+
+      command = options.slice(:action, :arguments)
+      timeout = options[:retry_until]
+      attempts = options[:attempts]
+
+      response =
+          if timeout
+            retry_until_timeout(timeout, command)
+          elsif attempts
+            retry_until_success(attempts, command)
+          else
+            execute_command(command)
+          end
+      log_action(command, response)
+      raise "Device: #{serial} :Action #{options} failed." unless response['success']
+      response
+    end
+
+    private
+
+    def retry_until_success(attempts, command)
+      completed = false
+      response = nil
+      tries = 0
+      until completed || (tries >= attempts) do
+        response = execute_command(command)
+        completed = response['success']
+        return response if completed
+        tries += 1
+        sleep 1
+      end
+      log_action(command, response)
+      raise "Device: #{serial} : All #{attempts} attempts failed while performing #{command[:action]}, with arguments: #{command[:arguments]}"
+    end
+
+    def retry_until_timeout(timeout, command)
+      completed = false
+      response = nil
+      Timeout.timeout(timeout.to_i) do
+        until completed do
+          sleep 1
+          response = execute_command(command)
+          completed = response['success']
+        end
+      end
+      return response
+    rescue Timeout::Error
+      log_action(command, response)
+      raise "Device: #{serial} :Timeout while performing #{command[:action]}, with arguments: #{command[:arguments]}"
+    end
+
+    def execute_command(command)
+      response = RestClient.get(device_endpoint, :params => stringify_keys(:command => command))
+      JSON.parse(response)
+    end
+
+    def log_action(command, response)
+      log "Device: #{serial} : executing command: #{command}"
+      log "Device: #{serial} : responded with: #{response}"
+    end
+
+    def stringify_keys(options)
+      JSON.parse(options.to_json)
+    end
+
+    def log(message)
+      puts message
+    end
+  end
+end

data/lib/honeydew/device_commands.rb

@@ -0,0 +1,84 @@
+module Honeydew
+  module DeviceCommands
+
+    def device_endpoint
+      "http://127.0.0.1:#{port}"
+    end
+
+    def dump_window_hierarchy(local_path)
+      path_in_device = perform_action(:action => 'dump_window_hierarchy')['description']
+      adb "pull #{path_in_device} #{local_path}"
+    end
+
+    def take_screenshot(local_path)
+      path_in_device = '/data/local/tmp/honeydew.png'
+      adb "shell /system/bin/screencap -p #{path_in_device}"
+      adb "pull #{path_in_device} #{local_path}"
+    end
+
+    def start_uiautomator_server
+      forwarding_port
+      terminate_uiautomator_server
+      log "Device: #{serial} : Starting server on the device"
+      start_automation_server
+    end
+
+    def terminate_uiautomator_server
+      log 'Terminating server'
+      RestClient.get("#{device_endpoint}/terminate")
+    rescue
+      # Swallow
+    end
+
+    def automation_test_jar_name
+      "android-server-0.0.1-SNAPSHOT.jar"
+    end
+
+    def automation_server_jar_path
+      File.absolute_path(File.join(File.dirname(__FILE__), "../../android-server/target/#{automation_test_jar_name}"))
+    end
+
+    def start_automation_server
+      Thread.new do
+        adb "push #{automation_server_jar_path} /data/local/tmp"
+        adb "shell uiautomator runtest #{automation_test_jar_name} -c com.uiautomator_cucumber.android_server.TestRunner"
+        log "Device: #{serial} initiated the start of automation server"
+      end
+      at_exit do
+        terminate_uiautomator_server
+      end
+    end
+
+    def forwarding_port
+      log "Device: #{serial} : Forwarding port #{port} to device"
+      adb "forward tcp:#{port} tcp:7120"
+    end
+
+    def uninstall_app(package_name)
+      adb "uninstall #{package_name}"
+    end
+
+    def install_app(apk_location)
+      adb "install #{apk_location}"
+    end
+
+    def clear_app_data(package_name)
+      adb "shell pm clear #{package_name}"
+    end
+
+    def reboot
+      adb 'reboot'
+    end
+
+    def launch_settings
+      adb 'shell am start -n com.android.settings/com.android.settings.Settings'
+    end
+
+    def adb(command)
+      adb_command = "adb -s #{serial} #{command}"
+      log "Device: #{serial} :Executing '#{adb_command}'"
+      `#{adb_command}`.tap { raise 'ADB command failed' unless $?.success? }
+    end
+
+  end
+end

data/lib/honeydew/device_matchers.rb

@@ -0,0 +1,52 @@
+module Honeydew
+  module DeviceMatchers
+
+    def has_text?(text, timeout = Honeydew.config.timeout)
+      perform_action :action => 'is_text_present', :arguments => {:text => text}, :retry_until => timeout
+    end
+
+    def has_element_with_description?(description, timeout = Honeydew.config.timeout)
+      perform_action :action => 'is_text_present', :arguments => {:description => description}, :retry_until => timeout
+    end
+
+    def has_edit_text?(text, timeout = Honeydew.config.timeout)
+      perform_action :action => 'is_text_present', :arguments => {:text => text, :type => 'EditText'}, :retry_until => timeout
+    end
+
+    def has_textview_text?(text, timeout = Honeydew.config.timeout)
+      perform_action :action => 'is_text_present', :arguments => {:text => text, :type => 'TextView'}, :retry_until => timeout
+    end
+
+    def has_textview_with_text_and_description?(text, description, timeout=Honeydew.config.timeout)
+      perform_action :action => 'is_text_present', :arguments => {:text => text, :description => description, :type => 'TextView'}, :retry_until => timeout
+    end
+
+    def has_button?(button_text, timeout = Honeydew.config.timeout)
+      perform_action(:action => 'is_button_present', :arguments => {:text => button_text}, :retry_until => timeout)
+    end
+
+    def has_child_count?(parent_element_description, child_element_description, child_count, timeout = Honeydew.config.timeout)
+      perform_action(:action => 'is_child_count_equal_to', :arguments => {:parent_description => parent_element_description, :child_description => child_element_description, :child_count => child_count}, :retry_until => timeout)
+    end
+
+    def has_element_with_nested_text?(parent_description, child_text, timeout = Honeydew.config.timeout)
+      perform_action(:action => 'is_element_with_nested_text_present', :arguments => {:parent_description => parent_description, :child_text => child_text}, :retry_until => timeout)
+    end
+
+    def has_app_installed?(package_name)
+      adb('shell pm list packages').include?(package_name)
+    end
+
+    def is_option_in_setting_enabled?(item_name, option_names)
+      perform_action :action => 'is_option_in_settings_menu_enabled', :arguments => {:menuName => item_name, :optionNames => option_names}
+    end
+
+    def is_option_in_setting_disabled?(item_name, option_names)
+      perform_action :action => 'is_option_in_settings_menu_disabled', :arguments => {:menuName => item_name, :optionNames => option_names}
+    end
+
+    def has_settings_menu_item?(item_name, timeout = 10)
+      perform_action(:action => 'has_settings_menu_item', :arguments => {:menuName => item_name}, :retry_until => timeout)
+    end
+  end
+end

data/lib/honeydew/dsl.rb

@@ -0,0 +1,9 @@
+module Honeydew
+  module DSL
+    def use_device(name, serial)
+      define_singleton_method name.to_sym do |*args, &block|
+        Honeydew.using_device(serial, &block)
+      end
+    end
+  end
+end

data/lib/honeydew/step_definitions.rb

@@ -0,0 +1,75 @@
+Given /^I unlock$/ do
+  Honeydew.current_device.unlock
+end
+
+Given /^I launch app "(.*?)"$/ do |app_name|
+  Honeydew.current_device.launch_application app_name
+end
+
+Given /^I launch home$/ do
+  Honeydew.current_device.launch_home
+end
+
+When /^I press back$/ do
+  Honeydew.current_device.press_back
+end
+
+Given /^I select "(.*?)" in the Settings view$/ do |menu_item|
+  Honeydew.current_device.launch_settings_item menu_item
+end
+
+Given /^I select app "(.*?)" from the Apps list in the Settings view$/ do |app_name|
+  Honeydew.current_device.launch_settings_app app_name
+end
+
+Given /^I should see text containing "(.*?)"$/ do |expected_text|
+  Honeydew.current_device.should have_textview_text expected_text
+end
+
+Given /^I enter text "(.*?)" into field with description "(.*?)"$/ do |text, field_description|
+  Honeydew.current_device.fill_in field_description, with: text
+end
+
+Given /^I press the "(.*?)" button$/ do |button_text|
+  Honeydew.current_device.click_button button_text
+end
+
+Given /^I press the "(.*?)" text$/ do |text|
+  Honeydew.current_device.click_text text
+end
+
+Given /^I press the element with description "(.*?)"$/ do |element_description|
+  Honeydew.current_device.click_element element_description
+end
+
+Given /^I long press the element with description "(.*?)"$/ do |element_description|
+  Honeydew.current_device.long_click_element element_description
+end
+
+When /^I wait up to (\d+) seconds for "(.*?)" to appear$/ do |timeout, text|
+  Honeydew.current_device.should have_textview_text text, timeout
+end
+
+When /^I wait up to (\d+) seconds for "(.*?)" to appear in edit text$/ do |timeout, text|
+  Honeydew.current_device.should have_edit_text text, timeout
+end
+
+Given /I uninstall the app "(.*?)" using ADB$/ do |pacakge_name|
+  Honeydew.current_device.uninstall_app pacakge_name
+end
+
+Given /I install the app "(.*?)" using ADB$/ do |apk_location|
+  Honeydew.current_device.install_app apk_location
+end
+
+Given /I reboot the device using ADB$/ do
+  Honeydew.current_device.reboot
+end
+
+Then /I see the app "(.*?)" installed using ADB$/ do |package_name|
+  Honeydew.current_device.should have_app_installed package_name
+end
+
+Then /I should see a button "(.*?)" with (package|description) as "(.*?)"$/ do |button_text, condition, package_name|
+  Honeydew.current_device.should have_button button_text
+end

data/lib/honeydew/version.rb

@@ -0,0 +1,3 @@
+module Honeydew
+  VERSION = "0.1.4"
+end