X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/ba2eb5205481fb0b90455a0c33ae25dc3f6801d2..e837727d9544c178eabd79fe2e8f37d039ccd7c5:/test/controllers/api/relations_controller_test.rb?ds=sidebyside diff --git a/test/controllers/api/relations_controller_test.rb b/test/controllers/api/relations_controller_test.rb index c4fb639b3..34953f7b7 100644 --- a/test/controllers/api/relations_controller_test.rb +++ b/test/controllers/api/relations_controller_test.rb @@ -6,16 +6,16 @@ module Api # test all routes which lead to this controller def test_routes assert_routing( - { :path => "/api/0.6/relation/create", :method => :put }, - { :controller => "api/relations", :action => "create" } + { :path => "/api/0.6/relations", :method => :get }, + { :controller => "api/relations", :action => "index" } ) assert_routing( - { :path => "/api/0.6/relation/1/full", :method => :get }, - { :controller => "api/relations", :action => "full", :id => "1" } + { :path => "/api/0.6/relations.json", :method => :get }, + { :controller => "api/relations", :action => "index", :format => "json" } ) assert_routing( - { :path => "/api/0.6/relation/1/full.json", :method => :get }, - { :controller => "api/relations", :action => "full", :id => "1", :format => "json" } + { :path => "/api/0.6/relations", :method => :post }, + { :controller => "api/relations", :action => "create" } ) assert_routing( { :path => "/api/0.6/relation/1", :method => :get }, @@ -26,20 +26,20 @@ module Api { :controller => "api/relations", :action => "show", :id => "1", :format => "json" } ) assert_routing( - { :path => "/api/0.6/relation/1", :method => :put }, - { :controller => "api/relations", :action => "update", :id => "1" } + { :path => "/api/0.6/relation/1/full", :method => :get }, + { :controller => "api/relations", :action => "full", :id => "1" } ) assert_routing( - { :path => "/api/0.6/relation/1", :method => :delete }, - { :controller => "api/relations", :action => "delete", :id => "1" } + { :path => "/api/0.6/relation/1/full.json", :method => :get }, + { :controller => "api/relations", :action => "full", :id => "1", :format => "json" } ) assert_routing( - { :path => "/api/0.6/relations", :method => :get }, - { :controller => "api/relations", :action => "index" } + { :path => "/api/0.6/relation/1", :method => :put }, + { :controller => "api/relations", :action => "update", :id => "1" } ) assert_routing( - { :path => "/api/0.6/relations.json", :method => :get }, - { :controller => "api/relations", :action => "index", :format => "json" } + { :path => "/api/0.6/relation/1", :method => :delete }, + { :controller => "api/relations", :action => "destroy", :id => "1" } ) assert_routing( @@ -66,26 +66,144 @@ module Api { :path => "/api/0.6/relation/1/relations.json", :method => :get }, { :controller => "api/relations", :action => "relations_for_relation", :id => "1", :format => "json" } ) + + assert_recognizes( + { :controller => "api/relations", :action => "create" }, + { :path => "/api/0.6/relation/create", :method => :put } + ) + end + + ## + # test fetching multiple relations + def test_index + relation1 = create(:relation) + relation2 = create(:relation, :deleted) + relation3 = create(:relation, :with_history, :version => 2) + relation4 = create(:relation, :with_history, :version => 2) + relation4.old_relations.find_by(:version => 1).redact!(create(:redaction)) + + # check error when no parameter provided + get api_relations_path + assert_response :bad_request + + # check error when no parameter value provided + get api_relations_path(:relations => "") + assert_response :bad_request + + # test a working call + get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}") + assert_response :success + assert_select "osm" do + assert_select "relation", :count => 4 + assert_select "relation[id='#{relation1.id}'][visible='true']", :count => 1 + assert_select "relation[id='#{relation2.id}'][visible='false']", :count => 1 + assert_select "relation[id='#{relation3.id}'][visible='true']", :count => 1 + assert_select "relation[id='#{relation4.id}'][visible='true']", :count => 1 + end + + # test a working call with json format + get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}", :format => "json") + + js = ActiveSupport::JSON.decode(@response.body) + assert_not_nil js + assert_equal 4, js["elements"].count + assert_equal 4, (js["elements"].count { |a| a["type"] == "relation" }) + assert_equal 1, (js["elements"].count { |a| a["id"] == relation1.id && a["visible"].nil? }) + assert_equal 1, (js["elements"].count { |a| a["id"] == relation2.id && a["visible"] == false }) + assert_equal 1, (js["elements"].count { |a| a["id"] == relation3.id && a["visible"].nil? }) + assert_equal 1, (js["elements"].count { |a| a["id"] == relation4.id && a["visible"].nil? }) + + # check error when a non-existent relation is included + get api_relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id},0") + assert_response :not_found end # ------------------------------------- # Test showing relations. # ------------------------------------- - def test_show - # check that a visible relation is returned properly - get api_relation_path(create(:relation)) - assert_response :success + def test_show_not_found + get api_relation_path(0) + assert_response :not_found + end - # check that an invisible relation is not returned + def test_show_deleted get api_relation_path(create(:relation, :deleted)) assert_response :gone + end - # check chat a non-existent relation is not returned - get api_relation_path(0) + def test_show + relation = create(:relation, :timestamp => "2021-02-03T00:00:00Z") + node = create(:node, :timestamp => "2021-04-05T00:00:00Z") + create(:relation_member, :relation => relation, :member => node) + + get api_relation_path(relation) + + assert_response :success + assert_not_nil @response.header["Last-Modified"] + assert_equal "2021-02-03T00:00:00Z", Time.parse(@response.header["Last-Modified"]).utc.xmlschema + assert_dom "node", :count => 0 + assert_dom "relation", :count => 1 do + assert_dom "> @id", :text => relation.id.to_s + end + end + + def test_full_not_found + get relation_full_path(999999) assert_response :not_found end + def test_full_deleted + get relation_full_path(create(:relation, :deleted)) + assert_response :gone + end + + def test_full_empty + relation = create(:relation) + + get relation_full_path(relation) + + assert_response :success + assert_dom "relation", :count => 1 do + assert_dom "> @id", :text => relation.id.to_s + end + end + + def test_full_with_node_member + relation = create(:relation) + node = create(:node) + create(:relation_member, :relation => relation, :member => node) + + get relation_full_path(relation) + + assert_response :success + assert_dom "node", :count => 1 do + assert_dom "> @id", :text => node.id.to_s + end + assert_dom "relation", :count => 1 do + assert_dom "> @id", :text => relation.id.to_s + end + end + + def test_full_with_way_member + relation = create(:relation) + way = create(:way_with_nodes) + create(:relation_member, :relation => relation, :member => way) + + get relation_full_path(relation) + + assert_response :success + assert_dom "node", :count => 1 do + assert_dom "> @id", :text => way.nodes[0].id.to_s + end + assert_dom "way", :count => 1 do + assert_dom "> @id", :text => way.id.to_s + end + assert_dom "relation", :count => 1 do + assert_dom "> @id", :text => relation.id.to_s + end + end + ## # check that all relations containing a particular node, and no extra # relations, are returned from the relations_for_node call. @@ -151,64 +269,6 @@ module Api [relation_with_relation, second_relation]) end - def test_full - # check the "full" mode - get relation_full_path(:id => 999999) - assert_response :not_found - - get relation_full_path(:id => create(:relation, :deleted).id) - assert_response :gone - - get relation_full_path(:id => create(:relation).id) - assert_response :success - # FIXME: check whether this contains the stuff we want! - end - - ## - # test fetching multiple relations - def test_index - relation1 = create(:relation) - relation2 = create(:relation, :deleted) - relation3 = create(:relation, :with_history, :version => 2) - relation4 = create(:relation, :with_history, :version => 2) - relation4.old_relations.find_by(:version => 1).redact!(create(:redaction)) - - # check error when no parameter provided - get relations_path - assert_response :bad_request - - # check error when no parameter value provided - get relations_path(:relations => "") - assert_response :bad_request - - # test a working call - get relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}") - assert_response :success - assert_select "osm" do - assert_select "relation", :count => 4 - assert_select "relation[id='#{relation1.id}'][visible='true']", :count => 1 - assert_select "relation[id='#{relation2.id}'][visible='false']", :count => 1 - assert_select "relation[id='#{relation3.id}'][visible='true']", :count => 1 - assert_select "relation[id='#{relation4.id}'][visible='true']", :count => 1 - end - - # test a working call with json format - get relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id}", :format => "json") - - js = ActiveSupport::JSON.decode(@response.body) - assert_not_nil js - assert_equal 4, js["elements"].count - assert_equal 4, (js["elements"].count { |a| a["type"] == "relation" }) - assert_equal 1, (js["elements"].count { |a| a["id"] == relation1.id && a["visible"].nil? }) - assert_equal 1, (js["elements"].count { |a| a["id"] == relation2.id && a["visible"] == false }) - assert_equal 1, (js["elements"].count { |a| a["id"] == relation3.id && a["visible"].nil? }) - assert_equal 1, (js["elements"].count { |a| a["id"] == relation4.id && a["visible"].nil? }) - - # check error when a non-existent relation is included - get relations_path(:relations => "#{relation1.id},#{relation2.id},#{relation3.id},#{relation4.id},0") - assert_response :not_found - end - # ------------------------------------- # Test simple relation creation. # ------------------------------------- @@ -221,11 +281,11 @@ module Api node = create(:node) way = create(:way_with_nodes, :nodes_count => 2) - auth_header = basic_authorization_header private_user.email, "test" + auth_header = bearer_authorization_header private_user # create an relation without members xml = "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for forbidden, due to user assert_response :forbidden, "relation upload should have failed with forbidden" @@ -236,7 +296,7 @@ module Api xml = "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for forbidden due to user assert_response :forbidden, "relation upload did not return forbidden status" @@ -246,7 +306,7 @@ module Api # need a role attribute to be included xml = "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for forbidden due to user assert_response :forbidden, "relation upload did not return forbidden status" @@ -257,17 +317,17 @@ module Api "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for forbidden, due to user assert_response :forbidden, "relation upload did not return success status" ## Now try with the public user - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # create an relation without members xml = "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for success assert_response :success, "relation upload did not return success status" @@ -295,7 +355,7 @@ module Api xml = "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for success assert_response :success, "relation upload did not return success status" @@ -323,7 +383,7 @@ module Api # need a role attribute to be included xml = "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for success assert_response :success, "relation upload did not return success status" @@ -352,7 +412,7 @@ module Api "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # hope for success assert_response :success, "relation upload did not return success status" @@ -391,7 +451,7 @@ module Api relation = create(:relation) create_list(:relation_tag, 4, :relation => relation) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user with_relation(relation.id) do |rel| # alter one of the tags @@ -423,7 +483,7 @@ module Api relation = create(:relation) create_list(:relation_tag, 4, :relation => relation) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user with_relation(relation.id) do |rel| # alter one of the tags @@ -450,7 +510,7 @@ module Api relation = create(:relation) other_relation = create(:relation) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user with_relation(relation.id) do |rel| update_changeset(rel, changeset.id) put api_relation_path(other_relation), :params => rel.to_s, :headers => auth_header @@ -466,13 +526,13 @@ module Api user = create(:user) changeset = create(:changeset, :user => user) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # create a relation with non-existing node as member xml = "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # expect failure assert_response :precondition_failed, "relation upload with invalid node did not return 'precondition failed'" @@ -487,13 +547,13 @@ module Api changeset = create(:changeset, :user => user) node = create(:node) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # create some xml that should return an error xml = "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header # expect failure assert_response :bad_request assert_match(/Cannot parse valid relation from xml string/, @response.body) @@ -504,7 +564,7 @@ module Api # Test deleting relations. # ------------------------------------- - def test_delete + def test_destroy private_user = create(:user, :data_public => false) private_user_closed_changeset = create(:changeset, :closed, :user => private_user) user = create(:user) @@ -522,7 +582,7 @@ module Api assert_response :unauthorized ## Then try with the private user, to make sure that you get a forbidden - auth_header = basic_authorization_header private_user.email, "test" + auth_header = bearer_authorization_header private_user # this shouldn't work, as we should need the payload... delete api_relation_path(relation), :headers => auth_header @@ -564,7 +624,7 @@ module Api assert_response :forbidden ## now set auth for the public user - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # this shouldn't work, as we should need the payload... delete api_relation_path(relation), :headers => auth_header @@ -641,15 +701,15 @@ module Api # box of all its members into the changeset. def test_tag_modify_bounding_box relation = create(:relation) - node1 = create(:node, :lat => 3, :lon => 3) - node2 = create(:node, :lat => 5, :lon => 5) + node1 = create(:node, :lat => 0.3, :lon => 0.3) + node2 = create(:node, :lat => 0.5, :lon => 0.5) way = create(:way) create(:way_node, :way => way, :node => node1) create(:relation_member, :relation => relation, :member => way) create(:relation_member, :relation => relation, :member => node2) # the relation contains nodes1 and node2 (node1 - # indirectly via the way), so the bbox should be [3,3,5,5]. - check_changeset_modify(BoundingBox.new(3, 3, 5, 5)) do |changeset_id, auth_header| + # indirectly via the way), so the bbox should be [0.3,0.3,0.5,0.5]. + check_changeset_modify(BoundingBox.new(0.3, 0.3, 0.5, 0.5)) do |changeset_id, auth_header| # add a tag to an existing relation relation_xml = xml_for_relation(relation) relation_element = relation_xml.find("//osm/relation").first @@ -743,7 +803,7 @@ module Api way1 = create(:way_with_nodes, :nodes_count => 2) way2 = create(:way_with_nodes, :nodes_count => 2) - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user doc_str = <<~OSM @@ -757,7 +817,7 @@ module Api OSM doc = XML::Parser.string(doc_str).parse - put relation_create_path, :params => doc.to_s, :headers => auth_header + post api_relations_path, :params => doc.to_s, :headers => auth_header assert_response :success, "can't create a relation: #{@response.body}" relation_id = @response.body.to_i @@ -788,7 +848,7 @@ module Api # check the ordering in the history tables: with_controller(OldRelationsController.new) do - get api_old_relation_path(:id => relation_id, :version => 2) + get api_old_relation_path(relation_id, 2) assert_response :success, "can't read back version 2 of the relation #{relation_id}" check_ordering(doc, @response.body) end @@ -816,15 +876,15 @@ module Api doc = XML::Parser.string(doc_str).parse ## First try with the private user - auth_header = basic_authorization_header private_user.email, "test" + auth_header = bearer_authorization_header private_user - put relation_create_path, :params => doc.to_s, :headers => auth_header + post api_relations_path, :params => doc.to_s, :headers => auth_header assert_response :forbidden ## Now try with the public user - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user - put relation_create_path, :params => doc.to_s, :headers => auth_header + post api_relations_path, :params => doc.to_s, :headers => auth_header assert_response :success, "can't create a relation: #{@response.body}" relation_id = @response.body.to_i @@ -855,9 +915,9 @@ module Api OSM doc = XML::Parser.string(doc_str).parse - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user - put relation_create_path, :params => doc.to_s, :headers => auth_header + post api_relations_path, :params => doc.to_s, :headers => auth_header assert_response :success, "can't create a relation: #{@response.body}" relation_id = @response.body.to_i @@ -868,7 +928,7 @@ module Api # check the ordering in the history tables: with_controller(OldRelationsController.new) do - get api_old_relation_path(:id => relation_id, :version => 1) + get api_old_relation_path(relation_id, 1) assert_response :success, "can't read back version 1 of the relation: #{@response.body}" check_ordering(doc, @response.body) end @@ -879,14 +939,14 @@ module Api # still technically valid. def test_remove_all_members relation = create(:relation) - node1 = create(:node, :lat => 3, :lon => 3) - node2 = create(:node, :lat => 5, :lon => 5) + node1 = create(:node, :lat => 0.3, :lon => 0.3) + node2 = create(:node, :lat => 0.5, :lon => 0.5) way = create(:way) create(:way_node, :way => way, :node => node1) create(:relation_member, :relation => relation, :member => way) create(:relation_member, :relation => relation, :member => node2) - check_changeset_modify(BoundingBox.new(3, 3, 5, 5)) do |changeset_id, auth_header| + check_changeset_modify(BoundingBox.new(0.3, 0.3, 0.5, 0.5)) do |changeset_id, auth_header| relation_xml = xml_for_relation(relation) relation_xml .find("//osm/relation/member") @@ -922,14 +982,14 @@ module Api :num_changes => Settings.initial_changes_per_hour - 1) # create authentication header - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # try creating a relation xml = "" \ "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header assert_response :success, "relation create did not return success status" # get the id of the relation we created @@ -953,7 +1013,7 @@ module Api "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header assert_response :too_many_requests, "relation create did not hit rate limit" end @@ -982,14 +1042,14 @@ module Api end # create authentication header - auth_header = basic_authorization_header user.email, "test" + auth_header = bearer_authorization_header user # try creating a relation xml = "" \ "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header assert_response :success, "relation create did not return success status" # get the id of the relation we created @@ -1013,7 +1073,7 @@ module Api "" \ "" \ "" - put relation_create_path, :params => xml, :headers => auth_header + post api_relations_path, :params => xml, :headers => auth_header assert_response :too_many_requests, "relation create did not hit rate limit" end @@ -1062,18 +1122,18 @@ module Api # that the changeset bounding box is +bbox+. def check_changeset_modify(bbox) ## First test with the private user to check that you get a forbidden - auth_header = basic_authorization_header create(:user, :data_public => false).email, "test" + auth_header = bearer_authorization_header create(:user, :data_public => false) # create a new changeset for this operation, so we are assured # that the bounding box will be newly-generated. - changeset_id = with_controller(Api::ChangesetsController.new) do + with_controller(Api::ChangesetsController.new) do xml = "" put changeset_create_path, :params => xml, :headers => auth_header assert_response :forbidden, "shouldn't be able to create changeset for modify test, as should get forbidden" end ## Now do the whole thing with the public user - auth_header = basic_authorization_header create(:user).email, "test" + auth_header = bearer_authorization_header # create a new changeset for this operation, so we are assured # that the bounding box will be newly-generated. @@ -1089,7 +1149,7 @@ module Api # now download the changeset to check its bounding box with_controller(Api::ChangesetsController.new) do - get changeset_show_path(:id => changeset_id) + get changeset_show_path(changeset_id) assert_response :success, "can't re-read changeset for modify test" assert_select "osm>changeset", 1, "Changeset element doesn't exist in #{@response.body}" assert_select "osm>changeset[id='#{changeset_id}']", 1, "Changeset id=#{changeset_id} doesn't exist in #{@response.body}" @@ -1109,7 +1169,7 @@ module Api get api_relation_path(id) else with_controller(OldRelationsController.new) do - get api_old_relation_path(:id => id, :version => ver) + get api_old_relation_path(id, ver) end end assert_response :success @@ -1153,7 +1213,7 @@ module Api change << modify modify << doc.import(rel.find("//osm/relation").first) - post changeset_upload_path(:id => cs_id), :params => doc.to_s, :headers => headers + post changeset_upload_path(cs_id), :params => doc.to_s, :headers => headers assert_response :success, "can't upload diff relation: #{@response.body}" version = xml_parse(@response.body).find("//diffResult/relation").first["new_version"].to_i end