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