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_without_file_api do |app|
  48   js = File.expand_path '../support/remove_file_api.js', __FILE__
  49   Capybara::Poltergeist::Driver.new app, poltergeist_opts.merge(extensions: [js])
  50 end
  51
  52 Capybara.register_driver :selenium do |app|
  53   Capybara::Selenium::Driver.new app, selenium_opts
  54 end
  55
  56 Capybara.register_driver :selenium_with_download do |app|
  57   profile = Selenium::WebDriver::Firefox::Profile.new
  58   profile['browser.download.dir'] = DownloadHelper.path.to_s
  59   profile['browser.download.downloadDir'] = DownloadHelper.path.to_s
  60   profile['browser.download.defaultFolder'] = DownloadHelper.path.to_s
  61   profile['browser.download.folderList'] = 2 # "save to user-defined location"
  62   profile['browser.download.manager.showWhenStarting'] = false
  63   profile['browser.helperApps.alwaysAsk.force'] = false
  64   profile['browser.helperApps.neverAsk.saveToDisk'] = 'text/plain,application/octet-stream'
  65   Capybara::Selenium::Driver.new app, selenium_opts.merge(profile: profile)
  66 end
  67
  68 module WaitForAjax
  69   Capybara.default_max_wait_time = 10
  70   def wait_for_ajax
  71     Timeout.timeout(Capybara.default_max_wait_time) do
  72       loop until finished_all_ajax_requests?
  73     end
  74   end
  75
  76   def finished_all_ajax_requests?
  77     page.evaluate_script('jQuery.active').zero?
  78   end
  79 end
  80
  81 module AssertDomEvent
  82   # Yield the supplied block, then wait for an event to arrive at a
  83   # DOM element.
  84   def assert_triggers_dom_event events, target='body'
  85     magic = 'received-dom-event-' + rand(2**30).to_s(36)
  86     page.evaluate_script <<eos
  87       $('#{target}').one('#{events}', function() {
  88         $('body').addClass('#{magic}');
  89       });
  90 eos
  91     yield
  92     assert_selector "body.#{magic}"
  93     page.evaluate_script "$('body').removeClass('#{magic}');";
  94   end
  95 end
  96
  97 module HeadlessHelper
  98   class HeadlessSingleton
  99     @display = ENV['ARVADOS_TEST_HEADLESS_DISPLAY'] || rand(400)+100
 100     STDERR.puts "Using display :#{@display} for headless tests"
 101     def self.get
 102       @headless ||= Headless.new reuse: false, display: @display
 103     end
 104   end
 105
 106   Capybara.default_driver = :rack_test
 107
 108   def self.included base
 109     base.class_eval do
 110       setup do
 111         Capybara.use_default_driver
 112         @headless = false
 113       end
 114
 115       teardown do
 116         if @headless
 117           @headless.stop
 118           @headless = false
 119         end
 120       end
 121     end
 122   end
 123
 124   def need_selenium reason=nil, driver=:selenium
 125     Capybara.current_driver = driver
 126     unless ENV['ARVADOS_TEST_HEADFUL'] or @headless
 127       @headless = HeadlessSingleton.get
 128       @headless.start
 129     end
 130   end
 131
 132   def need_javascript reason=nil
 133     unless Capybara.current_driver == :selenium
 134       Capybara.current_driver = :poltergeist
 135     end
 136   end
 137 end
 138
 139 module KeepWebConfig
 140   def getport service
 141     File.read(File.expand_path("../../../../tmp/#{service}.port", __FILE__))
 142   end
 143
 144   def use_keep_web_config
 145     @kwport = getport 'keep-web-ssl'
 146     @kwdport = getport 'keep-web-dl-ssl'
 147     Rails.configuration.keep_web_url = "https://localhost:#{@kwport}/c=%{uuid_or_pdh}"
 148     Rails.configuration.keep_web_download_url = "https://localhost:#{@kwdport}/c=%{uuid_or_pdh}"
 149     CollectionsController.any_instance.expects(:file_enumerator).never
 150   end
 151 end
 152
 153 class ActionDispatch::IntegrationTest
 154   # Make the Capybara DSL available in all integration tests
 155   include Capybara::DSL
 156   include ApiFixtureLoader
 157   include WaitForAjax
 158   include AssertDomEvent
 159   include HeadlessHelper
 160
 161   @@API_AUTHS = self.api_fixture('api_client_authorizations')
 162
 163   def page_with_token(token, path='/')
 164     # Generate a page path with an embedded API token.
 165     # Typical usage: visit page_with_token('token_name', page)
 166     # The token can be specified by the name of an api_client_authorizations
 167     # fixture, or passed as a raw string.
 168     api_token = ((@@API_AUTHS.include? token) ?
 169                  @@API_AUTHS[token]['api_token'] : token)
 170     path_parts = path.partition("#")
 171     sep = (path_parts.first.include? '?') ? '&' : '?'
 172     q_string = URI.encode_www_form('api_token' => api_token)
 173     path_parts.insert(1, "#{sep}#{q_string}")
 174     path_parts.join("")
 175   end
 176
 177   # Find a page element, but return false instead of raising an
 178   # exception if not found. Use this with assertions to explain that
 179   # the error signifies a failed test rather than an unexpected error
 180   # during a testing procedure.
 181   def find? *args
 182     begin
 183       find *args
 184     rescue Capybara::ElementNotFound
 185       false
 186     end
 187   end
 188
 189   @@screenshot_count = 1
 190   def screenshot
 191     image_file = "./tmp/workbench-fail-#{@@screenshot_count}.png"
 192     begin
 193       page.save_screenshot image_file
 194     rescue Capybara::NotSupportedByDriverError
 195       # C'est la vie.
 196     else
 197       puts "Saved #{image_file}"
 198       @@screenshot_count += 1
 199     end
 200   end
 201
 202   teardown do
 203     if not passed?
 204       screenshot
 205     end
 206     if Capybara.current_driver == :selenium
 207       page.execute_script("window.localStorage.clear()")
 208     end
 209     Capybara.reset_sessions!
 210   end
 211 end