appium_lib 0.0.30 → 0.3.0

data/lib/appium_lib/android/patch.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Appium::Android
+  # Implement useful features for element.
+  class Selenium::WebDriver::Element
+    # Cross platform way of entering text into a textfield
+    def type text
+      self.send_keys text
+    end
+  end
+end

data/lib/appium_lib/common/element/button.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+# UIAButton methods
+module Appium::Common
+  # Find a button by text and optionally number.
+  # @param text [String, Integer] the text to exactly match. If int then the button at that index is returned.
+  # @param number [Integer] the occurrence of the button matching text. Defaults to the first button.
+  # @return [Button] the button found with text and matching number
+  def button text, number=0
+    # return button at index.
+    return ele_index :button, text if text.is_a? Numeric
+
+    number >= 1 ? button_num( text, number ) :
+                  find_ele_by_text_include( :button, text )
+  end
+
+  # Get an array of button texts or button elements if text is provided.
+  # @param text [String] the text to exactly match
+  # @return [Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided.
+  def buttons text=nil
+    text == nil ? find_eles_attr( :button, :text ) :
+                  find_eles_by_text_include( :button, text )
+  end
+
+  # Get the first button element.
+  # @return [Button]
+  def first_button
+    first_ele :button
+  end
+
+  # Get the last button element.
+  # @return [Button]
+  def last_button
+    last_ele :button
+  end
+
+  # Get the first button element that exactly matches text.
+  # @param text [String] the text to match exactly
+  # @return [Button]
+  def button_exact text
+    find_ele_by_text :button, text
+  end
+
+  # Get all button elements that exactly match text.
+  # @param text [String] the text to match exactly
+  # @return [Array<Button>]
+  def buttons_exact text
+    find_eles_by_text :button, text
+  end
+
+  # Get an array of button elements.
+  # @return [Array<Button>]
+  def e_buttons
+    find_eles :button
+  end
+
+  # Expected to be called via button method.
+  #
+  # Get the button element exactly matching text and
+  # occurrence. number=2 means the 2nd occurrence.
+  #
+  # find the second Sign In button
+  #
+  # b = e_button 'Sign In', 2
+  #
+  # Button order will change in iOS vs Android
+  # so if there's no button found at number then
+  # return the first button.
+  #
+  # @param text [String] the text to match
+  # @param number [Integer] the button occurance to return. 1 = first button
+  # @return [Button] the button that matches text and number
+  def button_num text, number=1
+    raise 'Number must be >= 1' if number <= 0
+    number = number - 1 # zero indexed
+    result = nil
+
+    elements = buttons text
+    elements.size > number ? result = elements[number]
+                           : result = elements.first
+
+    result
+  end
+end # module Appium::Common

data/lib/appium_lib/common/element/text.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+# UIAStaticText methods
+module Appium::Common
+  # s_ prefix for static_text to avoid conflict with generic text methods.
+
+  # Get an array of text texts.
+  # @return [Array<String>]
+  def s_texts
+    find_eles_attr :text, :text
+  end
+
+  # Get an array of text elements.
+  # @return [Array<Text>]
+  def e_s_texts
+    find_eles :text
+  end
+
+  # Get the first text element.
+  # @return [Text]
+  def s_first_text
+    first_ele :text
+  end
+
+  # Get the last text element
+  # @return [Text]
+  def s_last_text
+    last_ele :text
+  end
+
+  # Get the first element that includes text.
+  # @param text [String, Integer] the text to find. If int then the text at that index is returned.
+  # @return [Text]
+  def s_text text
+    return ele_index :text, text if text.is_a? Numeric
+    find_ele_by_text_include :text, text
+  end
+
+  # Get the first textfield that matches text.
+  # @param text [String] the text that the tag must match
+  # @return [Text]
+  def s_text_exact text
+    find_ele_by_text :text, text
+  end
+end # module Appium::Common

data/lib/appium_lib/common/element/window.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# UIAWindow methods
+module Appium::Common
+  # Get the window's size
+  def window_size
+    return nil if @driver.nil?
+    @driver.manage.window.size
+  end
+end # module Appium::Common

