apps/workbench/test/integration_helper.rb

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