Merge remote-tracking branch 'openstreetmap/pull/1521'
[rails.git] / test / controllers / relation_controller_test.rb
1 require "test_helper"
2 require "relation_controller"
3
4 class RelationControllerTest < ActionController::TestCase
5   api_fixtures
6
7   ##
8   # test all routes which lead to this controller
9   def test_routes
10     assert_routing(
11       { :path => "/api/0.6/relation/create", :method => :put },
12       { :controller => "relation", :action => "create" }
13     )
14     assert_routing(
15       { :path => "/api/0.6/relation/1/full", :method => :get },
16       { :controller => "relation", :action => "full", :id => "1" }
17     )
18     assert_routing(
19       { :path => "/api/0.6/relation/1", :method => :get },
20       { :controller => "relation", :action => "read", :id => "1" }
21     )
22     assert_routing(
23       { :path => "/api/0.6/relation/1", :method => :put },
24       { :controller => "relation", :action => "update", :id => "1" }
25     )
26     assert_routing(
27       { :path => "/api/0.6/relation/1", :method => :delete },
28       { :controller => "relation", :action => "delete", :id => "1" }
29     )
30     assert_routing(
31       { :path => "/api/0.6/relations", :method => :get },
32       { :controller => "relation", :action => "relations" }
33     )
34
35     assert_routing(
36       { :path => "/api/0.6/node/1/relations", :method => :get },
37       { :controller => "relation", :action => "relations_for_node", :id => "1" }
38     )
39     assert_routing(
40       { :path => "/api/0.6/way/1/relations", :method => :get },
41       { :controller => "relation", :action => "relations_for_way", :id => "1" }
42     )
43     assert_routing(
44       { :path => "/api/0.6/relation/1/relations", :method => :get },
45       { :controller => "relation", :action => "relations_for_relation", :id => "1" }
46     )
47   end
48
49   # -------------------------------------
50   # Test reading relations.
51   # -------------------------------------
52
53   def test_read
54     # check that a visible relation is returned properly
55     get :read, :id => current_relations(:visible_relation).id
56     assert_response :success
57
58     # check that an invisible relation is not returned
59     get :read, :id => current_relations(:invisible_relation).id
60     assert_response :gone
61
62     # check chat a non-existent relation is not returned
63     get :read, :id => 0
64     assert_response :not_found
65   end
66
67   ##
68   # check that all relations containing a particular node, and no extra
69   # relations, are returned from the relations_for_node call.
70   def test_relations_for_node
71     node = create(:node)
72     # should include relations with that node as a member
73     relation_with_node = create(:relation_member, :member => node).relation
74     # should ignore relations without that node as a member
75     _relation_without_node = create(:relation_member).relation
76     # should ignore relations with the node involved indirectly, via a way
77     way = create(:way_node, :node => node).way
78     _relation_with_way = create(:relation_member, :member => way).relation
79     # should ignore relations with the node involved indirectly, via a relation
80     second_relation = create(:relation_member, :member => node).relation
81     _super_relation = create(:relation_member, :member => second_relation).relation
82     # should combine multiple relation_member references into just one relation entry
83     create(:relation_member, :member => node, :relation => relation_with_node, :sequence_id => 2)
84     # should not include deleted relations
85     deleted_relation = create(:relation, :deleted)
86     create(:relation_member, :member => node, :relation => deleted_relation)
87
88     check_relations_for_element(:relations_for_node, "node",
89                                 node.id,
90                                 [relation_with_node, second_relation])
91   end
92
93   def test_relations_for_way
94     way = create(:way)
95     # should include relations with that way as a member
96     relation_with_way = create(:relation_member, :member => way).relation
97     # should ignore relations without that way as a member
98     _relation_without_way = create(:relation_member).relation
99     # should ignore relations with the way involved indirectly, via a relation
100     second_relation = create(:relation_member, :member => way).relation
101     _super_relation = create(:relation_member, :member => second_relation).relation
102     # should combine multiple relation_member references into just one relation entry
103     create(:relation_member, :member => way, :relation => relation_with_way, :sequence_id => 2)
104     # should not include deleted relations
105     deleted_relation = create(:relation, :deleted)
106     create(:relation_member, :member => way, :relation => deleted_relation)
107
108     check_relations_for_element(:relations_for_way, "way",
109                                 way.id,
110                                 [relation_with_way, second_relation])
111   end
112
113   def test_relations_for_relation
114     relation = create(:relation)
115     # should include relations with that relation as a member
116     relation_with_relation = create(:relation_member, :member => relation).relation
117     # should ignore any relation without that relation as a member
118     _relation_without_relation = create(:relation_member).relation
119     # should ignore relations with the relation involved indirectly, via a relation
120     second_relation = create(:relation_member, :member => relation).relation
121     _super_relation = create(:relation_member, :member => second_relation).relation
122     # should combine multiple relation_member references into just one relation entry
123     create(:relation_member, :member => relation, :relation => relation_with_relation, :sequence_id => 2)
124     # should not include deleted relations
125     deleted_relation = create(:relation, :deleted)
126     create(:relation_member, :member => relation, :relation => deleted_relation)
127     check_relations_for_element(:relations_for_relation, "relation",
128                                 relation.id,
129                                 [relation_with_relation, second_relation])
130   end
131
132   def check_relations_for_element(method, type, id, expected_relations)
133     # check the "relations for relation" mode
134     get method, :id => id
135     assert_response :success
136
137     # count one osm element
138     assert_select "osm[version='#{API_VERSION}'][generator='OpenStreetMap server']", 1
139
140     # we should have only the expected number of relations
141     assert_select "osm>relation", expected_relations.size
142
143     # and each of them should contain the element we originally searched for
144     expected_relations.each do |relation|
145       # The relation should appear once, but the element could appear multiple times
146       assert_select "osm>relation[id='#{relation.id}']", 1
147       assert_select "osm>relation[id='#{relation.id}']>member[type='#{type}'][ref='#{id}']"
148     end
149   end
150
151   def test_full
152     # check the "full" mode
153     get :full, :id => 999999
154     assert_response :not_found
155
156     get :full, :id => current_relations(:invisible_relation).id
157     assert_response :gone
158
159     get :full, :id => current_relations(:visible_relation).id
160     assert_response :success
161     # FIXME: check whether this contains the stuff we want!
162   end
163
164   ##
165   # test fetching multiple relations
166   def test_relations
167     # check error when no parameter provided
168     get :relations
169     assert_response :bad_request
170
171     # check error when no parameter value provided
172     get :relations, :relations => ""
173     assert_response :bad_request
174
175     # test a working call
176     get :relations, :relations => "1,2,4,7"
177     assert_response :success
178     assert_select "osm" do
179       assert_select "relation", :count => 4
180       assert_select "relation[id='1'][visible='true']", :count => 1
181       assert_select "relation[id='2'][visible='false']", :count => 1
182       assert_select "relation[id='4'][visible='true']", :count => 1
183       assert_select "relation[id='7'][visible='true']", :count => 1
184     end
185
186     # check error when a non-existent relation is included
187     get :relations, :relations => "1,2,4,7,400"
188     assert_response :not_found
189   end
190
191   # -------------------------------------
192   # Test simple relation creation.
193   # -------------------------------------
194
195   def test_create
196     private_user = create(:user, :data_public => false)
197     private_changeset = create(:changeset, :user => private_user)
198     user = create(:user)
199     changeset = create(:changeset, :user => user)
200     node = create(:node)
201     way = create(:way_with_nodes, :nodes_count => 2)
202
203     basic_authorization private_user.email, "test"
204
205     # create an relation without members
206     content "<osm><relation changeset='#{private_changeset.id}'><tag k='test' v='yes' /></relation></osm>"
207     put :create
208     # hope for forbidden, due to user
209     assert_response :forbidden,
210                     "relation upload should have failed with forbidden"
211
212     ###
213     # create an relation with a node as member
214     # This time try with a role attribute in the relation
215     content "<osm><relation changeset='#{private_changeset.id}'>" +
216             "<member  ref='#{node.id}' type='node' role='some'/>" +
217             "<tag k='test' v='yes' /></relation></osm>"
218     put :create
219     # hope for forbidden due to user
220     assert_response :forbidden,
221                     "relation upload did not return forbidden status"
222
223     ###
224     # create an relation with a node as member, this time test that we don't
225     # need a role attribute to be included
226     content "<osm><relation changeset='#{private_changeset.id}'>" +
227             "<member  ref='#{node.id}' type='node'/>" + "<tag k='test' v='yes' /></relation></osm>"
228     put :create
229     # hope for forbidden due to user
230     assert_response :forbidden,
231                     "relation upload did not return forbidden status"
232
233     ###
234     # create an relation with a way and a node as members
235     content "<osm><relation changeset='#{private_changeset.id}'>" +
236             "<member type='node' ref='#{node.id}' role='some'/>" +
237             "<member type='way' ref='#{way.id}' role='other'/>" +
238             "<tag k='test' v='yes' /></relation></osm>"
239     put :create
240     # hope for forbidden, due to user
241     assert_response :forbidden,
242                     "relation upload did not return success status"
243
244     ## Now try with the public user
245     basic_authorization user.email, "test"
246
247     # create an relation without members
248     content "<osm><relation changeset='#{changeset.id}'><tag k='test' v='yes' /></relation></osm>"
249     put :create
250     # hope for success
251     assert_response :success,
252                     "relation upload did not return success status"
253     # read id of created relation and search for it
254     relationid = @response.body
255     checkrelation = Relation.find(relationid)
256     assert_not_nil checkrelation,
257                    "uploaded relation not found in data base after upload"
258     # compare values
259     assert_equal checkrelation.members.length, 0,
260                  "saved relation contains members but should not"
261     assert_equal checkrelation.tags.length, 1,
262                  "saved relation does not contain exactly one tag"
263     assert_equal changeset.id, checkrelation.changeset.id,
264                  "saved relation does not belong in the changeset it was assigned to"
265     assert_equal user.id, checkrelation.changeset.user_id,
266                  "saved relation does not belong to user that created it"
267     assert_equal true, checkrelation.visible,
268                  "saved relation is not visible"
269     # ok the relation is there but can we also retrieve it?
270     get :read, :id => relationid
271     assert_response :success
272
273     ###
274     # create an relation with a node as member
275     # This time try with a role attribute in the relation
276     content "<osm><relation changeset='#{changeset.id}'>" +
277             "<member  ref='#{node.id}' type='node' role='some'/>" +
278             "<tag k='test' v='yes' /></relation></osm>"
279     put :create
280     # hope for success
281     assert_response :success,
282                     "relation upload did not return success status"
283     # read id of created relation and search for it
284     relationid = @response.body
285     checkrelation = Relation.find(relationid)
286     assert_not_nil checkrelation,
287                    "uploaded relation not found in data base after upload"
288     # compare values
289     assert_equal checkrelation.members.length, 1,
290                  "saved relation does not contain exactly one member"
291     assert_equal checkrelation.tags.length, 1,
292                  "saved relation does not contain exactly one tag"
293     assert_equal changeset.id, checkrelation.changeset.id,
294                  "saved relation does not belong in the changeset it was assigned to"
295     assert_equal user.id, checkrelation.changeset.user_id,
296                  "saved relation does not belong to user that created it"
297     assert_equal true, checkrelation.visible,
298                  "saved relation is not visible"
299     # ok the relation is there but can we also retrieve it?
300
301     get :read, :id => relationid
302     assert_response :success
303
304     ###
305     # create an relation with a node as member, this time test that we don't
306     # need a role attribute to be included
307     content "<osm><relation changeset='#{changeset.id}'>" +
308             "<member  ref='#{node.id}' type='node'/>" + "<tag k='test' v='yes' /></relation></osm>"
309     put :create
310     # hope for success
311     assert_response :success,
312                     "relation upload did not return success status"
313     # read id of created relation and search for it
314     relationid = @response.body
315     checkrelation = Relation.find(relationid)
316     assert_not_nil checkrelation,
317                    "uploaded relation not found in data base after upload"
318     # compare values
319     assert_equal checkrelation.members.length, 1,
320                  "saved relation does not contain exactly one member"
321     assert_equal checkrelation.tags.length, 1,
322                  "saved relation does not contain exactly one tag"
323     assert_equal changeset.id, checkrelation.changeset.id,
324                  "saved relation does not belong in the changeset it was assigned to"
325     assert_equal user.id, checkrelation.changeset.user_id,
326                  "saved relation does not belong to user that created it"
327     assert_equal true, checkrelation.visible,
328                  "saved relation is not visible"
329     # ok the relation is there but can we also retrieve it?
330
331     get :read, :id => relationid
332     assert_response :success
333
334     ###
335     # create an relation with a way and a node as members
336     content "<osm><relation changeset='#{changeset.id}'>" +
337             "<member type='node' ref='#{node.id}' role='some'/>" +
338             "<member type='way' ref='#{way.id}' role='other'/>" +
339             "<tag k='test' v='yes' /></relation></osm>"
340     put :create
341     # hope for success
342     assert_response :success,
343                     "relation upload did not return success status"
344     # read id of created relation and search for it
345     relationid = @response.body
346     checkrelation = Relation.find(relationid)
347     assert_not_nil checkrelation,
348                    "uploaded relation not found in data base after upload"
349     # compare values
350     assert_equal checkrelation.members.length, 2,
351                  "saved relation does not have exactly two members"
352     assert_equal checkrelation.tags.length, 1,
353                  "saved relation does not contain exactly one tag"
354     assert_equal changeset.id, checkrelation.changeset.id,
355                  "saved relation does not belong in the changeset it was assigned to"
356     assert_equal user.id, checkrelation.changeset.user_id,
357                  "saved relation does not belong to user that created it"
358     assert_equal true, checkrelation.visible,
359                  "saved relation is not visible"
360     # ok the relation is there but can we also retrieve it?
361     get :read, :id => relationid
362     assert_response :success
363   end
364
365   # ------------------------------------
366   # Test updating relations
367   # ------------------------------------
368
369   ##
370   # test that, when tags are updated on a relation, the correct things
371   # happen to the correct tables and the API gives sensible results.
372   # this is to test a case that gregory marler noticed and posted to
373   # josm-dev.
374   ## FIXME Move this to an integration test
375   def test_update_relation_tags
376     basic_authorization "test@example.com", "test"
377     rel_id = current_relations(:multi_tag_relation).id
378     create_list(:relation_tag, 4, :relation => current_relations(:multi_tag_relation))
379     cs_id = changesets(:public_user_first_change).id
380
381     with_relation(rel_id) do |rel|
382       # alter one of the tags
383       tag = rel.find("//osm/relation/tag").first
384       tag["v"] = "some changed value"
385       update_changeset(rel, cs_id)
386
387       # check that the downloaded tags are the same as the uploaded tags...
388       new_version = with_update(rel) do |new_rel|
389         assert_tags_equal rel, new_rel
390       end
391
392       # check the original one in the current_* table again
393       with_relation(rel_id) { |r| assert_tags_equal rel, r }
394
395       # now check the version in the history
396       with_relation(rel_id, new_version) { |r| assert_tags_equal rel, r }
397     end
398   end
399
400   ##
401   # test that, when tags are updated on a relation when using the diff
402   # upload function, the correct things happen to the correct tables
403   # and the API gives sensible results. this is to test a case that
404   # gregory marler noticed and posted to josm-dev.
405   def test_update_relation_tags_via_upload
406     user = create(:user)
407     changeset = create(:changeset, :user => user)
408     relation = create(:relation)
409     create_list(:relation_tag, 4, :relation => relation)
410
411     basic_authorization user.email, "test"
412
413     with_relation(relation.id) do |rel|
414       # alter one of the tags
415       tag = rel.find("//osm/relation/tag").first
416       tag["v"] = "some changed value"
417       update_changeset(rel, changeset.id)
418
419       # check that the downloaded tags are the same as the uploaded tags...
420       new_version = with_update_diff(rel) do |new_rel|
421         assert_tags_equal rel, new_rel
422       end
423
424       # check the original one in the current_* table again
425       with_relation(relation.id) { |r| assert_tags_equal rel, r }
426
427       # now check the version in the history
428       with_relation(relation.id, new_version) { |r| assert_tags_equal rel, r }
429     end
430   end
431
432   def test_update_wrong_id
433     user = create(:user)
434     changeset = create(:changeset, :user => user)
435     relation = create(:relation)
436     other_relation = create(:relation)
437
438     basic_authorization user.email, "test"
439     with_relation(relation.id) do |rel|
440       update_changeset(rel, changeset.id)
441       content rel
442       put :update, :id => other_relation.id
443       assert_response :bad_request
444     end
445   end
446
447   # -------------------------------------
448   # Test creating some invalid relations.
449   # -------------------------------------
450
451   def test_create_invalid
452     user = create(:user)
453     changeset = create(:changeset, :user => user)
454
455     basic_authorization user.email, "test"
456
457     # create a relation with non-existing node as member
458     content "<osm><relation changeset='#{changeset.id}'>" +
459             "<member type='node' ref='0'/><tag k='test' v='yes' />" +
460             "</relation></osm>"
461     put :create
462     # expect failure
463     assert_response :precondition_failed,
464                     "relation upload with invalid node did not return 'precondition failed'"
465     assert_equal "Precondition failed: Relation with id  cannot be saved due to Node with id 0", @response.body
466   end
467
468   # -------------------------------------
469   # Test creating a relation, with some invalid XML
470   # -------------------------------------
471   def test_create_invalid_xml
472     user = create(:user)
473     changeset = create(:changeset, :user => user)
474     node = create(:node)
475
476     basic_authorization user.email, "test"
477
478     # create some xml that should return an error
479     content "<osm><relation changeset='#{changeset.id}'>" +
480             "<member type='type' ref='#{node.id}' role=''/>" +
481             "<tag k='tester' v='yep'/></relation></osm>"
482     put :create
483     # expect failure
484     assert_response :bad_request
485     assert_match(/Cannot parse valid relation from xml string/, @response.body)
486     assert_match(/The type is not allowed only, /, @response.body)
487   end
488
489   # -------------------------------------
490   # Test deleting relations.
491   # -------------------------------------
492
493   def test_delete
494     private_user = create(:user, :data_public => false)
495     private_user_closed_changeset = create(:changeset, :closed, :user => private_user)
496     user = create(:user)
497     closed_changeset = create(:changeset, :closed, :user => user)
498     changeset = create(:changeset, :user => user)
499     relation = create(:relation)
500     used_relation = create(:relation)
501     super_relation = create(:relation_member, :member => used_relation).relation
502     deleted_relation = create(:relation, :deleted)
503     multi_tag_relation = create(:relation)
504     create_list(:relation_tag, 4, :relation => multi_tag_relation)
505
506     ## First try to delete relation without auth
507     delete :delete, :id => relation.id
508     assert_response :unauthorized
509
510     ## Then try with the private user, to make sure that you get a forbidden
511     basic_authorization(private_user.email, "test")
512
513     # this shouldn't work, as we should need the payload...
514     delete :delete, :id => relation.id
515     assert_response :forbidden
516
517     # try to delete without specifying a changeset
518     content "<osm><relation id='#{relation.id}'/></osm>"
519     delete :delete, :id => relation.id
520     assert_response :forbidden
521
522     # try to delete with an invalid (closed) changeset
523     content update_changeset(relation.to_xml,
524                              private_user_closed_changeset.id)
525     delete :delete, :id => relation.id
526     assert_response :forbidden
527
528     # try to delete with an invalid (non-existent) changeset
529     content update_changeset(relation.to_xml, 0)
530     delete :delete, :id => relation.id
531     assert_response :forbidden
532
533     # this won't work because the relation is in-use by another relation
534     content(used_relation.to_xml)
535     delete :delete, :id => used_relation.id
536     assert_response :forbidden
537
538     # this should work when we provide the appropriate payload...
539     content(relation.to_xml)
540     delete :delete, :id => relation.id
541     assert_response :forbidden
542
543     # this won't work since the relation is already deleted
544     content(deleted_relation.to_xml)
545     delete :delete, :id => deleted_relation.id
546     assert_response :forbidden
547
548     # this won't work since the relation never existed
549     delete :delete, :id => 0
550     assert_response :forbidden
551
552     ## now set auth for the public user
553     basic_authorization(user.email, "test")
554
555     # this shouldn't work, as we should need the payload...
556     delete :delete, :id => relation.id
557     assert_response :bad_request
558
559     # try to delete without specifying a changeset
560     content "<osm><relation id='#{relation.id}' version='#{relation.version}' /></osm>"
561     delete :delete, :id => relation.id
562     assert_response :bad_request
563     assert_match(/Changeset id is missing/, @response.body)
564
565     # try to delete with an invalid (closed) changeset
566     content update_changeset(relation.to_xml,
567                              closed_changeset.id)
568     delete :delete, :id => relation.id
569     assert_response :conflict
570
571     # try to delete with an invalid (non-existent) changeset
572     content update_changeset(relation.to_xml, 0)
573     delete :delete, :id => relation.id
574     assert_response :conflict
575
576     # this won't work because the relation is in a changeset owned by someone else
577     content update_changeset(relation.to_xml, create(:changeset).id)
578     delete :delete, :id => relation.id
579     assert_response :conflict,
580                     "shouldn't be able to delete a relation in a changeset owned by someone else (#{@response.body})"
581
582     # this won't work because the relation in the payload is different to that passed
583     content update_changeset(relation.to_xml, changeset.id)
584     delete :delete, :id => create(:relation).id
585     assert_response :bad_request, "shouldn't be able to delete a relation when payload is different to the url"
586
587     # this won't work because the relation is in-use by another relation
588     content update_changeset(used_relation.to_xml, changeset.id)
589     delete :delete, :id => used_relation.id
590     assert_response :precondition_failed,
591                     "shouldn't be able to delete a relation used in a relation (#{@response.body})"
592     assert_equal "Precondition failed: The relation #{used_relation.id} is used in relation #{super_relation.id}.", @response.body
593
594     # this should work when we provide the appropriate payload...
595     content update_changeset(multi_tag_relation.to_xml, changeset.id)
596     delete :delete, :id => multi_tag_relation.id
597     assert_response :success
598
599     # valid delete should return the new version number, which should
600     # be greater than the old version number
601     assert @response.body.to_i > multi_tag_relation.version,
602            "delete request should return a new version number for relation"
603
604     # this won't work since the relation is already deleted
605     content update_changeset(deleted_relation.to_xml, changeset.id)
606     delete :delete, :id => deleted_relation.id
607     assert_response :gone
608
609     # Public visible relation needs to be deleted
610     content update_changeset(super_relation.to_xml, changeset.id)
611     delete :delete, :id => super_relation.id
612     assert_response :success
613
614     # this works now because the relation which was using this one
615     # has been deleted.
616     content update_changeset(used_relation.to_xml, changeset.id)
617     delete :delete, :id => used_relation.id
618     assert_response :success,
619                     "should be able to delete a relation used in an old relation (#{@response.body})"
620
621     # this won't work since the relation never existed
622     delete :delete, :id => 0
623     assert_response :not_found
624   end
625
626   ##
627   # when a relation's tag is modified then it should put the bounding
628   # box of all its members into the changeset.
629   def test_tag_modify_bounding_box
630     # in current fixtures, relation 5 contains nodes 3 and 5 (node 3
631     # indirectly via way 3), so the bbox should be [3,3,5,5].
632     check_changeset_modify(BoundingBox.new(3, 3, 5, 5)) do |changeset_id|
633       # add a tag to an existing relation
634       relation_xml = current_relations(:visible_relation).to_xml
635       relation_element = relation_xml.find("//osm/relation").first
636       new_tag = XML::Node.new("tag")
637       new_tag["k"] = "some_new_tag"
638       new_tag["v"] = "some_new_value"
639       relation_element << new_tag
640
641       # update changeset ID to point to new changeset
642       update_changeset(relation_xml, changeset_id)
643
644       # upload the change
645       content relation_xml
646       put :update, :id => current_relations(:visible_relation).id
647       assert_response :success, "can't update relation for tag/bbox test"
648     end
649   end
650
651   ##
652   # add a member to a relation and check the bounding box is only that
653   # element.
654   def test_add_member_bounding_box
655     relation_id = current_relations(:visible_relation).id
656
657     [current_nodes(:used_node_1),
658      current_nodes(:used_node_2),
659      current_ways(:used_way),
660      current_ways(:way_with_versions)].each_with_index do |element, _version|
661       bbox = element.bbox.to_unscaled
662       check_changeset_modify(bbox) do |changeset_id|
663         relation_xml = Relation.find(relation_id).to_xml
664         relation_element = relation_xml.find("//osm/relation").first
665         new_member = XML::Node.new("member")
666         new_member["ref"] = element.id.to_s
667         new_member["type"] = element.class.to_s.downcase
668         new_member["role"] = "some_role"
669         relation_element << new_member
670
671         # update changeset ID to point to new changeset
672         update_changeset(relation_xml, changeset_id)
673
674         # upload the change
675         content relation_xml
676         put :update, :id => current_relations(:visible_relation).id
677         assert_response :success, "can't update relation for add #{element.class}/bbox test: #{@response.body}"
678
679         # get it back and check the ordering
680         get :read, :id => relation_id
681         assert_response :success, "can't read back the relation: #{@response.body}"
682         check_ordering(relation_xml, @response.body)
683       end
684     end
685   end
686
687   ##
688   # remove a member from a relation and check the bounding box is
689   # only that element.
690   def test_remove_member_bounding_box
691     check_changeset_modify(BoundingBox.new(5, 5, 5, 5)) do |changeset_id|
692       # remove node 5 (5,5) from an existing relation
693       relation_xml = current_relations(:visible_relation).to_xml
694       relation_xml
695         .find("//osm/relation/member[@type='node'][@ref='5']")
696         .first.remove!
697
698       # update changeset ID to point to new changeset
699       update_changeset(relation_xml, changeset_id)
700
701       # upload the change
702       content relation_xml
703       put :update, :id => current_relations(:visible_relation).id
704       assert_response :success, "can't update relation for remove node/bbox test"
705     end
706   end
707
708   ##
709   # check that relations are ordered
710   def test_relation_member_ordering
711     basic_authorization(users(:public_user).email, "test")
712
713     doc_str = <<OSM
714 <osm>
715  <relation changeset='4'>
716   <member ref='1' type='node' role='first'/>
717   <member ref='3' type='node' role='second'/>
718   <member ref='1' type='way' role='third'/>
719   <member ref='3' type='way' role='fourth'/>
720  </relation>
721 </osm>
722 OSM
723     doc = XML::Parser.string(doc_str).parse
724
725     content doc
726     put :create
727     assert_response :success, "can't create a relation: #{@response.body}"
728     relation_id = @response.body.to_i
729
730     # get it back and check the ordering
731     get :read, :id => relation_id
732     assert_response :success, "can't read back the relation: #{@response.body}"
733     check_ordering(doc, @response.body)
734
735     # insert a member at the front
736     new_member = XML::Node.new "member"
737     new_member["ref"] = 5.to_s
738     new_member["type"] = "node"
739     new_member["role"] = "new first"
740     doc.find("//osm/relation").first.child.prev = new_member
741     # update the version, should be 1?
742     doc.find("//osm/relation").first["id"] = relation_id.to_s
743     doc.find("//osm/relation").first["version"] = 1.to_s
744
745     # upload the next version of the relation
746     content doc
747     put :update, :id => relation_id
748     assert_response :success, "can't update relation: #{@response.body}"
749     assert_equal 2, @response.body.to_i
750
751     # get it back again and check the ordering again
752     get :read, :id => relation_id
753     assert_response :success, "can't read back the relation: #{@response.body}"
754     check_ordering(doc, @response.body)
755
756     # check the ordering in the history tables:
757     with_controller(OldRelationController.new) do
758       get :version, :id => relation_id, :version => 2
759       assert_response :success, "can't read back version 2 of the relation #{relation_id}"
760       check_ordering(doc, @response.body)
761     end
762   end
763
764   ##
765   # check that relations can contain duplicate members
766   def test_relation_member_duplicates
767     doc_str = <<OSM
768 <osm>
769  <relation changeset='4'>
770   <member ref='1' type='node' role='forward'/>
771   <member ref='3' type='node' role='forward'/>
772   <member ref='1' type='node' role='forward'/>
773   <member ref='3' type='node' role='forward'/>
774  </relation>
775 </osm>
776 OSM
777     doc = XML::Parser.string(doc_str).parse
778
779     ## First try with the private user
780     basic_authorization(users(:normal_user).email, "test")
781
782     content doc
783     put :create
784     assert_response :forbidden
785
786     ## Now try with the public user
787     basic_authorization(users(:public_user).email, "test")
788
789     content doc
790     put :create
791     assert_response :success, "can't create a relation: #{@response.body}"
792     relation_id = @response.body.to_i
793
794     # get it back and check the ordering
795     get :read, :id => relation_id
796     assert_response :success, "can't read back the relation: #{relation_id}"
797     check_ordering(doc, @response.body)
798   end
799
800   ##
801   # test that the ordering of elements in the history is the same as in current.
802   def test_history_ordering
803     doc_str = <<OSM
804 <osm>
805  <relation changeset='4'>
806   <member ref='1' type='node' role='forward'/>
807   <member ref='5' type='node' role='forward'/>
808   <member ref='4' type='node' role='forward'/>
809   <member ref='3' type='node' role='forward'/>
810  </relation>
811 </osm>
812 OSM
813     doc = XML::Parser.string(doc_str).parse
814     basic_authorization(users(:public_user).email, "test")
815
816     content doc
817     put :create
818     assert_response :success, "can't create a relation: #{@response.body}"
819     relation_id = @response.body.to_i
820
821     # check the ordering in the current tables:
822     get :read, :id => relation_id
823     assert_response :success, "can't read back the relation: #{@response.body}"
824     check_ordering(doc, @response.body)
825
826     # check the ordering in the history tables:
827     with_controller(OldRelationController.new) do
828       get :version, :id => relation_id, :version => 1
829       assert_response :success, "can't read back version 1 of the relation: #{@response.body}"
830       check_ordering(doc, @response.body)
831     end
832   end
833
834   ##
835   # remove all the members from a relation. the result is pretty useless, but
836   # still technically valid.
837   def test_remove_all_members
838     check_changeset_modify(BoundingBox.new(3, 3, 5, 5)) do |changeset_id|
839       relation_xml = current_relations(:visible_relation).to_xml
840       relation_xml
841         .find("//osm/relation/member")
842         .each(&:remove!)
843
844       # update changeset ID to point to new changeset
845       update_changeset(relation_xml, changeset_id)
846
847       # upload the change
848       content relation_xml
849       put :update, :id => current_relations(:visible_relation).id
850       assert_response :success, "can't update relation for remove all members test"
851       checkrelation = Relation.find(current_relations(:visible_relation).id)
852       assert_not_nil(checkrelation,
853                      "uploaded relation not found in database after upload")
854       assert_equal(0, checkrelation.members.length,
855                    "relation contains members but they should have all been deleted")
856     end
857   end
858
859   # ============================================================
860   # utility functions
861   # ============================================================
862
863   ##
864   # checks that the XML document and the string arguments have
865   # members in the same order.
866   def check_ordering(doc, xml)
867     new_doc = XML::Parser.string(xml).parse
868
869     doc_members = doc.find("//osm/relation/member").collect do |m|
870       [m["ref"].to_i, m["type"].to_sym, m["role"]]
871     end
872
873     new_members = new_doc.find("//osm/relation/member").collect do |m|
874       [m["ref"].to_i, m["type"].to_sym, m["role"]]
875     end
876
877     doc_members.zip(new_members).each do |d, n|
878       assert_equal d, n, "members are not equal - ordering is wrong? (#{doc}, #{xml})"
879     end
880   end
881
882   ##
883   # create a changeset and yield to the caller to set it up, then assert
884   # that the changeset bounding box is +bbox+.
885   def check_changeset_modify(bbox)
886     ## First test with the private user to check that you get a forbidden
887     basic_authorization(users(:normal_user).email, "test")
888
889     # create a new changeset for this operation, so we are assured
890     # that the bounding box will be newly-generated.
891     changeset_id = with_controller(ChangesetController.new) do
892       content "<osm><changeset/></osm>"
893       put :create
894       assert_response :forbidden, "shouldn't be able to create changeset for modify test, as should get forbidden"
895     end
896
897     ## Now do the whole thing with the public user
898     basic_authorization(users(:public_user).email, "test")
899
900     # create a new changeset for this operation, so we are assured
901     # that the bounding box will be newly-generated.
902     changeset_id = with_controller(ChangesetController.new) do
903       content "<osm><changeset/></osm>"
904       put :create
905       assert_response :success, "couldn't create changeset for modify test"
906       @response.body.to_i
907     end
908
909     # go back to the block to do the actual modifies
910     yield changeset_id
911
912     # now download the changeset to check its bounding box
913     with_controller(ChangesetController.new) do
914       get :read, :id => changeset_id
915       assert_response :success, "can't re-read changeset for modify test"
916       assert_select "osm>changeset", 1, "Changeset element doesn't exist in #{@response.body}"
917       assert_select "osm>changeset[id='#{changeset_id}']", 1, "Changeset id=#{changeset_id} doesn't exist in #{@response.body}"
918       assert_select "osm>changeset[min_lon='#{bbox.min_lon}']", 1, "Changeset min_lon wrong in #{@response.body}"
919       assert_select "osm>changeset[min_lat='#{bbox.min_lat}']", 1, "Changeset min_lat wrong in #{@response.body}"
920       assert_select "osm>changeset[max_lon='#{bbox.max_lon}']", 1, "Changeset max_lon wrong in #{@response.body}"
921       assert_select "osm>changeset[max_lat='#{bbox.max_lat}']", 1, "Changeset max_lat wrong in #{@response.body}"
922     end
923   end
924
925   ##
926   # yields the relation with the given +id+ (and optional +version+
927   # to read from the history tables) into the block. the parsed XML
928   # doc is returned.
929   def with_relation(id, ver = nil)
930     if ver.nil?
931       get :read, :id => id
932     else
933       with_controller(OldRelationController.new) do
934         get :version, :id => id, :version => ver
935       end
936     end
937     assert_response :success
938     yield xml_parse(@response.body)
939   end
940
941   ##
942   # updates the relation (XML) +rel+ and
943   # yields the new version of that relation into the block.
944   # the parsed XML doc is retured.
945   def with_update(rel)
946     rel_id = rel.find("//osm/relation").first["id"].to_i
947     content rel
948     put :update, :id => rel_id
949     assert_response :success, "can't update relation: #{@response.body}"
950     version = @response.body.to_i
951
952     # now get the new version
953     get :read, :id => rel_id
954     assert_response :success
955     new_rel = xml_parse(@response.body)
956
957     yield new_rel
958
959     version
960   end
961
962   ##
963   # updates the relation (XML) +rel+ via the diff-upload API and
964   # yields the new version of that relation into the block.
965   # the parsed XML doc is retured.
966   def with_update_diff(rel)
967     rel_id = rel.find("//osm/relation").first["id"].to_i
968     cs_id = rel.find("//osm/relation").first["changeset"].to_i
969     version = nil
970
971     with_controller(ChangesetController.new) do
972       doc = OSM::API.new.get_xml_doc
973       change = XML::Node.new "osmChange"
974       doc.root = change
975       modify = XML::Node.new "modify"
976       change << modify
977       modify << doc.import(rel.find("//osm/relation").first)
978
979       content doc.to_s
980       post :upload, :id => cs_id
981       assert_response :success, "can't upload diff relation: #{@response.body}"
982       version = xml_parse(@response.body).find("//diffResult/relation").first["new_version"].to_i
983     end
984
985     # now get the new version
986     get :read, :id => rel_id
987     assert_response :success
988     new_rel = xml_parse(@response.body)
989
990     yield new_rel
991
992     version
993   end
994
995   ##
996   # returns a k->v hash of tags from an xml doc
997   def get_tags_as_hash(a)
998     a.find("//osm/relation/tag").sort_by { |v| v["k"] }.each_with_object({}) do |v, h|
999       h[v["k"]] = v["v"]
1000     end
1001   end
1002
1003   ##
1004   # assert that all tags on relation documents +a+ and +b+
1005   # are equal
1006   def assert_tags_equal(a, b)
1007     # turn the XML doc into tags hashes
1008     a_tags = get_tags_as_hash(a)
1009     b_tags = get_tags_as_hash(b)
1010
1011     assert_equal a_tags.keys, b_tags.keys, "Tag keys should be identical."
1012     a_tags.each do |k, v|
1013       assert_equal v, b_tags[k],
1014                    "Tags which were not altered should be the same. " +
1015                    "#{a_tags.inspect} != #{b_tags.inspect}"
1016     end
1017   end
1018
1019   ##
1020   # update the changeset_id of a node element
1021   def update_changeset(xml, changeset_id)
1022     xml_attr_rewrite(xml, "changeset", changeset_id)
1023   end
1024
1025   ##
1026   # update an attribute in the node element
1027   def xml_attr_rewrite(xml, name, value)
1028     xml.find("//osm/relation").first[name] = value.to_s
1029     xml
1030   end
1031
1032   ##
1033   # parse some xml
1034   def xml_parse(xml)
1035     parser = XML::Parser.string(xml)
1036     parser.parse
1037   end
1038 end