2 require_relative "elements_test_helper"
5 class RelationsControllerTest < ActionDispatch::IntegrationTest
6 include ElementsTestHelper
9 # test all routes which lead to this controller
12 { :path => "/api/0.6/relations", :method => :get },
13 { :controller => "api/relations", :action => "index" }
16 { :path => "/api/0.6/relations.json", :method => :get },
17 { :controller => "api/relations", :action => "index", :format => "json" }
20 { :path => "/api/0.6/relations", :method => :post },
21 { :controller => "api/relations", :action => "create" }
24 { :path => "/api/0.6/relation/1", :method => :get },
25 { :controller => "api/relations", :action => "show", :id => "1" }
28 { :path => "/api/0.6/relation/1.json", :method => :get },
29 { :controller => "api/relations", :action => "show", :id => "1", :format => "json" }
32 { :path => "/api/0.6/relation/1/full", :method => :get },
33 { :controller => "api/relations", :action => "show", :full => true, :id => "1" }
36 { :path => "/api/0.6/relation/1/full.json", :method => :get },
37 { :controller => "api/relations", :action => "show", :full => true, :id => "1", :format => "json" }
40 { :path => "/api/0.6/relation/1", :method => :put },
41 { :controller => "api/relations", :action => "update", :id => "1" }
44 { :path => "/api/0.6/relation/1", :method => :delete },
45 { :controller => "api/relations", :action => "destroy", :id => "1" }
49 { :controller => "api/relations", :action => "create" },
50 { :path => "/api/0.6/relation/create", :method => :put }
55 # test fetching multiple relations
57 relation1 = create(:relation)
58 relation2 = create(:relation, :deleted)
59 relation3 = create(:relation, :with_history, :version => 2)
60 relation4 = create(:relation, :with_history, :version => 2)
61 relation4.old_relations.find_by(:version => 1).redact!(create(:redaction))
63 # check error when no parameter provided
64 get api_relations_path
65 assert_response :bad_request
67 # check error when no parameter value provided
68 get api_relations_path(:relations => "")
69 assert_response :bad_request
72 get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}")
73 assert_response :success
74 assert_select "osm" do
75 assert_select "relation", :count => 4
76 assert_select "relation[id='#{relation1.id}'][visible='true']", :count => 1
77 assert_select "relation[id='#{relation2.id}'][visible='false']", :count => 1
78 assert_select "relation[id='#{relation3.id}'][visible='true']", :count => 1
79 assert_select "relation[id='#{relation4.id}'][visible='true']", :count => 1
82 # test a working call with json format
83 get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}", :format => "json")
85 js = ActiveSupport::JSON.decode(@response.body)
87 assert_equal 4, js["elements"].count
88 assert_equal 4, (js["elements"].count { |a| a["type"] == "relation" })
89 assert_equal 1, (js["elements"].count { |a| a["id"] == relation1.id && a["visible"].nil? })
90 assert_equal 1, (js["elements"].count { |a| a["id"] == relation2.id && a["visible"] == false })
91 assert_equal 1, (js["elements"].count { |a| a["id"] == relation3.id && a["visible"].nil? })
92 assert_equal 1, (js["elements"].count { |a| a["id"] == relation4.id && a["visible"].nil? })
94 # check error when a non-existent relation is included
95 get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id},0")
96 assert_response :not_found
99 # -------------------------------------
100 # Test showing relations.
101 # -------------------------------------
103 def test_show_not_found
104 get api_relation_path(0)
105 assert_response :not_found
108 def test_show_deleted
109 get api_relation_path(create(:relation, :deleted))
110 assert_response :gone
114 relation = create(:relation, :timestamp => "2021-02-03T00:00:00Z")
115 node = create(:node, :timestamp => "2021-04-05T00:00:00Z")
116 create(:relation_member, :relation => relation, :member => node)
118 get api_relation_path(relation)
120 assert_response :success
121 assert_not_nil @response.header["Last-Modified"]
122 assert_equal "2021-02-03T00:00:00Z", Time.parse(@response.header["Last-Modified"]).utc.xmlschema
123 assert_dom "node", :count => 0
124 assert_dom "relation", :count => 1 do
125 assert_dom "> @id", :text => relation.id.to_s
129 def test_full_not_found
130 get api_relation_path(999999, :full => true)
131 assert_response :not_found
134 def test_full_deleted
135 get api_relation_path(create(:relation, :deleted), :full => true)
136 assert_response :gone
140 relation = create(:relation)
142 get api_relation_path(relation, :full => true)
144 assert_response :success
145 assert_dom "relation", :count => 1 do
146 assert_dom "> @id", :text => relation.id.to_s
150 def test_full_with_node_member
151 relation = create(:relation)
153 create(:relation_member, :relation => relation, :member => node)
155 get api_relation_path(relation, :full => true)
157 assert_response :success
158 assert_dom "node", :count => 1 do
159 assert_dom "> @id", :text => node.id.to_s
161 assert_dom "relation", :count => 1 do
162 assert_dom "> @id", :text => relation.id.to_s
166 def test_full_with_way_member
167 relation = create(:relation)
168 way = create(:way_with_nodes)
169 create(:relation_member, :relation => relation, :member => way)
171 get api_relation_path(relation, :full => true)
173 assert_response :success
174 assert_dom "node", :count => 1 do
175 assert_dom "> @id", :text => way.nodes[0].id.to_s
177 assert_dom "way", :count => 1 do
178 assert_dom "> @id", :text => way.id.to_s
180 assert_dom "relation", :count => 1 do
181 assert_dom "> @id", :text => relation.id.to_s
185 def test_full_with_node_member_json
186 relation = create(:relation)
188 create(:relation_member, :relation => relation, :member => node)
190 get api_relation_path(relation, :full => true, :format => "json")
192 assert_response :success
193 js = ActiveSupport::JSON.decode(@response.body)
195 assert_equal 2, js["elements"].count
197 js_relations = js["elements"].filter { |e| e["type"] == "relation" }
198 assert_equal 1, js_relations.count
199 assert_equal relation.id, js_relations[0]["id"]
200 assert_equal 1, js_relations[0]["members"].count
201 assert_equal "node", js_relations[0]["members"][0]["type"]
202 assert_equal node.id, js_relations[0]["members"][0]["ref"]
204 js_nodes = js["elements"].filter { |e| e["type"] == "node" }
205 assert_equal 1, js_nodes.count
206 assert_equal node.id, js_nodes[0]["id"]
209 # -------------------------------------
210 # Test creating relations.
211 # -------------------------------------
213 def test_create_without_members_by_private_user
214 with_unchanging_request([:data_public => false]) do |headers, changeset|
217 <relation changeset='#{changeset.id}'>
218 <tag k='test' v='yes' />
223 post api_relations_path, :params => osm, :headers => headers
225 assert_response :forbidden, "relation upload should have failed with forbidden"
229 def test_create_with_node_member_with_role_by_private_user
232 with_unchanging_request([:data_public => false]) do |headers, changeset|
235 <relation changeset='#{changeset.id}'>
236 <member ref='#{node.id}' type='node' role='some'/>
237 <tag k='test' v='yes' />
242 post api_relations_path, :params => osm, :headers => headers
244 assert_response :forbidden, "relation upload did not return forbidden status"
248 def test_create_with_node_member_without_role_by_private_user
251 with_unchanging_request([:data_public => false]) do |headers, changeset|
254 <relation changeset='#{changeset.id}'>
255 <member ref='#{node.id}' type='node'/>
256 <tag k='test' v='yes' />
261 post api_relations_path, :params => osm, :headers => headers
263 assert_response :forbidden, "relation upload did not return forbidden status"
267 def test_create_with_node_and_way_members_by_private_user
269 way = create(:way_with_nodes, :nodes_count => 2)
271 with_unchanging_request([:data_public => false]) do |headers, changeset|
274 <relation changeset='#{changeset.id}'>
275 <member type='node' ref='#{node.id}' role='some'/>
276 <member type='way' ref='#{way.id}' role='other'/>
277 <tag k='test' v='yes' />
282 post api_relations_path, :params => osm, :headers => headers
284 assert_response :forbidden, "relation upload did not return success status"
288 def test_create_without_members
289 with_request do |headers, changeset|
290 assert_difference "Relation.count" => 1,
291 "RelationMember.count" => 0 do
294 <relation changeset='#{changeset.id}'>
295 <tag k='test' v='yes' />
300 post api_relations_path, :params => osm, :headers => headers
302 assert_response :success, "relation upload did not return success status"
305 created_relation_id = @response.body
306 relation = Relation.find(created_relation_id)
307 assert_empty relation.members
308 assert_equal({ "test" => "yes" }, relation.tags)
309 assert_equal changeset.id, relation.changeset_id, "saved relation does not belong in the changeset it was assigned to"
310 assert relation.visible, "saved relation is not visible"
314 def test_create_with_node_member_with_role
317 with_request do |headers, changeset|
318 assert_difference "Relation.count" => 1,
319 "RelationMember.count" => 1 do
322 <relation changeset='#{changeset.id}'>
323 <member ref='#{node.id}' type='node' role='some'/>
324 <tag k='test' v='yes' />
329 post api_relations_path, :params => osm, :headers => headers
331 assert_response :success, "relation upload did not return success status"
334 created_relation_id = @response.body
335 relation = Relation.find(created_relation_id)
336 assert_equal [["Node", node.id, "some"]], relation.members
337 assert_equal({ "test" => "yes" }, relation.tags)
338 assert_equal changeset.id, relation.changeset_id, "saved relation does not belong in the changeset it was assigned to"
339 assert relation.visible, "saved relation is not visible"
343 def test_create_with_node_member_without_role
346 with_request do |headers, changeset|
347 assert_difference "Relation.count" => 1,
348 "RelationMember.count" => 1 do
351 <relation changeset='#{changeset.id}'>
352 <member ref='#{node.id}' type='node'/>
353 <tag k='test' v='yes' />
358 post api_relations_path, :params => osm, :headers => headers
360 assert_response :success, "relation upload did not return success status"
363 created_relation_id = @response.body
364 relation = Relation.find(created_relation_id)
365 assert_equal [["Node", node.id, ""]], relation.members
366 assert_equal({ "test" => "yes" }, relation.tags)
367 assert_equal changeset.id, relation.changeset_id, "saved relation does not belong in the changeset it was assigned to"
368 assert relation.visible, "saved relation is not visible"
372 def test_create_with_node_and_way_members
374 way = create(:way_with_nodes, :nodes_count => 2)
376 with_request do |headers, changeset|
377 assert_difference "Relation.count" => 1,
378 "RelationMember.count" => 2 do
381 <relation changeset='#{changeset.id}'>
382 <member type='node' ref='#{node.id}' role='some'/>
383 <member type='way' ref='#{way.id}' role='other'/>
384 <tag k='test' v='yes' />
389 post api_relations_path, :params => osm, :headers => headers
391 assert_response :success, "relation upload did not return success status"
394 created_relation_id = @response.body
395 relation = Relation.find(created_relation_id)
396 assert_equal [["Node", node.id, "some"],
397 ["Way", way.id, "other"]], relation.members
398 assert_equal({ "test" => "yes" }, relation.tags)
399 assert_equal changeset.id, relation.changeset_id, "saved relation does not belong in the changeset it was assigned to"
400 assert relation.visible, "saved relation is not visible"
404 def test_create_with_missing_node_member
405 with_unchanging_request do |headers, changeset|
408 <relation changeset='#{changeset.id}'>
409 <member type='node' ref='0'/>
414 post api_relations_path, :params => osm, :headers => headers
416 assert_response :precondition_failed, "relation upload with invalid node did not return 'precondition failed'"
417 assert_equal "Precondition failed: Relation with id cannot be saved due to Node with id 0", @response.body
421 def test_create_and_show
423 changeset = create(:changeset, :user => user)
427 <relation changeset='#{changeset.id}'/>
431 post api_relations_path, :params => osm, :headers => bearer_authorization_header(user)
433 assert_response :success, "relation upload did not return success status"
435 created_relation_id = @response.body
437 get api_relation_path(created_relation_id)
439 assert_response :success
442 # ------------------------------------
443 # Test updating relations
444 # ------------------------------------
446 def test_update_wrong_id
448 changeset = create(:changeset, :user => user)
449 relation = create(:relation)
450 other_relation = create(:relation)
452 auth_header = bearer_authorization_header user
453 get api_relation_path(relation)
454 assert_response :success
455 rel = XML::Parser.string(@response.body).parse
457 update_changeset(rel, changeset.id)
458 put api_relation_path(other_relation), :params => rel.to_s, :headers => auth_header
459 assert_response :bad_request
462 # -------------------------------------
463 # Test creating a relation, with some invalid XML
464 # -------------------------------------
465 def test_create_invalid_xml
467 changeset = create(:changeset, :user => user)
470 auth_header = bearer_authorization_header user
472 # create some xml that should return an error
475 <relation changeset='#{changeset.id}'>
476 <member type='type' ref='#{node.id}' role=''/>
480 post api_relations_path, :params => xml, :headers => auth_header
482 assert_response :bad_request
483 assert_match(/Cannot parse valid relation from xml string/, @response.body)
484 assert_match(/The type is not allowed only, /, @response.body)
487 # -------------------------------------
488 # Test deleting relations.
489 # -------------------------------------
492 private_user = create(:user, :data_public => false)
493 private_user_closed_changeset = create(:changeset, :closed, :user => private_user)
495 closed_changeset = create(:changeset, :closed, :user => user)
496 changeset = create(:changeset, :user => user)
497 relation = create(:relation)
498 used_relation = create(:relation)
499 super_relation = create(:relation_member, :member => used_relation).relation
500 deleted_relation = create(:relation, :deleted)
501 multi_tag_relation = create(:relation)
502 create_list(:relation_tag, 4, :relation => multi_tag_relation)
504 ## First try to delete relation without auth
505 delete api_relation_path(relation)
506 assert_response :unauthorized
508 ## Then try with the private user, to make sure that you get a forbidden
509 auth_header = bearer_authorization_header private_user
511 # this shouldn't work, as we should need the payload...
512 delete api_relation_path(relation), :headers => auth_header
513 assert_response :forbidden
515 # try to delete without specifying a changeset
516 xml = "<osm><relation id='#{relation.id}'/></osm>"
517 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
518 assert_response :forbidden
520 # try to delete with an invalid (closed) changeset
521 xml = update_changeset(xml_for_relation(relation),
522 private_user_closed_changeset.id)
523 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
524 assert_response :forbidden
526 # try to delete with an invalid (non-existent) changeset
527 xml = update_changeset(xml_for_relation(relation), 0)
528 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
529 assert_response :forbidden
531 # this won't work because the relation is in-use by another relation
532 xml = xml_for_relation(used_relation)
533 delete api_relation_path(used_relation), :params => xml.to_s, :headers => auth_header
534 assert_response :forbidden
536 # this should work when we provide the appropriate payload...
537 xml = xml_for_relation(relation)
538 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
539 assert_response :forbidden
541 # this won't work since the relation is already deleted
542 xml = xml_for_relation(deleted_relation)
543 delete api_relation_path(deleted_relation), :params => xml.to_s, :headers => auth_header
544 assert_response :forbidden
546 # this won't work since the relation never existed
547 delete api_relation_path(0), :headers => auth_header
548 assert_response :forbidden
550 ## now set auth for the public user
551 auth_header = bearer_authorization_header user
553 # this shouldn't work, as we should need the payload...
554 delete api_relation_path(relation), :headers => auth_header
555 assert_response :bad_request
557 # try to delete without specifying a changeset
558 xml = "<osm><relation id='#{relation.id}' version='#{relation.version}' /></osm>"
559 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
560 assert_response :bad_request
561 assert_match(/Changeset id is missing/, @response.body)
563 # try to delete with an invalid (closed) changeset
564 xml = update_changeset(xml_for_relation(relation),
566 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
567 assert_response :conflict
569 # try to delete with an invalid (non-existent) changeset
570 xml = update_changeset(xml_for_relation(relation), 0)
571 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
572 assert_response :conflict
574 # this won't work because the relation is in a changeset owned by someone else
575 xml = update_changeset(xml_for_relation(relation), create(:changeset).id)
576 delete api_relation_path(relation), :params => xml.to_s, :headers => auth_header
577 assert_response :conflict,
578 "shouldn't be able to delete a relation in a changeset owned by someone else (#{@response.body})"
580 # this won't work because the relation in the payload is different to that passed
581 xml = update_changeset(xml_for_relation(relation), changeset.id)
582 delete api_relation_path(create(:relation)), :params => xml.to_s, :headers => auth_header
583 assert_response :bad_request, "shouldn't be able to delete a relation when payload is different to the url"
585 # this won't work because the relation is in-use by another relation
586 xml = update_changeset(xml_for_relation(used_relation), changeset.id)
587 delete api_relation_path(used_relation), :params => xml.to_s, :headers => auth_header
588 assert_response :precondition_failed,
589 "shouldn't be able to delete a relation used in a relation (#{@response.body})"
590 assert_equal "Precondition failed: The relation #{used_relation.id} is used in relation #{super_relation.id}.", @response.body
592 # this should work when we provide the appropriate payload...
593 xml = update_changeset(xml_for_relation(multi_tag_relation), changeset.id)
594 delete api_relation_path(multi_tag_relation), :params => xml.to_s, :headers => auth_header
595 assert_response :success
597 # valid delete should return the new version number, which should
598 # be greater than the old version number
599 assert_operator @response.body.to_i, :>, multi_tag_relation.version, "delete request should return a new version number for relation"
601 # this won't work since the relation is already deleted
602 xml = update_changeset(xml_for_relation(deleted_relation), changeset.id)
603 delete api_relation_path(deleted_relation), :params => xml.to_s, :headers => auth_header
604 assert_response :gone
606 # Public visible relation needs to be deleted
607 xml = update_changeset(xml_for_relation(super_relation), changeset.id)
608 delete api_relation_path(super_relation), :params => xml.to_s, :headers => auth_header
609 assert_response :success
611 # this works now because the relation which was using this one
613 xml = update_changeset(xml_for_relation(used_relation), changeset.id)
614 delete api_relation_path(used_relation), :params => xml.to_s, :headers => auth_header
615 assert_response :success,
616 "should be able to delete a relation used in an old relation (#{@response.body})"
618 # this won't work since the relation never existed
619 delete api_relation_path(0), :headers => auth_header
620 assert_response :not_found
624 # test initial rate limit
625 def test_initial_rate_limit
630 node1 = create(:node)
631 node2 = create(:node)
633 # create a changeset that puts us near the initial rate limit
634 changeset = create(:changeset, :user => user,
635 :created_at => Time.now.utc - 5.minutes,
636 :num_changes => Settings.initial_changes_per_hour - 1)
638 # create authentication header
639 auth_header = bearer_authorization_header user
641 # try creating a relation
644 <relation changeset='#{changeset.id}'>
645 <member ref='#{node1.id}' type='node' role='some'/>
646 <member ref='#{node2.id}' type='node' role='some'/>
650 post api_relations_path, :params => xml, :headers => auth_header
651 assert_response :success, "relation create did not return success status"
653 # get the id of the relation we created
654 relationid = @response.body
656 # try updating the relation, which should be rate limited
659 <relation id='#{relationid}' version='1' changeset='#{changeset.id}'>
660 <member ref='#{node2.id}' type='node' role='some'/>
661 <member ref='#{node1.id}' type='node' role='some'/>
665 put api_relation_path(relationid), :params => xml, :headers => auth_header
666 assert_response :too_many_requests, "relation update did not hit rate limit"
668 # try deleting the relation, which should be rate limited
669 xml = "<osm><relation id='#{relationid}' version='2' changeset='#{changeset.id}'/></osm>"
670 delete api_relation_path(relationid), :params => xml, :headers => auth_header
671 assert_response :too_many_requests, "relation delete did not hit rate limit"
673 # try creating a relation, which should be rate limited
676 <relation changeset='#{changeset.id}'>
677 <member ref='#{node1.id}' type='node' role='some'/>
678 <member ref='#{node2.id}' type='node' role='some'/>
682 post api_relations_path, :params => xml, :headers => auth_header
683 assert_response :too_many_requests, "relation create did not hit rate limit"
687 # test maximum rate limit
688 def test_maximum_rate_limit
693 node1 = create(:node)
694 node2 = create(:node)
696 # create a changeset to establish our initial edit time
697 changeset = create(:changeset, :user => user,
698 :created_at => Time.now.utc - 28.days)
700 # create changeset to put us near the maximum rate limit
701 total_changes = Settings.max_changes_per_hour - 1
702 while total_changes.positive?
703 changes = [total_changes, Changeset::MAX_ELEMENTS].min
704 changeset = create(:changeset, :user => user,
705 :created_at => Time.now.utc - 5.minutes,
706 :num_changes => changes)
707 total_changes -= changes
710 # create authentication header
711 auth_header = bearer_authorization_header user
713 # try creating a relation
716 <relation changeset='#{changeset.id}'>
717 <member ref='#{node1.id}' type='node' role='some'/>
718 <member ref='#{node2.id}' type='node' role='some'/>
722 post api_relations_path, :params => xml, :headers => auth_header
723 assert_response :success, "relation create did not return success status"
725 # get the id of the relation we created
726 relationid = @response.body
728 # try updating the relation, which should be rate limited
731 <relation id='#{relationid}' version='1' changeset='#{changeset.id}'>
732 <member ref='#{node2.id}' type='node' role='some'/>
733 <member ref='#{node1.id}' type='node' role='some'/>
737 put api_relation_path(relationid), :params => xml, :headers => auth_header
738 assert_response :too_many_requests, "relation update did not hit rate limit"
740 # try deleting the relation, which should be rate limited
741 xml = "<osm><relation id='#{relationid}' version='2' changeset='#{changeset.id}'/></osm>"
742 delete api_relation_path(relationid), :params => xml, :headers => auth_header
743 assert_response :too_many_requests, "relation delete did not hit rate limit"
745 # try creating a relation, which should be rate limited
748 <relation changeset='#{changeset.id}'>
749 <member ref='#{node1.id}' type='node' role='some'/>
750 <member ref='#{node2.id}' type='node' role='some'/>
754 post api_relations_path, :params => xml, :headers => auth_header
755 assert_response :too_many_requests, "relation create did not hit rate limit"
761 [Relation, RelationTag, RelationMember,
762 OldRelation, OldRelationTag, OldRelationMember]
766 # update an attribute in the node element
767 def xml_attr_rewrite(xml, name, value)
768 xml.find("//osm/relation").first[name] = value.to_s