test_helper.rb
448 lines
| 16.9 KiB
| text/x-ruby
|
RubyLexer
/ test / test_helper.rb
Jean-Philippe Lang
|
r5055 | # Redmine - project management software | ||
| # Copyright (C) 2006-2011 Jean-Philippe Lang | ||||
|
Jean-Philippe Lang
|
r5 | # | ||
| # This program is free software; you can redistribute it and/or | ||||
| # modify it under the terms of the GNU General Public License | ||||
| # as published by the Free Software Foundation; either version 2 | ||||
| # of the License, or (at your option) any later version. | ||||
Toshi MARUYAMA
|
r6003 | # | ||
|
Jean-Philippe Lang
|
r5 | # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
| # GNU General Public License for more details. | ||||
|
Toshi MARUYAMA
|
r6003 | # | ||
|
Jean-Philippe Lang
|
r5 | # You should have received a copy of the GNU General Public License | ||
| # along with this program; if not, write to the Free Software | ||||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
Eric Davis
|
r3726 | ENV["RAILS_ENV"] = "test" | ||
|
Jean-Philippe Lang
|
r2 | require File.expand_path(File.dirname(__FILE__) + "/../config/environment") | ||
| require 'test_help' | ||||
|
Jean-Philippe Lang
|
r688 | require File.expand_path(File.dirname(__FILE__) + '/helper_testcase') | ||
|
Toshi MARUYAMA
|
r6003 | require Rails.root.join('test', 'mocks', 'open_id_authentication_mock.rb') | ||
|
Jean-Philippe Lang
|
r2 | |||
|
Eric Davis
|
r2824 | require File.expand_path(File.dirname(__FILE__) + '/object_daddy_helpers') | ||
| include ObjectDaddyHelpers | ||||
|
Eric Davis
|
r2823 | |||
|
Eric Davis
|
r2773 | class ActiveSupport::TestCase | ||
|
Jean-Philippe Lang
|
r2 | # Transactional fixtures accelerate your tests by wrapping each test method | ||
| # in a transaction that's rolled back on completion. This ensures that the | ||||
| # test database remains unchanged so your fixtures don't have to be reloaded | ||||
| # between every test method. Fewer database queries means faster tests. | ||||
| # | ||||
| # Read Mike Clark's excellent walkthrough at | ||||
| # http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting | ||||
| # | ||||
| # Every Active Record database supports transactions except MyISAM tables | ||||
| # in MySQL. Turn off transactional fixtures in this case; however, if you | ||||
| # don't care one way or the other, switching from MyISAM to InnoDB tables | ||||
| # is recommended. | ||||
| self.use_transactional_fixtures = true | ||||
| # Instantiated fixtures are slow, but give you @david where otherwise you | ||||
| # would need people(:david). If you don't want to migrate your existing | ||||
| # test cases which use the @david style and don't mind the speed hit (each | ||||
| # instantiated fixtures translates to a database query per test method), | ||||
| # then set this back to true. | ||||
| self.use_instantiated_fixtures = false | ||||
| # Add more helper methods to be used by all tests here... | ||||
|
Jean-Philippe Lang
|
r5 | |||
| def log_user(login, password) | ||||
|
Jean-Philippe Lang
|
r3009 | User.anonymous | ||
|
Jean-Philippe Lang
|
r2430 | get "/login" | ||
|
Jean-Philippe Lang
|
r10 | assert_equal nil, session[:user_id] | ||
|
Jean-Philippe Lang
|
r5 | assert_response :success | ||
| assert_template "account/login" | ||||
|
Jean-Philippe Lang
|
r2430 | post "/login", :username => login, :password => password | ||
|
Jean-Philippe Lang
|
r10 | assert_equal login, User.find(session[:user_id]).login | ||
|
Jean-Philippe Lang
|
r5 | end | ||
|
Jean-Philippe Lang
|
r1030 | |||
|
Jean-Philippe Lang
|
r2795 | def uploaded_test_file(name, mime) | ||
|
Jean-Philippe Lang
|
r4483 | ActionController::TestUploadedFile.new(ActiveSupport::TestCase.fixture_path + "/files/#{name}", mime, true) | ||
|
Jean-Philippe Lang
|
r1030 | end | ||
|
Eric Davis
|
r3659 | |||
| # Mock out a file | ||||
|
Eric Davis
|
r3896 | def self.mock_file | ||
|
Eric Davis
|
r3659 | file = 'a_file.png' | ||
| file.stubs(:size).returns(32) | ||||
| file.stubs(:original_filename).returns('a_file.png') | ||||
| file.stubs(:content_type).returns('image/png') | ||||
| file.stubs(:read).returns(false) | ||||
| file | ||||
| end | ||||
|
Eric Davis
|
r3896 | |||
| def mock_file | ||||
| self.class.mock_file | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1506 | # Use a temporary directory for attachment related tests | ||
| def set_tmp_attachments_directory | ||||
|
Toshi MARUYAMA
|
r5961 | Dir.mkdir "#{Rails.root}/tmp/test" unless File.directory?("#{Rails.root}/tmp/test") | ||
| unless File.directory?("#{Rails.root}/tmp/test/attachments") | ||||
| Dir.mkdir "#{Rails.root}/tmp/test/attachments" | ||||
| end | ||||
| Attachment.storage_path = "#{Rails.root}/tmp/test/attachments" | ||||
|
Jean-Philippe Lang
|
r1506 | end | ||
|
Toshi MARUYAMA
|
r5961 | |||
|
Jean-Philippe Lang
|
r2442 | def with_settings(options, &block) | ||
| saved_settings = options.keys.inject({}) {|h, k| h[k] = Setting[k].dup; h} | ||||
| options.each {|k, v| Setting[k] = v} | ||||
| yield | ||||
|
Jean-Philippe Lang
|
r5107 | ensure | ||
|
Jean-Philippe Lang
|
r2442 | saved_settings.each {|k, v| Setting[k] = v} | ||
| end | ||||
|
Eric Davis
|
r3155 | |||
|
Eric Davis
|
r3837 | def change_user_password(login, new_password) | ||
| user = User.first(:conditions => {:login => login}) | ||||
| user.password, user.password_confirmation = new_password, new_password | ||||
| user.save! | ||||
| end | ||||
|
Eric Davis
|
r3324 | def self.ldap_configured? | ||
| @test_ldap = Net::LDAP.new(:host => '127.0.0.1', :port => 389) | ||||
| return @test_ldap.bind | ||||
|
Jean-Philippe Lang
|
r3328 | rescue Exception => e | ||
| # LDAP is not listening | ||||
| return nil | ||||
|
Eric Davis
|
r3324 | end | ||
|
Toshi MARUYAMA
|
r5983 | |||
|
Jean-Philippe Lang
|
r3606 | # Returns the path to the test +vendor+ repository | ||
| def self.repository_path(vendor) | ||||
|
Toshi MARUYAMA
|
r5983 | Rails.root.join("tmp/test/#{vendor.downcase}_repository").to_s | ||
|
Jean-Philippe Lang
|
r3606 | end | ||
|
Toshi MARUYAMA
|
r5983 | |||
|
Toshi MARUYAMA
|
r5062 | # Returns the url of the subversion test repository | ||
|
Jean-Philippe Lang
|
r5055 | def self.subversion_repository_url | ||
| path = repository_path('subversion') | ||||
| path = '/' + path unless path.starts_with?('/') | ||||
| "file://#{path}" | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5983 | |||
|
Jean-Philippe Lang
|
r3606 | # Returns true if the +vendor+ test repository is configured | ||
| def self.repository_configured?(vendor) | ||||
| File.directory?(repository_path(vendor)) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5983 | |||
|
Jean-Philippe Lang
|
r4172 | def assert_error_tag(options={}) | ||
|
Jean-Philippe Lang
|
r4315 | assert_tag({:attributes => { :id => 'errorExplanation' }}.merge(options)) | ||
|
Jean-Philippe Lang
|
r4172 | end | ||
|
Jean-Philippe Lang
|
r6097 | |||
| def assert_include(expected, s) | ||||
| assert s.include?(expected), "\"#{expected}\" not found in \"#{s}\"" | ||||
| end | ||||
|
Eric Davis
|
r3324 | |||
|
Eric Davis
|
r3155 | # Shoulda macros | ||
| def self.should_render_404 | ||||
| should_respond_with :not_found | ||||
|
Jean-Philippe Lang
|
r4172 | should_render_template 'common/error' | ||
|
Eric Davis
|
r3155 | end | ||
| def self.should_have_before_filter(expected_method, options = {}) | ||||
| should_have_filter('before', expected_method, options) | ||||
| end | ||||
| def self.should_have_after_filter(expected_method, options = {}) | ||||
| should_have_filter('after', expected_method, options) | ||||
| end | ||||
| def self.should_have_filter(filter_type, expected_method, options) | ||||
| description = "have #{filter_type}_filter :#{expected_method}" | ||||
| description << " with #{options.inspect}" unless options.empty? | ||||
| should description do | ||||
| klass = "action_controller/filters/#{filter_type}_filter".classify.constantize | ||||
| expected = klass.new(:filter, expected_method.to_sym, options) | ||||
| assert_equal 1, @controller.class.filter_chain.select { |filter| | ||||
| filter.method == expected.method && filter.kind == expected.kind && | ||||
| filter.options == expected.options && filter.class == expected.class | ||||
| }.size | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r3438 | |||
| def self.should_show_the_old_and_new_values_for(prop_key, model, &block) | ||||
| context "" do | ||||
| setup do | ||||
| if block_given? | ||||
| instance_eval &block | ||||
| else | ||||
| @old_value = model.generate! | ||||
| @new_value = model.generate! | ||||
| end | ||||
| end | ||||
| should "use the new value's name" do | ||||
| @detail = JournalDetail.generate!(:property => 'attr', | ||||
| :old_value => @old_value.id, | ||||
| :value => @new_value.id, | ||||
| :prop_key => prop_key) | ||||
| assert_match @new_value.name, show_detail(@detail, true) | ||||
| end | ||||
| should "use the old value's name" do | ||||
| @detail = JournalDetail.generate!(:property => 'attr', | ||||
| :old_value => @old_value.id, | ||||
| :value => @new_value.id, | ||||
| :prop_key => prop_key) | ||||
| assert_match @old_value.name, show_detail(@detail, true) | ||||
| end | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r3791 | |||
| def self.should_create_a_new_user(&block) | ||||
| should "create a new user" do | ||||
| user = instance_eval &block | ||||
| assert user | ||||
| assert_kind_of User, user | ||||
| assert !user.new_record? | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r4244 | |||
|
Eric Davis
|
r4250 | # Test that a request allows the three types of API authentication | ||
| # | ||||
| # * HTTP Basic with username and password | ||||
| # * HTTP Basic with an api key for the username | ||||
| # * Key based with the key=X parameter | ||||
| # | ||||
| # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) | ||||
| # @param [String] url the request url | ||||
| # @param [optional, Hash] parameters additional request parameters | ||||
|
Eric Davis
|
r4251 | # @param [optional, Hash] options additional options | ||
| # @option options [Symbol] :success_code Successful response code (:success) | ||||
| # @option options [Symbol] :failure_code Failure response code (:unauthorized) | ||||
| def self.should_allow_api_authentication(http_method, url, parameters={}, options={}) | ||||
| should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters, options) | ||||
| should_allow_http_basic_auth_with_key(http_method, url, parameters, options) | ||||
| should_allow_key_based_auth(http_method, url, parameters, options) | ||||
|
Eric Davis
|
r4250 | end | ||
|
Eric Davis
|
r4246 | # Test that a request allows the username and password for HTTP BASIC | ||
| # | ||||
| # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) | ||||
| # @param [String] url the request url | ||||
| # @param [optional, Hash] parameters additional request parameters | ||||
|
Eric Davis
|
r4251 | # @param [optional, Hash] options additional options | ||
| # @option options [Symbol] :success_code Successful response code (:success) | ||||
| # @option options [Symbol] :failure_code Failure response code (:unauthorized) | ||||
| def self.should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters={}, options={}) | ||||
| success_code = options[:success_code] || :success | ||||
| failure_code = options[:failure_code] || :unauthorized | ||||
|
Eric Davis
|
r4246 | context "should allow http basic auth using a username and password for #{http_method} #{url}" do | ||
| context "with a valid HTTP authentication" do | ||||
| setup do | ||||
| @user = User.generate_with_protected!(:password => 'my_password', :password_confirmation => 'my_password', :admin => true) # Admin so they can access the project | ||||
| @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'my_password') | ||||
| send(http_method, url, parameters, {:authorization => @authorization}) | ||||
| end | ||||
|
Eric Davis
|
r4251 | should_respond_with success_code | ||
|
Eric Davis
|
r4246 | should_respond_with_content_type_based_on_url(url) | ||
| should "login as the user" do | ||||
| assert_equal @user, User.current | ||||
| end | ||||
| end | ||||
| context "with an invalid HTTP authentication" do | ||||
| setup do | ||||
| @user = User.generate_with_protected! | ||||
| @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'wrong_password') | ||||
| send(http_method, url, parameters, {:authorization => @authorization}) | ||||
| end | ||||
|
Eric Davis
|
r4251 | should_respond_with failure_code | ||
|
Eric Davis
|
r4246 | should_respond_with_content_type_based_on_url(url) | ||
| should "not login as the user" do | ||||
| assert_equal User.anonymous, User.current | ||||
| end | ||||
| end | ||||
| context "without credentials" do | ||||
| setup do | ||||
| send(http_method, url, parameters, {:authorization => ''}) | ||||
| end | ||||
|
Eric Davis
|
r4251 | should_respond_with failure_code | ||
|
Eric Davis
|
r4246 | should_respond_with_content_type_based_on_url(url) | ||
| should "include_www_authenticate_header" do | ||||
| assert @controller.response.headers.has_key?('WWW-Authenticate') | ||||
| end | ||||
| end | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r4249 | # Test that a request allows the API key with HTTP BASIC | ||
| # | ||||
| # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) | ||||
| # @param [String] url the request url | ||||
| # @param [optional, Hash] parameters additional request parameters | ||||
|
Eric Davis
|
r4251 | # @param [optional, Hash] options additional options | ||
| # @option options [Symbol] :success_code Successful response code (:success) | ||||
| # @option options [Symbol] :failure_code Failure response code (:unauthorized) | ||||
| def self.should_allow_http_basic_auth_with_key(http_method, url, parameters={}, options={}) | ||||
| success_code = options[:success_code] || :success | ||||
| failure_code = options[:failure_code] || :unauthorized | ||||
|
Eric Davis
|
r4249 | context "should allow http basic auth with a key for #{http_method} #{url}" do | ||
| context "with a valid HTTP authentication using the API token" do | ||||
| setup do | ||||
|
Eric Davis
|
r4250 | @user = User.generate_with_protected!(:admin => true) | ||
|
Eric Davis
|
r4249 | @token = Token.generate!(:user => @user, :action => 'api') | ||
| @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X') | ||||
| send(http_method, url, parameters, {:authorization => @authorization}) | ||||
| end | ||||
|
Eric Davis
|
r4251 | should_respond_with success_code | ||
|
Eric Davis
|
r4249 | should_respond_with_content_type_based_on_url(url) | ||
|
Eric Davis
|
r4250 | should_be_a_valid_response_string_based_on_url(url) | ||
|
Eric Davis
|
r4249 | should "login as the user" do | ||
| assert_equal @user, User.current | ||||
| end | ||||
| end | ||||
| context "with an invalid HTTP authentication" do | ||||
| setup do | ||||
| @user = User.generate_with_protected! | ||||
| @token = Token.generate!(:user => @user, :action => 'feeds') | ||||
| @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X') | ||||
| send(http_method, url, parameters, {:authorization => @authorization}) | ||||
| end | ||||
|
Eric Davis
|
r4251 | should_respond_with failure_code | ||
|
Eric Davis
|
r4249 | should_respond_with_content_type_based_on_url(url) | ||
| should "not login as the user" do | ||||
| assert_equal User.anonymous, User.current | ||||
| end | ||||
| end | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r4244 | # Test that a request allows full key authentication | ||
| # | ||||
| # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) | ||||
| # @param [String] url the request url, without the key=ZXY parameter | ||||
|
Eric Davis
|
r4250 | # @param [optional, Hash] parameters additional request parameters | ||
|
Eric Davis
|
r4251 | # @param [optional, Hash] options additional options | ||
| # @option options [Symbol] :success_code Successful response code (:success) | ||||
| # @option options [Symbol] :failure_code Failure response code (:unauthorized) | ||||
| def self.should_allow_key_based_auth(http_method, url, parameters={}, options={}) | ||||
| success_code = options[:success_code] || :success | ||||
| failure_code = options[:failure_code] || :unauthorized | ||||
|
Eric Davis
|
r4246 | context "should allow key based auth using key=X for #{http_method} #{url}" do | ||
|
Eric Davis
|
r4244 | context "with a valid api token" do | ||
| setup do | ||||
|
Eric Davis
|
r4250 | @user = User.generate_with_protected!(:admin => true) | ||
|
Eric Davis
|
r4244 | @token = Token.generate!(:user => @user, :action => 'api') | ||
|
Eric Davis
|
r4250 | # Simple url parse to add on ?key= or &key= | ||
| request_url = if url.match(/\?/) | ||||
| url + "&key=#{@token.value}" | ||||
| else | ||||
| url + "?key=#{@token.value}" | ||||
| end | ||||
| send(http_method, request_url, parameters) | ||||
|
Eric Davis
|
r4244 | end | ||
|
Eric Davis
|
r4251 | should_respond_with success_code | ||
|
Eric Davis
|
r4244 | should_respond_with_content_type_based_on_url(url) | ||
|
Eric Davis
|
r4250 | should_be_a_valid_response_string_based_on_url(url) | ||
|
Eric Davis
|
r4244 | should "login as the user" do | ||
| assert_equal @user, User.current | ||||
| end | ||||
| end | ||||
| context "with an invalid api token" do | ||||
| setup do | ||||
| @user = User.generate_with_protected! | ||||
| @token = Token.generate!(:user => @user, :action => 'feeds') | ||||
|
Eric Davis
|
r4251 | # Simple url parse to add on ?key= or &key= | ||
| request_url = if url.match(/\?/) | ||||
| url + "&key=#{@token.value}" | ||||
| else | ||||
| url + "?key=#{@token.value}" | ||||
| end | ||||
| send(http_method, request_url, parameters) | ||||
|
Eric Davis
|
r4244 | end | ||
|
Eric Davis
|
r4251 | should_respond_with failure_code | ||
|
Eric Davis
|
r4244 | should_respond_with_content_type_based_on_url(url) | ||
| should "not login as the user" do | ||||
| assert_equal User.anonymous, User.current | ||||
| end | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r4459 | context "should allow key based auth using X-Redmine-API-Key header for #{http_method} #{url}" do | ||
| setup do | ||||
| @user = User.generate_with_protected!(:admin => true) | ||||
| @token = Token.generate!(:user => @user, :action => 'api') | ||||
| send(http_method, url, parameters, {'X-Redmine-API-Key' => @token.value.to_s}) | ||||
| end | ||||
| should_respond_with success_code | ||||
| should_respond_with_content_type_based_on_url(url) | ||||
| should_be_a_valid_response_string_based_on_url(url) | ||||
| should "login as the user" do | ||||
| assert_equal @user, User.current | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r4244 | end | ||
| # Uses should_respond_with_content_type based on what's in the url: | ||||
| # | ||||
| # '/project/issues.xml' => should_respond_with_content_type :xml | ||||
| # '/project/issues.json' => should_respond_with_content_type :json | ||||
| # | ||||
| # @param [String] url Request | ||||
| def self.should_respond_with_content_type_based_on_url(url) | ||||
| case | ||||
| when url.match(/xml/i) | ||||
| should_respond_with_content_type :xml | ||||
| when url.match(/json/i) | ||||
| should_respond_with_content_type :json | ||||
| else | ||||
| raise "Unknown content type for should_respond_with_content_type_based_on_url: #{url}" | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r4250 | |||
| # Uses the url to assert which format the response should be in | ||||
| # | ||||
| # '/project/issues.xml' => should_be_a_valid_xml_string | ||||
| # '/project/issues.json' => should_be_a_valid_json_string | ||||
| # | ||||
| # @param [String] url Request | ||||
| def self.should_be_a_valid_response_string_based_on_url(url) | ||||
| case | ||||
| when url.match(/xml/i) | ||||
| should_be_a_valid_xml_string | ||||
| when url.match(/json/i) | ||||
| should_be_a_valid_json_string | ||||
| else | ||||
| raise "Unknown content type for should_be_a_valid_response_based_on_url: #{url}" | ||||
| end | ||||
| end | ||||
| # Checks that the response is a valid JSON string | ||||
| def self.should_be_a_valid_json_string | ||||
|
Eric Davis
|
r4252 | should "be a valid JSON string (or empty)" do | ||
|
Jean-Philippe Lang
|
r5032 | assert(response.body.blank? || ActiveSupport::JSON.decode(response.body)) | ||
|
Eric Davis
|
r4250 | end | ||
| end | ||||
| # Checks that the response is a valid XML string | ||||
| def self.should_be_a_valid_xml_string | ||||
| should "be a valid XML string" do | ||||
| assert REXML::Document.new(response.body) | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2 | end | ||
|
Eric Davis
|
r4243 | |||
| # Simple module to "namespace" all of the API tests | ||||
| module ApiTest | ||||
| end | ||||