angular_webdriver 0.0.7 → 1.0.0

data/lib/angular_webdriver/protractor/watir_patch.rb

@@ -0,0 +1,209 @@
+require 'watir-webdriver/elements/element'
+
+# match protractor semantics
+# unfortunately setting always locate doesn't always locate.
+Watir.always_locate = true
+
+#
+# This patch serves a few purposes. The first is matching Protractor semantics
+# of lazy finding elements and always relocating elements (ex: element.text)
+#
+# The second is removing unnecessary bloatware from Watir which has a number
+# of checks that don't make sense for angular.js testing. The specifics
+# of this patch will change in the next Watir release. Currently version
+# 0.7.0 is targeted.
+#
+# The third is teaching Watir about angular specific locators
+#
+# Design goal: element.all(by.binding('slowHttpStatus'))
+#              should not make any server requests
+#
+
+module Watir
+
+  class HTMLElementCollection
+    # Return original selector.
+    # Method added for protractor compatibility
+    def locator
+      @selector
+    end
+  end
+
+  module Container
+    #
+    # Alias of elements for Protractor
+    #
+
+    def all(*args)
+      elements(*args)
+    end
+
+    # Redefine extract_selector to wrap find by repeater
+    upstream_extract_selector = instance_method(:extract_selector)
+    define_method(:extract_selector) do |selectors|
+      selectors = AngularWebdriver::ByRepeaterInner.wrap_repeater selectors
+
+      upstream_extract_selector.bind(self).call selectors
+    end
+
+  end # module Container
+
+  #
+  # Base class for HTML elements.
+  #
+
+  # Note the element class is different on master.
+
+  class Element
+
+    # Always raise on stale element ref error. Prevents infinite retry loop.
+    def element_call
+      yield
+    rescue Selenium::WebDriver::Error::StaleElementReferenceError
+      raise
+    end
+
+    def selected?
+      assert_exists
+      element_call { @element.selected? }
+    end
+
+    # required for watir otherwise execute_script will fail
+    #
+    # e = browser.element(tag_name: 'div')
+    # driver.execute_script 'return arguments[0].tagName', e
+    # {"script":"return arguments[0].tagName","args":[{"ELEMENT":"0"}]}
+    #
+    # Convert to a WebElement JSON Object for transmission over the wire.
+    # @see https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#basic-terms-and-concepts
+    #
+    # @api private
+    #
+    def to_json(*args)
+      assert_exists
+      { ELEMENT: @element.ref }.to_json
+    end
+
+    # Ensure that the element exists by always relocating it
+    # Required to trigger waitForAngular. Caching the element here will
+    # break the Protractor sync feature so this must be @element = locate.
+    def assert_exists
+      @element = locate
+    end
+
+    def assert_not_stale
+      nil
+    end
+
+    def assert_enabled
+      nil
+    end
+
+    # Return original selector.
+    # Method added for protractor compatibility
+    def locator
+      @selector
+    end
+
+    # avoid context lookup
+    def locate
+      locator_class.new(@parent.wd, @selector, self.class.attribute_list).locate
+    end
+
+    # Invoke protractor.allowAnimations with freshly located element and
+    # optional value.
+    def allowAnimations value=nil
+      assert_exists
+      driver.protractor.allowAnimations @element, value
+    end
+
+    # Watir doesn't define a clear method on element so we have to provide one.
+    def clear
+      assert_exists
+      element_call { @element.clear }
+    end
+
+    # Evaluate an Angular expression as if it were on the scope
+    # of the current element.
+    #
+    # @param expression <String> The expression to evaluate.
+    #
+    # @return <Object> The result of the evaluation.
+    def evaluate expression
+      assert_exists
+      driver.protractor.evaluate @element, expression
+    end
+
+    #
+    # Returns true if the element exists and is visible on the page.
+    #
+    # @return [Boolean]
+    # @see Watir::Wait
+    #
+    #
+    # rescue element not found
+    def present?
+      exists? && visible?
+    rescue Selenium::WebDriver::Error::NoSuchElementError, Selenium::WebDriver::Error::StaleElementReferenceError, UnknownObjectException
+      # if the element disappears between the exists? and visible? calls,
+      # consider it not present.
+      false
+    end
+  end
+
+
+  #
+  # The main class through which you control the browser.
+  #
+
+  class Browser
+    def assert_exists
+      # remove expensive window check
+      raise Exception::Error, 'browser was closed' if @closed
+    end
+
+    def inspect
+      nil # avoid expensive browser url and title lookup
+    end
+  end
+
+  class ElementLocator
+    def validate_element(element)
+      tn = @selector[:tag_name]
+      return element unless tn # don't validate nil tag names
+      element_tag_name = element.tag_name.downcase
+
+      return if tn && !tag_name_matches?(element_tag_name, tn)
+
+      if element_tag_name == 'input'
+        return if @selector[:type] && @selector[:type] != element.attribute(:type)
+      end
+
+      element
+    end
+
+    # always raise element not found / stale reference error
+    def locate
+      # element.all(by.partialButtonText('text')).to_a[0].value creates the
+      # selector {:element=>#<Selenium::WebDriver::Element ...>}
+      # in that case we've already located the element.
+      #
+      # see 'should find multiple buttons containing "text"' in locators_spec.rb
+      return @selector[:element] if @selector.is_a?(Hash) && @selector[:element].is_a?(Selenium::WebDriver::Element)
+
+      e = by_id and return e # short-circuit if :id is given
+
+      if @selector.size == 1
+        element = find_first_by_one
+      else
+        element = find_first_by_multiple
+      end
+
+      # This actually only applies when finding by xpath/css - browser.text_field(:xpath, "//input[@type='radio']")
+      # We don't need to validate the element if we built the xpath ourselves.
+      # It is also used to alter behavior of methods locating more than one type of element
+      # (e.g. text_field locates both input and textarea)
+      validate_element(element) if element
+    end
+  end
+end

