services/api/test/test_helper.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 ENV["RAILS_ENV"] = "test"
   6 unless ENV["NO_COVERAGE_TEST"]
   7   begin
   8     verbose_orig = $VERBOSE
   9     begin
  10       $VERBOSE = nil
  11       require 'simplecov'
  12       require 'simplecov-rcov'
  13     ensure
  14       $VERBOSE = verbose_orig
  15     end
  16     class SimpleCov::Formatter::MergedFormatter
  17       def format(result)
  18         SimpleCov::Formatter::HTMLFormatter.new.format(result)
  19         SimpleCov::Formatter::RcovFormatter.new.format(result)
  20       end
  21     end
  22     SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
  23     SimpleCov.start do
  24       add_filter '/test/'
  25       add_filter 'initializers/secret_token'
  26       add_filter 'initializers/omniauth'
  27     end
  28   rescue Exception => e
  29     $stderr.puts "SimpleCov unavailable (#{e}). Proceeding without."
  30   end
  31 end
  32
  33 require File.expand_path('../../config/environment', __FILE__)
  34 require 'rails/test_help'
  35 require 'mocha'
  36 require 'mocha/minitest'
  37
  38 module ArvadosTestSupport
  39   def json_response
  40     Oj.strict_load response.body
  41   end
  42
  43   def api_token(api_client_auth_name)
  44     api_client_authorizations(api_client_auth_name).token
  45   end
  46
  47   def auth(api_client_auth_name)
  48     {'HTTP_AUTHORIZATION' => "Bearer #{api_token(api_client_auth_name)}"}
  49   end
  50
  51   def show_errors model
  52     return lambda { model.errors.full_messages.inspect }
  53   end
  54 end
  55
  56 class ActiveSupport::TestCase
  57   include FactoryBot::Syntax::Methods
  58   fixtures :all
  59
  60   include ArvadosTestSupport
  61   include CurrentApiClient
  62
  63   teardown do
  64     Thread.current[:api_client_ip_address] = nil
  65     Thread.current[:api_client_authorization] = nil
  66     Thread.current[:api_client_uuid] = nil
  67     Thread.current[:api_client] = nil
  68     Thread.current[:token] = nil
  69     Thread.current[:user] = nil
  70     restore_configuration
  71   end
  72
  73   def assert_equal(expect, *args)
  74     if expect.nil?
  75       assert_nil(*args)
  76     else
  77       super
  78     end
  79   end
  80
  81   def assert_not_allowed
  82     # Provide a block that calls a Rails boolean "true or false" success value,
  83     # like model.save or model.destroy.  This method will test that it either
  84     # returns false, or raises a Permission Denied exception.
  85     begin
  86       refute(yield)
  87     rescue ArvadosModel::PermissionDeniedError
  88     end
  89   end
  90
  91   def add_permission_link from_who, to_what, perm_type
  92     act_as_system_user do
  93       Link.create!(tail_uuid: from_who.uuid,
  94                    head_uuid: to_what.uuid,
  95                    link_class: 'permission',
  96                    name: perm_type)
  97     end
  98   end
  99
 100   def restore_configuration
 101     # Restore configuration settings changed during tests
 102     ConfigLoader.copy_into_config $arvados_config, Rails.configuration
 103     ConfigLoader.copy_into_config $remaining_config, Rails.configuration
 104   end
 105
 106   def set_user_from_auth(auth_name)
 107     client_auth = api_client_authorizations(auth_name)
 108     Thread.current[:api_client_authorization] = client_auth
 109     Thread.current[:api_client] = client_auth.api_client
 110     Thread.current[:user] = client_auth.user
 111     Thread.current[:token] = client_auth.token
 112   end
 113
 114   def expect_json
 115     self.request.headers["Accept"] = "text/json"
 116   end
 117
 118   def authorize_with api_client_auth_name
 119     authorize_with_token api_client_authorizations(api_client_auth_name).token
 120   end
 121
 122   def authorize_with_token token
 123     t = token
 124     t = t.token if t.respond_to? :token
 125     ArvadosApiToken.new.call("rack.input" => "",
 126                              "HTTP_AUTHORIZATION" => "Bearer #{t}")
 127   end
 128
 129   def salt_token(fixture:, remote:)
 130     auth = api_client_authorizations(fixture)
 131     uuid = auth.uuid
 132     token = auth.api_token
 133     hmac = OpenSSL::HMAC.hexdigest('sha1', token, remote)
 134     return "v2/#{uuid}/#{hmac}"
 135   end
 136
 137   def self.skip_slow_tests?
 138     !(ENV['RAILS_TEST_SHORT'] || '').empty?
 139   end
 140
 141   def self.skip(*args, &block)
 142   end
 143
 144   def self.slow_test(name, &block)
 145     test(name, &block) unless skip_slow_tests?
 146   end
 147 end
 148
 149 class ActionController::TestCase
 150   setup do
 151     @test_counter = 0
 152     self.request.headers['Accept'] = 'application/json'
 153     self.request.headers['Content-Type'] = 'application/json'
 154   end
 155
 156   def check_counter action
 157     @test_counter += 1
 158     if @test_counter == 2
 159       assert_equal 1, 2, "Multiple actions in functional test"
 160     end
 161   end
 162
 163   [:get, :post, :put, :patch, :delete].each do |method|
 164     define_method method do |action, *args|
 165       check_counter action
 166       # After Rails 5.0 upgrade, some params don't get properly serialized.
 167       # One case are filters: [['attr', 'op', 'val']] become [['attr'], ['op'], ['val']]
 168       # if not passed upstream as a JSON string.
 169       if args[0].is_a?(Hash) && args[0][:params].is_a?(Hash)
 170         args[0][:params].each do |key, _|
 171           next if key == :exclude_script_versions # Job Reuse tests
 172           # Keys could be: :filters, :where, etc
 173           if [Array, Hash].include?(args[0][:params][key].class)
 174             args[0][:params][key] = SafeJSON.dump(args[0][:params][key])
 175           end
 176         end
 177       end
 178       super action, *args
 179     end
 180   end
 181
 182   def self.suite
 183     s = super
 184     def s.run(*args)
 185       @test_case.startup()
 186       begin
 187         super
 188       ensure
 189         @test_case.shutdown()
 190       end
 191     end
 192     s
 193   end
 194   def self.startup; end
 195   def self.shutdown; end
 196 end
 197
 198 class ActionDispatch::IntegrationTest
 199   teardown do
 200     Thread.current[:api_client_ip_address] = nil
 201     Thread.current[:api_client_authorization] = nil
 202     Thread.current[:api_client_uuid] = nil
 203     Thread.current[:api_client] = nil
 204     Thread.current[:token] = nil
 205     Thread.current[:user] = nil
 206   end
 207 end
 208
 209 # Ensure permissions are computed from the test fixtures.
 210 User.invalidate_permissions_cache