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
  26 class ActiveSupport::TestCase
  27   # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in
  28   # alphabetical order.
  29   #
  30   # Note: You'll currently still have to declare fixtures explicitly
  31   # in integration tests -- they do not yet inherit this setting
  32   fixtures :all
  33   def use_token token_name
  34     auth = api_fixture('api_client_authorizations')[token_name.to_s]
  35     Thread.current[:arvados_api_token] = auth['api_token']
  36   end
  37
  38   def teardown
  39     Thread.current[:arvados_api_token] = nil
  40     Thread.current[:reader_tokens] = nil
  41     super
  42   end
  43 end
  44
  45 module ApiFixtureLoader
  46   def self.included(base)
  47     base.extend(ClassMethods)
  48   end
  49
  50   module ClassMethods
  51     @@api_fixtures = {}
  52     def api_fixture(name)
  53       # Returns the data structure from the named API server test fixture.
  54       @@api_fixtures[name] ||= \
  55       begin
  56         path = File.join(ApiServerForTests::ARV_API_SERVER_DIR,
  57                          'test', 'fixtures', "#{name}.yml")
  58         YAML.load(IO.read(path))
  59       end
  60     end
  61   end
  62   def api_fixture name
  63     self.class.api_fixture name
  64   end
  65 end
  66
  67 class ActiveSupport::TestCase
  68   include ApiFixtureLoader
  69   def session_for api_client_auth_name
  70     {
  71       arvados_api_token: api_fixture('api_client_authorizations')[api_client_auth_name.to_s]['api_token']
  72     }
  73   end
  74   def json_response
  75     Oj.load(@response.body)
  76   end
  77 end
  78
  79 class ApiServerForTests
  80   ARV_API_SERVER_DIR = File.expand_path('../../../../services/api', __FILE__)
  81   SERVER_PID_PATH = File.expand_path('tmp/pids/wbtest-server.pid', ARV_API_SERVER_DIR)
  82   @main_process_pid = $$
  83
  84   def self._system(*cmd)
  85     $stderr.puts "_system #{cmd.inspect}"
  86     Bundler.with_clean_env do
  87       if not system({'RAILS_ENV' => 'test'}, *cmd)
  88         raise RuntimeError, "#{cmd[0]} returned exit code #{$?.exitstatus}"
  89       end
  90     end
  91   end
  92
  93   def self.make_ssl_cert
  94     unless File.exists? './self-signed.key'
  95       _system('openssl', 'req', '-new', '-x509', '-nodes',
  96               '-out', './self-signed.pem',
  97               '-keyout', './self-signed.key',
  98               '-days', '3650',
  99               '-subj', '/CN=localhost')
 100     end
 101   end
 102
 103   def self.kill_server
 104     if (pid = find_server_pid)
 105       $stderr.puts "Sending TERM to API server, pid #{pid}"
 106       Process.kill 'TERM', pid
 107     end
 108   end
 109
 110   def self.find_server_pid
 111     pid = nil
 112     begin
 113       pid = IO.read(SERVER_PID_PATH).to_i
 114       $stderr.puts "API server is running, pid #{pid.inspect}"
 115     rescue Errno::ENOENT
 116     end
 117     return pid
 118   end
 119
 120   def self.run(args=[])
 121     ::MiniTest.after_run do
 122       self.kill_server
 123     end
 124
 125     # Kill server left over from previous test run
 126     self.kill_server
 127
 128     Capybara.javascript_driver = :poltergeist
 129     Dir.chdir(ARV_API_SERVER_DIR) do |apidir|
 130       ENV["NO_COVERAGE_TEST"] = "1"
 131       make_ssl_cert
 132       _system('bundle', 'exec', 'rake', 'db:test:load')
 133       _system('bundle', 'exec', 'rake', 'db:fixtures:load')
 134       _system('bundle', 'exec', 'passenger', 'start', '-d', '-p3000',
 135               '--pid-file', SERVER_PID_PATH,
 136               '--ssl',
 137               '--ssl-certificate', 'self-signed.pem',
 138               '--ssl-certificate-key', 'self-signed.key')
 139       timeout = Time.now.tv_sec + 10
 140       good_pid = false
 141       while (not good_pid) and (Time.now.tv_sec < timeout)
 142         sleep 0.2
 143         server_pid = find_server_pid
 144         good_pid = (server_pid and
 145                     (server_pid > 0) and
 146                     (Process.kill(0, server_pid) rescue false))
 147       end
 148       if not good_pid
 149         raise RuntimeError, "could not find API server Rails pid"
 150       end
 151     end
 152   end
 153 end
 154
 155 class ActionController::TestCase
 156   setup do
 157     @counter = 0
 158   end
 159
 160   def check_counter action
 161     @counter += 1
 162     if @counter == 2
 163       # TODO: when existing mistakes are fixed, start failing broken
 164       # test cases like this:
 165       #
 166       # assert_equal 1, 2, "Multiple actions in functional test"
 167       #
 168       # Meanwhile, just warn (just once per test case):
 169       $stderr.puts " [WARNING: Multiple actions in functional test]"
 170     end
 171   end
 172
 173   [:get, :post, :put, :patch, :delete].each do |method|
 174     define_method method do |action, *args|
 175       check_counter action
 176       super action, *args
 177     end
 178   end
 179 end
 180
 181 if ENV["RAILS_ENV"].eql? 'test'
 182   ApiServerForTests.run
 183 end