wda_lib 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfdde1a94a7e89b876fd905f1db859231e2cd73b
+  data.tar.gz: 37a66250c8f8f125ef8294fbceff4669599e4ac0
+SHA512:
+  metadata.gz: 1691ebedf044e9e1bb4d2a197ee179c91bb846ebe05d9a3809179fa2d12c8fbe21a15ac9258b4c3828cf2d6037c1a23b7a07a11380abb944ad5c8c49eef157ac
+  data.tar.gz: 77982675f07d2486c1a5e8f261399d8495171b84c6b01091e48ebc5af48b2baa08091ce8213f28da70e35fdc6bad4f69b483cce15127c5715621f4939a9904fd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/*.gem
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,171 @@
+### wda_lib
+
+A simple ruby lib of binding methods for WebDriverAgent
+
+## Install
+
+```
+gem install wda_lib
+```
+
+## Usage example
+A simple test to show all actions on WDA IntegrationApp
+
+```ruby
+require 'wda_lib'
+
+app = WDA.new
+
+app.x
+
+app.homescreen
+
+app.launch_app('com.facebook.IntegrationApp')
+
+app.status
+
+app.session
+
+app.button('Alerts')
+
+app.button('Alerts').ref
+
+app.button('Alerts').name
+
+app.button('Alerts').click
+
+app.partial_texts('Create')[1].click
+
+app.alert_text
+
+app.accept_alert
+
+app.button('Back').click
+
+app.partial_text('Attri').click
+
+app.xpath_search('StaticText', 'label', 'Label')
+
+app.xpath_search('Button', 'name', 'Second')[0].click
+
+app.textfield('Value').click
+
+app.textfield('Value').send_keys('test')
+
+app.textfield('Valuetest').clear
+
+location = app.textfield('Value2').location
+
+app.tap_on(location[:x], location[:y])
+
+app.keys('Type more keys')
+
+app.button('Back').click
+
+sleep 1
+
+app.find(:xpath, "//XCUIElementTypeButton[@name='Scrolling']").click
+
+app.text('ScrollView').click
+
+app.text('7').scroll('down')
+
+app.text('7').scroll('down')
+
+app.text('7').scroll('up')
+
+app.swipe(180, 180, 330, 100)
+
+app.swipe(180, 180, 100, 330)
+
+app.button('Back').click
+
+app.button('Back').click
+
+app.x
+
+```
+
+## Example of multiple devices
+
+```ruby
+iphone_testing = true
+simulator_testing = true
+
+thread_iphone = Thread.new{
+  start_time = Time.now
+  app = WDA.new(device_url: 'http://192.168.1.56:8100/')
+  app.x
+  app.homescreen
+  app.launch_app('com.facebook.IntegrationApp')
+  app.find(:xpath, "//XCUIElementTypeButton[@name='Scrolling']").click
+  app.text('ScrollView').click
+  app.text('7').scroll('down')
+  app.text('7').scroll('down')
+  app.text('7').scroll('up')
+  app.swipe(180, 180, 330, 100)
+  app.swipe(180, 180, 100, 330)
+  app.button('Back').click
+  app.x
+  end_time = Time.now  
+  p "Testing time: #{end_time-start_time}"
+  iphone_testing = false
+}
+
+thread_simulator = Thread.new{
+  start_time = Time.now
+  sim = WDA.new
+  sim.x
+  sim.homescreen
+  sim.launch_app('com.facebook.IntegrationApp')
+  sim.find(:xpath, "//XCUIElementTypeButton[@name='Scrolling']").click
+  sim.text('ScrollView').click
+  sim.text('7').scroll('down')
+  sim.text('7').scroll('down')
+  sim.text('7').scroll('up')
+  sim.swipe(180, 180, 330, 100)
+  sim.swipe(180, 180, 100, 330)
+  sim.button('Back').click
+  sim.x
+  end_time = Time.now  
+  p "Testing time: #{end_time-start_time}"
+  simulator_testing = false
+}
+
+while iphone_testing || simulator_testing do 
+  sleep 5 
+end
+
+```
+
+## Options
+
+This lib is also providing access of selenium-webdriver method find_element and find_elements.
+You can do:
+
+```ruby
+element = app.find_element(:link_text, 'label=Attributes')
+```
+
+Then you can use all methods for selenium element object:
+```
+element.click
+element.name
+element.size
+element.rect
+element.location
+```
+
+## TODO
+
+Add more tests...
+
+## Contributing
+
+Welcome to get your contributions, to help improving the lib.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/selenium_patch/commands.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Remote
+      class W3CBridge
+        #
+        # http://www.w3.org/TR/2015/WD-webdriver-20150918/#list-of-endpoints
+        #
+
+        #
+        # session handling
+        #
+
+        command :newSession, :post, 'session'
+        command :deleteSession, :delete, 'session/:session_id'
+
+        #
+        # basic driver
+        #
+
+        command :get, :post, 'session/:session_id/url'
+        command :getCurrentUrl, :get, 'session/:session_id/url'
+        command :back, :post, 'session/:session_id/back'
+        command :forward, :post, 'session/:session_id/forward'
+        command :refresh, :post, 'session/:session_id/refresh'
+        command :getTitle, :get, 'session/:session_id/title'
+
+        #
+        # window and Frame handling
+        #
+
+        command :getWindowHandle, :get, 'session/:session_id/window'
+        command :closeWindow, :delete, 'session/:session_id/window'
+        command :switchToWindow, :post, 'session/:session_id/window'
+        command :getWindowHandles, :get, 'session/:session_id/window/handles'
+        command :fullscreenWindow, :post, 'session/:session_id/window/fullscreen'
+        command :maximizeWindow, :post, 'session/:session_id/window/maximize'
+        command :setWindowSize, :post, 'session/:session_id/window/size'
+        command :getWindowSize, :get, 'session/:session_id/window/size'
+        command :switchToFrame, :post, 'session/:session_id/frame'
+        command :switchToParentFrame, :post, 'session/:session_id/frame/parent'
+
+        #
+        # element
+        #
+
+        command :findElement, :post, 'session/:session_id/element'
+        command :findElements, :post, 'session/:session_id/elements'
+        command :findChildElement, :post, 'session/:session_id/element/:id/element'
+        command :findChildElements, :post, 'session/:session_id/element/:id/elements'
+        command :getActiveElement, :get, 'session/:session_id/element/active'
+        command :isElementSelected, :get, 'session/:session_id/element/:id/selected'
+        command :getElementAttribute, :get, 'session/:session_id/element/:id/attribute/:name'
+        command :getElementProperty, :get, 'session/:session_id/element/:id/property/:name'
+        command :getElementCssValue, :get, 'session/:session_id/element/:id/css/:property_name'
+        command :getElementText, :get, 'session/:session_id/element/:id/text'
+        command :getElementTagName, :get, 'session/:session_id/element/:id/name'
+        command :getElementRect, :get, 'session/:session_id/element/:id/rect'
+        command :isElementEnabled, :get, 'session/:session_id/element/:id/enabled'
+
+        #
+        # document handling
+        #
+
+        command :getPageSource, :get, '/session/:session_id/source'
+        command :executeScript, :post, 'session/:session_id/execute/sync'
+        command :executeAsyncScript, :post, 'session/:session_id/execute/async'
+
+        #
+        # cookies
+        #
+
+        command :getAllCookies, :get, 'session/:session_id/cookie'
+        command :getCookie, :get, 'session/:session_id/cookie/:name'
+        command :addCookie, :post, 'session/:session_id/cookie'
+        command :deleteCookie, :delete, 'session/:session_id/cookie/:name'
+
+        #
+        # timeouts
+        #
+
+        command :setTimeout, :post, 'session/:session_id/timeouts'
+
+        #
+        # actions
+        #
+
+        command :actions, :post, 'session/:session_id/actions'
+
+        #
+        # Element Operations
+        #
+
+        command :elementClick, :post, 'session/:session_id/element/:id/click'
+        command :elementTap, :post, 'session/:session_id/element/:id/tap'
+        command :elementClear, :post, 'session/:session_id/element/:id/clear'
+        command :elementSendKeys, :post, 'session/:session_id/element/:id/value'
+        command :elementScroll, :post, 'session/:session_id/uiaElement/:id/scroll'
+
+        #
+        # alerts
+        #
+
+        command :dismissAlert, :post, 'session/:session_id/alert/dismiss'
+        command :acceptAlert, :post, 'session/:session_id/alert/accept'
+        command :getAlertText, :get, 'session/:session_id/alert/text'
+        command :sendAlertText, :post, 'session/:session_id/alert/text'
+
+        #
+        # screenshot
+        #
+
+        command :takeScreenshot, :get, 'session/:session_id/screenshot'
+        command :takeElementScreenshot, :get, 'session/:session_id/element/:id/screenshot'
+      end
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium_patch/element_patch.rb

@@ -0,0 +1,53 @@
+# require 'selenium-webdriver'
+
+# Patch or add methods for Element instance
+Selenium::WebDriver::Element.class_eval do 
+  def eid
+    @id['ELEMENT']
+  end
+
+  # Scroll on an element with its id
+  # @param id [String], direction [String] up, down, left, right
+  # @return {}
+  def scroll(direction)
+    bridge.element_scroll @id, direction
+  end
+
+  # Get wdRect by id
+  # @param id [String] Element uuid
+  # @return rect [Hash] location: y, x, size: width, height 
+  def rect
+    bridge.element_rect @id
+  end
+
+  # Get element type attribute
+  # @return [String] example: "XCUIElementTypePageIndicator", "XCUIElementTypeButton"
+  def type
+    bridge.element_tag_name @id
+  end
+
+  # Get element value attribute
+  def value
+    bridge.element_attribute @id, 'value'
+  end
+
+  # Get element name attribute
+  def name
+    bridge.element_attribute @id, 'name'
+  end
+
+  # Get element name attribute
+  def label
+    bridge.element_attribute @id, 'label'
+  end
+
+  # Get the value of a the given attribute of the element.
+  # @param [String]
+  #   attribute name, example: type, label, name, value, rect
+  # @return [String,nil]
+  #   attribute value
+  def attribute(name)
+    bridge.element_attribute @id, name
+  end
+
+end

data/lib/selenium_patch/w3c_bridge_patch.rb

@@ -0,0 +1,31 @@
+# Patch or add methods for Bridge. Called by Element instance or Bridge instance
+
+Selenium::WebDriver::Remote::W3CBridge.class_eval do
+  # Patch W3CBridge create_session method
+  def create_session(desired_capabilities)
+    @session_id = desired_capabilities[:session_id]
+    if !desired_capabilities[:session_valid]
+      resp = raw_execute :newSession, {}, {desiredCapabilities: desired_capabilities}
+      desired_capabilities[:session_id] = resp['sessionId']
+      desired_capabilities[:session_valid] = true 
+      @session_id = resp['sessionId']
+    end
+    return desired_capabilities
+  end
+
+  # Add element_scroll method
+  def element_scroll(element, direction)
+    execute :elementScroll, {id: element.values.first}, {direction: direction}
+  end
+
+  # Add element_rect method
+  def element_rect(element)
+    data = execute :getElementRect, id: element['ELEMENT']
+    return data
+  end
+
+  # Patch W3CBridge element_attribute method
+  def element_attribute(element, name)
+    execute :getElementAttribute, id: element['ELEMENT'], name: name
+  end
+end

data/lib/wda_lib/alert.rb

@@ -0,0 +1,21 @@
+class WDA
+  module Alert
+
+    # Get alert
+    # Return text [String]
+    def alert_text
+      get('/alert/text')['value']
+    end
+
+    # Accept alert
+    def accept_alert
+      post '/alert/accept'
+    end
+
+    # Dismiss alert
+    def dismiss_alert
+      post '/alert/dismiss'
+    end
+  end
+end
+    

data/lib/wda_lib/custom.rb

@@ -0,0 +1,33 @@
+class WDA
+  module Custome
+
+    # Go to home screen
+    def homescreen
+      post(@base_url + '/homescreen')
+    end
+
+    # Same as homescreen, go to home screen
+    def springboard
+      homescreen
+    end
+
+    # Deactivate application for given time
+    def pause(duration)
+      post '/deactivateApp', { duration: duration }
+    end
+
+    # Timeout(without Session)
+    # @param duraiton [Float] the timeout in milliseconds
+    # @return [void]
+    def timeout(duraiton)
+      post(@base_url + '/timeout', { type: 'xctevent', ms: duration })
+    end
+
+    # Timeout(with Session)
+    # @param duration [Float] the timeout in milliseconds
+    # @return [void]
+    def timeout_in_session(duraiton)
+      post '/timeout', { type: 'xctevent', ms: duration }
+    end
+  end
+end

data/lib/wda_lib/debug.rb

@@ -0,0 +1,26 @@
+class WDA
+  module Debug
+    
+    # Get all elements on the screen
+    def source(session_id = nil, accessible = true)
+      if session_id.nil?
+        post(@base_url + '/source', { accessible: accessible })
+      else
+        post '/source', { accessible: accessible }
+      end 
+    end
+
+    def get_source
+      get(@base_url + '/source')['value']['tree']['children']
+    end
+
+    def get_window_statusbar
+      get(@base_url + '/source')['value']['tree']['children'][2]
+    end
+
+    def get_window(window_number = 0)
+      get(@base_url + '/source')['value']['tree']['children'][window_number]
+    end
+
+  end
+end

data/lib/wda_lib/element.rb

@@ -0,0 +1,183 @@
+class WDA
+  class Element
+
+    def initialize(client, id)
+      @client = client
+      @id = id
+    end
+
+    # Remove useless attributes, return object only with element
+    def inspect
+      format '#<%s:0x%x id=%s>', self.class, hash * 2, @id.inspect
+    end
+
+    def ref
+      @id
+    end
+
+    def eid
+      @id['ELEMENT']
+    end
+
+    # Check if element is enabled?
+    # @param id [String] Element uuid
+    # @return isEnabled? [Boolean]
+    def enabled?
+      client.get '/element/' + eid + '/enabled'
+    end
+
+    # Get wdRect by id
+    # @param id [String] Element uuid
+    # @return wdRect 
+    def rect
+      client.get '/element/' + eid + '/rect'
+    end
+
+    # Get attribute value
+    # @param id [String], name [String]
+    # @return attributeValue [String]
+    def attribute(name)
+      client.get '/element/' + eid + '/attribute/' + name
+    end
+
+    # Get text from an element(StaticText or Button)
+    # @param id [String] Element uuid
+    # @return text [String]
+    def text
+      client.get '/element/' + eid + '/text'
+    end
+
+    # Check if element is displayed?
+    # @param id [String] Element uuid
+    # @return isVisible? [Boolean]
+    def displayed?
+      client.get '/element/' + eid + '/displayed'
+    end
+    
+    # Check if element is accessible?
+    # @param id [String] Element uuid
+    # @return is accessible? [String]
+    def accessible?
+      client.get '/element/' + eid + '/accessible'
+    end
+    
+    # Check if element is accessibilityContainer?
+    # @param id [String] Element uuid
+    # @return is accessibilityContainer? [String]
+    def accessible_container?
+      client.get '/element/' + eid + '/accessibilityContainer'
+    end
+
+
+    # Get type from an element
+    # @param id [String] Element uuid
+    # @return type [String]
+    def name
+      client.get '/element/' + eid + '/name'
+    end
+
+    # Set value to an element
+    # @param id [String] Element uuid, value [String]
+    # @return element uuid [String]
+    def send_keys(value)
+      client.post '/element/' + eid + '/value', { value: value.chars }
+    end
+
+    # Tap on an element with its id
+    # @param id [String] Element uuid
+    # @return element uuid [String]
+    def click
+      client.post '/element/' + eid + '/click'
+    end
+
+    # Clearing text of an given element
+    # @param id [String] Element uuid
+    # @return element uuid [String]
+    def clear
+      client.post '/element/' + eid + '/clear'
+    end
+
+    # Double tap on an element with its id
+    # @param id [String] Element uuid
+    # @return element uuid [String]
+    def double_tap
+      client.post '/uiaElement/' + eid + '/doubleTap'
+    end
+
+    # Two finger tap on an element with its id
+    # @param id [String] Element uuid
+    # @return element uuid [String]
+    def two_finger_tap
+      client.post '/uiaElement/' + eid + '/twoFingerTap'
+    end
+
+    # Touch and hold on for a while finger tap on an element with its id
+    # @param id [String], duration [Double]
+    # @return element uuid [String]
+    def touch_hold(duration)
+      client.post '/uiaElement/' + eid + '/touchAndHold', { duration: duration }
+    end
+
+    # Scroll on an element with its id
+    # @param id [String], direction [String] up, down, left, right
+    # @return [Hash]
+    def scroll(direction = nil)
+      client.post '/uiaElement/' + eid + '/scroll', { direction: direction }
+    end
+
+    # Drag on an element with its id and position
+    # @param to* [String], duration [Double]
+    def drag_to(toX, toY, duration = 0)
+      fromX = location[:x]
+      fromY = location[:y]
+      client.post '/uiaTarget/' + eid + '/dragfromtoforduration', { fromX: fromX, toX: toX, fromY: fromY, toY: toY, duration: duration }
+    end
+
+    # Get element size
+    # @return [Struct] [:width, :height]
+    def size
+      r = rect['value']
+      Dimension.new(r['width'], r['height'])
+    end
+
+    # Get element size
+    # @return [Struct] [:x, :y]
+    def location
+      r = rect['value']
+      Point.new(r['x'], r['y'])
+    end
+
+    alias_method :[], :attribute
+
+    private
+
+    attr_reader :client
+
+  end
+
+  # Swipe on an element with its id and position
+  # @param [Integer]
+  def swipe(fromX, toX, fromY, toY)
+    post '/uiaTarget/0/dragfromtoforduration', { fromX: fromX, toX: toX, fromY: fromY, toY: toY, duration: 0 }
+  end
+
+  # Tap on a given positon
+  # @param id [String], x, y [Integer]
+  def tap_on(x, y)
+    post '/tap/0', { x: x, y: y }
+  end
+
+  # Type text to textfield
+  # @param value [String] 
+  def keys(value)
+    post '/keys', { value: value.chars }
+  end
+
+  # @return width, height
+  def window_size
+    win_size = get('/window/size')['value']
+    Dimension.new(win_size['width'], win_size['height'])
+  end
+
+end
+