X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8e6cd14b7884a691a110110b0f366577437c6d9e..d6446b03e2f5d5079a870bdd7b963456dc12b485:/services/api/test/test_helper.rb diff --git a/services/api/test/test_helper.rb b/services/api/test/test_helper.rb index 86bc2397c5..0255d8907d 100644 --- a/services/api/test/test_helper.rb +++ b/services/api/test/test_helper.rb @@ -1,8 +1,20 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + +require_relative '../lib/update_permissions' + ENV["RAILS_ENV"] = "test" unless ENV["NO_COVERAGE_TEST"] begin - require 'simplecov' - require 'simplecov-rcov' + verbose_orig = $VERBOSE + begin + $VERBOSE = nil + require 'simplecov' + require 'simplecov-rcov' + ensure + $VERBOSE = verbose_orig + end class SimpleCov::Formatter::MergedFormatter def format(result) SimpleCov::Formatter::HTMLFormatter.new.format(result) @@ -13,7 +25,6 @@ unless ENV["NO_COVERAGE_TEST"] SimpleCov.start do add_filter '/test/' add_filter 'initializers/secret_token' - add_filter 'initializers/omniauth' end rescue Exception => e $stderr.puts "SimpleCov unavailable (#{e}). Proceeding without." @@ -23,6 +34,7 @@ end require File.expand_path('../../config/environment', __FILE__) require 'rails/test_help' require 'mocha' +require 'mocha/minitest' module ArvadosTestSupport def json_response @@ -30,11 +42,11 @@ module ArvadosTestSupport end def api_token(api_client_auth_name) - api_client_authorizations(api_client_auth_name).api_token + api_client_authorizations(api_client_auth_name).token end def auth(api_client_auth_name) - {'HTTP_AUTHORIZATION' => "OAuth2 #{api_token(api_client_auth_name)}"} + {'HTTP_AUTHORIZATION' => "Bearer #{api_token(api_client_auth_name)}"} end def show_errors model @@ -43,25 +55,38 @@ module ArvadosTestSupport end class ActiveSupport::TestCase - include FactoryGirl::Syntax::Methods + include FactoryBot::Syntax::Methods fixtures :all include ArvadosTestSupport include CurrentApiClient setup do - Rails.logger.warn "\n\n#{'=' * 70}\n#{self.class}\##{method_name}\n#{'-' * 70}\n\n" - end - - teardown do Thread.current[:api_client_ip_address] = nil Thread.current[:api_client_authorization] = nil Thread.current[:api_client_uuid] = nil Thread.current[:api_client] = nil + Thread.current[:token] = nil Thread.current[:user] = nil restore_configuration end + teardown do + # Confirm that any changed configuration doesn't include non-symbol keys + $arvados_config.keys.each do |conf_name| + conf = Rails.configuration.send(conf_name) + confirm_keys_as_symbols(conf, conf_name) if conf.respond_to?('keys') + end + end + + def assert_equal(expect, *args) + if expect.nil? + assert_nil(*args) + else + super + end + end + def assert_not_allowed # Provide a block that calls a Rails boolean "true or false" success value, # like model.save or model.destroy. This method will test that it either @@ -81,20 +106,27 @@ class ActiveSupport::TestCase end end + def confirm_keys_as_symbols(conf, conf_name) + assert(conf.is_a?(ActiveSupport::OrderedOptions), "#{conf_name} should be an OrderedOptions object") + conf.keys.each do |k| + assert(k.is_a?(Symbol), "Key '#{k}' on section '#{conf_name}' should be a Symbol") + confirm_keys_as_symbols(conf[k], "#{conf_name}.#{k}") if conf[k].respond_to?('keys') + end + end + def restore_configuration # Restore configuration settings changed during tests - $application_config.each do |k,v| - if k.match(/^[^.]*$/) - Rails.configuration.send (k + '='), v - end - end + ConfigLoader.copy_into_config $arvados_config, Rails.configuration + ConfigLoader.copy_into_config $remaining_config, Rails.configuration end def set_user_from_auth(auth_name) client_auth = api_client_authorizations(auth_name) + client_auth.user.forget_cached_group_perms Thread.current[:api_client_authorization] = client_auth Thread.current[:api_client] = client_auth.api_client Thread.current[:user] = client_auth.user + Thread.current[:token] = client_auth.token end def expect_json @@ -102,14 +134,22 @@ class ActiveSupport::TestCase end def authorize_with api_client_auth_name - authorize_with_token api_client_authorizations(api_client_auth_name).api_token + authorize_with_token api_client_authorizations(api_client_auth_name).token end def authorize_with_token token t = token - t = t.api_token if t.respond_to? :api_token + t = t.token if t.respond_to? :token ArvadosApiToken.new.call("rack.input" => "", - "HTTP_AUTHORIZATION" => "OAuth2 #{t}") + "HTTP_AUTHORIZATION" => "Bearer #{t}") + end + + def salt_token(fixture:, remote:) + auth = api_client_authorizations(fixture) + uuid = auth.uuid + token = auth.api_token + hmac = OpenSSL::HMAC.hexdigest('sha1', token, remote) + return "v2/#{uuid}/#{hmac}" end def self.skip_slow_tests? @@ -120,15 +160,15 @@ class ActiveSupport::TestCase end def self.slow_test(name, &block) - define_method(name, block) unless skip_slow_tests? + test(name, &block) unless skip_slow_tests? end - - alias_method :skip, :omit end class ActionController::TestCase setup do @test_counter = 0 + self.request.headers['Accept'] = 'application/json' + self.request.headers['Content-Type'] = 'application/json' end def check_counter action @@ -139,9 +179,21 @@ class ActionController::TestCase end [:get, :post, :put, :patch, :delete].each do |method| - define_method method do |action, *args| + define_method method do |action, **kwargs| check_counter action - super action, *args + # After Rails 5.0 upgrade, some params don't get properly serialized. + # One case are filters: [['attr', 'op', 'val']] become [['attr'], ['op'], ['val']] + # if not passed upstream as a JSON string. + if kwargs[:params].is_a?(Hash) + kwargs[:params].each do |key, _| + next if key == :exclude_script_versions # Job Reuse tests + # Keys could be: :filters, :where, etc + if [Array, Hash].include?(kwargs[:params][key].class) + kwargs[:params][key] = SafeJSON.dump(kwargs[:params][key]) + end + end + end + super action, **kwargs end end @@ -167,9 +219,11 @@ class ActionDispatch::IntegrationTest Thread.current[:api_client_authorization] = nil Thread.current[:api_client_uuid] = nil Thread.current[:api_client] = nil + Thread.current[:token] = nil Thread.current[:user] = nil end end # Ensure permissions are computed from the test fixtures. -User.invalidate_permissions_cache +refresh_permissions +refresh_trashed