axe-core-api 4.0.0 → 4.2.0.pre.33afee3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9643d81e17129aeceeeae359d0bff29ca30fea8fe9291bf35081caee537eec42
-  data.tar.gz: 58e7bd8b82a0a1a17d047a3417a22e82b794ada5b62447b83acf2a5689a12a9f
+  metadata.gz: f912af3af630db04fffaf7bf951e439d8d50b302446cb531928a453d317f55c5
+  data.tar.gz: c144064037bd09230de05f6a25c55846dc92742ad126be45d6023db8b2298406
 SHA512:
-  metadata.gz: 1926fe5633260d63b6b4f21a5cd5e8387135a7b46767f7796abe8dd354f6c6da996aab61c70b4f700b28d5e7ed892a3d0b2860b9479a0b5baff76d0d50c6e744
-  data.tar.gz: 5452fd2f97449a985d9eaa9f448c665048aaab8b5f7f7900e5171a78811a2fafb5b217804990963f9d50908ef956f72134b61ee29ee015e0398046f4ace38696
+  metadata.gz: 330231cec5eb39c3dbdb18acc05a69d0c19051da826a2753f51364d120445731113eb8fabb3af801294817a6b536ee28083a2086b0f13e1df28490404e39ba82
+  data.tar.gz: b84595ee0edd9b02e241248eb47c429d4ae5ae651961f20e08454d79bca303c58042520a2993c1fa124d3ca43e4c096efc5394d1d8d8f5ebe10d2d0c37a280cd

data/lib/axe/api/context.rb

@@ -16,13 +16,19 @@ module Axe
         @exclusion.concat selectors.map { |s| Array(Selector.new s) }
       end
 
+      def to_h
+        to_hash
+      end
       def to_hash
-        { include: @inclusion, exclude: @exclusion }
-          .reject { |k, v| v.empty? }
+        return { exclude: @exclusion } if @inclusion.empty?
+        h = {}
+        h["include"] = @inclusion unless @inclusion.empty?
+        h["exclude"] = @exclusion unless @exclusion.empty?
+        h
       end
 
-      def to_json
-        to_hash.to_json
+      def to_json(options = nil)
+        to_hash.to_json options
       end
 
       def empty?

data/lib/axe/api/options.rb

@@ -14,12 +14,16 @@ module Axe
         @custom = {}
       end
 
+      def to_h
+        to_hash
+      end
+
       def to_hash
         @rules.to_hash.merge(@custom)
       end
 
-      def to_json
-        to_hash.to_json
+      def to_json(options = nil)
+        to_hash.to_json options
       end
 
       def empty?

data/lib/axe/api/results.rb

@@ -10,6 +10,10 @@ module Axe
         attribute :incomplete, ::Array[Rule]
         attribute :passes, ::Array[Rule]
         attribute :timestamp
+        attribute :testEngine
+        attribute :testEnvironment
+        attribute :testRunner
+        attribute :toolOptions
         attribute :url, ::String
         attribute :violations, ::Array[Rule]
       end
@@ -28,12 +32,18 @@ module Axe
           inapplicable: inapplicable.map(&:to_h),
           incomplete: incomplete.map(&:to_h),
           passes: passes.map(&:to_h),
+          testEngine: testEngine,
           timestamp: timestamp,
           url: url,
           violations: violations.map(&:to_h),
         }
       end
 
+      def timestamp=(ts)
+        timestamp = ts
+      end
+
+
       private
 
       def violation_count_message

data/lib/axe/api/run.rb

@@ -27,21 +27,182 @@ module Axe
       end
 
       def call(page)
-        audit page do |results|
-          Audit.new to_js, Results.new(results)
-        end
+        results = audit page
+        Audit.new to_js, Results.new(results)
+      end
+
+      def analyze_post_43x(page, lib)
+        @original_window = window_handle page
+        partial_results = run_partial_recursive(page, @context, lib, true)
+        throw partial_results if partial_results.respond_to?("key?") and partial_results.key?("errorMessage")
+        results = within_about_blank_context(page) { |page|
+          Common::Loader.new(page, lib).load_top_level Axe::Configuration.instance.jslib
+          begin
+            axe_finish_run page, partial_results
+          rescue
+            raise StandardError.new "axe.finishRun failed. Please check out https://github.com/dequelabs/axe-core-gems/error-handling.md`"
+          end
+        }
+        Audit.new to_js, Results.new(results)
       end
 
       private
 
       def audit(page)
