honeydew 0.1.4 → 0.10.0

data/README.md

@@ -1,6 +1,9 @@
 # Honeydew
 
-TODO: Write a gem description
+NOTE: Honeydew is currently in alpha and is not quite ready for use.
+
+Honeydew is a Ruby driver for UIAutomator which enables automated testing of
+Android devices.
 
 ## Installation
 

data/Rakefile

@@ -11,7 +11,7 @@ task :build_android_server do
 end
 
 def android_server_path
-  File.absolute_path(File.join(File.dirname(__FILE__), 'android-server'))
+  File.absolute_path(File.join(File.dirname(__FILE__), 'server'))
 end
 
-task :build => [:spec, :build_android_server]
+task :build => [:spec, :build_android_server]

data/example/Gemfile

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

data/honeydew.gemspec

@@ -6,11 +6,13 @@ 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.authors       = ["Selvakumar Natesan", "Christopher Rex", "Shyam Vala", "John Barker"]
+  spec.email         = ["scmp-team@amplify.com", "jbarker@amplify.com"]
+  spec.summary       = %q{Ruby DSL for controlling Android devices}
+  spec.description   = <<-EOF
+Honeydew is a Ruby driver for UIAutomator which enables automated testing of
+Android devices.
+  EOF
 
   spec.files         = `git ls-files`.split($/) + Dir['android-server/target/*.jar']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -21,7 +23,6 @@ Gem::Specification.new do |spec|
   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")

data/lib/honeydew.rb

@@ -3,8 +3,8 @@ require 'bundler/setup'
 require 'restclient'
 require 'active_support/core_ext'
 
-require "honeydew/version"
-require "honeydew/device"
+require 'honeydew/version'
+require 'honeydew/device'
 
 module Honeydew
   class Configuration

data/lib/honeydew/device.rb

@@ -18,24 +18,15 @@ module Honeydew
     end
 
     def contains_textview_text?(text, timeout = Honeydew.config.timeout)
-      response = has_textview_text? text, timeout
-      response['success']
-    rescue
-      false
+      has_textview_text? text, timeout
     end
 
     def contains_element_with_description?(description, timeout = Honeydew.config.timeout)
-      response = has_element_with_description? description, timeout
-      response['success']
-    rescue
-      false
+       has_element_with_description? description, timeout
     end
 
     def contains_button?(text, timeout = Honeydew.config.timeout)
-      response = has_button? text, timeout
-      response['success']
-    rescue
-      false
+      has_button? text, timeout
     end
 
     def is_app_installed?(package_name)

data/lib/honeydew/device_actions.rb

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

data/lib/honeydew/device_commands.rb

@@ -6,7 +6,7 @@ module Honeydew
     end
 
     def dump_window_hierarchy(local_path)
-      path_in_device = perform_action(:action => 'dump_window_hierarchy')['description']
+      path_in_device = perform_action('dump_window_hierarchy')['description']
       adb "pull #{path_in_device} #{local_path}"
     end
 
@@ -41,7 +41,7 @@ module Honeydew
     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"
+        adb "shell uiautomator runtest #{automation_test_jar_name} -c com.amplify.honeydew_server.TestRunner"
         log "Device: #{serial} initiated the start of automation server"
       end
       at_exit do
@@ -81,4 +81,4 @@ module Honeydew
     end
 
   end
-end
+end

data/lib/honeydew/device_matchers.rb

@@ -1,36 +1,54 @@
 module Honeydew
   module DeviceMatchers
-
     def has_text?(text, timeout = Honeydew.config.timeout)
-      perform_action :action => 'is_text_present', :arguments => {:text => text}, :retry_until => timeout
+      perform_assertion :is_text_present,
+        {:text => text},
+        :timeout => timeout
     end
 
     def has_element_with_description?(description, timeout = Honeydew.config.timeout)
-      perform_action :action => 'is_text_present', :arguments => {:description => description}, :retry_until => timeout
+      perform_assertion :is_text_present,
+        {:description => description},
+        :timeout => 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
+      perform_assertion :is_text_present,
+        {:text => text, :type => 'EditText'},
+        :timeout => 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
+      perform_assertion :is_text_present,
+        {:text => text, :type => 'TextView'},
+        :timeout => 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
+    def has_textview_with_text_and_description?(text, description, timeout = Honeydew.config.timeout)
+      perform_assertion :is_text_present,
+        {:text => text, :description => description, :type => 'TextView'},
+        :timeout => timeout
     end
 
     def has_button?(button_text, timeout = Honeydew.config.timeout)
-      perform_action(:action => 'is_button_present', :arguments => {:text => button_text}, :retry_until => timeout)
+      perform_assertion :is_button_present,
+        {:text => button_text},
+        :timeout => 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)
+      perform_assertion :is_child_count_equal_to,
+        {:parent_description => parent_element_description,
+         :child_description => child_element_description,
+         :child_count => child_count},
+        :timeout => 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)
+      perform_assertion :is_element_with_nested_text_present,
+        {:parent_description => parent_description,
+         :child_text => child_text},
+        :timeout => timeout
     end
 
     def has_app_installed?(package_name)
@@ -38,15 +56,19 @@ module Honeydew
     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}
+      perform_assertion :is_option_in_settings_menu_enabled,
+        :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}
+      perform_assertion :is_option_in_settings_menu_disabled,
+        :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)
+      perform_assertion :has_settings_menu_item,
+        {:menuName => item_name},
+        :timeout => timeout
     end
   end
-end
+end

data/lib/honeydew/version.rb

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

data/{android-server → server}/pom.xml

@@ -3,11 +3,11 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>uiautomator-cucumber</groupId>
-    <artifactId>android-server</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
+    <groupId>amplify</groupId>
+    <artifactId>honeydew-server</artifactId>
+    <version>0.10.0</version>
     <packaging>jar</packaging>
-    <name>UIAutomator Cucumber - Android Server</name>
+    <name>Honeydew Android Server</name>
 
     <properties>
         <platform.version>4.1.1.4</platform.version>
@@ -105,7 +105,7 @@
                         <skip>false</skip>
                         <testClassOrMethods>
                             <testClassOrMethod>
-                                com.uiautomator_cucumber.android_server.TestRunner
+                                com.amplify.honeydew.TestRunner
                             </testClassOrMethod>
                         </testClassOrMethods>
                         <createReport>true</createReport>