X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5141c3ee23e89696773e227a93236ef2a51543c2..f69d2824c997c53caa11d30ba816768bad52e12b:/apps/workbench/test/test_helper.rb diff --git a/apps/workbench/test/test_helper.rb b/apps/workbench/test/test_helper.rb index ab2ac395b4..ade6292efe 100644 --- a/apps/workbench/test/test_helper.rb +++ b/apps/workbench/test/test_helper.rb @@ -1,4 +1,4 @@ -ENV["RAILS_ENV"] = "test" if (ENV["RAILS_ENV"] != "diagnostics") +ENV["RAILS_ENV"] = "test" if (ENV["RAILS_ENV"] != "diagnostics" and ENV["RAILS_ENV"] != "performance") unless ENV["NO_COVERAGE_TEST"] begin @@ -32,8 +32,16 @@ class ActiveSupport::TestCase # in integration tests -- they do not yet inherit this setting fixtures :all def use_token token_name + was = Thread.current[:arvados_api_token] auth = api_fixture('api_client_authorizations')[token_name.to_s] Thread.current[:arvados_api_token] = auth['api_token'] + if block_given? + begin + yield + ensure + Thread.current[:arvados_api_token] = was + end + end end teardown do @@ -43,6 +51,10 @@ class ActiveSupport::TestCase # Diagnostics suite doesn't run a server, so there's no cache to clear. Rails.cache.clear unless (Rails.env == "diagnostics") # Restore configuration settings changed during tests + self.class.reset_application_config + end + + def self.reset_application_config $application_config.each do |k,v| if k.match /^[^.]*$/ Rails.configuration.send (k + '='), v @@ -82,6 +94,29 @@ module ApiFixtureLoader end end +module ApiMockHelpers + def stub_api_calls_with_body body, status_code=200 + resp = mock + stubbed_client = ArvadosApiClient.new + stubbed_client.instance_eval do + resp.responds_like_instance_of HTTP::Message + resp.stubs(:content).returns body + resp.stubs(:status_code).returns status_code + @api_client = HTTPClient.new + @api_client.stubs(:post).returns resp + end + ArvadosApiClient.stubs(:new_or_current).returns(stubbed_client) + end + + def stub_api_calls_with_invalid_json + stub_api_calls_with_body ']"omg,bogus"[' + end +end + +class ActiveSupport::TestCase + include ApiMockHelpers +end + class ActiveSupport::TestCase include ApiFixtureLoader def session_for api_client_auth_name @@ -95,91 +130,73 @@ class ActiveSupport::TestCase end class ApiServerForTests + PYTHON_TESTS_DIR = File.expand_path('../../../../sdk/python/tests', __FILE__) ARV_API_SERVER_DIR = File.expand_path('../../../../services/api', __FILE__) - SERVER_PID_PATH = File.expand_path('tmp/pids/wbtest-server.pid', ARV_API_SERVER_DIR) - WEBSOCKET_PID_PATH = File.expand_path('tmp/pids/wstest-server.pid', ARV_API_SERVER_DIR) + SERVER_PID_PATH = File.expand_path('tmp/pids/test-server.pid', ARV_API_SERVER_DIR) + WEBSOCKET_PID_PATH = File.expand_path('tmp/pids/test-server.pid', ARV_API_SERVER_DIR) @main_process_pid = $$ + @@server_is_running = false - def _system(*cmd) - $stderr.puts "_system #{cmd.inspect}" + def check_call *args + output = nil Bundler.with_clean_env do - if not system({'RAILS_ENV' => 'test', "ARVADOS_WEBSOCKETS" => (if @websocket then "ws-only" end)}, *cmd) - raise RuntimeError, "#{cmd[0]} returned exit code #{$?.exitstatus}" + output = IO.popen *args do |io| + io.read + end + if not $?.success? + raise RuntimeError, "Command failed (#{$?}): #{args.inspect}" end end + output end - def make_ssl_cert - unless File.exists? './self-signed.key' - _system('openssl', 'req', '-new', '-x509', '-nodes', - '-out', './self-signed.pem', - '-keyout', './self-signed.key', - '-days', '3650', - '-subj', '/CN=localhost') + def run_test_server + env_script = nil + Dir.chdir PYTHON_TESTS_DIR do + env_script = check_call %w(python ./run_test_server.py start --auth admin) + end + test_env = {} + env_script.each_line do |line| + line = line.chomp + if 0 == line.index('export ') + toks = line.sub('export ', '').split '=', 2 + $stderr.puts "run_test_server.py: #{toks[0]}=#{toks[1]}" + test_env[toks[0]] = toks[1] + end end + test_env end - def kill_server - if (pid = find_server_pid) - $stderr.puts "Sending TERM to API server, pid #{pid}" - Process.kill 'TERM', pid + def stop_test_server + Dir.chdir PYTHON_TESTS_DIR do + # This is a no-op if we're running within run-tests.sh + check_call %w(python ./run_test_server.py stop) end + @@server_is_running = false end - def find_server_pid - pid = nil - begin - pid = IO.read(@pidfile).to_i - $stderr.puts "API server is running, pid #{pid.inspect}" - rescue Errno::ENOENT + def run args=[] + return if @@server_is_running + + # Stop server left over from interrupted previous run + stop_test_server + + ::MiniTest.after_run do + stop_test_server end - return pid + + test_env = run_test_server + $application_config['arvados_login_base'] = "https://#{test_env['ARVADOS_API_HOST']}/login" + $application_config['arvados_v1_base'] = "https://#{test_env['ARVADOS_API_HOST']}/arvados/v1" + $application_config['arvados_insecure_host'] = true + ActiveSupport::TestCase.reset_application_config + + @@server_is_running = true end - def run(args=[]) - ::MiniTest.after_run do - self.kill_server - end - - @websocket = args.include?("--websockets") - - @pidfile = if @websocket - WEBSOCKET_PID_PATH - else - SERVER_PID_PATH - end - - # Kill server left over from previous test run - self.kill_server - - Capybara.javascript_driver = :poltergeist - Dir.chdir(ARV_API_SERVER_DIR) do |apidir| - ENV["NO_COVERAGE_TEST"] = "1" - if @websocket - _system('bundle', 'exec', 'passenger', 'start', '-d', '-p3333', - '--pid-file', @pidfile) - else - make_ssl_cert - _system('bundle', 'exec', 'rake', 'db:test:load') - _system('bundle', 'exec', 'rake', 'db:fixtures:load') - _system('bundle', 'exec', 'passenger', 'start', '-d', '-p3000', - '--pid-file', @pidfile, - '--ssl', - '--ssl-certificate', 'self-signed.pem', - '--ssl-certificate-key', 'self-signed.key') - end - timeout = Time.now.tv_sec + 10 - good_pid = false - while (not good_pid) and (Time.now.tv_sec < timeout) - sleep 0.2 - server_pid = find_server_pid - good_pid = (server_pid and - (server_pid > 0) and - (Process.kill(0, server_pid) rescue false)) - end - if not good_pid - raise RuntimeError, "could not find API server Rails pid" - end + def run_rake_task task_name, arg_string + Dir.chdir ARV_API_SERVER_DIR do + check_call ['bundle', 'exec', 'rake', "#{task_name}[#{arg_string}]"] end end end @@ -192,7 +209,7 @@ class ActionController::TestCase def check_counter action @counter += 1 if @counter == 2 - assert_equal 1, 2, "Multiple actions in functional test" + assert_equal 1, 2, "Multiple actions in controller test" end end @@ -204,6 +221,74 @@ class ActionController::TestCase end end +# Test classes can call reset_api_fixtures(when_to_reset,flag) to +# override the default. Example: +# +# class MySuite < ActionDispatch::IntegrationTest +# reset_api_fixtures :after_each_test, false +# reset_api_fixtures :after_suite, true +# ... +# end +# +# The default behavior is reset_api_fixtures(:after_each_test,true). +# +class ActiveSupport::TestCase + + def self.inherited subclass + subclass.class_eval do + class << self + attr_accessor :want_reset_api_fixtures + end + @want_reset_api_fixtures = { + after_each_test: true, + after_suite: false, + before_suite: false, + } + end + super + end + # Existing subclasses of ActiveSupport::TestCase (ones that already + # existed before we set up the self.inherited hook above) will not + # get their own instance variable. They're not real test cases + # anyway, so we give them a "don't reset anywhere" stub. + def self.want_reset_api_fixtures + {} + end + + def self.reset_api_fixtures where, t=true + if not want_reset_api_fixtures.has_key? where + raise ArgumentError, "There is no #{where.inspect} hook" + end + self.want_reset_api_fixtures[where] = t + end + + def self.run *args + reset_api_fixtures_now if want_reset_api_fixtures[:before_suite] + result = super + reset_api_fixtures_now if want_reset_api_fixtures[:after_suite] + result + end + + def after_teardown + if self.class.want_reset_api_fixtures[:after_each_test] + self.class.reset_api_fixtures_now + end + super + end + + protected + def self.reset_api_fixtures_now + # Never try to reset fixtures when we're just using test + # infrastructure to run performance/diagnostics suites. + return unless Rails.env == 'test' + + auth = api_fixture('api_client_authorizations')['admin_trustedclient'] + Thread.current[:arvados_api_token] = auth['api_token'] + ArvadosApiClient.new.api(nil, '../../database/reset', {}) + Thread.current[:arvados_api_token] = nil + end +end + # If it quacks like a duck, it must be a HTTP request object. class RequestDuck def self.host @@ -219,7 +304,24 @@ class RequestDuck end end +# Example: +# +# apps/workbench$ RAILS_ENV=test bundle exec irb -Ilib:test +# > load 'test/test_helper.rb' +# > singletest 'integration/collection_upload_test.rb', 'Upload two empty files' +# +def singletest test_class_file, test_name + load File.join('test', test_class_file) + Minitest.run ['-v', '-n', "test_#{test_name.gsub ' ', '_'}"] + Object.send(:remove_const, + test_class_file.gsub(/.*\/|\.rb$/, '').camelize.to_sym) + ::Minitest::Runnable.runnables.reject! { true } +end + if ENV["RAILS_ENV"].eql? 'test' ApiServerForTests.new.run ApiServerForTests.new.run ["--websockets"] end + +# Reset fixtures now (i.e., before any tests run). +ActiveSupport::TestCase.reset_api_fixtures_now