-        yield page.execute_async_script "#{METHOD_NAME}.apply(#{Core::JS_NAME}, arguments)", *js_args
+        script = <<-JS
+          var callback = arguments[arguments.length - 1];
+          var context = arguments[0] || document;
+          var options = arguments[1] || {};
+          #{METHOD_NAME}(context, options).then(callback);
+        JS
+        page.execute_async_script_fixed script, *js_args
+      end
+
+      def switch_to_frame_by_handle(page, handle)
+        page = get_selenium page
+        page.switch_to.frame handle
+      end
+
+      def switch_to_parent_frame(page)
+        page = get_selenium page
+        page.switch_to.parent_frame
+      end
+
+      def within_about_blank_context(page)
+        driver = get_selenium page
+
+        num_handles = page.window_handles.length
+        begin
+          driver.execute_script("window.open('about:blank'), '_blank'")
+          if num_handles == page.window_handles.length
+            raise StandardError.new "Could not open new window. Please make sure that you have popup blockers disabled."
+          end
+          driver.switch_to.window page.window_handles[-1]
+        rescue
+            raise StandardError.new "switchToWindow failed. Are you using updated browser drivers?"
+        end
+        driver.get "about:blank"
+
+        ret = yield page
+
+        driver.switch_to.window page.window_handles[-1]
+        driver.close
+        driver.switch_to.window @original_window
+
+        ret
+      end
+      def window_handle(page)
+        page = get_selenium page
+
+        return page.window_handle if page.respond_to?("window_handle")
+        page.current_window_handle
+      end
+
+      def run_partial_recursive(page, context, lib, top_level = false)
+        begin
+          if not top_level
+            begin
+              Common::Loader.new(page, lib).load_top_level Axe::Configuration.instance.jslib
+            rescue
+              return [nil]
+            end
+
+          end
+
+          frame_contexts = get_frame_context_script page
+          if frame_contexts.respond_to?("key?") and frame_contexts.key?("errorMessage")
+            throw frame_contexts if top_level
+            return [nil]
+          end
+
+          res = axe_run_partial page, context
+          if res.key?("errorMessage")
+            throw res if top_level
+            return [nil]
+          else
+            results = [res]
+          end
+
+          for frame_context in frame_contexts
+            frame_selector = frame_context["frameSelector"]
+            frame_context = frame_context["frameContext"]
+            frame = axe_shadow_select page, frame_selector
+            switch_to_frame_by_handle page, frame
+            res = run_partial_recursive page, frame_context, lib
+            results += res
+          end
+
+        ensure
+          switch_to_parent_frame page if not top_level
+        end
+        return results
+      end
+
+      def axe_finish_run(page, partial_results)
+        script = <<-JS
+          const partialResults = arguments[0];
+          return axe.finishRun(partialResults);
+        JS
+        page.execute_script_fixed script, partial_results
+      end
+
+      def axe_shadow_select(page, frame_selector)
+        script = <<-JS
+          const frameSelector = arguments[0];
+          return axe.utils.shadowSelect(frameSelector);
+        JS
+        page.execute_script_fixed script, frame_selector
+      end
+
+      def axe_run_partial(page, context)
+        script = <<-JS
+          const context = arguments[0];
+          const options = arguments[1];
+          const cb = arguments[arguments.length - 1];
+          try {
+            const ret = window.axe.runPartial(context, options);
+            cb(ret);
+          } catch (err) {
+            const ret = {
+              violations: [],
+              passes: [],
+              url: '',
+              timestamp: new Date().toString(),
+              errorMessage: err.message
+            };
+            cb(ret);
+          }
+        JS
+        page.execute_async_script_fixed script, context, @options
+      end
+
+      def get_frame_context_script(page)
+        script = <<-JS
+          const context = arguments[0];
+          try {
+            return window.axe.utils.getFrameContexts(context);
+          } catch (err) {
+            return {
+              violations: [],
+              passes: [],
+              url: '',
+              timestamp: new Date().toString(),
+              errorMessage: err.message
+            };
+          }
+        JS
+        page.execute_script_fixed script, @context
+      end
+
+      def get_selenium(page)
+        page = page.driver if page.respond_to?("driver")
+        page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
+        page
       end
 
       def js_args
         [@context, @options]