data/lib/angular_webdriver/protractor/webdriver_patch.rb

@@ -0,0 +1,246 @@
+# https://github.com/SeleniumHQ/selenium/blob/1221ea539d92a46f392b00abccb9f48886415d26/rb/lib/selenium/webdriver/remote/bridge.rb#L576
+
+require 'selenium/webdriver/common/search_context'
+require 'selenium/webdriver/remote'
+require 'selenium/webdriver/remote/bridge'
+
+module Selenium
+  module WebDriver
+
+    class Driver
+      def protractor
+        @bridge.protractor
+      end
+
+      def protractor= protractor_object
+        @bridge.protractor = protractor_object
+      end
+
+      def bridge
+        @bridge
+      end
+
+      #
+      # Sets the wait time in seconds used when locating elements and
+      # waiting for angular tohttps://www.youtube.com/watch?v=o9c3U5_8tGY load.
+      #
+      # @param value [Numeric] the amount of time to wait in seconds
+      #
+      # @return [Numeric] the wait time in seconds
+      #
+      def set_max_wait value
+        @bridge.set_max_wait value
+      end
+
+      #
+      # Returns the wait time in seconds used when locating elements and
+      # waiting for angular to load.
+      #
+      def max_wait_seconds
+        @bridge.max_wait_seconds
+      end
+    end
+
+    module Remote
+      class Bridge
+        attr_accessor :protractor
+
+        def set_max_wait value
+          fail 'set_max_wait value must be a number' unless value.is_a?(Numeric)
+          # ensure no negative values
+          @max_wait_seconds = value >= 0 ? value : 0
+        end
+
+        def max_wait_seconds
+          # default to 0
+          @max_wait_seconds ||= 0
+        end
+
+        # execute_script requires a JSON representation of the element id
+        # otherwise the element will not be sent correctly to the browser
+        class WrappedParent
+          def initialize id
+            @id = id
+          end
+
+          def to_json *args
+            { ELEMENT: @id }.to_json
+          end
+        end
+
+        def protractor_find(many, how, what, parent = nil)
+          timeout = max_wait_seconds
+
+          # we have to waitForAngular here. unlike selenium locators,
+          # protractor locators don't go through execute. execute uses
+          # protractor.sync to run waitForAngular when finding elements.
+          wait(timeout: timeout, bubble: true) { protractor.waitForAngular }
+
+          # execute_script will invoke to_json on the parent, WrappedParent
+          # ensures that the JSON produces the expected result.
+          using         = parent ? WrappedParent.new(parent) : false
+          root_selector = protractor.root_element
+          comment       = "Protractor find by.#{how}"
+
+          # args order from locators.js
+          case how
+            when 'binding', 'exactBinding'
+              exact              = how == 'exactBinding'
+              binding_descriptor = what
+              args               = [binding_descriptor, exact, using, root_selector]
+              protractor_js      = protractor.client_side_scripts.find_bindings
+            when 'partialButtonText'
+              search_text   = what
+              args          = [search_text, using, root_selector]
+              protractor_js = protractor.client_side_scripts.find_by_partial_button_text
+            when 'buttonText'
+              search_text   = what
+              args          = [search_text, using, root_selector]
+              protractor_js = protractor.client_side_scripts.find_by_button_text
+            when 'model'
+              model         = what
+              args          = [model, using, root_selector]
+              protractor_js = protractor.client_side_scripts.find_by_model
+            when 'options'
+              options_descriptor = what
+              args               = [options_descriptor, using, root_selector]
+              protractor_js      = protractor.client_side_scripts.find_by_options
+            when 'cssContainingText'
+              json          = JSON.parse what
+              css_selector  = json['cssSelector']
+              search_text   = json['searchText']
+              args          = [css_selector, search_text, using, root_selector]
+              protractor_js = protractor.client_side_scripts.find_by_css_containing_text
+            when 'repeater' # includes 'exactRepeater'
+              json          = JSON.parse what
+              repeater_args = json['args'].values # json args is a hash
+              # using and root_selector are always passed to repeater even
+              # if the script doesn't use them.
+              args          = repeater_args + [using, root_selector]
+
+              # findRepeaterElement, findRepeaterRows, findRepeaterColumn, findAllRepeaterRows
+              script_name   = json['script'].intern
+
+              protractor_js = protractor.client_side_scripts.scripts[script_name]
+          end
+
+          finder = lambda { protractor.executeScript_(protractor_js, comment, *args) }
+
+          result = []
+
+          # Ignore any exceptions here because find_elements returns
+          # an empty array when there are no values found, not an error.
+          ignore do
+            wait_true(timeout) do
+              result = finder.call
+              result.length > 0
+            end
+          end
+
+          result ||= []
+
+          if many
+            return result
+          else
+            result = result.first
+            return result if result
+            fail ::Selenium::WebDriver::Error::NoSuchElementError
+          end
+        end
+
+        def find_element_by(how, what, parent = nil)
+          if protractor.finder? how
+            return protractor_find(false, how, what, parent)
+          end
+
+          if parent
+            id = execute :findChildElement, { :id => parent }, { :using => how, :value => what }
+          else
+            id = execute :findElement, {}, { :using => how, :value => what }
+          end
+
+          Element.new self, element_id_from(id)
+        end
+
+        def find_elements_by(how, what, parent = nil)
+          if protractor.finder? how
+            return protractor_find(true, how, what, parent)
+          end
+
+          if parent
+            ids = execute :findChildElements, { :id => parent }, { :using => how, :value => what }
+          else
+            ids = execute :findElements, {}, { :using => how, :value => what }
+          end
+
+          ids.map { |id| Element.new self, element_id_from(id) }
+        end
+
+        #
+        # driver.get uses execute which invokes protractor.get
+        # protractor.get needs to call driver.get without invoking
+        # protractor.get.
+        #
+        # this is accomplished by using driver_get and raw_execute
+        #
+
+        def driver_get(url)
+          raw_execute(:get, {}, :url => url)['value']
+        end
+
+        FIND_ELEMENT_METHODS  = [:findElement, :findChildElement].freeze
+        FIND_ELEMENTS_METHODS = [:findElements, :findChildElements].freeze
+
+        #
+        # executes a command on the remote server.
+        #
+        #
+        # Returns the 'value' of the returned payload
+        #
+
+        def execute(*args)
+          raise 'Must initialize protractor' unless protractor
+          method_symbol = args.first
+          unless protractor.ignore_sync
+            # override get method which has special sync logic
+            # (not handled via sync method)
+            if method_symbol == :get
+              url = args.last[:url]
+              return protractor.get url
+            end
+
+            protractor.sync method_symbol
+          end
+
+          timeout            = max_wait_seconds
+          finder             = lambda { raw_execute(*args)['value'] }
+          find_one_element   = FIND_ELEMENT_METHODS.include?(method_symbol)
+          find_many_elements = FIND_ELEMENTS_METHODS.include?(method_symbol)
+
+          if find_one_element
+            wait(timeout: timeout, bubble: true) do
+              finder.call
+            end
+          elsif find_many_elements
+            result = []
+
+            # Ignore any exceptions here because find_elements returns
+            # an empty array when there are no values found, not an error.
+            ignore do
+              wait_true(timeout) do
+                result = finder.call
+                result.length > 0
+              end
+            end
+
+            result ||= []
+            result
+          else # all other commands
+            finder.call
+          end
+        end
+
+      end # class Bridge
+    end # module Remote
+  end # module WebDriver
+end # module Selenium

