test_helper.rb
495 lines
| 17.8 KiB
| text/x-ruby
|
RubyLexer
/ test / test_helper.rb
|
r5055 | # Redmine - project management software | ||
|
r12461 | # Copyright (C) 2006-2014 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. | ||||
|
r6003 | # | ||
|
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. | ||||
|
r6003 | # | ||
|
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. | ||||
|
r9346 | #require 'shoulda' | ||
|
r3726 | ENV["RAILS_ENV"] = "test" | ||
|
r2 | require File.expand_path(File.dirname(__FILE__) + "/../config/environment") | ||
|
r9346 | require 'rails/test_help' | ||
|
r7682 | require Rails.root.join('test', 'mocks', 'open_id_authentication_mock.rb').to_s | ||
|
r2 | |||
|
r9336 | require File.expand_path(File.dirname(__FILE__) + '/object_helpers') | ||
include ObjectHelpers | ||||
|
r2823 | |||
|
r12418 | require 'awesome_nested_set/version' | ||
|
r2773 | class ActiveSupport::TestCase | ||
|
r9346 | include ActionDispatch::TestProcess | ||
|
r2 | |||
|
r11027 | self.use_transactional_fixtures = true | ||
|
r2 | self.use_instantiated_fixtures = false | ||
|
r12518 | ESCAPED_CANT = 'can't' | ||
ESCAPED_UCANT = 'Can't' | ||||
|
r12505 | # Rails 4.0.2 | ||
|
r12518 | #ESCAPED_CANT = 'can't' | ||
#ESCAPED_UCANT = 'Can't' | ||||
|
r12505 | |||
|
r5 | def log_user(login, password) | ||
|
r3009 | User.anonymous | ||
|
r2430 | get "/login" | ||
|
r10 | assert_equal nil, session[:user_id] | ||
|
r5 | assert_response :success | ||
assert_template "account/login" | ||||
|
r2430 | post "/login", :username => login, :password => password | ||
|
r10 | assert_equal login, User.find(session[:user_id]).login | ||
|
r5 | end | ||
|
r6826 | |||
|
r2795 | def uploaded_test_file(name, mime) | ||
|
r9346 | fixture_file_upload("files/#{name}", mime, true) | ||
|
r1030 | end | ||
|
r3659 | |||
|
r8355 | def credentials(user, password=nil) | ||
|
r9346 | {'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials(user, password || user)} | ||
|
r8355 | end | ||
|
r3659 | # Mock out a file | ||
|
r3896 | def self.mock_file | ||
|
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 | ||||
|
r3896 | |||
def mock_file | ||||
self.class.mock_file | ||||
end | ||||
|
r7771 | def mock_file_with_options(options={}) | ||
file = '' | ||||
file.stubs(:size).returns(32) | ||||
original_filename = options[:original_filename] || nil | ||||
file.stubs(:original_filename).returns(original_filename) | ||||
content_type = options[:content_type] || nil | ||||
file.stubs(:content_type).returns(content_type) | ||||
file.stubs(:read).returns(false) | ||||
file | ||||
end | ||||
|
r1506 | # Use a temporary directory for attachment related tests | ||
def set_tmp_attachments_directory | ||||
|
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" | ||||
|
r1506 | end | ||
|
r5961 | |||
|
r8128 | def set_fixtures_attachments_directory | ||
Attachment.storage_path = "#{Rails.root}/test/fixtures/files" | ||||
end | ||||
|
r2442 | def with_settings(options, &block) | ||
|
r11164 | saved_settings = options.keys.inject({}) do |h, k| | ||
h[k] = case Setting[k] | ||||
when Symbol, false, true, nil | ||||
Setting[k] | ||||
else | ||||
Setting[k].dup | ||||
end | ||||
h | ||||
end | ||||
|
r2442 | options.each {|k, v| Setting[k] = v} | ||
yield | ||||
|
r5107 | ensure | ||
|
r7818 | saved_settings.each {|k, v| Setting[k] = v} if saved_settings | ||
|
r2442 | end | ||
|
r3155 | |||
|
r10462 | # Yields the block with user as the current user | ||
def with_current_user(user, &block) | ||||
saved_user = User.current | ||||
User.current = user | ||||
yield | ||||
ensure | ||||
User.current = saved_user | ||||
end | ||||
|
r12621 | def with_locale(locale, &block) | ||
saved_localed = ::I18n.locale | ||||
::I18n.locale = locale | ||||
yield | ||||
ensure | ||||
::I18n.locale = saved_localed | ||||
end | ||||
|
r3837 | def change_user_password(login, new_password) | ||
|
r11733 | user = User.where(:login => login).first | ||
|
r3837 | user.password, user.password_confirmation = new_password, new_password | ||
user.save! | ||||
end | ||||
|
r3324 | def self.ldap_configured? | ||
@test_ldap = Net::LDAP.new(:host => '127.0.0.1', :port => 389) | ||||
return @test_ldap.bind | ||||
|
r3328 | rescue Exception => e | ||
# LDAP is not listening | ||||
return nil | ||||
|
r3324 | end | ||
|
r5983 | |||
|
r9750 | def self.convert_installed? | ||
|
r9831 | Redmine::Thumbnail.convert_available? | ||
|
r9750 | end | ||
|
r3606 | # Returns the path to the test +vendor+ repository | ||
def self.repository_path(vendor) | ||||
|
r5983 | Rails.root.join("tmp/test/#{vendor.downcase}_repository").to_s | ||
|
r3606 | end | ||
|
r5983 | |||
|
r5062 | # Returns the url of the subversion test repository | ||
|
r5055 | def self.subversion_repository_url | ||
path = repository_path('subversion') | ||||
path = '/' + path unless path.starts_with?('/') | ||||
"file://#{path}" | ||||
end | ||||
|
r5983 | |||
|
r3606 | # Returns true if the +vendor+ test repository is configured | ||
def self.repository_configured?(vendor) | ||||
File.directory?(repository_path(vendor)) | ||||
end | ||||
|
r5983 | |||
|
r8803 | def repository_path_hash(arr) | ||
hs = {} | ||||
hs[:path] = arr.join("/") | ||||
|
r9346 | hs[:param] = arr.join("/") | ||
|
r8803 | hs | ||
end | ||||
|
r10376 | def assert_save(object) | ||
saved = object.save | ||||
message = "#{object.class} could not be saved" | ||||
errors = object.errors.full_messages.map {|m| "- #{m}"} | ||||
message << ":\n#{errors.join("\n")}" if errors.any? | ||||
assert_equal true, saved, message | ||||
end | ||||
|
r4172 | def assert_error_tag(options={}) | ||
|
r4315 | assert_tag({:attributes => { :id => 'errorExplanation' }}.merge(options)) | ||
|
r4172 | end | ||
|
r6826 | |||
|
r9876 | def assert_include(expected, s, message=nil) | ||
assert s.include?(expected), (message || "\"#{expected}\" not found in \"#{s}\"") | ||||
|
r6097 | end | ||
|
r3324 | |||
|
r11782 | def assert_not_include(expected, s, message=nil) | ||
assert !s.include?(expected), (message || "\"#{expected}\" found in \"#{s}\"") | ||||
|
r8966 | end | ||
|
r10469 | def assert_select_in(text, *args, &block) | ||
d = HTML::Document.new(CGI::unescapeHTML(String.new(text))).root | ||||
assert_select(d, *args, &block) | ||||
end | ||||
|
r11782 | def assert_mail_body_match(expected, mail, message=nil) | ||
|
r8966 | if expected.is_a?(String) | ||
|
r11782 | assert_include expected, mail_body(mail), message | ||
|
r8966 | else | ||
|
r11782 | assert_match expected, mail_body(mail), message | ||
|
r8966 | end | ||
end | ||||
|
r11782 | def assert_mail_body_no_match(expected, mail, message=nil) | ||
|
r8966 | if expected.is_a?(String) | ||
|
r11782 | assert_not_include expected, mail_body(mail), message | ||
|
r8966 | else | ||
|
r11782 | assert_no_match expected, mail_body(mail), message | ||
|
r8966 | end | ||
end | ||||
|
r8972 | def mail_body(mail) | ||
|
r9346 | mail.parts.first.body.encoded | ||
|
r8972 | end | ||
|
r12418 | |||
# awesome_nested_set new node lft and rgt value changed this refactor revision. | ||||
# https://github.com/collectiveidea/awesome_nested_set/commit/199fca9bb938e40200cd90714dc69247ef017c61 | ||||
|
r12419 | # The reason of behavior change is that "self.class.base_class.unscoped" was added to this line. | ||
|
r12418 | # https://github.com/collectiveidea/awesome_nested_set/commit/199fca9bb9#diff-f61b59a5e6319024e211b0ffdd0e4ef1R273 | ||
# It seems correct behavior because of this line comment. | ||||
# https://github.com/collectiveidea/awesome_nested_set/blame/199fca9bb9/lib/awesome_nested_set/model.rb#L278 | ||||
def new_issue_lft | ||||
|
r12734 | # ::AwesomeNestedSet::VERSION > "2.1.6" ? Issue.maximum(:rgt) + 1 : 1 | ||
Issue.maximum(:rgt) + 1 | ||||
|
r12418 | end | ||
|
r11023 | end | ||
|
r3438 | |||
|
r11023 | module Redmine | ||
module ApiTest | ||||
# Base class for API tests | ||||
class Base < ActionDispatch::IntegrationTest | ||||
# 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 | ||||
# @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) | ||||
end | ||||
# 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 | ||||
# @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 | ||||
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! do |user| | ||||
user.admin = true | ||||
user.password = 'my_password' | ||||
end | ||||
send(http_method, url, parameters, credentials(@user.login, 'my_password')) | ||||
end | ||||
should_respond_with success_code | ||||
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! | ||||
send(http_method, url, parameters, credentials(@user.login, 'wrong_password')) | ||||
end | ||||
should_respond_with failure_code | ||||
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) | ||||
end | ||||
should_respond_with failure_code | ||||
should_respond_with_content_type_based_on_url(url) | ||||
should "include_www_authenticate_header" do | ||||
assert @controller.response.headers.has_key?('WWW-Authenticate') | ||||
end | ||||
|
r9335 | end | ||
|
r4246 | end | ||
end | ||||
|
r11023 | |||
# 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 | ||||
# @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 | ||||
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 | ||||
@user = User.generate! do |user| | ||||
user.admin = true | ||||
end | ||||
@token = Token.create!(:user => @user, :action => 'api') | ||||
send(http_method, url, parameters, credentials(@token.value, 'X')) | ||||
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 | ||||
context "with an invalid HTTP authentication" do | ||||
setup do | ||||
@user = User.generate! | ||||
@token = Token.create!(:user => @user, :action => 'feeds') | ||||
send(http_method, url, parameters, credentials(@token.value, 'X')) | ||||
end | ||||
should_respond_with failure_code | ||||
should_respond_with_content_type_based_on_url(url) | ||||
should "not login as the user" do | ||||
assert_equal User.anonymous, User.current | ||||
end | ||||
end | ||||
|
r4246 | end | ||
end | ||||
|
r11023 | |||
# 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 | ||||
# @param [optional, Hash] parameters additional request parameters | ||||
# @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 | ||||
context "should allow key based auth using key=X for #{http_method} #{url}" do | ||||
context "with a valid api token" do | ||||
setup do | ||||
@user = User.generate! do |user| | ||||
user.admin = true | ||||
end | ||||
@token = Token.create!(:user => @user, :action => 'api') | ||||
# 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) | ||||
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 | ||||
context "with an invalid api token" do | ||||
setup do | ||||
@user = User.generate! do |user| | ||||
user.admin = true | ||||
end | ||||
@token = Token.create!(:user => @user, :action => 'feeds') | ||||
# 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) | ||||
end | ||||
should_respond_with failure_code | ||||
should_respond_with_content_type_based_on_url(url) | ||||
should "not login as the user" do | ||||
assert_equal User.anonymous, User.current | ||||
end | ||||
end | ||||
|
r4246 | end | ||
|
r11023 | |||
context "should allow key based auth using X-Redmine-API-Key header for #{http_method} #{url}" do | ||||
setup do | ||||
@user = User.generate! do |user| | ||||
user.admin = true | ||||
end | ||||
@token = Token.create!(: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 | ||||
|
r4246 | end | ||
end | ||||
|
r11023 | |||
# 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 XML" do | ||||
assert_equal 'application/xml', @response.content_type | ||||
|
r9335 | end | ||
|
r11023 | when url.match(/json/i) | ||
should "respond with JSON" do | ||||
assert_equal 'application/json', @response.content_type | ||||
end | ||||
else | ||||
raise "Unknown content type for should_respond_with_content_type_based_on_url: #{url}" | ||||
|
r4249 | end | ||
end | ||||
|
r11023 | |||
# 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}" | ||||
|
r4249 | end | ||
end | ||||
|
r11023 | |||
# Checks that the response is a valid JSON string | ||||
def self.should_be_a_valid_json_string | ||||
should "be a valid JSON string (or empty)" do | ||||
assert(response.body.blank? || ActiveSupport::JSON.decode(response.body)) | ||||
|
r4244 | end | ||
end | ||||
|
r11023 | |||
# 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) | ||||
|
r4244 | end | ||
end | ||||
|
r11023 | |||
def self.should_respond_with(status) | ||||
should "respond with #{status}" do | ||||
assert_response status | ||||
|
r9335 | end | ||
|
r4459 | end | ||
end | ||||
|
r4244 | end | ||
|
r4243 | end | ||
|
r10683 | |||
# URL helpers do not work with config.threadsafe! | ||||
# https://github.com/rspec/rspec-rails/issues/476#issuecomment-4705454 | ||||
ActionView::TestCase::TestController.instance_eval do | ||||
helper Rails.application.routes.url_helpers | ||||
end | ||||
ActionView::TestCase::TestController.class_eval do | ||||
def _routes | ||||
Rails.application.routes | ||||
end | ||||
end | ||||