-          .reject(&:empty?)
-          .map(&:to_json)
+          .map(&:to_h)
       end
 
       def to_js

data/lib/axe/configuration.rb

@@ -14,7 +14,8 @@ module Axe
     attr_writer :jslib
     attr_accessor :page,
                   :jslib_path,
-                  :skip_iframes
+                  :skip_iframes,
+                  :legacy_mode
     def_delegators ::WebDriverScriptAdapter,
                    :async_results_identifier,
                    :async_results_identifier=,
@@ -26,7 +27,7 @@ module Axe
     # init
     def initialize
       @page = :page
-      @skip_iframes = :skip_iframes
+      @skip_iframes = nil
       @jslib_path = get_root + "/node_modules/axe-core/axe.min.js"
     end
 

data/lib/axe/core.rb

@@ -14,13 +14,36 @@ module Axe
     end
 
     def call(callable)
-      callable.call(@page)
+      if use_run_partial
+        callable.analyze_post_43x @page, self
+      else
+        callable.call @page
+      end
+    end
+
+    def call_verbatim(callable)
+      callable.call @page
     end
 
     private
 
+    def use_run_partial
+      has_run_partial? and not Axe::Configuration.instance.legacy_mode
+    end
+
     def load_axe_core(source)
-      Common::Loader.new(@page, self).call(source) unless already_loaded?
+      return if already_loaded?
+      loader = Common::Loader.new(@page, self)
+      loader.load_top_level source
+      return if use_run_partial
+
+      loader.call source
+    end
+
+    def has_run_partial?
+      @page.evaluate_script <<-JS
+          typeof window.axe.runPartial === 'function'
+      JS
     end
 
     def already_loaded?
@@ -31,6 +54,7 @@ module Axe
     end
 
     def wrap_driver(driver)