data/lib/angular_webdriver/version.rb

@@ -1,4 +1,4 @@
 module AngularWebdriver
-  VERSION = '0.0.7' unless defined? ::AngularWebdriver::VERSION
-  DATE    = '2015-05-12' unless defined? ::AngularWebdriver::DATE
+  VERSION = '1.0.0' unless defined? ::AngularWebdriver::VERSION
+  DATE    = '2015-06-06' unless defined? ::AngularWebdriver::DATE
 end

data/lib/angular_webdriver.rb

@@ -1 +1,14 @@
-require_relative 'angular_webdriver/protractor/protractor'
+require_relative 'angular_webdriver/version'
+
+require 'rubygems'
+require 'selenium-webdriver'
+require 'watir-webdriver'
+
+require_relative 'angular_webdriver/protractor/by'
+require_relative 'angular_webdriver/protractor/by_repeater_inner'
+require_relative 'angular_webdriver/protractor/client_side_scripts'
+require_relative 'angular_webdriver/protractor/protractor'
+require_relative 'angular_webdriver/protractor/protractor_element'
+require_relative 'angular_webdriver/protractor/rspec_helpers'
+require_relative 'angular_webdriver/protractor/webdriver_patch'
+require_relative 'angular_webdriver/protractor/watir_patch'

