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