+      driver = driver.driver if driver.respond_to? :driver
       ::WebDriverScriptAdapter::QuerySelectorAdapter.wrap(
         ::WebDriverScriptAdapter::FrameAdapter.wrap(
           ::WebDriverScriptAdapter::ExecuteAsyncScriptAdapter.wrap(

data/lib/loader.rb

@@ -6,19 +6,33 @@ module Common
     def initialize(page, lib)
       @page = page
       @lib = lib
+      @loaded_top_level = false
     end
 
-    def call(source)
+    def load_top_level(source)
       @page.execute_script source
+      @loaded_top_level = true
+      Common::Hooks.run_after_load @lib
+    end
+
+    def call(source, is_top_level = true)
+      @page.execute_script source unless (@loaded_top_level and is_top_level)
+      set_allowed_origins
       Common::Hooks.run_after_load @lib
       load_into_iframes(source) unless Axe::Configuration.instance.skip_iframes
     end
 
     private
 
+    def set_allowed_origins
+      allowed_origins = "<unsafe_all_origins>"
+      allowed_origins = "<same_origin>" if Axe::Configuration.instance.legacy_mode
+      @page.execute_script "axe.configure({ allowedOrigins: ['#{allowed_origins}'] });"
+    end
+
     def load_into_iframes(source)
       @page.find_frames.each do |iframe|
-        @page.within_frame(iframe) { call source }
+        @page.within_frame(iframe) { call source, false }
       end
     end
   end

data/lib/webdriver_script_adapter/exec_eval_script_adapter.rb

@@ -8,7 +8,7 @@ module WebDriverScriptAdapter
     def self.wrap(driver)
       raise WebDriverError, "WebDriver must respond to #execute_script" unless driver.respond_to? :execute_script
 
-      driver.respond_to?(:evaluate_script) ? driver : new(driver)
+      driver.respond_to?(:evaluate_script) ? ExecEvalScriptAdapter2.new(driver) : new(driver)
     end
 
     # executes script without returning result
@@ -21,6 +21,19 @@ module WebDriverScriptAdapter
     def evaluate_script(script)
       __getobj__.execute_script "return #{script}"
     end
+
+    def execute_script_fixed(script, *args)
+      page = __getobj__
+      page.execute_script(script, *args)
+    end
+  end
+  class ExecEvalScriptAdapter2 < ::DumbDelegator
+    def execute_script_fixed(script, *args)
+      page = __getobj__
+      page = page.driver if page.respond_to?("driver")
+      page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
+      page.execute_script(script, *args)
+    end
   end
 
   class WebDriverError < TypeError; end

data/lib/webdriver_script_adapter/execute_async_script_adapter.rb

@@ -3,6 +3,11 @@ require "securerandom"
 require "timeout"
 require_relative "./exec_eval_script_adapter"
 
+def get_selenium(page)
+  page = page.driver if page.respond_to?("driver")
+  page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(Symbol)
+  page
+end
 module WebDriverScriptAdapter
   class << self
     attr_accessor :async_results_identifier,
@@ -76,7 +81,7 @@ module WebDriverScriptAdapter
 
   class ExecuteAsyncScriptAdapter < ::DumbDelegator
     def self.wrap(driver)
-      new ExecEvalScriptAdapter.wrap driver
+      new driver
     end
 
     def execute_async_script(script, *args)
@@ -84,6 +89,13 @@ module WebDriverScriptAdapter
       execute_script ScriptWriter.async_wrapper(script, *args, ScriptWriter.callback(results))
       Patiently.wait_until { evaluate_script results }
     end
+
+    def execute_async_script_fixed(script, *args)
+      page = __getobj__
+      page = page.driver if page.respond_to?("driver")
+      page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
+      page.execute_async_script(script, *args)
+    end
   end
 
   configure do |c|

data/lib/webdriver_script_adapter/frame_adapter.rb

@@ -3,7 +3,7 @@ require "dumb_delegator"
 module WebDriverScriptAdapter
   class FrameAdapter < ::DumbDelegator
     def self.wrap(driver)
-      if driver.respond_to?(:within_frame)
+      if driver.respond_to?(:find_css)
         CapybaraAdapter.new driver
       elsif !driver.respond_to?(:switch_to)
         WatirAdapter.new driver
@@ -16,20 +16,19 @@ module WebDriverScriptAdapter
 
     private
 
-    class CapybaraAdapter < ::DumbDelegator
-      def find_frames
-        all(:css, "iframe")
+    class WatirAdapter < ::DumbDelegator
+      def initialize(driver)
+        super(driver)
+        @driver = driver
       end
-    end
 
-    class WatirAdapter < ::DumbDelegator
       # delegate to Watir's Selenium #driver
       def within_frame(frame, &block)
-        SeleniumAdapter.instance_method(:within_frame).bind(FrameAdapter.wrap driver).call(frame, &block)
+        SeleniumAdapter.instance_method(:within_frame).bind(FrameAdapter.wrap @driver).call(frame, &block)
       end
 
       def find_frames
-        driver.find_elements(:css, "iframe")
+        find_elements(:css, "iframe")
       end
     end
 
@@ -57,6 +56,41 @@ module WebDriverScriptAdapter
       end
     end
 
+    class CapybaraAdapter < ::DumbDelegator
+      def initialize(driver)
+        super(driver)
+        @driver = driver
+      end
+
+      def within_frame(frame)
+        # Patch the `Symbol` class to respond to the :native method.
+        # Will be fixed in https://github.com/teamcapybara/capybara/pull/2462
+        (:parent).class.define_method(:native) do
+          nil
+        end
+        switch_to_frame frame
+        yield
+      ensure
+        begin
+          switch_to_frame :parent
+        rescue => e
+          if /switchToParentFrame|frame\/parent/.match(e.message)
+            ::Kernel.warn "WARNING:
+            This browser only supports first-level iframes.
+            Second-level iframes and beyond will not be audited.
+            To skip auditing all iframes,
+            set Axe::Configuration#skip_iframes=true"
+          end
+          switch_to_frame :top
+        end
+      end
+
+      def find_frames
+        find_css("iframe")
+      end
+    end
+
+
     # Selenium Webdriver < 2.43 doesnt support moving back to the parent
     class ParentlessFrameAdapter < ::DumbDelegator
       # storage of frame stack (for reverting to parent) taken from Capybara