##// END OF EJS Templates
jro_apps » redmine
RSS
code layout clean up uploaded_test_file of test/test_helper.rb...
Toshi MARUYAMA -
r7735:66d6d611baad
parent child
Show More
Side by Side Unified
Context file:
r7735:66d6d611baad Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,448 +1,449
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 ENV["RAILS_ENV"] = "test"
19 19 require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
20 20 require 'test_help'
21 21 require File.expand_path(File.dirname(__FILE__) + '/helper_testcase')
22 22 require Rails.root.join('test', 'mocks', 'open_id_authentication_mock.rb').to_s
23 23
24 24 require File.expand_path(File.dirname(__FILE__) + '/object_daddy_helpers')
25 25 include ObjectDaddyHelpers
26 26
27 27 class ActiveSupport::TestCase
28 28 # Transactional fixtures accelerate your tests by wrapping each test method
29 29 # in a transaction that's rolled back on completion. This ensures that the
30 30 # test database remains unchanged so your fixtures don't have to be reloaded
31 31 # between every test method. Fewer database queries means faster tests.
32 32 #
33 33 # Read Mike Clark's excellent walkthrough at
34 34 # http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
35 35 #
36 36 # Every Active Record database supports transactions except MyISAM tables
37 37 # in MySQL. Turn off transactional fixtures in this case; however, if you
38 38 # don't care one way or the other, switching from MyISAM to InnoDB tables
39 39 # is recommended.
40 40 self.use_transactional_fixtures = true
41 41
42 42 # Instantiated fixtures are slow, but give you @david where otherwise you
43 43 # would need people(:david). If you don't want to migrate your existing
44 44 # test cases which use the @david style and don't mind the speed hit (each
45 45 # instantiated fixtures translates to a database query per test method),
46 46 # then set this back to true.
47 47 self.use_instantiated_fixtures = false
48 48
49 49 # Add more helper methods to be used by all tests here...
50 50
51 51 def log_user(login, password)
52 52 User.anonymous
53 53 get "/login"
54 54 assert_equal nil, session[:user_id]
55 55 assert_response :success
56 56 assert_template "account/login"
57 57 post "/login", :username => login, :password => password
58 58 assert_equal login, User.find(session[:user_id]).login
59 59 end
60 60
61 61 def uploaded_test_file(name, mime)
62 ActionController::TestUploadedFile.new(ActiveSupport::TestCase.fixture_path + "/files/#{name}", mime, true)
62 ActionController::TestUploadedFile.new(
63 ActiveSupport::TestCase.fixture_path + "/files/#{name}", mime, true)
63 64 end
64 65
65 66 # Mock out a file
66 67 def self.mock_file
67 68 file = 'a_file.png'
68 69 file.stubs(:size).returns(32)
69 70 file.stubs(:original_filename).returns('a_file.png')
70 71 file.stubs(:content_type).returns('image/png')
71 72 file.stubs(:read).returns(false)
72 73 file
73 74 end
74 75
75 76 def mock_file
76 77 self.class.mock_file
77 78 end
78 79
79 80 # Use a temporary directory for attachment related tests
80 81 def set_tmp_attachments_directory
81 82 Dir.mkdir "#{Rails.root}/tmp/test" unless File.directory?("#{Rails.root}/tmp/test")
82 83 unless File.directory?("#{Rails.root}/tmp/test/attachments")
83 84 Dir.mkdir "#{Rails.root}/tmp/test/attachments"
84 85 end
85 86 Attachment.storage_path = "#{Rails.root}/tmp/test/attachments"
86 87 end
87 88
88 89 def with_settings(options, &block)
89 90 saved_settings = options.keys.inject({}) {|h, k| h[k] = Setting[k].dup; h}
90 91 options.each {|k, v| Setting[k] = v}
91 92 yield
92 93 ensure
93 94 saved_settings.each {|k, v| Setting[k] = v}
94 95 end
95 96
96 97 def change_user_password(login, new_password)
97 98 user = User.first(:conditions => {:login => login})
98 99 user.password, user.password_confirmation = new_password, new_password
99 100 user.save!
100 101 end
101 102
102 103 def self.ldap_configured?
103 104 @test_ldap = Net::LDAP.new(:host => '127.0.0.1', :port => 389)
104 105 return @test_ldap.bind
105 106 rescue Exception => e
106 107 # LDAP is not listening
107 108 return nil
108 109 end
109 110
110 111 # Returns the path to the test +vendor+ repository
111 112 def self.repository_path(vendor)
112 113 Rails.root.join("tmp/test/#{vendor.downcase}_repository").to_s
113 114 end
114 115
115 116 # Returns the url of the subversion test repository
116 117 def self.subversion_repository_url
117 118 path = repository_path('subversion')
118 119 path = '/' + path unless path.starts_with?('/')
119 120 "file://#{path}"
120 121 end
121 122
122 123 # Returns true if the +vendor+ test repository is configured
123 124 def self.repository_configured?(vendor)
124 125 File.directory?(repository_path(vendor))
125 126 end
126 127
127 128 def assert_error_tag(options={})
128 129 assert_tag({:attributes => { :id => 'errorExplanation' }}.merge(options))
129 130 end
130 131
131 132 def assert_include(expected, s)
132 133 assert s.include?(expected), "\"#{expected}\" not found in \"#{s}\""
133 134 end
134 135
135 136 # Shoulda macros
136 137 def self.should_render_404
137 138 should_respond_with :not_found
138 139 should_render_template 'common/error'
139 140 end
140 141
141 142 def self.should_have_before_filter(expected_method, options = {})
142 143 should_have_filter('before', expected_method, options)
143 144 end
144 145
145 146 def self.should_have_after_filter(expected_method, options = {})
146 147 should_have_filter('after', expected_method, options)
147 148 end
148 149
149 150 def self.should_have_filter(filter_type, expected_method, options)
150 151 description = "have #{filter_type}_filter :#{expected_method}"
151 152 description << " with #{options.inspect}" unless options.empty?
152 153
153 154 should description do
154 155 klass = "action_controller/filters/#{filter_type}_filter".classify.constantize
155 156 expected = klass.new(:filter, expected_method.to_sym, options)
156 157 assert_equal 1, @controller.class.filter_chain.select { |filter|
157 158 filter.method == expected.method && filter.kind == expected.kind &&
158 159 filter.options == expected.options && filter.class == expected.class
159 160 }.size
160 161 end
161 162 end
162 163
163 164 def self.should_show_the_old_and_new_values_for(prop_key, model, &block)
164 165 context "" do
165 166 setup do
166 167 if block_given?
167 168 instance_eval &block
168 169 else
169 170 @old_value = model.generate!
170 171 @new_value = model.generate!
171 172 end
172 173 end
173 174
174 175 should "use the new value's name" do
175 176 @detail = JournalDetail.generate!(:property => 'attr',
176 177 :old_value => @old_value.id,
177 178 :value => @new_value.id,
178 179 :prop_key => prop_key)
179 180
180 181 assert_match @new_value.name, show_detail(@detail, true)
181 182 end
182 183
183 184 should "use the old value's name" do
184 185 @detail = JournalDetail.generate!(:property => 'attr',
185 186 :old_value => @old_value.id,
186 187 :value => @new_value.id,
187 188 :prop_key => prop_key)
188 189
189 190 assert_match @old_value.name, show_detail(@detail, true)
190 191 end
191 192 end
192 193 end
193 194
194 195 def self.should_create_a_new_user(&block)
195 196 should "create a new user" do
196 197 user = instance_eval &block
197 198 assert user
198 199 assert_kind_of User, user
199 200 assert !user.new_record?
200 201 end
201 202 end
202 203
203 204 # Test that a request allows the three types of API authentication
204 205 #
205 206 # * HTTP Basic with username and password
206 207 # * HTTP Basic with an api key for the username
207 208 # * Key based with the key=X parameter
208 209 #
209 210 # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
210 211 # @param [String] url the request url
211 212 # @param [optional, Hash] parameters additional request parameters
212 213 # @param [optional, Hash] options additional options
213 214 # @option options [Symbol] :success_code Successful response code (:success)
214 215 # @option options [Symbol] :failure_code Failure response code (:unauthorized)
215 216 def self.should_allow_api_authentication(http_method, url, parameters={}, options={})
216 217 should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters, options)
217 218 should_allow_http_basic_auth_with_key(http_method, url, parameters, options)
218 219 should_allow_key_based_auth(http_method, url, parameters, options)
219 220 end
220 221
221 222 # Test that a request allows the username and password for HTTP BASIC
222 223 #
223 224 # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
224 225 # @param [String] url the request url
225 226 # @param [optional, Hash] parameters additional request parameters
226 227 # @param [optional, Hash] options additional options
227 228 # @option options [Symbol] :success_code Successful response code (:success)
228 229 # @option options [Symbol] :failure_code Failure response code (:unauthorized)
229 230 def self.should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters={}, options={})
230 231 success_code = options[:success_code] || :success
231 232 failure_code = options[:failure_code] || :unauthorized
232 233
233 234 context "should allow http basic auth using a username and password for #{http_method} #{url}" do
234 235 context "with a valid HTTP authentication" do
235 236 setup do
236 237 @user = User.generate_with_protected!(:password => 'my_password', :password_confirmation => 'my_password', :admin => true) # Admin so they can access the project
237 238 @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'my_password')
238 239 send(http_method, url, parameters, {:authorization => @authorization})
239 240 end
240 241
241 242 should_respond_with success_code
242 243 should_respond_with_content_type_based_on_url(url)
243 244 should "login as the user" do
244 245 assert_equal @user, User.current
245 246 end
246 247 end
247 248
248 249 context "with an invalid HTTP authentication" do
249 250 setup do
250 251 @user = User.generate_with_protected!
251 252 @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'wrong_password')
252 253 send(http_method, url, parameters, {:authorization => @authorization})
253 254 end
254 255
255 256 should_respond_with failure_code
256 257 should_respond_with_content_type_based_on_url(url)
257 258 should "not login as the user" do
258 259 assert_equal User.anonymous, User.current
259 260 end
260 261 end
261 262
262 263 context "without credentials" do
263 264 setup do
264 265 send(http_method, url, parameters, {:authorization => ''})
265 266 end
266 267
267 268 should_respond_with failure_code
268 269 should_respond_with_content_type_based_on_url(url)
269 270 should "include_www_authenticate_header" do
270 271 assert @controller.response.headers.has_key?('WWW-Authenticate')
271 272 end
272 273 end
273 274 end
274 275
275 276 end
276 277
277 278 # Test that a request allows the API key with HTTP BASIC
278 279 #
279 280 # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
280 281 # @param [String] url the request url
281 282 # @param [optional, Hash] parameters additional request parameters
282 283 # @param [optional, Hash] options additional options
283 284 # @option options [Symbol] :success_code Successful response code (:success)
284 285 # @option options [Symbol] :failure_code Failure response code (:unauthorized)
285 286 def self.should_allow_http_basic_auth_with_key(http_method, url, parameters={}, options={})
286 287 success_code = options[:success_code] || :success
287 288 failure_code = options[:failure_code] || :unauthorized
288 289
289 290 context "should allow http basic auth with a key for #{http_method} #{url}" do
290 291 context "with a valid HTTP authentication using the API token" do
291 292 setup do
292 293 @user = User.generate_with_protected!(:admin => true)
293 294 @token = Token.generate!(:user => @user, :action => 'api')
294 295 @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X')
295 296 send(http_method, url, parameters, {:authorization => @authorization})
296 297 end
297 298
298 299 should_respond_with success_code
299 300 should_respond_with_content_type_based_on_url(url)
300 301 should_be_a_valid_response_string_based_on_url(url)
301 302 should "login as the user" do
302 303 assert_equal @user, User.current
303 304 end
304 305 end
305 306
306 307 context "with an invalid HTTP authentication" do
307 308 setup do
308 309 @user = User.generate_with_protected!
309 310 @token = Token.generate!(:user => @user, :action => 'feeds')
310 311 @authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X')
311 312 send(http_method, url, parameters, {:authorization => @authorization})
312 313 end
313 314
314 315 should_respond_with failure_code
315 316 should_respond_with_content_type_based_on_url(url)
316 317 should "not login as the user" do
317 318 assert_equal User.anonymous, User.current
318 319 end
319 320 end
320 321 end
321 322 end
322 323
323 324 # Test that a request allows full key authentication
324 325 #
325 326 # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
326 327 # @param [String] url the request url, without the key=ZXY parameter
327 328 # @param [optional, Hash] parameters additional request parameters
328 329 # @param [optional, Hash] options additional options
329 330 # @option options [Symbol] :success_code Successful response code (:success)
330 331 # @option options [Symbol] :failure_code Failure response code (:unauthorized)
331 332 def self.should_allow_key_based_auth(http_method, url, parameters={}, options={})
332 333 success_code = options[:success_code] || :success
333 334 failure_code = options[:failure_code] || :unauthorized
334 335
335 336 context "should allow key based auth using key=X for #{http_method} #{url}" do
336 337 context "with a valid api token" do
337 338 setup do
338 339 @user = User.generate_with_protected!(:admin => true)
339 340 @token = Token.generate!(:user => @user, :action => 'api')
340 341 # Simple url parse to add on ?key= or &key=
341 342 request_url = if url.match(/\?/)
342 343 url + "&key=#{@token.value}"
343 344 else
344 345 url + "?key=#{@token.value}"
345 346 end
346 347 send(http_method, request_url, parameters)
347 348 end
348 349
349 350 should_respond_with success_code
350 351 should_respond_with_content_type_based_on_url(url)
351 352 should_be_a_valid_response_string_based_on_url(url)
352 353 should "login as the user" do
353 354 assert_equal @user, User.current
354 355 end
355 356 end
356 357
357 358 context "with an invalid api token" do
358 359 setup do
359 360 @user = User.generate_with_protected!
360 361 @token = Token.generate!(:user => @user, :action => 'feeds')
361 362 # Simple url parse to add on ?key= or &key=
362 363 request_url = if url.match(/\?/)
363 364 url + "&key=#{@token.value}"
364 365 else
365 366 url + "?key=#{@token.value}"
366 367 end
367 368 send(http_method, request_url, parameters)
368 369 end
369 370
370 371 should_respond_with failure_code
371 372 should_respond_with_content_type_based_on_url(url)
372 373 should "not login as the user" do
373 374 assert_equal User.anonymous, User.current
374 375 end
375 376 end
376 377 end
377 378
378 379 context "should allow key based auth using X-Redmine-API-Key header for #{http_method} #{url}" do
379 380 setup do
380 381 @user = User.generate_with_protected!(:admin => true)
381 382 @token = Token.generate!(:user => @user, :action => 'api')
382 383 send(http_method, url, parameters, {'X-Redmine-API-Key' => @token.value.to_s})
383 384 end
384 385
385 386 should_respond_with success_code
386 387 should_respond_with_content_type_based_on_url(url)
387 388 should_be_a_valid_response_string_based_on_url(url)
388 389 should "login as the user" do
389 390 assert_equal @user, User.current
390 391 end
391 392 end
392 393 end
393 394
394 395 # Uses should_respond_with_content_type based on what's in the url:
395 396 #
396 397 # '/project/issues.xml' => should_respond_with_content_type :xml
397 398 # '/project/issues.json' => should_respond_with_content_type :json
398 399 #
399 400 # @param [String] url Request
400 401 def self.should_respond_with_content_type_based_on_url(url)
401 402 case
402 403 when url.match(/xml/i)
403 404 should_respond_with_content_type :xml
404 405 when url.match(/json/i)
405 406 should_respond_with_content_type :json
406 407 else
407 408 raise "Unknown content type for should_respond_with_content_type_based_on_url: #{url}"
408 409 end
409 410
410 411 end
411 412
412 413 # Uses the url to assert which format the response should be in
413 414 #
414 415 # '/project/issues.xml' => should_be_a_valid_xml_string
415 416 # '/project/issues.json' => should_be_a_valid_json_string
416 417 #
417 418 # @param [String] url Request
418 419 def self.should_be_a_valid_response_string_based_on_url(url)
419 420 case
420 421 when url.match(/xml/i)
421 422 should_be_a_valid_xml_string
422 423 when url.match(/json/i)
423 424 should_be_a_valid_json_string
424 425 else
425 426 raise "Unknown content type for should_be_a_valid_response_based_on_url: #{url}"
426 427 end
427 428
428 429 end
429 430
430 431 # Checks that the response is a valid JSON string
431 432 def self.should_be_a_valid_json_string
432 433 should "be a valid JSON string (or empty)" do
433 434 assert(response.body.blank? || ActiveSupport::JSON.decode(response.body))
434 435 end
435 436 end
436 437
437 438 # Checks that the response is a valid XML string
438 439 def self.should_be_a_valid_xml_string
439 440 should "be a valid XML string" do
440 441 assert REXML::Document.new(response.body)
441 442 end
442 443 end
443 444
444 445 end
445 446
446 447 # Simple module to "namespace" all of the API tests
447 448 module ApiTest
448 449 end
General Comments 0
You need to be logged in to leave comments. Login now