apps/workbench/test/integration_helper.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'test_helper'
   6 require 'capybara/rails'
   7 require 'capybara/poltergeist'
   8 require 'uri'
   9 require 'yaml'
  10
  11 def available_port for_what
  12   begin
  13     Addrinfo.tcp("0.0.0.0", 0).listen do |srv|
  14       port = srv.connect_address.ip_port
  15       # Selenium needs an additional locking port, check if it's available
  16       # and retry if necessary.
  17       if for_what == 'selenium'
  18         locking_port = port - 1
  19         Addrinfo.tcp("0.0.0.0", locking_port).listen.close
  20       end
  21       STDERR.puts "Using port #{port} for #{for_what}"
  22       return port
  23     end
  24   rescue Errno::EADDRINUSE, Errno::EACCES
  25     retry
  26   end
  27 end
  28
  29 def selenium_opts
  30   {
  31     port: available_port('selenium'),
  32   }
  33 end
  34
  35 def poltergeist_opts
  36   {
  37     phantomjs_options: ['--ignore-ssl-errors=true'],
  38     port: available_port('poltergeist'),
  39     window_size: [1200, 800],
  40   }
  41 end
  42
  43 Capybara.register_driver :poltergeist do |app|
  44   Capybara::Poltergeist::Driver.new app, poltergeist_opts
  45 end
  46
  47 Capybara.register_driver :poltergeist_debug do |app|
  48   Capybara::Poltergeist::Driver.new app, poltergeist_opts.merge(inspector: true)
  49 end
  50
  51 Capybara.register_driver :poltergeist_with_fake_websocket do |app|
  52   js = File.expand_path '../support/fake_websocket.js', __FILE__
  53   Capybara::Poltergeist::Driver.new app, poltergeist_opts.merge(extensions: [js])
  54 end
  55
  56 Capybara.register_driver :poltergeist_without_file_api do |app|
  57   js = File.expand_path '../support/remove_file_api.js', __FILE__
  58   Capybara::Poltergeist::Driver.new app, poltergeist_opts.merge(extensions: [js])
  59 end
  60
  61 Capybara.register_driver :selenium do |app|
  62   Capybara::Selenium::Driver.new app, selenium_opts
  63 end
  64
  65 Capybara.register_driver :selenium_with_download do |app|
  66   profile = Selenium::WebDriver::Firefox::Profile.new
  67   profile['browser.download.dir'] = DownloadHelper.path.to_s
  68   profile['browser.download.downloadDir'] = DownloadHelper.path.to_s
  69   profile['browser.download.defaultFolder'] = DownloadHelper.path.to_s
  70   profile['browser.download.folderList'] = 2 # "save to user-defined location"
  71   profile['browser.download.manager.showWhenStarting'] = false
  72   profile['browser.helperApps.alwaysAsk.force'] = false
  73   profile['browser.helperApps.neverAsk.saveToDisk'] = 'text/plain,application/octet-stream'
  74   Capybara::Selenium::Driver.new app, selenium_opts.merge(profile: profile)
  75 end
  76
  77 module WaitForAjax
  78   # FIXME: Huge side effect here
  79   # The following line changes the global default Capybara wait time, affecting
  80   # every test which follows this one. This should be removed and the failing tests
  81   # should have their individual wait times increased, if appropriate, using
  82   # the using_wait_time(N) construct to temporarily change the wait time.
  83   # Note: the below is especially bad because there are places that increase wait
  84   # times using a multiplier e.g. using_wait_time(3 * Capybara.default_max_wait_time)
  85   Capybara.default_max_wait_time = 10
  86   def wait_for_ajax
  87     timeout = 10
  88     count = 0
  89     while page.evaluate_script("jQuery.active").to_i > 0
  90       count += 1
  91       raise "AJAX request took more than #{timeout} seconds" if count > timeout * 10
  92       sleep(0.1)
  93     end
  94   end
  95
  96 end
  97
  98 module AssertDomEvent
  99   # Yield the supplied block, then wait for an event to arrive at a
 100   # DOM element.
 101   def assert_triggers_dom_event events, target='body'
 102     magic = 'received-dom-event-' + rand(2**30).to_s(36)
 103     page.evaluate_script <<eos
 104       $('#{target}').one('#{events}', function() {
 105         $('body').addClass('#{magic}');
 106       });
 107 eos
 108     yield
 109     assert_selector "body.#{magic}"
 110     page.evaluate_script "$('body').removeClass('#{magic}');";
 111   end
 112 end
 113
 114 module HeadlessHelper
 115   class HeadlessSingleton
 116     @display = ENV['ARVADOS_TEST_HEADLESS_DISPLAY'] || rand(400)+100
 117     STDERR.puts "Using display :#{@display} for headless tests"
 118     def self.get
 119       @headless ||= Headless.new reuse: false, display: @display
 120     end
 121   end
 122
 123   Capybara.default_driver = :rack_test
 124
 125   def self.included base
 126     base.class_eval do
 127       setup do
 128         Capybara.use_default_driver
 129         @headless = false
 130       end
 131
 132       teardown do
 133         if @headless
 134           @headless.stop
 135           @headless = false
 136         end
 137       end
 138     end
 139   end
 140
 141   def need_selenium reason=nil, driver=:selenium
 142     Capybara.current_driver = driver
 143     unless ENV['ARVADOS_TEST_HEADFUL'] or @headless
 144       @headless = HeadlessSingleton.get
 145       @headless.start
 146     end
 147   end
 148
 149   def need_javascript reason=nil
 150     unless Capybara.current_driver == :selenium
 151       Capybara.current_driver = :poltergeist
 152     end
 153   end
 154 end
 155
 156 module KeepWebConfig
 157   def getport service
 158     File.read(File.expand_path("../../../../tmp/#{service}.port", __FILE__))
 159   end
 160
 161   def use_keep_web_config
 162     @kwport = getport 'keep-web-ssl'
 163     @kwdport = getport 'keep-web-dl-ssl'
 164     Rails.configuration.keep_web_url = "https://localhost:#{@kwport}/c=%{uuid_or_pdh}"
 165     Rails.configuration.keep_web_download_url = "https://localhost:#{@kwdport}/c=%{uuid_or_pdh}"
 166     CollectionsController.any_instance.expects(:file_enumerator).never
 167   end
 168 end
 169
 170 class ActionDispatch::IntegrationTest
 171   # Make the Capybara DSL available in all integration tests
 172   include Capybara::DSL
 173   include ApiFixtureLoader
 174   include WaitForAjax
 175   include AssertDomEvent
 176   include HeadlessHelper
 177
 178   @@API_AUTHS = self.api_fixture('api_client_authorizations')
 179
 180   def page_with_token(token, path='/')
 181     # Generate a page path with an embedded API token.
 182     # Typical usage: visit page_with_token('token_name', page)
 183     # The token can be specified by the name of an api_client_authorizations
 184     # fixture, or passed as a raw string.
 185     api_token = ((@@API_AUTHS.include? token) ?
 186                  @@API_AUTHS[token]['api_token'] : token)
 187     path_parts = path.partition("#")
 188     sep = (path_parts.first.include? '?') ? '&' : '?'
 189     q_string = URI.encode_www_form('api_token' => api_token)
 190     path_parts.insert(1, "#{sep}#{q_string}")
 191     path_parts.join("")
 192   end
 193
 194   # Find a page element, but return false instead of raising an
 195   # exception if not found. Use this with assertions to explain that
 196   # the error signifies a failed test rather than an unexpected error
 197   # during a testing procedure.
 198   def find? *args
 199     begin
 200       find *args
 201     rescue Capybara::ElementNotFound
 202       false
 203     end
 204   end
 205
 206   @@screenshot_count = 1
 207   def screenshot
 208     image_file = "./tmp/workbench-fail-#{@@screenshot_count}.png"
 209     begin
 210       page.save_screenshot image_file
 211     rescue Capybara::NotSupportedByDriverError
 212       # C'est la vie.
 213     else
 214       puts "Saved #{image_file}"
 215       @@screenshot_count += 1
 216     end
 217   end
 218
 219   teardown do
 220     if not passed?
 221       screenshot
 222     end
 223     if Capybara.current_driver == :selenium
 224       page.execute_script("window.localStorage.clear()")
 225     end
 226     Capybara.reset_sessions!
 227   end
 228
 229   def accept_alert
 230     if Capybara.current_driver == :selenium
 231       (0..9).each do
 232         begin
 233           page.driver.browser.switch_to.alert.accept
 234           break
 235         rescue Selenium::WebDriver::Error::NoSuchAlertError
 236          sleep 0.1
 237         end
 238       end
 239     else
 240       # poltergeist returns true for confirm, so no need to accept
 241     end
 242   end
 243 end