data/{lib/angular_webdriver/protractor/get_url_trace.rb → notes/bootstrap_notes.md}

@@ -1,3 +1,15 @@
+# https://github.com/SeleniumHQ/selenium/blob/51fd82ec9cb1ebe7596bf7bb3fb8290113466a9a/rb/lib/selenium/webdriver/common/search_context.rb#L23
+# protractor/lib/locators.js
+#
+# ProtractorBy.prototype.binding = function(bindingDescriptor) {
+# return {
+#   findElementsOverride: function(driver, using, rootSelector) {
+#     return driver.findElements(
+#         webdriver.By.js(clientSideScripts.findBindings,
+#             bindingDescriptor, false, using, rootSelector));
+#   },
+
+```
 =begin
 
 executeAsyncScript_ & executeScript_ wrappers not required. The description
@@ -213,3 +225,4 @@ catch(e) { throw (e instanceof Error) ? e : new Error(e); }, [, false, null, bod
 14:20:15.086 INFO - Executing: [get text: 1 [org.openqa.selenium.remote.RemoteWebElement@dee620f8 -> unknown locator]])
 ...
 =end
+```

data/notes/element_by_id/element_by_id_sync_off.txt

@@ -0,0 +1,12 @@
+browser.get('https://angularjs.org/')
+element(by.id('the-basics')).getText()
+The Basics
+
+13:06:18.990 INFO - Executing: [execute script: , []])
+13:06:18.990 INFO - Executing: [execute script: , []])
+13:06:18.990 INFO - Executing: [find elements: By.id: the-basics])
+13:06:19.704 INFO - Done: [execute script: , []]
+13:06:19.799 INFO - Done: [find elements: By.id: the-basics]
+13:06:19.815 INFO - Executing: [get text: 0 [[FirefoxDriver: firefox on MAC (6e728ccc-09cf-0b47-a80e-44bdfdbb8a1b)] -> id: the-basics]])
+13:06:19.865 INFO - Done: [execute script: , []]
+13:06:19.930 INFO - Done: [get text: 0 [[FirefoxDriver: firefox on MAC (6e728ccc-09cf-0b47-a80e-44bdfdbb8a1b)] -> id: the-basics]]

data/notes/element_by_id/element_by_id_sync_on.txt

