honeydew 0.12.0 → 0.14.0

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Selva
+Copyright (c) 2013 Amplify Inc.
 
 MIT License
 

data/README.md

@@ -1,24 +1,95 @@
 # 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
 
-Add this line to your application's Gemfile:
+Install the honeydew gem:
+
+    $ gem install honeydew
+
+Or if you're using Bundler, add honeydew to your Gemfile:
 
     gem 'honeydew'
 
-And then execute:
+You'll need to have the Android SDK installed, ANDROID_HOME set correctly as
+well as Maven.
 
-    $ bundle
+## Using Honeydew
 
-Or install it yourself as:
+In typical operation, Honeydew connects to the first Android device connected
+to your system which has debugging enabled. You can send commands to this
+device like so:
 
-    $ gem install honeydew
+``` ruby
+    Honeydew.current_device.launch_home
+    Honeydew.
+```
+
+If you want to interact with multiple Android devices at the same time, you can
+create separate device instances by specifying their serial IDS. You can get
+the serial IDs of all android devices connected to your system with the ``adb
+devices -l``` command, e.g:
+
+    $ adb devices -l
+    List of devices attached
+
+Once you have the serial ID of a device you wish to control, create a device
+object for it:
+
+``` ruby
+    nexus = Honeydew::Device.new ''
+```
+
+Then you can begin issuing commands:
+
+``` ruby
+    nexus.click_text 'Android Air-Hockey'
+    if nexus.has_text? 'New Game'
+      nexus.click_button 'New Game'
+    ...
+```
+
+## Using Honeydew with RSpec
+
+Honeydew comes with a DSL that can be used in RSpec as well as matchers for use
+with RSpec.
+
+## Using Honeydew with Cucumber
+
+If you're using Cucumber, Honeydew comes with a DSL that can ease the creation
+of device related steps. Firstly require the honeydew cucumber files:
+
+``` ruby
+    require 'honeydew/cucumber'
+```
+
+This adds the Honeydew DSL to World so you can interact with the device in your
+steps like so:
+
+``` ruby
+    using_device :teacher_tablet
+    teacher_tablet.launch_settings
+```
+
+## Controlling Android Devices
+
+Honeydew provides a number of methods for interacting with an Android device.
+
+## Thanks
 
-## Usage
+Honeydew is sponsored by [Amplify](http://www.amplify.com/) and was created by
+[Selvakumar Natesan](https://github.com/selvakn) and [Christopher
+Rex](https://github.com/christopher-rex) of
+[ThoughtWorks](http://www.thoughtworks.com/).
 
-TODO: Write usage instructions here
+Additional thanks to [Shyam Vala](https://github.com/shyamvala), [Premanand
+Chandrasekaran](https://github.com/premanandc) and [John
+Barker](https://github.com/excepttheweasel/) for multi device support, testing
+and a little bit of polish.
 
 ## Contributing
 

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/examples/cucumber/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'honeydew'
+gem 'rspec'
+gem 'rake'

data/examples/rspec/spec/browse_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'Browser' do
+  before do
+    use_device :my_tablet
+  end
+
+  context 'surfing the web' do
+    it 'launches hacker news' do
+      my_tablet.launch_home
+      my_tablet.click_text 'Chrome'
+      my_tablet.fill_in 'Search, or say Google', with: 'http://news.ycombinator.com'
+      expect(my_tablet).to have_text 'Hacker News'
+    end
+  end
+end

data/examples/rspec/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'honeydew'
+require 'honeydew/dsl'
+
+RSpec.configure do |config|
+  config.include Honeydew::DSL
+end

data/honeydew.gemspec

@@ -4,25 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'honeydew/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "honeydew"
+  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       = '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) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/) + Dir["server/target/honeydew-server-#{Honeydew::VERSION}*.jar"]
+  spec.test_files    = spec.files.grep(/spec/)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency('activesupport')
+  spec.add_dependency('json')
 
-  spec.add_dependency("cucumber")
-  spec.add_dependency("json")
-  spec.add_dependency("rest-client")
-  spec.add_dependency("activesupport")
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
 end

data/honeydew.iml

@@ -1,28 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="RailsFacetType" name="Ruby on Rails">
+      <configuration>
+        <RAILS_FACET_CONFIG_ID NAME="RAILS_FACET_SUPPORT_REMOVED" VALUE="false" />
+        <RAILS_FACET_CONFIG_ID NAME="RAILS_TESTS_SOURCES_PATCHED" VALUE="true" />
+        <RAILS_FACET_CONFIG_ID NAME="RAILS_FACET_APPLICATION_ROOT" VALUE="$MODULE_DIR$" />
+      </configuration>
+    </facet>
+  </component>
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/android-server/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
     </content>
-    <orderEntry type="jdk" jdkName="RVM: jruby-1.7.3" jdkType="JRUBY_SDK" />
+    <orderEntry type="inheritedJdk" />
     <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.rb

@@ -1,72 +1 @@
-require 'bundler'
-require 'bundler/setup'
-require 'restclient'
-require 'active_support/core_ext'
-
-require "honeydew/version"
-require "honeydew/device"
-
-module Honeydew
-  class Configuration
-    attr_accessor :port, :timeout
-
-    def initialize
-      @port = 7120
-      @timeout = 5.seconds
-    end
-
-    def obtain_new_port
-      @port.tap { @port += 1 }
-    end
-  end
-
-  class <<self
-    attr_accessor :config
-
-    def config
-      return @config if @config
-      configure
-      @config
-    end
-
-    def configure
-      @config ||= Configuration.new
-      yield(@config) if block_given?
-    end
-
-    def attached_devices
-      `adb devices`.split("\n").drop(1).collect {|line| line.split[0].chomp}
-    end
-
-    def default_device_serial
-      attached_devices.first
-    end
-
-    def default_device
-      @default_device ||= device[default_device_serial]
-    end
-
-    def current_device
-      @current_device ||= default_device
-    end
-
-    def using_device(serial, &block)
-      original_device = current_device
-      use_device(serial).tap do |device|
-        device.instance_eval(&block) if block_given?
-      end
-    ensure
-      @current_device = original_device
-    end
-
-    def use_device(serial)
-      @current_device = device[serial]
-    end
-
-    def device
-      @devices ||= Hash.new do |hash, serial|
-        hash[serial] = Device.new(serial) if attached_devices.include?(serial)
-      end
-    end
-  end
-end
+require 'honeydew/honeydew'

data/lib/honeydew/device.rb

@@ -1,79 +1,114 @@
-require "honeydew/device_matchers"
-require "honeydew/device_actions"
+require 'net/http'
+
+require 'honeydew/device_matchers'
+require 'honeydew/device_actions'
 
 module Honeydew
   class Device
     include Honeydew::DeviceActions
     include Honeydew::DeviceMatchers
 
+    ServerTimeoutError = Class.new(Timeout::Error)
+    ActionFailedError = Class.new(Timeout::Error)
+    FinderTimeout = Class.new(Timeout::Error)
+
     attr_reader :serial, :port
 
     def initialize(serial)
-      if serial.to_s.empty?
-        raise ArgumentError, 'HoneyDew: Invalid serial or no device connected'
+      @serial = serial
+
+      unless Honeydew.attached_devices.include?(@serial)
+        raise ArgumentError, "No device with serial #{@serial} attached"
       end
+
       @port = Honeydew.config.obtain_new_port
-      @serial = serial
-      start_uiautomator_server
+      start_honeydew_server
     end
 
-    def contains_textview_text?(text, timeout = Honeydew.config.timeout)
-      response = has_textview_text? text, timeout
-      response['success']
-    rescue
-      false
+    def using_timeout timeout
+      old_timeout = Honeydew.config.timeout
+      Honeydew.config.timeout = timeout
+      yield
+    ensure
+      Honeydew.config.timeout = old_timeout
     end
 
-    def contains_element_with_description?(description, timeout = Honeydew.config.timeout)
-      response = has_element_with_description? description, timeout
-      response['success']
-    rescue
-      false
+    private
+
+    def perform_assertion action, arguments = {}, options = {}
+      ensure_device_ready
+
+      log "performing assertion #{action} with arguments #{arguments}"
+      Timeout.timeout Honeydew.config.timeout.to_i, FinderTimeout do
+        begin
+          send_command action, arguments
+        rescue ActionFailedError
+          sleep 0.3
+          retry
+        end
+      end
+
+    rescue FinderTimeout
     end
 
-    def contains_button?(text, timeout = Honeydew.config.timeout)
-      response = has_button? text, timeout
-      response['success']
-    rescue
-      false
+    def perform_action action, arguments = {}, options = {}
+      ensure_device_ready
+
+      log "performing action #{action} with arguments #{arguments}"
+      send_command action, arguments
     end
 
-    def is_app_installed?(package_name)
-      has_app_installed?(package_name)
+    def send_command action, arguments
+      uri = device_endpoint('/command')
+
+      request = Net::HTTP::Post.new uri.path
+      request.set_form_data action: action, arguments: arguments.to_json.to_s
+
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.read_timeout = Honeydew.config.server_timeout
+        http.request request
+      end
+
+      case response
+      when Net::HTTPOK
+        true
+      when Net::HTTPRequestedRangeNotSatisfiable
+        raise ActionFailedError.new response.body
+      else
+        raise "honeydew-server failed to process command, response: #{response.value}"
+      end
     end
 
-    def clear_directory(directory)
-      all_files_in_directory_path = [directory.chomp('/'), '/*'].join
-      adb "shell rm -r #{all_files_in_directory_path}"
+    def log message
+      return unless Honeydew.config.debug
+      STDERR.puts "Device #{serial}: #{message}"
     end
-    private
 
-    def ensure_tablet_ready
+    def ensure_device_ready
       @device_ready ||= begin
-        wait_for_android_server
+        wait_for_honeydew_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
+    def timeout_server_operation &block
+      Timeout.timeout(Honeydew.config.server_timeout.to_i, ServerTimeoutError, &block)
     end
 
-    def retriable(options, &block)
-      tries = options[:tries]
-      yield
-    rescue *[*options[:on]]
-      tries -= 1
-      if tries > 0
-        sleep options[:interval]
-        retry
-      else
-        raise
+    def wait_for_honeydew_server
+      log 'waiting for honeydew-server to respond'
+      timeout_server_operation do
+        sleep 0.1 until honeydew_server_alive?
       end
+      log 'honeydew-server is alive and awaiting commands'
+
+    rescue ServerTimeoutError
+      raise 'timed out waiting for honeydew-server to respond'
     end
 
+    def honeydew_server_alive?
+      Net::HTTP.get_response(device_endpoint('/status')).code.to_i == 200
+    rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::ENETRESET, EOFError
+    end
   end
 end