data/lib/appium_lib/common/helper.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+# Generic helper methods not specific
+# to a particular tag name
+module Appium::Common
+  # json and ap are required for the source method.
+  require 'json'
+  require 'ap' # awesome print
+  require 'timeout' # for wait
+
+  # iOS .name returns the accessibility attribute if it's set. if not set, the string value is used.
+  # Android .name returns the accessibility attribute and nothing if it's not set.
+  #
+  # .text should be cross platform so prefer that over name, unless both
+  # Android and iOS have proper accessibility attributes.
+  # .text and .value should be the same so use .text over .value.
+  #
+  # secure tag_name is iOS only because it can't be implemented using uiautomator for Android.
+  #
+  # find_element :text doesn't work so use XPath to find by text.
+
+  # Check every 0.5 seconds to see if block.call is true.
+  # Give up after 30 seconds.
+  # @param block [Block] the block to call
+  # @return [Object] the result of block.call
+  def wait &block
+    # Rescue Timeout::Error: execution expired
+    result = nil
+    timeout(30) { until (result = begin; block.call; rescue; end) do; sleep 0.5 end }
+    result
+  end
+
+  # Presses the back button on Android.
+  # @return [void]
+  def back
+    @driver.navigate.back
+  end
+
+  def xpath xpath_str
+    find_element :xpath, xpath_str
+  end
+
+  def xpaths xpath_str
+    find_elements :xpath, xpath_str
+  end
+
+  # Get the element of type tag_name at matching index.
+  # @param tag_name [String] the tag name to find
+  # @param index [Integer] the index
+  # @return [Element] the found element of type tag_name
+  def ele_index tag_name, index
+    # XPath index starts at 1. ruby_lib index starts at 0
+    find_element :xpath, "//#{tag_name}[#{index + 1}]"
+  end
+
+  # Get all elements exactly matching tag name
+  # @param tag_name [String] the tag name to find
+  # @return [Array<Element>] the found elements of type tag_name
+  def find_eles tag_name
+    @driver.find_elements :tag_name, tag_name
+  end
+
+  # Get the first tag that exactly matches tag and text.
+  # @param tag [String] the tag name to match
+  # @param text [String] the text to exactly match
+  # @return [Element] the element of type tag exactly matching text
+  def find_ele_by_text tag, text
+    @driver.find_element :xpath, %Q(#{tag}[@text='#{text}'])
+  end
+
+  # Get all tags that exactly match tag and text.
+  # @param tag [String] the tag name to match
+  # @param text [String] the text to exactly match
+  # @return [Array<Element>] the elements of type tag exactly matching text
+  def find_eles_by_text tag, text
+    @driver.find_elements :xpath, %Q(#{tag}[@text='#{text}'])
+  end
+
+  # Get the first tag by attribute that exactly matches value.
+  # @param tag [String] the tag name to match
+  # @param attr [String] the attribute to compare
+  # @param value [String] the value of the attribute that the element must include
+  # @return [Element] the element of type tag who's attribute includes value
+  def find_ele_by_attr_include tag, attr, value
+    @driver.find_element :xpath, %Q(#{tag}[contains(@#{attr}, '#{value}')])
+  end
+
+  # Get tags by attribute that include value.
+  # @param tag [String] the tag name to match
+  # @param attr [String] the attribute to compare
+  # @param value [String] the value of the attribute that the element must include
+  # @return [Array<Element>] the elements of type tag who's attribute includes value
+  def find_eles_by_attr_include tag, attr, value
+    @driver.find_elements :xpath, %Q(#{tag}[contains(@#{attr}, '#{value}')])
+  end
+
+  # Get the first tag that includes text.
+  # @param tag [String] the tag name to match
+  # @param text [String] the text the element must include
+  # @return [Element] the element of type tag that includes text
+  # element.attribute(:text).include? text
+  def find_ele_by_text_include tag, text
+    find_ele_by_attr_include tag, :text, text
+  end
+
+  # Get the tags that include text.
+  # @param tag [String] the tag name to match
+  # @param text [String] the text the element must include
+  # @return [Array<Element>] the elements of type tag that includes text
+  # element.attribute(:text).include? text
+  def find_eles_by_text_include tag, text
+    find_eles_by_attr_include tag, :text, text
+  end
+
+  # Get the first tag that matches tag_name
+  # @param tag_name [String] the tag to match
+  # @return [Element]
+  def first_ele tag_name
+    # XPath index starts at 1
+    find_element :xpath, "//#{tag_name}[1]"
+  end
+
+  # Get the last tag that matches tag_name
+  # @param tag_name [String] the tag to match
+  # @return [Element]
+  def last_ele tag_name
+    xpath "//#{tag_name}[last()]"
+  end
+
+  # Prints a JSON view of the current page
+  # @return [void]
+  def source
+    ap get_source
+  end
+
+  # Gets a JSON view of the current page
+  # @return [JSON]
+  def get_source
+    JSON.parse(@driver.page_source)
+  end
+end # module Appium::Common

data/lib/appium_lib/common/patch.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+module Appium::Common
+  # Implement useful features for element.
+  class Selenium::WebDriver::Element
+    # Note: For testing .text should be used over value, and name.
+
+    # Fixes NoMethodError: undefined method `value' for #<Selenium::WebDriver::Element:0x..fa4a9148235390a44 id="1">
+    def value
+      self.attribute :value
+    end
+
+    # Fixes NoMethodError: undefined method `name' for #<Selenium::WebDriver::Element
+    def name
+      self.attribute :name
+    end
+
+    # Use tag_name to get element's type.
+    #
+    # Tag name appears to be the same as type.
+    #
+    # Fixes Selenium::WebDriver::Error::UnknownError: Not yet implemented
+    def tag_name
+      self.attribute :type
+    end
+
+    # For use with mobile tap.
+    #
+    # execute_script 'mobile: tap', :x => 0.0, :y => 0.98
+    #
+    # https://github.com/appium/appium/wiki/Automating-mobile-gestures
+    # @return [OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
+    def location_rel
+      xy = self.location
+      w = window_size
+      OpenStruct.new( x: xy.x.to_f / w.width.to_f,
+                      y: xy.y.to_f / w.height.to_f )
+    end
+  end
+end # module Appium::Common
+
+# Print JSON posted to Appium. Not scoped to an Appium module.
+#
+# Requires from lib/selenium/webdriver/remote.rb
+require 'selenium/webdriver/remote/capabilities'
+require 'selenium/webdriver/remote/bridge'
+require 'selenium/webdriver/remote/server_error'
+require 'selenium/webdriver/remote/response'
+require 'selenium/webdriver/remote/commands'
+require 'selenium/webdriver/remote/http/common'
+require 'selenium/webdriver/remote/http/default'
+
+# Show http calls to the Selenium server.
+#
+# Invaluable for debugging.
+module Selenium::WebDriver::Remote
+  class Bridge
+    # Code from lib/selenium/webdriver/remote/bridge.rb
+    def raw_execute(command, opts = {}, command_hash = nil)
+      verb, path = COMMANDS[command] || raise(ArgumentError, "unknown command: #{command.inspect}")
+      path       = path.dup
+
+      path[':session_id'] = @session_id if path.include?(':session_id')
+
+      begin
+        opts.each { |key, value| path[key.inspect] = escaper.escape(value.to_s) }
+        rescue IndexError
+        raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
+      end
+
+      # change path from session/efac972c-941a-499c-803c-d7d008749/execute
+      # to /execute
+      # path may be nil, session, or not have anything after the session_id.
+      path_str = ''
+      path_match = path.match /.*\h{8}-\h{4}-\h{4}-\h{4}-\h{12}/
+      path_str = path.sub(path_match[0], '') unless path_match.nil?
+
+      puts "#{verb} #{path_str}"
+      puts command_hash.to_json unless command_hash.to_json == 'null'
+      # puts "verb: #{verb}, path #{path}, command_hash #{command_hash.to_json}"
+      http.call verb, path, command_hash
+    end # def
+  end # class
+end if defined? Pry # module Selenium::WebDriver::Remote

data/lib/appium_lib/common/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Appium
+  # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
+  VERSION = '0.3.0' unless defined? ::Appium::VERSION
+  DATE = '2013-04-25' unless defined? ::Appium::DATE
+end

data/lib/appium_lib/driver.rb

@@ -0,0 +1,265 @@
+# encoding: utf-8
+=begin
+Based on simple_test.rb
+https://github.com/appium/appium/blob/82995f47408530c80c3376f4e07a1f649d96ba22/sample-code/examples/ruby/simple_test.rb
+https://github.com/appium/appium/blob/c58eeb66f2d6fa3b9a89d188a2e657cca7cb300f/LICENSE
+=end
+module Appium
+  add_to_path __FILE__
+
+  require 'selenium-webdriver'
+
+  # common
+  require 'common/helper'
+  require 'common/patch'
+  require 'common/version'
+  require 'common/element/button'
+  require 'common/element/text'
+  require 'common/element/window'
+
+  # ios
+  require 'ios/helper'
+  require 'ios/patch'
+  require 'ios/element/alert'
+  require 'ios/element/generic'
+  require 'ios/element/textfield'
+
+  # android
+  require 'android/helper'
+  require 'android/patch'
+  require 'android/element/alert'
+  require 'android/element/generic'
+  require 'android/element/textfield'
+
+  class Driver
+    def initialize opts={}
+      opts = {} if opts.nil?
+      # Path to the .apk, .app or .app.zip.
+      # The path can be local or remote for Sauce.
+      @app_path = opts.fetch 'APP_PATH', ENV['APP_PATH']
+      raise 'APP_PATH must be set.' if @app_path.nil?
+
+      # The name to use for the test run on Sauce.
+      @app_name = opts.fetch 'APP_NAME', ENV['APP_NAME']
+
+      # Android app package
+      @app_package = opts.fetch 'APP_PACKAGE', ENV['APP_PACKAGE']
+
+      # Android app starting activity.
+      @app_activity = opts.fetch 'APP_ACTIVITY', ENV['APP_ACTIVITY']
+
+      # Android app waiting activity
+      @app_wait_activity = opts.fetch 'APP_WAIT_ACTIVITY', ENV['APP_WAIT_ACTIVITY']
+
+      # Sauce Username
+      @sauce_username = opts.fetch'SAUCE_USERNAME', ENV['SAUCE_USERNAME']
+
+      # Sauce Key
+      @sauce_access_key = opts.fetch 'SAUCE_ACCESS_KEY', ENV['SAUCE_ACCESS_KEY']
+
+      @port = opts.fetch 'PORT', ENV['PORT'] || 4723
+
+      @os = :ios
+      @os = :android if @app_path.end_with?('.apk') || @app_path.end_with?('.apk.zip')
+      puts "OS is: #{@os}" if defined?(Pry)
+
+      # load common methods
+      extend Appium::Common
+      if @os == :android
+        raise 'APP_ACTIVITY must be set.' if @app_activity.nil?
+
+        # load Android specific methods
+        extend Appium::Android
+      else
+        # load iOS specific methods
+        extend Appium::Ios
+      end
+
+      # Save global reference to last created Appium driver for top level methods.
+      $last_driver = self
+    end # def initialize
+
+    # WebDriver capabilities. Must be valid for Sauce to work.
+    # https://github.com/jlipps/appium/blob/master/app/android.js
+    def android_capabilities
+      {
+        browserName: 'Android',
+        platform: 'LINUX',
+        version: '4.1',
+        device: 'Android',
+        name: @app_name || 'Ruby Console Android Appium',
+        app: absolute_app_path,
+        :'app-package' => @app_package,
+        :'app-activity' => @app_activity,
+        :'app-wait-activity' => @app_wait_activity
+      }
+    end
+
+    # WebDriver capabilities. Must be valid for Sauce to work.
+    def ios_capabilities
+      {
+        browserName: 'iOS 6.0',
+        platform: 'Mac 10.8',
+        version: '6.0',
+        device: 'iPhone Simulator',
+        name: @app_name || 'Ruby Console iOS Appium',
+        app: absolute_app_path
+      }
+    end
+
+    def capabilities
+      @os == :ios ? ios_capabilities : android_capabilities
+    end
+
+    # Converts environment variable APP_PATH to an absolute path.
+    # @return [String] APP_PATH as an absolute path
+    def absolute_app_path
+        raise 'APP_PATH environment variable not set!' if @app_path.nil? || @app_path.empty?
+        return @app_path if @app_path.match(/^http/) # public URL for Sauce
+        if @app_path.match(/^\//) # absolute file path
+          raise "App doesn't exist. #{@app_path}" unless File.exist? @app_path
+          return @app_path
+        end
+        file = File.join(File.dirname(__FILE__), @app_path)
+        raise "App doesn't exist #{file}" unless File.exist? file
+        file
+    end
+
+    # Get the server url for sauce or local based on env vars.
+    # @return [String] the server url
+    def server_url
+      if !@sauce_username.nil? && !@sauce_access_key.nil?
+        "http://#{@sauce_username}:#{@sauce_access_key}@ondemand.saucelabs.com:80/wd/hub"
+      else
+        "http://127.0.0.1:#{@port}/wd/hub"
+      end
+    end
+
+    # Restarts the driver
+    def restart
+      driver_quit
+      start_driver
+    end
+
+    # Quits the driver
+    # @return [void]
+    def driver_quit
+      # rescue NoSuchDriverError
+      begin; @driver.quit unless @driver.nil?; rescue; end
+    end
+
+    # Creates a new global driver and quits the old one if it exists.
+    # @return [Selenium::WebDriver] the new global driver
+    def start_driver wait=30
+      @client = @client || Selenium::WebDriver::Remote::Http::Default.new
+      @client.timeout = 999999
+
+      @default_wait = wait
+
+      begin
+        @driver = Selenium::WebDriver.for :remote, http_client: @client, desired_capabilities: capabilities, url: server_url
+      rescue Errno::ECONNREFUSED
+        raise 'ERROR: Unable to connect to Appium. Is the server running?'
+      end
+
+      # Set timeout to a large number so that Appium doesn't quit
+      # when no commands are entered after 60 seconds.
+      mobile :setCommandTimeout, timeout: 9999
+
+      # Set implicit wait by default unless we're using Pry.
+      @driver.manage.timeouts.implicit_wait = @default_wait unless defined? Pry
+
+      @driver
+    end
+
+    # Set implicit wait to zero.
+    def no_wait
+      @driver.manage.timeouts.implicit_wait = 0
+    end
+
+    # Set implicit wait to timeout, defaults to 30.
+    # @param timeout [Integer] the timeout in seconds
+    # @return [void]
+    def set_wait timeout=@default_wait
+      @driver.manage.timeouts.implicit_wait = timeout
+    end
+
+    # Returns the default client side wait.
+    # This value is independent of what the server is using
+    # @return [Integer]
+    def get_wait
+      @default_wait
+    end
+
+    # Returns existence of element.
+    #
+    # Example:
+    #
+    # exists { button('sign in') } ? puts('true') : puts('false')
+    #
+    # @return [Boolean]
+    def exists &search_block
+      pre_check = 0
+      post_check = @default_wait
+
+      set_wait pre_check # set wait to zero
+
+      # the element exists unless an error is raised.
+      exists = true
+
+      begin
+        search_block.call # search for element
+      rescue
+        exists = false # error means it's not there
+      end
+
+      # restore wait
+      set_wait post_check
+
+      exists
+    end
+
+    # The same as @driver.execute_script
+    # @return [Object] the object returned by execute_script
+    def execute_script script, *args
+      @driver.execute_script script, *args
+    end
+
+    # Helper method for mobile gestures
+    #
+    # https://github.com/appium/appium/wiki/Automating-mobile-gestures
+    #
+    # @driver.execute_script 'mobile: swipe', endX: 100, endY: 100, duration: 0.01
+    #
+    # becomes
+    #
+    # mobile :swipe, endX: 100, endY: 100, duration: 0.01
+    def mobile method, *args
+      raise 'Method must not be nil' if method.nil?
+      raise 'Method must have .to_s' unless method.respond_to? :to_s
+      @driver.execute_script "mobile: #{method.to_s}", *args
+    end
+
+    # Calls @driver.find_elements
+    def find_elements *args
+      @driver.find_elements *args
+    end
+
+    # Calls @driver.find_elements
+    def find_element *args
+      @driver.find_element *args
+    end
+
+    # Quit the driver and Pry.
+    # quit and exit are reserved by Pry.
+    def x
+      driver_quit
+      exit # exit pry
+    end
+  end # end class Driver
+end # end module Appium
+
+# Paging in Pry is annoying :q required to exit.
+# With pager disabled, the output is similar to IRB
+# Only set if Pry is defined.
+Pry.config.pager = false if defined?(Pry)