@@ -0,0 +1,74 @@
+browser.get('https://angularjs.org/')
+element(by.id('the-basics')).getText()
+The Basics
+
+
+the waitForAngular method is called before the get by id method.
+
+
+13:04:57.684 INFO - Executing: [execute script: , []])
+13:04:57.684 INFO - Executing: [execute script: , []])
+
+waitForAngular - clientsidescript
+
+13:04:57.684 INFO - Executing: [execute async script: try { return (function (rootSelector, callback) {
+  var el = document.querySelector(rootSelector);
+
+  try {
+    if (!window.angular) {
+      throw new Error('angular could not be found on the window');
+    }
+    if (angular.getTestability) {
+      angular.getTestability(el).whenStable(callback);
+    } else {
+      if (!angular.element(el).injector()) {
+        throw new Error('root element (' + rootSelector + ') has no injector.' +
+           ' this may mean it is not inside ng-app.');
+      }
+      angular.element(el).injector().get('$browser').
+          notifyWhenNoOutstandingRequests(callback);
+    }
+  } catch (err) {
+    callback(err.message);
+  }
+}).apply(this, arguments); }
+catch(e) { throw (e instanceof Error) ? e : new Error(e); }, [body]])
+13:04:57.684 INFO - Executing: [execute script: , []])
+13:04:57.685 INFO - Executing: [execute script: , []])
+13:04:58.617 INFO - Done: [execute script: , []]
+13:04:58.694 INFO - Done: [execute script: , []]
+
+waitForAngular - clientsidescript
+
+13:04:58.771 INFO - Done: [execute async script: try { return (function (rootSelector, callback) {
+  var el = document.querySelector(rootSelector);
+
+  try {
+    if (!window.angular) {
+      throw new Error('angular could not be found on the window');
+    }
+    if (angular.getTestability) {
+      angular.getTestability(el).whenStable(callback);
+    } else {
+      if (!angular.element(el).injector()) {
+        throw new Error('root element (' + rootSelector + ') has no injector.' +
+           ' this may mean it is not inside ng-app.');
+      }
+      angular.element(el).injector().get('$browser').
+          notifyWhenNoOutstandingRequests(callback);
+    }
+  } catch (err) {
+    callback(err.message);
+  }
+}).apply(this, arguments); }
+catch(e) { throw (e instanceof Error) ? e : new Error(e); }, [body]]
+13:04:58.792 INFO - Executing: [find elements: By.id: the-basics])
+
+13:04:59.019 INFO - Done: [execute script: , []]
+13:04:59.085 INFO - Done: [execute script: , []]
+13:04:59.218 INFO - Done: [find elements: By.id: the-basics]
+13:04:59.240 INFO - Executing: [get text: 0 [[FirefoxDriver: firefox on MAC (6e728ccc-09cf-0b47-a80e-44bdfdbb8a1b)] -> id: the-basics]])
+13:04:59.286 INFO - Done: [get text: 0 [[FirefoxDriver: firefox on MAC (6e728ccc-09cf-0b47-a80e-44bdfdbb8a1b)] -> id: the-basics]]
+
+
+

data/notes/element_chaining_debug.txt

@@ -0,0 +1,94 @@
+debugging  'should allow chaining while returning a single column'
+
+["allinfo in days", false, 2, "name", "{ebfdf19b-a4a8-be46-8118-6f313da550fd}", nil]
+
+
+
+The element reference isn't being sent properly.
+
+
+Ruby server output:
+
+catch(e) { throw (e instanceof Error) ? e : new Error(e); }, [allinfo in days, false, 2, name, 0, body]])
+
+
+element.ref is 0
+
+
+Protractor server output:
+
+[allinfo in days, false, 2, name, [[FirefoxDriver: firefox on MAC (7f28005d-8e97-024e-86aa-879ee42d9e76)] -> css selector: .allinfo], body]]
+
+catch(e) { throw (e instanceof Error) ? e : new Error(e); }, [allinfo in days, false, 2, name, [[FirefoxDriver: firefox on MAC (7f28005d-8e97-024e-86aa-879ee42d9e76)] -> css selector: .allinfo], body]]
+
+---
+
+browser.get('http://localhost:8081/#/repeater')
+
+
+var secondName = element(by.css('.allinfo')).element(by.repeater('allinfo in days').column('name').row(2))
+
+---
+
+> e.ref
+=> "2"
+
+
+driver.execute_script 'return arguments[0].tagName', e
+> DIV
+driver.execute_script 'return arguments[0].tagName', e.ref
+> nil
+
+driver.execute_script 'return arguments[0].tagName', 2
+=> nil
+
+driver.execute_script 'return arguments[0].tagName', '2'
+=> nil
+
+
+driver.execute_script 'return arguments[0].tagName', '{7c79f087-b7a2-dd43-be77-2a4076cb5959}'
+=> nil
+
+
+e =  browser.element(tag_name: 'div')
+
+
+---
+
+> command_hash
+=> {:script=>"return arguments[0].tagName", :args=>[#<Selenium::WebDriver::Element:0x..fea95b8c7217851b0 id="0">]}
+
+---
+
+e = browser.element(tag_name: 'div')
+driver.execute_script 'return arguments[0].tagName', e
+
+Requesting: {"script":"return arguments[0].tagName","args":["#<Watir::HTMLElement:0x007f8a6d098ae0>"]}
+
+patched webdriver http default to output request body
+
+def new_request_for(verb, url, headers, payload)
+  puts "Requesting: #{req.body}"
+
+---
+
+e = driver.find_element(tag_name: 'div')
+driver.execute_script 'return arguments[0].tagName', e
+Requesting: {"script":"return arguments[0].tagName","args":[{"ELEMENT":"0"}]}
+
+----
+
+> puts e.to_json
+{"ELEMENT":"0"}
+
+---
+
+
+element id changes depending on if a remote bridge or a firefox bridge is used.
+remote bridges start at 0 and go up by one.
+
+firefox bridge uses hashes.
+
+---
+
+driver.execute_script 'return arguments[0].tagName', WrappedParent.new('0')