apps/workbench/test/test_helper.rb

   1 ENV["RAILS_ENV"] = "test" if (ENV["RAILS_ENV"] != "diagnostics")
   2
   3 unless ENV["NO_COVERAGE_TEST"]
   4   begin
   5     require 'simplecov'
   6     require 'simplecov-rcov'
   7     class SimpleCov::Formatter::MergedFormatter
   8       def format(result)
   9         SimpleCov::Formatter::HTMLFormatter.new.format(result)
  10         SimpleCov::Formatter::RcovFormatter.new.format(result)
  11       end
  12     end
  13     SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
  14     SimpleCov.start do
  15       add_filter '/test/'
  16       add_filter 'initializers/secret_token'
  17     end
  18   rescue Exception => e
  19     $stderr.puts "SimpleCov unavailable (#{e}). Proceeding without."
  20   end
  21 end
  22
  23 require File.expand_path('../../config/environment', __FILE__)
  24 require 'rails/test_help'
  25 require 'mocha/mini_test'
  26
  27 class ActiveSupport::TestCase
  28   # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in
  29   # alphabetical order.
  30   #
  31   # Note: You'll currently still have to declare fixtures explicitly
  32   # in integration tests -- they do not yet inherit this setting
  33   fixtures :all
  34   def use_token token_name
  35     auth = api_fixture('api_client_authorizations')[token_name.to_s]
  36     Thread.current[:arvados_api_token] = auth['api_token']
  37   end
  38
  39   teardown do
  40     Thread.current[:arvados_api_token] = nil
  41     Thread.current[:user] = nil
  42     Thread.current[:reader_tokens] = nil
  43     # Diagnostics suite doesn't run a server, so there's no cache to clear.
  44     Rails.cache.clear unless (Rails.env == "diagnostics")
  45     # Restore configuration settings changed during tests
  46     $application_config.each do |k,v|
  47       if k.match /^[^.]*$/
  48         Rails.configuration.send (k + '='), v
  49       end
  50     end
  51   end
  52 end
  53
  54 module ApiFixtureLoader
  55   def self.included(base)
  56     base.extend(ClassMethods)
  57   end
  58
  59   module ClassMethods
  60     @@api_fixtures = {}
  61     def api_fixture(name, *keys)
  62       # Returns the data structure from the named API server test fixture.
  63       @@api_fixtures[name] ||= \
  64       begin
  65         path = File.join(ApiServerForTests::ARV_API_SERVER_DIR,
  66                          'test', 'fixtures', "#{name}.yml")
  67         file = IO.read(path)
  68         trim_index = file.index('# Test Helper trims the rest of the file')
  69         file = file[0, trim_index] if trim_index
  70         YAML.load(file)
  71       end
  72       keys.inject(@@api_fixtures[name]) { |hash, key| hash[key] }
  73     end
  74   end
  75   def api_fixture(name, *keys)
  76     self.class.api_fixture(name, *keys)
  77   end
  78
  79   def find_fixture(object_class, name)
  80     object_class.find(api_fixture(object_class.to_s.pluralize.underscore,
  81                                   name, "uuid"))
  82   end
  83 end
  84
  85 class ActiveSupport::TestCase
  86   include ApiFixtureLoader
  87   def session_for api_client_auth_name
  88     {
  89       arvados_api_token: api_fixture('api_client_authorizations')[api_client_auth_name.to_s]['api_token']
  90     }
  91   end
  92   def json_response
  93     Oj.load(@response.body)
  94   end
  95 end
  96
  97 class ApiServerForTests
  98   ARV_API_SERVER_DIR = File.expand_path('../../../../services/api', __FILE__)
  99   SERVER_PID_PATH = File.expand_path('tmp/pids/wbtest-server.pid', ARV_API_SERVER_DIR)
 100   WEBSOCKET_PID_PATH = File.expand_path('tmp/pids/wstest-server.pid', ARV_API_SERVER_DIR)
 101   @main_process_pid = $$
 102
 103   def _system(*cmd)
 104     $stderr.puts "_system #{cmd.inspect}"
 105     Bundler.with_clean_env do
 106       if not system({'RAILS_ENV' => 'test', "ARVADOS_WEBSOCKETS" => (if @websocket then "ws-only" end)}, *cmd)
 107         raise RuntimeError, "#{cmd[0]} returned exit code #{$?.exitstatus}"
 108       end
 109     end
 110   end
 111
 112   def make_ssl_cert
 113     unless File.exists? './self-signed.key'
 114       _system('openssl', 'req', '-new', '-x509', '-nodes',
 115               '-out', './self-signed.pem',
 116               '-keyout', './self-signed.key',
 117               '-days', '3650',
 118               '-subj', '/CN=localhost')
 119     end
 120   end
 121
 122   def kill_server
 123     if (pid = find_server_pid)
 124       $stderr.puts "Sending TERM to API server, pid #{pid}"
 125       Process.kill 'TERM', pid
 126     end
 127   end
 128
 129   def find_server_pid
 130     pid = nil
 131     @pidfile = if @websocket
 132                  WEBSOCKET_PID_PATH
 133                else
 134                  SERVER_PID_PATH
 135                end
 136     begin
 137       pid = IO.read(@pidfile).to_i
 138       $stderr.puts "API server is running, pid #{pid.inspect}"
 139     rescue Errno::ENOENT
 140     end
 141     return pid
 142   end
 143
 144   def run(args=[])
 145     ::MiniTest.after_run do
 146       self.kill_server
 147     end
 148
 149     @websocket = args.include?("--websockets")
 150
 151     # Kill server left over from previous test run
 152     self.kill_server
 153
 154     Capybara.javascript_driver = :poltergeist
 155     Dir.chdir(ARV_API_SERVER_DIR) do |apidir|
 156       ENV["NO_COVERAGE_TEST"] = "1"
 157       if @websocket
 158         _system('bundle', 'exec', 'passenger', 'start', '-d', '-p3333',
 159                 '--pid-file', WEBSOCKET_PID_PATH)
 160       else
 161         make_ssl_cert
 162         _system('bundle', 'exec', 'rake', 'db:test:load')
 163         _system('bundle', 'exec', 'rake', 'db:fixtures:load')
 164         _system('bundle', 'exec', 'passenger', 'start', '-d', '-p3000',
 165                 '--pid-file', SERVER_PID_PATH,
 166                 '--ssl',
 167                 '--ssl-certificate', 'self-signed.pem',
 168                 '--ssl-certificate-key', 'self-signed.key')
 169       end
 170       timeout = Time.now.tv_sec + 10
 171       good_pid = false
 172       while (not good_pid) and (Time.now.tv_sec < timeout)
 173         sleep 0.2
 174         server_pid = find_server_pid
 175         good_pid = (server_pid and
 176                     (server_pid > 0) and
 177                     (Process.kill(0, server_pid) rescue false))
 178       end
 179       if not good_pid
 180         raise RuntimeError, "could not find API server Rails pid"
 181       end
 182     end
 183   end
 184 end
 185
 186 class ActionController::TestCase
 187   setup do
 188     @counter = 0
 189   end
 190
 191   def check_counter action
 192     @counter += 1
 193     if @counter == 2
 194       assert_equal 1, 2, "Multiple actions in functional test"
 195     end
 196   end
 197
 198   [:get, :post, :put, :patch, :delete].each do |method|
 199     define_method method do |action, *args|
 200       check_counter action
 201       super action, *args
 202     end
 203   end
 204 end
 205
 206 if ENV["RAILS_ENV"].eql? 'test'
 207   ApiServerForTests.new.run
 208   ApiServerForTests.new.run ["--websockets"]
 209 end