4 class ChangesetsControllerTest < ActionDispatch::IntegrationTest
6 # test all routes which lead to this controller
9 { :path => "/api/0.6/changesets", :method => :get },
10 { :controller => "api/changesets", :action => "index" }
13 { :path => "/api/0.6/changesets.json", :method => :get },
14 { :controller => "api/changesets", :action => "index", :format => "json" }
17 { :path => "/api/0.6/changesets", :method => :post },
18 { :controller => "api/changesets", :action => "create" }
21 { :path => "/api/0.6/changeset/1", :method => :get },
22 { :controller => "api/changesets", :action => "show", :id => "1" }
25 { :path => "/api/0.6/changeset/1.json", :method => :get },
26 { :controller => "api/changesets", :action => "show", :id => "1", :format => "json" }
29 { :path => "/api/0.6/changeset/1", :method => :put },
30 { :controller => "api/changesets", :action => "update", :id => "1" }
34 { :controller => "api/changesets", :action => "create" },
35 { :path => "/api/0.6/changeset/create", :method => :put }
40 # test the query functionality of changesets
42 private_user = create(:user, :data_public => false)
43 private_user_changeset = create(:changeset, :user => private_user)
44 private_user_closed_changeset = create(:changeset, :closed, :user => private_user)
46 changeset = create(:changeset, :user => user)
47 closed_changeset = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
48 changeset2 = create(:changeset, :bbox => [5, 5, 15, 15])
49 changeset3 = create(:changeset, :bbox => [4.5, 4.5, 5, 5])
51 get api_changesets_path(:bbox => "-10,-10, 10, 10")
52 assert_response :success, "can't get changesets in bbox"
53 assert_changesets_in_order [changeset3, changeset2]
55 get api_changesets_path(:bbox => "4.5,4.5,4.6,4.6")
56 assert_response :success, "can't get changesets in bbox"
57 assert_changesets_in_order [changeset3]
59 # not found when looking for changesets of non-existing users
60 get api_changesets_path(:user => User.maximum(:id) + 1)
61 assert_response :not_found
62 assert_equal "text/plain", @response.media_type
63 get api_changesets_path(:display_name => " ")
64 assert_response :not_found
65 assert_equal "text/plain", @response.media_type
67 # can't get changesets of user 1 without authenticating
68 get api_changesets_path(:user => private_user.id)
69 assert_response :not_found, "shouldn't be able to get changesets by non-public user (ID)"
70 get api_changesets_path(:display_name => private_user.display_name)
71 assert_response :not_found, "shouldn't be able to get changesets by non-public user (name)"
73 # but this should work
74 auth_header = bearer_authorization_header private_user
75 get api_changesets_path(:user => private_user.id), :headers => auth_header
76 assert_response :success, "can't get changesets by user ID"
77 assert_changesets_in_order [private_user_changeset, private_user_closed_changeset]
79 get api_changesets_path(:display_name => private_user.display_name), :headers => auth_header
80 assert_response :success, "can't get changesets by user name"
81 assert_changesets_in_order [private_user_changeset, private_user_closed_changeset]
84 get api_changesets_path(:display_name => private_user.display_name), :headers => auth_header, :params => { :format => "json" }
85 assert_response :success, "can't get changesets by user name"
87 js = ActiveSupport::JSON.decode(@response.body)
90 assert_equal Settings.api_version, js["version"]
91 assert_equal Settings.generator, js["generator"]
92 assert_equal 2, js["changesets"].count
94 # check that the correct error is given when we provide both UID and name
95 get api_changesets_path(:user => private_user.id,
96 :display_name => private_user.display_name), :headers => auth_header
97 assert_response :bad_request, "should be a bad request to have both ID and name specified"
99 get api_changesets_path(:user => private_user.id, :open => true), :headers => auth_header
100 assert_response :success, "can't get changesets by user and open"
101 assert_changesets_in_order [private_user_changeset]
103 get api_changesets_path(:time => "2007-12-31"), :headers => auth_header
104 assert_response :success, "can't get changesets by time-since"
105 assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset, private_user_closed_changeset, closed_changeset]
107 get api_changesets_path(:time => "2008-01-01T12:34Z"), :headers => auth_header
108 assert_response :success, "can't get changesets by time-since with hour"
109 assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset, private_user_closed_changeset, closed_changeset]
111 get api_changesets_path(:time => "2007-12-31T23:59Z,2008-01-02T00:01Z"), :headers => auth_header
112 assert_response :success, "can't get changesets by time-range"
113 assert_changesets_in_order [closed_changeset]
115 get api_changesets_path(:open => "true"), :headers => auth_header
116 assert_response :success, "can't get changesets by open-ness"
117 assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset]
119 get api_changesets_path(:closed => "true"), :headers => auth_header
120 assert_response :success, "can't get changesets by closed-ness"
121 assert_changesets_in_order [private_user_closed_changeset, closed_changeset]
123 get api_changesets_path(:closed => "true", :user => private_user.id), :headers => auth_header
124 assert_response :success, "can't get changesets by closed-ness and user"
125 assert_changesets_in_order [private_user_closed_changeset]
127 get api_changesets_path(:closed => "true", :user => user.id), :headers => auth_header
128 assert_response :success, "can't get changesets by closed-ness and user"
129 assert_changesets_in_order [closed_changeset]
131 get api_changesets_path(:changesets => "#{private_user_changeset.id},#{changeset.id},#{closed_changeset.id}"), :headers => auth_header
132 assert_response :success, "can't get changesets by id (as comma-separated string)"
133 assert_changesets_in_order [changeset, private_user_changeset, closed_changeset]
135 get api_changesets_path(:changesets => ""), :headers => auth_header
136 assert_response :bad_request, "should be a bad request since changesets is empty"
140 # test the query functionality of changesets with the limit parameter
143 changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
144 changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 2, 1, 0, 0, 0), :closed_at => Time.utc(2008, 2, 2, 0, 0, 0))
145 changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 3, 1, 0, 0, 0), :closed_at => Time.utc(2008, 3, 2, 0, 0, 0))
146 changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 4, 1, 0, 0, 0), :closed_at => Time.utc(2008, 4, 2, 0, 0, 0))
147 changeset5 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 5, 1, 0, 0, 0), :closed_at => Time.utc(2008, 5, 2, 0, 0, 0))
149 get api_changesets_path
150 assert_response :success
151 assert_changesets_in_order [changeset5, changeset4, changeset3, changeset2, changeset1]
153 get api_changesets_path(:limit => "3")
154 assert_response :success
155 assert_changesets_in_order [changeset5, changeset4, changeset3]
157 get api_changesets_path(:limit => "0")
158 assert_response :bad_request
160 get api_changesets_path(:limit => Settings.max_changeset_query_limit)
161 assert_response :success
162 assert_changesets_in_order [changeset5, changeset4, changeset3, changeset2, changeset1]
164 get api_changesets_path(:limit => Settings.max_changeset_query_limit + 1)
165 assert_response :bad_request
169 # test the query functionality of sequential changesets with order and time parameters
172 changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
173 changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 2, 1, 0, 0, 0), :closed_at => Time.utc(2008, 2, 2, 0, 0, 0))
174 changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 3, 1, 0, 0, 0), :closed_at => Time.utc(2008, 3, 2, 0, 0, 0))
175 changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 4, 1, 0, 0, 0), :closed_at => Time.utc(2008, 4, 2, 0, 0, 0))
176 changeset5 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 5, 1, 0, 0, 0), :closed_at => Time.utc(2008, 5, 2, 0, 0, 0))
177 changeset6 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 6, 1, 0, 0, 0), :closed_at => Time.utc(2008, 6, 2, 0, 0, 0))
179 get api_changesets_path
180 assert_response :success
181 assert_changesets_in_order [changeset6, changeset5, changeset4, changeset3, changeset2, changeset1]
183 get api_changesets_path(:order => "oldest")
184 assert_response :success
185 assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4, changeset5, changeset6]
188 # lower time bound at the opening time of a changeset
189 ["2008-02-01T00:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3, changeset2]],
190 # lower time bound in the middle of a changeset
191 ["2008-02-01T12:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3]],
192 # lower time bound at the closing time of a changeset
193 ["2008-02-02T00:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3]],
194 # lower time bound after the closing time of a changeset
195 ["2008-02-02T00:00:01Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3], [changeset5, changeset4, changeset3]],
196 # upper time bound in the middle of a changeset
197 ["2007-09-09T12:00:00Z", "2008-04-01T12:00:00Z", [changeset4, changeset3, changeset2, changeset1], [changeset4, changeset3, changeset2, changeset1]],
199 ["2009-02-02T00:00:01Z", "2018-05-15T00:00:00Z", [], []]
200 ].each do |from, to, interval_changesets, point_changesets|
201 get api_changesets_path(:time => "#{from},#{to}")
202 assert_response :success
203 assert_changesets_in_order interval_changesets
205 get api_changesets_path(:from => from, :to => to)
206 assert_response :success
207 assert_changesets_in_order point_changesets
209 get api_changesets_path(:from => from, :to => to, :order => "oldest")
210 assert_response :success
211 assert_changesets_in_order point_changesets.reverse
216 # test the query functionality of overlapping changesets with order and time parameters
217 def test_index_order_overlapping
219 changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 17, 0, 0), :closed_at => Time.utc(2015, 6, 4, 17, 0, 0))
220 changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 16, 0, 0), :closed_at => Time.utc(2015, 6, 4, 18, 0, 0))
221 changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 14, 0, 0), :closed_at => Time.utc(2015, 6, 4, 20, 0, 0))
222 changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 3, 23, 0, 0), :closed_at => Time.utc(2015, 6, 4, 23, 0, 0))
223 create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 2, 23, 0, 0), :closed_at => Time.utc(2015, 6, 3, 23, 0, 0))
225 get api_changesets_path(:time => "2015-06-04T00:00:00Z")
226 assert_response :success
227 assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4]
229 get api_changesets_path(:from => "2015-06-04T00:00:00Z")
230 assert_response :success
231 assert_changesets_in_order [changeset1, changeset2, changeset3]
233 get api_changesets_path(:from => "2015-06-04T00:00:00Z", :order => "oldest")
234 assert_response :success
235 assert_changesets_in_order [changeset3, changeset2, changeset1]
237 get api_changesets_path(:time => "2015-06-04T16:00:00Z,2015-06-04T17:30:00Z")
238 assert_response :success
239 assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4]
241 get api_changesets_path(:from => "2015-06-04T16:00:00Z", :to => "2015-06-04T17:30:00Z")
242 assert_response :success
243 assert_changesets_in_order [changeset1, changeset2]
245 get api_changesets_path(:from => "2015-06-04T16:00:00Z", :to => "2015-06-04T17:30:00Z", :order => "oldest")
246 assert_response :success
247 assert_changesets_in_order [changeset2, changeset1]
251 # check that errors are returned if garbage is inserted
253 def test_index_invalid
256 ";drop table users;"].each do |bbox|
257 get api_changesets_path(:bbox => bbox)
258 assert_response :bad_request, "'#{bbox}' isn't a bbox"
263 ";drop table users;",
265 "-,-"].each do |time|
266 get api_changesets_path(:time => time)
267 assert_response :bad_request, "'#{time}' isn't a valid time range"
274 get api_changesets_path(:user => uid)
275 assert_response :bad_request, "'#{uid}' isn't a valid user ID"
278 get api_changesets_path(:order => "oldest", :time => "2008-01-01T00:00Z,2018-01-01T00:00Z")
279 assert_response :bad_request, "cannot use order=oldest with time"
282 # -----------------------
283 # Test simple changeset creation
284 # -----------------------
287 auth_header = bearer_authorization_header create(:user, :data_public => false)
288 # Create the first user's changeset
289 xml = "<osm><changeset>" \
290 "<tag k='created_by' v='osm test suite checking changesets'/>" \
292 post api_changesets_path, :params => xml, :headers => auth_header
293 assert_require_public_data
295 auth_header = bearer_authorization_header
296 # Create the first user's changeset
297 xml = "<osm><changeset>" \
298 "<tag k='created_by' v='osm test suite checking changesets'/>" \
300 post api_changesets_path, :params => xml, :headers => auth_header
302 assert_response :success, "Creation of changeset did not return success status"
303 newid = @response.body.to_i
305 # check end time, should be an hour ahead of creation time
306 cs = Changeset.find(newid)
307 duration = cs.closed_at - cs.created_at
308 # the difference can either be a rational, or a floating point number
309 # of seconds, depending on the code path taken :-(
310 if duration.instance_of?(Rational)
311 assert_equal Rational(1, 24), duration, "initial idle timeout should be an hour (#{cs.created_at} -> #{cs.closed_at})"
313 # must be number of seconds...
314 assert_equal 3600, duration.round, "initial idle timeout should be an hour (#{cs.created_at} -> #{cs.closed_at})"
317 # checks if uploader was subscribed
318 assert_equal 1, cs.subscribers.length
321 def test_create_invalid
322 auth_header = bearer_authorization_header create(:user, :data_public => false)
323 xml = "<osm><changeset></osm>"
324 post api_changesets_path, :params => xml, :headers => auth_header
325 assert_require_public_data
327 ## Try the public user
328 auth_header = bearer_authorization_header
329 xml = "<osm><changeset></osm>"
330 post api_changesets_path, :params => xml, :headers => auth_header
331 assert_response :bad_request, "creating a invalid changeset should fail"
334 def test_create_invalid_no_content
335 ## First check with no auth
336 post api_changesets_path
337 assert_response :unauthorized, "shouldn't be able to create a changeset with no auth"
339 ## Now try to with a non-public user
340 auth_header = bearer_authorization_header create(:user, :data_public => false)
341 post api_changesets_path, :headers => auth_header
342 assert_require_public_data
344 ## Try an inactive user
345 auth_header = bearer_authorization_header create(:user, :pending)
346 post api_changesets_path, :headers => auth_header
349 ## Now try to use a normal user
350 auth_header = bearer_authorization_header
351 post api_changesets_path, :headers => auth_header
352 assert_response :bad_request, "creating a changeset with no content should fail"
355 def test_create_wrong_method
356 auth_header = bearer_authorization_header
358 put api_changesets_path, :headers => auth_header
359 assert_response :not_found
360 assert_template "rescues/routing_error"
363 def test_create_legacy_path
364 auth_header = bearer_authorization_header
365 xml = "<osm><changeset></changeset></osm>"
367 assert_difference "Changeset.count", 1 do
368 put "/api/0.6/changeset/create", :params => xml, :headers => auth_header
371 assert_response :success, "Creation of changeset did not return success status"
372 assert_equal Changeset.last.id, @response.body.to_i
376 # check that the changeset can be shown and returns the correct
377 # document structure.
379 changeset = create(:changeset)
381 get api_changeset_path(changeset)
382 assert_response :success, "cannot get first changeset"
384 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
385 assert_single_changeset changeset do
386 assert_dom "> discussion", 0
389 get api_changeset_path(changeset, :include_discussion => true)
390 assert_response :success, "cannot get first changeset with comments"
392 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
393 assert_single_changeset changeset do
394 assert_dom "> discussion", 1
395 assert_dom "> discussion > comment", 0
399 def test_show_comments
400 # all comments visible
401 changeset = create(:changeset, :closed)
402 comment1, comment2, comment3 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
404 get api_changeset_path(changeset, :include_discussion => true)
405 assert_response :success, "cannot get closed changeset with comments"
407 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1 do
408 assert_single_changeset changeset do
409 assert_dom "> discussion", 1 do
410 assert_dom "> comment", 3 do |dom_comments|
411 assert_dom dom_comments[0], "> @id", comment1.id.to_s
412 assert_dom dom_comments[0], "> @visible", "true"
413 assert_dom dom_comments[1], "> @id", comment2.id.to_s
414 assert_dom dom_comments[1], "> @visible", "true"
415 assert_dom dom_comments[2], "> @id", comment3.id.to_s
416 assert_dom dom_comments[2], "> @visible", "true"
422 # one hidden comment not included because not asked for
423 comment2.update(:visible => false)
426 get api_changeset_path(changeset, :include_discussion => true)
427 assert_response :success, "cannot get closed changeset with comments"
429 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
430 assert_single_changeset changeset do
431 assert_dom "> discussion", 1 do
432 assert_dom "> comment", 2 do |dom_comments|
433 assert_dom dom_comments[0], "> @id", comment1.id.to_s
434 assert_dom dom_comments[0], "> @visible", "true"
435 assert_dom dom_comments[1], "> @id", comment3.id.to_s
436 assert_dom dom_comments[1], "> @visible", "true"
441 # one hidden comment not included because no permissions
442 get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true)
443 assert_response :success, "cannot get closed changeset with comments"
445 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
446 assert_single_changeset changeset do
447 assert_dom "> discussion", 1 do
448 assert_dom "> comment", 2 do |dom_comments|
449 assert_dom dom_comments[0], "> @id", comment1.id.to_s
450 assert_dom dom_comments[0], "> @visible", "true"
451 # maybe will show an empty comment element with visible=false in the future
452 assert_dom dom_comments[1], "> @id", comment3.id.to_s
453 assert_dom dom_comments[1], "> @visible", "true"
458 # one hidden comment shown to moderators
459 moderator_user = create(:moderator_user)
460 auth_header = bearer_authorization_header moderator_user
461 get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
462 assert_response :success, "cannot get closed changeset with comments"
464 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
465 assert_single_changeset changeset do
466 assert_dom "> discussion", 1 do
467 assert_dom "> comment", 3 do |dom_comments|
468 assert_dom dom_comments[0], "> @id", comment1.id.to_s
469 assert_dom dom_comments[0], "> @visible", "true"
470 assert_dom dom_comments[1], "> @id", comment2.id.to_s
471 assert_dom dom_comments[1], "> @visible", "false"
472 assert_dom dom_comments[2], "> @id", comment3.id.to_s
473 assert_dom dom_comments[2], "> @visible", "true"
480 changeset = create(:changeset, :closed)
481 create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
482 create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
484 get api_changeset_path(changeset)
486 assert_response :success
487 assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
488 assert_single_changeset changeset do
489 assert_dom "> tag", 2
490 assert_dom "> tag[k='created_by'][v='JOSM/1.5 (18364)']", 1
491 assert_dom "> tag[k='comment'][v='changeset comment']", 1
496 changeset = create(:changeset)
498 get api_changeset_path(changeset, :format => "json")
499 assert_response :success, "cannot get first changeset"
501 js = ActiveSupport::JSON.decode(@response.body)
504 assert_equal Settings.api_version, js["version"]
505 assert_equal Settings.generator, js["generator"]
506 assert_single_changeset_json changeset, js
507 assert_nil js["changeset"]["tags"]
508 assert_nil js["changeset"]["comments"]
509 assert_equal changeset.user.id, js["changeset"]["uid"]
510 assert_equal changeset.user.display_name, js["changeset"]["user"]
512 get api_changeset_path(changeset, :format => "json", :include_discussion => true)
513 assert_response :success, "cannot get first changeset with comments"
515 js = ActiveSupport::JSON.decode(@response.body)
517 assert_equal Settings.api_version, js["version"]
518 assert_equal Settings.generator, js["generator"]
519 assert_single_changeset_json changeset, js
520 assert_nil js["changeset"]["tags"]
521 assert_nil js["changeset"]["min_lat"]
522 assert_nil js["changeset"]["min_lon"]
523 assert_nil js["changeset"]["max_lat"]
524 assert_nil js["changeset"]["max_lon"]
525 assert_equal 0, js["changeset"]["comments"].count
528 def test_show_comments_json
529 # all comments visible
530 changeset = create(:changeset, :closed)
531 comment0, comment1, comment2 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
533 get api_changeset_path(changeset, :format => "json", :include_discussion => true)
534 assert_response :success, "cannot get closed changeset with comments"
536 js = ActiveSupport::JSON.decode(@response.body)
538 assert_equal Settings.api_version, js["version"]
539 assert_equal Settings.generator, js["generator"]
540 assert_single_changeset_json changeset, js
541 assert_equal 3, js["changeset"]["comments"].count
542 assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
543 assert js["changeset"]["comments"][0]["visible"]
544 assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
545 assert js["changeset"]["comments"][1]["visible"]
546 assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
547 assert js["changeset"]["comments"][2]["visible"]
549 # one hidden comment not included because not asked for
550 comment1.update(:visible => false)
553 get api_changeset_path(changeset, :format => "json", :include_discussion => true)
554 assert_response :success, "cannot get closed changeset with comments"
556 js = ActiveSupport::JSON.decode(@response.body)
558 assert_equal Settings.api_version, js["version"]
559 assert_equal Settings.generator, js["generator"]
560 assert_single_changeset_json changeset, js
561 assert_equal 2, js["changeset"]["comments"].count
562 assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
563 assert js["changeset"]["comments"][0]["visible"]
564 assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
565 assert js["changeset"]["comments"][1]["visible"]
567 # one hidden comment not included because no permissions
568 get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true)
569 assert_response :success, "cannot get closed changeset with comments"
571 js = ActiveSupport::JSON.decode(@response.body)
573 assert_equal Settings.api_version, js["version"]
574 assert_equal Settings.generator, js["generator"]
575 assert_single_changeset_json changeset, js
576 assert_equal 2, js["changeset"]["comments"].count
577 assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
578 assert js["changeset"]["comments"][0]["visible"]
579 # maybe will show an empty comment element with visible=false in the future
580 assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
581 assert js["changeset"]["comments"][1]["visible"]
583 # one hidden comment shown to moderators
584 moderator_user = create(:moderator_user)
585 auth_header = bearer_authorization_header moderator_user
586 get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
587 assert_response :success, "cannot get closed changeset with comments"
589 js = ActiveSupport::JSON.decode(@response.body)
591 assert_equal Settings.api_version, js["version"]
592 assert_equal Settings.generator, js["generator"]
593 assert_single_changeset_json changeset, js
594 assert_equal 3, js["changeset"]["comments"].count
595 assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
596 assert js["changeset"]["comments"][0]["visible"]
597 assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
598 assert_not js["changeset"]["comments"][1]["visible"]
599 assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
600 assert js["changeset"]["comments"][2]["visible"]
603 def test_show_tags_json
604 changeset = create(:changeset, :closed)
605 create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
606 create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
608 get api_changeset_path(changeset, :format => "json")
610 assert_response :success
611 js = ActiveSupport::JSON.decode(@response.body)
613 assert_equal Settings.api_version, js["version"]
614 assert_equal Settings.generator, js["generator"]
615 assert_single_changeset_json changeset, js
616 assert_equal 2, js["changeset"]["tags"].count
617 assert_equal "JOSM/1.5 (18364)", js["changeset"]["tags"]["created_by"]
618 assert_equal "changeset comment", js["changeset"]["tags"]["comment"]
621 def test_show_bbox_json
622 changeset = create(:changeset, :bbox => [5, -5, 12, 15])
624 get api_changeset_path(changeset, :format => "json")
625 assert_response :success, "cannot get first changeset"
627 js = ActiveSupport::JSON.decode(@response.body)
629 assert_equal(-5, js["changeset"]["min_lat"])
630 assert_equal 5, js["changeset"]["min_lon"]
631 assert_equal 15, js["changeset"]["max_lat"]
632 assert_equal 12, js["changeset"]["max_lon"]
636 # check that a changeset that doesn't exist returns an appropriate message
637 def test_show_not_found
638 [0, -32, 233455644, "afg", "213"].each do |id|
639 get api_changeset_path(id)
640 assert_response :not_found, "should get a not found"
641 rescue ActionController::UrlGenerationError => e
642 assert_match(/No route matches/, e.to_s)
646 def test_repeated_changeset_create
648 auth_header = bearer_authorization_header
650 # create a temporary changeset
651 xml = "<osm><changeset>" \
652 "<tag k='created_by' v='osm test suite checking changesets'/>" \
654 assert_difference "Changeset.count", 1 do
655 post api_changesets_path, :params => xml, :headers => auth_header
657 assert_response :success
662 # when we make some simple changes we get the same changes back from the
664 def test_diff_download_simple
667 ## First try with a non-public user, which should get a forbidden
668 auth_header = bearer_authorization_header create(:user, :data_public => false)
670 # create a temporary changeset
671 xml = "<osm><changeset>" \
672 "<tag k='created_by' v='osm test suite checking changesets'/>" \
674 post api_changesets_path, :params => xml, :headers => auth_header
675 assert_response :forbidden
677 ## Now try with a normal user
678 auth_header = bearer_authorization_header
680 # create a temporary changeset
681 xml = "<osm><changeset>" \
682 "<tag k='created_by' v='osm test suite checking changesets'/>" \
684 post api_changesets_path, :params => xml, :headers => auth_header
685 assert_response :success
686 changeset_id = @response.body.to_i
692 <node id='#{node.id}' lon='0.0' lat='0.0' changeset='#{changeset_id}' version='1'/>
693 <node id='#{node.id}' lon='0.1' lat='0.0' changeset='#{changeset_id}' version='2'/>
694 <node id='#{node.id}' lon='0.1' lat='0.1' changeset='#{changeset_id}' version='3'/>
695 <node id='#{node.id}' lon='0.1' lat='0.2' changeset='#{changeset_id}' version='4'/>
696 <node id='#{node.id}' lon='0.2' lat='0.2' changeset='#{changeset_id}' version='5'/>
697 <node id='#{node.id}' lon='0.3' lat='0.2' changeset='#{changeset_id}' version='6'/>
698 <node id='#{node.id}' lon='0.3' lat='0.3' changeset='#{changeset_id}' version='7'/>
699 <node id='#{node.id}' lon='0.9' lat='0.9' changeset='#{changeset_id}' version='8'/>
705 post api_changeset_upload_path(changeset_id), :params => diff, :headers => auth_header
706 assert_response :success,
707 "can't upload multiple versions of an element in a diff: #{@response.body}"
709 get api_changeset_download_path(changeset_id)
710 assert_response :success
712 assert_select "osmChange", 1
713 assert_select "osmChange>modify", 8
714 assert_select "osmChange>modify>node", 8
718 # culled this from josm to ensure that nothing in the way that josm
719 # is formatting the request is causing it to fail.
721 # NOTE: the error turned out to be something else completely!
723 auth_header = bearer_authorization_header
725 # create a temporary changeset
726 xml = "<osm><changeset>" \
727 "<tag k='created_by' v='osm test suite checking changesets'/>" \
729 post api_changesets_path, :params => xml, :headers => auth_header
730 assert_response :success
731 changeset_id = @response.body.to_i
734 <osmChange version="0.6" generator="JOSM">
735 <create version="0.6" generator="JOSM">
736 <node id='-1' visible='true' changeset='#{changeset_id}' lat='51.49619982187321' lon='-0.18722061869438314' />
737 <node id='-2' visible='true' changeset='#{changeset_id}' lat='51.496359883909605' lon='-0.18653093576241928' />
738 <node id='-3' visible='true' changeset='#{changeset_id}' lat='51.49598132358285' lon='-0.18719613290981638' />
739 <node id='-4' visible='true' changeset='#{changeset_id}' lat='51.4961591711078' lon='-0.18629015888084607' />
740 <node id='-5' visible='true' changeset='#{changeset_id}' lat='51.49582126021711' lon='-0.18708186591517145' />
741 <node id='-6' visible='true' changeset='#{changeset_id}' lat='51.49591018437858' lon='-0.1861432441734455' />
742 <node id='-7' visible='true' changeset='#{changeset_id}' lat='51.49560784152179' lon='-0.18694719410005425' />
743 <node id='-8' visible='true' changeset='#{changeset_id}' lat='51.49567389979617' lon='-0.1860289771788006' />
744 <node id='-9' visible='true' changeset='#{changeset_id}' lat='51.49543761398892' lon='-0.186820684213126' />
745 <way id='-10' action='modify' visible='true' changeset='#{changeset_id}'>
755 <tag k='highway' v='residential' />
756 <tag k='name' v='Foobar Street' />
763 post api_changeset_upload_path(changeset_id), :params => diff, :headers => auth_header
764 assert_response :success,
765 "can't upload a diff from JOSM: #{@response.body}"
767 get api_changeset_download_path(changeset_id)
768 assert_response :success
770 assert_select "osmChange", 1
771 assert_select "osmChange>create>node", 9
772 assert_select "osmChange>create>way", 1
773 assert_select "osmChange>create>way>nd", 9
774 assert_select "osmChange>create>way>tag", 2
778 # when we make some complex changes we get the same changes back from the
780 def test_diff_download_complex
782 node2 = create(:node)
784 auth_header = bearer_authorization_header
786 # create a temporary changeset
787 xml = "<osm><changeset>" \
788 "<tag k='created_by' v='osm test suite checking changesets'/>" \
790 post api_changesets_path, :params => xml, :headers => auth_header
791 assert_response :success
792 changeset_id = @response.body.to_i
798 <node id='#{node.id}' lon='0.0' lat='0.0' changeset='#{changeset_id}' version='1'/>
801 <node id='-1' lon='0.9' lat='0.9' changeset='#{changeset_id}' version='0'/>
802 <node id='-2' lon='0.8' lat='0.9' changeset='#{changeset_id}' version='0'/>
803 <node id='-3' lon='0.7' lat='0.9' changeset='#{changeset_id}' version='0'/>
806 <node id='#{node2.id}' lon='2.0' lat='1.5' changeset='#{changeset_id}' version='1'/>
807 <way id='#{way.id}' changeset='#{changeset_id}' version='1'>
808 <nd ref='#{node2.id}'/>
818 post api_changeset_upload_path(changeset_id), :params => diff, :headers => auth_header
819 assert_response :success,
820 "can't upload multiple versions of an element in a diff: #{@response.body}"
822 get api_changeset_download_path(changeset_id)
823 assert_response :success
825 assert_select "osmChange", 1
826 assert_select "osmChange>create", 3
827 assert_select "osmChange>delete", 1
828 assert_select "osmChange>modify", 2
829 assert_select "osmChange>create>node", 3
830 assert_select "osmChange>delete>node", 1
831 assert_select "osmChange>modify>node", 1
832 assert_select "osmChange>modify>way", 1
836 # check that the bounding box of a changeset gets updated correctly
837 # FIXME: This should really be moded to a integration test due to the with_controller
838 def test_changeset_bbox
840 create(:way_node, :way => way, :node => create(:node, :lat => 0.3, :lon => 0.3))
842 auth_header = bearer_authorization_header
844 # create a new changeset
845 xml = "<osm><changeset/></osm>"
846 post api_changesets_path, :params => xml, :headers => auth_header
847 assert_response :success, "Creating of changeset failed."
848 changeset_id = @response.body.to_i
850 # add a single node to it
851 with_controller(NodesController.new) do
852 xml = "<osm><node lon='0.1' lat='0.2' changeset='#{changeset_id}'/></osm>"
853 post api_nodes_path, :params => xml, :headers => auth_header
854 assert_response :success, "Couldn't create node."
857 # get the bounding box back from the changeset
858 get api_changeset_path(changeset_id)
859 assert_response :success, "Couldn't read back changeset."
860 assert_select "osm>changeset[min_lon='0.1000000']", 1
861 assert_select "osm>changeset[max_lon='0.1000000']", 1
862 assert_select "osm>changeset[min_lat='0.2000000']", 1
863 assert_select "osm>changeset[max_lat='0.2000000']", 1
865 # add another node to it
866 with_controller(NodesController.new) do
867 xml = "<osm><node lon='0.2' lat='0.1' changeset='#{changeset_id}'/></osm>"
868 post api_nodes_path, :params => xml, :headers => auth_header
869 assert_response :success, "Couldn't create second node."
872 # get the bounding box back from the changeset
873 get api_changeset_path(changeset_id)
874 assert_response :success, "Couldn't read back changeset for the second time."
875 assert_select "osm>changeset[min_lon='0.1000000']", 1
876 assert_select "osm>changeset[max_lon='0.2000000']", 1
877 assert_select "osm>changeset[min_lat='0.1000000']", 1
878 assert_select "osm>changeset[max_lat='0.2000000']", 1
880 # add (delete) a way to it, which contains a point at (3,3)
881 with_controller(WaysController.new) do
882 xml = update_changeset(xml_for_way(way), changeset_id)
883 delete api_way_path(way), :params => xml.to_s, :headers => auth_header
884 assert_response :success, "Couldn't delete a way."
887 # get the bounding box back from the changeset
888 get api_changeset_path(changeset_id)
889 assert_response :success, "Couldn't read back changeset for the third time."
890 assert_select "osm>changeset[min_lon='0.1000000']", 1
891 assert_select "osm>changeset[max_lon='0.3000000']", 1
892 assert_select "osm>changeset[min_lat='0.1000000']", 1
893 assert_select "osm>changeset[max_lat='0.3000000']", 1
897 # check updating tags on a changeset
898 def test_changeset_update
899 private_user = create(:user, :data_public => false)
900 private_changeset = create(:changeset, :user => private_user)
902 changeset = create(:changeset, :user => user)
904 ## First try with a non-public user
905 new_changeset = create_changeset_xml(:user => private_user)
906 new_tag = XML::Node.new "tag"
907 new_tag["k"] = "tagtesting"
908 new_tag["v"] = "valuetesting"
909 new_changeset.find("//osm/changeset").first << new_tag
911 # try without any authorization
912 put api_changeset_path(private_changeset), :params => new_changeset.to_s
913 assert_response :unauthorized
915 # try with the wrong authorization
916 auth_header = bearer_authorization_header
917 put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
918 assert_response :conflict
920 # now this should get an unauthorized
921 auth_header = bearer_authorization_header private_user
922 put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
923 assert_require_public_data "user with their data non-public, shouldn't be able to edit their changeset"
925 ## Now try with the public user
926 new_changeset = create_changeset_xml(:id => 1)
927 new_tag = XML::Node.new "tag"
928 new_tag["k"] = "tagtesting"
929 new_tag["v"] = "valuetesting"
930 new_changeset.find("//osm/changeset").first << new_tag
932 # try without any authorization
933 put api_changeset_path(changeset), :params => new_changeset.to_s
934 assert_response :unauthorized
936 # try with the wrong authorization
937 auth_header = bearer_authorization_header
938 put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
939 assert_response :conflict
941 # now this should work...
942 auth_header = bearer_authorization_header user
943 put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
944 assert_response :success
946 assert_select "osm>changeset[id='#{changeset.id}']", 1
947 assert_select "osm>changeset>tag", 1
948 assert_select "osm>changeset>tag[k='tagtesting'][v='valuetesting']", 1
952 # check that a user different from the one who opened the changeset
954 def test_changeset_update_invalid
955 auth_header = bearer_authorization_header
957 changeset = create(:changeset)
958 new_changeset = create_changeset_xml(:user => changeset.user, :id => changeset.id)
959 new_tag = XML::Node.new "tag"
960 new_tag["k"] = "testing"
961 new_tag["v"] = "testing"
962 new_changeset.find("//osm/changeset").first << new_tag
964 put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
965 assert_response :conflict
969 # check that a changeset can contain a certain max number of changes.
970 ## FIXME should be changed to an integration test due to the with_controller
971 def test_changeset_limits
973 auth_header = bearer_authorization_header user
975 # create an old changeset to ensure we have the maximum rate limit
976 create(:changeset, :user => user, :created_at => Time.now.utc - 28.days)
978 # open a new changeset
979 xml = "<osm><changeset/></osm>"
980 post api_changesets_path, :params => xml, :headers => auth_header
981 assert_response :success, "can't create a new changeset"
982 cs_id = @response.body.to_i
984 # start the counter just short of where the changeset should finish.
986 # alter the database to set the counter on the changeset directly,
987 # otherwise it takes about 6 minutes to fill all of them.
988 changeset = Changeset.find(cs_id)
989 changeset.num_changes = Changeset::MAX_ELEMENTS - offset
992 with_controller(NodesController.new) do
994 xml = "<osm><node changeset='#{cs_id}' lat='0.0' lon='0.0'/></osm>"
995 post api_nodes_path, :params => xml, :headers => auth_header
996 assert_response :success, "can't create a new node"
997 node_id = @response.body.to_i
999 get api_node_path(node_id)
1000 assert_response :success, "can't read back new node"
1001 node_doc = XML::Parser.string(@response.body).parse
1002 node_xml = node_doc.find("//osm/node").first
1004 # loop until we fill the changeset with nodes
1006 node_xml["lat"] = rand.to_s
1007 node_xml["lon"] = rand.to_s
1008 node_xml["version"] = (i + 1).to_s
1010 put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
1011 assert_response :success, "attempt #{i} should have succeeded"
1014 # trying again should fail
1015 node_xml["lat"] = rand.to_s
1016 node_xml["lon"] = rand.to_s
1017 node_xml["version"] = offset.to_s
1019 put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
1020 assert_response :conflict, "final attempt should have failed"
1023 changeset = Changeset.find(cs_id)
1024 assert_equal Changeset::MAX_ELEMENTS + 1, changeset.num_changes
1026 # check that the changeset is now closed as well
1027 assert_not(changeset.open?,
1028 "changeset should have been auto-closed by exceeding " \
1035 # check that the output consists of one specific changeset
1036 def assert_single_changeset(changeset, &)
1037 assert_dom "> changeset", 1 do
1038 assert_dom "> @id", changeset.id.to_s
1039 assert_dom "> @created_at", changeset.created_at.xmlschema
1041 assert_dom "> @open", "true"
1042 assert_dom "> @closed_at", 0
1044 assert_dom "> @open", "false"
1045 assert_dom "> @closed_at", changeset.closed_at.xmlschema
1047 assert_dom "> @comments_count", changeset.comments.length.to_s
1048 assert_dom "> @changes_count", changeset.num_changes.to_s
1049 yield if block_given?
1053 def assert_single_changeset_json(changeset, js)
1054 assert_equal changeset.id, js["changeset"]["id"]
1055 assert_equal changeset.created_at.xmlschema, js["changeset"]["created_at"]
1057 assert js["changeset"]["open"]
1058 assert_nil js["changeset"]["closed_at"]
1060 assert_not js["changeset"]["open"]
1061 assert_equal changeset.closed_at.xmlschema, js["changeset"]["closed_at"]
1063 assert_equal changeset.comments.length, js["changeset"]["comments_count"]
1064 assert_equal changeset.num_changes, js["changeset"]["changes_count"]
1068 # check that certain changesets exist in the output in the specified order
1069 def assert_changesets_in_order(changesets)
1070 assert_select "osm>changeset", changesets.size
1071 changesets.each_with_index do |changeset, index|
1072 assert_select "osm>changeset:nth-child(#{index + 1})[id='#{changeset.id}']", 1
1077 # update the changeset_id of a way element
1078 def update_changeset(xml, changeset_id)
1079 xml_attr_rewrite(xml, "changeset", changeset_id)
1083 # update an attribute in a way element
1084 def xml_attr_rewrite(xml, name, value)
1085 xml.find("//osm/way").first[name] = value.to_s
1090 # build XML for changesets
1091 def create_changeset_xml(user: nil, id: nil)
1092 root = XML::Document.new
1093 root.root = XML::Node.new "osm"
1094 cs = XML::Node.new "changeset"
1096 cs["user"] = user.display_name
1097 cs["uid"] = user.id.to_s
1099 cs["id"] = id.to_s if id