require File.dirname(__FILE__) + '/../test_helper'
require 'way_controller'
-# Re-raise errors caught by the controller.
-class WayController; def rescue_action(e) raise e end; end
-
-class WayControllerTest < Test::Unit::TestCase
+class WayControllerTest < ActionController::TestCase
api_fixtures
- def setup
- @controller = WayController.new
- @request = ActionController::TestRequest.new
- @response = ActionController::TestResponse.new
- end
-
- def basic_authorization(user, pass)
- @request.env["HTTP_AUTHORIZATION"] = "Basic %s" % Base64.encode64("#{user}:#{pass}")
- end
-
- def content(c)
- @request.env["RAW_POST_DATA"] = c.to_s
+ ##
+ # test all routes which lead to this controller
+ def test_routes
+ assert_routing(
+ { :path => "/api/0.6/way/create", :method => :put },
+ { :controller => "way", :action => "create" }
+ )
+ assert_routing(
+ { :path => "/api/0.6/way/1/full", :method => :get },
+ { :controller => "way", :action => "full", :id => "1" }
+ )
+ assert_routing(
+ { :path => "/api/0.6/way/1", :method => :get },
+ { :controller => "way", :action => "read", :id => "1" }
+ )
+ assert_routing(
+ { :path => "/api/0.6/way/1", :method => :put },
+ { :controller => "way", :action => "update", :id => "1" }
+ )
+ assert_routing(
+ { :path => "/api/0.6/way/1", :method => :delete },
+ { :controller => "way", :action => "delete", :id => "1" }
+ )
+ assert_routing(
+ { :path => "/api/0.6/ways", :method => :get },
+ { :controller => "way", :action => "ways" }
+ )
end
# -------------------------------------
# check chat a non-existent way is not returned
get :read, :id => 0
assert_response :not_found
+ end
- # check the "ways for node" mode
- get :ways_for_node, :id => current_nodes(:used_node_1).id
- assert_response :success
- # FIXME check whether this contains the stuff we want!
- #print @response.body
- # Needs to be updated when changing fixtures
- # The generator should probably be defined in the environment.rb file
- # in the same place as the api version
- assert_select "osm[version=#{API_VERSION}][generator=\"OpenStreetMap server\"]", 1
- assert_select "osm way", 3
- assert_select "osm way nd", 3
- assert_select "osm way tag", 3
-
- # check the "full" mode
- get :full, :id => current_ways(:visible_way).id
+ ##
+ # check the "full" mode
+ def test_full
+ Way.all.each do |way|
+ get :full, :id => way.id
+
+ # full call should say "gone" for non-visible ways...
+ unless way.visible
+ assert_response :gone
+ next
+ end
+
+ # otherwise it should say success
+ assert_response :success
+
+ # Check the way is correctly returned
+ assert_select "osm way[id=#{way.id}][version=#{way.version}][visible=#{way.visible}]", 1
+
+ # check that each node in the way appears once in the output as a
+ # reference and as the node element.
+ way.nodes.each do |n|
+ count = (way.nodes - (way.nodes - [n])).length
+ assert_select "osm way nd[ref=#{n.id}]", count
+ assert_select "osm node[id=#{n.id}][version=#{n.version}][lat=#{n.lat}][lon=#{n.lon}]", 1
+ end
+ end
+ end
+
+ ##
+ # test fetching multiple ways
+ def test_ways
+ # check error when no parameter provided
+ get :ways
+ assert_response :bad_request
+
+ # check error when no parameter value provided
+ get :ways, :ways => ""
+ assert_response :bad_request
+
+ # test a working call
+ get :ways, :ways => "1,2,4,6"
assert_response :success
- # FIXME check whether this contains the stuff we want!
- #print @response.body
- # Check the way is correctly returned
- way = current_ways(:visible_way)
- assert_select "osm way[id=#{way.id}][version=#{way.version}][visible=#{way.visible}]", 1
- assert_select "osm way nd[ref=#{way.way_nodes[0].node_id}]", 1
- # Check that the node is correctly returned
- nd = current_ways(:visible_way).nodes
- assert_equal 1, nd.count
- nda = nd[0]
- assert_select "osm node[id=#{nda.id}][version=#{nda.version}][lat=#{nda.lat}][lon=#{nda.lon}]", 1
+ assert_select "osm" do
+ assert_select "way", :count => 4
+ assert_select "way[id=1][visible=true]", :count => 1
+ assert_select "way[id=2][visible=false]", :count => 1
+ assert_select "way[id=4][visible=true]", :count => 1
+ assert_select "way[id=6][visible=true]", :count => 1
+ end
+
+ # check error when a non-existent way is included
+ get :ways, :ways => "1,2,4,6,400"
+ assert_response :not_found
end
# -------------------------------------
# -------------------------------------
def test_create
+ ## First check that it fails when creating a way using a non-public user
nid1 = current_nodes(:used_node_1).id
nid2 = current_nodes(:used_node_2).id
- basic_authorization "test@openstreetmap.org", "test"
+ basic_authorization users(:normal_user).email, "test"
# use the first user's open changeset
changeset_id = changesets(:normal_user_first_change).id
+ # create a way with pre-existing nodes
+ content "<osm><way changeset='#{changeset_id}'>" +
+ "<nd ref='#{nid1}'/><nd ref='#{nid2}'/>" +
+ "<tag k='test' v='yes' /></way></osm>"
+ put :create
+ # hope for success
+ assert_response :forbidden,
+ "way upload did not return success status"
+ # read id of created way and search for it
+ wayid = @response.body
+
+ ## Now use a public user
+ nid1 = current_nodes(:used_node_1).id
+ nid2 = current_nodes(:used_node_2).id
+ basic_authorization users(:public_user).email, "test"
+
+ # use the first user's open changeset
+ changeset_id = changesets(:public_user_first_change).id
+
# create a way with pre-existing nodes
content "<osm><way changeset='#{changeset_id}'>" +
"<nd ref='#{nid1}'/><nd ref='#{nid2}'/>" +
"saved way does not contain the right node on pos 1"
assert_equal checkway.changeset_id, changeset_id,
"saved way does not belong to the correct changeset"
- assert_equal users(:normal_user).id, checkway.changeset.user_id,
+ assert_equal users(:public_user).id, checkway.changeset.user_id,
"saved way does not belong to user that created it"
assert_equal true, checkway.visible,
"saved way is not visible"
# -------------------------------------
def test_create_invalid
- basic_authorization "test@openstreetmap.org", "test"
+ ## First test with a private user to make sure that they are not authorized
+ basic_authorization users(:normal_user).email, "test"
# use the first user's open changeset
open_changeset_id = changesets(:normal_user_first_change).id
closed_changeset_id = changesets(:normal_user_closed_change).id
nid1 = current_nodes(:used_node_1).id
+ # create a way with non-existing node
+ content "<osm><way changeset='#{open_changeset_id}'>" +
+ "<nd ref='0'/><tag k='test' v='yes' /></way></osm>"
+ put :create
+ # expect failure
+ assert_response :forbidden,
+ "way upload with invalid node using a private user did not return 'forbidden'"
+
+ # create a way with no nodes
+ content "<osm><way changeset='#{open_changeset_id}'>" +
+ "<tag k='test' v='yes' /></way></osm>"
+ put :create
+ # expect failure
+ assert_response :forbidden,
+ "way upload with no node using a private userdid not return 'forbidden'"
+
+ # create a way inside a closed changeset
+ content "<osm><way changeset='#{closed_changeset_id}'>" +
+ "<nd ref='#{nid1}'/></way></osm>"
+ put :create
+ # expect failure
+ assert_response :forbidden,
+ "way upload to closed changeset with a private user did not return 'forbidden'"
+
+
+ ## Now test with a public user
+ basic_authorization users(:public_user).email, "test"
+
+ # use the first user's open changeset
+ open_changeset_id = changesets(:public_user_first_change).id
+ closed_changeset_id = changesets(:public_user_closed_change).id
+ nid1 = current_nodes(:used_node_1).id
+
# create a way with non-existing node
content "<osm><way changeset='#{open_changeset_id}'>" +
"<nd ref='0'/><tag k='test' v='yes' /></way></osm>"
# expect failure
assert_response :precondition_failed,
"way upload with invalid node did not return 'precondition failed'"
+ assert_equal "Precondition failed: Way requires the nodes with id in (0), which either do not exist, or are not visible.", @response.body
# create a way with no nodes
content "<osm><way changeset='#{open_changeset_id}'>" +
# expect failure
assert_response :precondition_failed,
"way upload with no node did not return 'precondition failed'"
+ assert_equal "Precondition failed: Cannot create way: data is invalid.", @response.body
# create a way inside a closed changeset
content "<osm><way changeset='#{closed_changeset_id}'>" +
# expect failure
assert_response :conflict,
"way upload to closed changeset did not return 'conflict'"
+
+ # create a way with a tag which is too long
+ content "<osm><way changeset='#{open_changeset_id}'>" +
+ "<nd ref='#{nid1}'/>" +
+ "<tag k='foo' v='#{'x'*256}'/>" +
+ "</way></osm>"
+ put :create
+ # expect failure
+ assert_response :bad_request,
+ "way upload to with too long tag did not return 'bad_request'"
end
# -------------------------------------
delete :delete, :id => current_ways(:visible_way).id
assert_response :unauthorized
+ # now set auth using the private user
+ basic_authorization(users(:normal_user).email, "test");
+
+ # this shouldn't work as with the 0.6 api we need pay load to delete
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :forbidden
+
+ # Now try without having a changeset
+ content "<osm><way id='#{current_ways(:visible_way).id}'/></osm>"
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :forbidden
+
+ # try to delete with an invalid (closed) changeset
+ content update_changeset(current_ways(:visible_way).to_xml,
+ changesets(:normal_user_closed_change).id)
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :forbidden
+
+ # try to delete with an invalid (non-existent) changeset
+ content update_changeset(current_ways(:visible_way).to_xml,0)
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :forbidden
+
+ # Now try with a valid changeset
+ content current_ways(:visible_way).to_xml
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :forbidden
+
+ # check the returned value - should be the new version number
+ # valid delete should return the new version number, which should
+ # be greater than the old version number
+ #assert @response.body.to_i > current_ways(:visible_way).version,
+ # "delete request should return a new version number for way"
+
+ # this won't work since the way is already deleted
+ content current_ways(:invisible_way).to_xml
+ delete :delete, :id => current_ways(:invisible_way).id
+ assert_response :forbidden
+
+ # this shouldn't work as the way is used in a relation
+ content current_ways(:used_way).to_xml
+ delete :delete, :id => current_ways(:used_way).id
+ assert_response :forbidden,
+ "shouldn't be able to delete a way used in a relation (#{@response.body}), when done by a private user"
+
+ # this won't work since the way never existed
+ delete :delete, :id => 0
+ assert_response :forbidden
+
+
+ ### Now check with a public user
# now set auth
- basic_authorization("test@openstreetmap.org", "test");
+ basic_authorization(users(:public_user).email, "test");
# this shouldn't work as with the 0.6 api we need pay load to delete
delete :delete, :id => current_ways(:visible_way).id
assert_response :bad_request
# Now try without having a changeset
- content "<osm><way id='#{current_ways(:visible_way).id}'></osm>"
+ content "<osm><way id='#{current_ways(:visible_way).id}'/></osm>"
delete :delete, :id => current_ways(:visible_way).id
assert_response :bad_request
- # Now try and get a changeset
- changeset_id = changesets(:normal_user_first_change).id
+ # try to delete with an invalid (closed) changeset
+ content update_changeset(current_ways(:visible_way).to_xml,
+ changesets(:public_user_closed_change).id)
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :conflict
+
+ # try to delete with an invalid (non-existent) changeset
+ content update_changeset(current_ways(:visible_way).to_xml,0)
+ delete :delete, :id => current_ways(:visible_way).id
+ assert_response :conflict
+
+ # Now try with a valid changeset
content current_ways(:visible_way).to_xml
delete :delete, :id => current_ways(:visible_way).id
assert_response :success
+ # check the returned value - should be the new version number
+ # valid delete should return the new version number, which should
+ # be greater than the old version number
+ assert @response.body.to_i > current_ways(:visible_way).version,
+ "delete request should return a new version number for way"
+
# this won't work since the way is already deleted
content current_ways(:invisible_way).to_xml
delete :delete, :id => current_ways(:invisible_way).id
assert_response :gone
+ # this shouldn't work as the way is used in a relation
+ content current_ways(:used_way).to_xml
+ delete :delete, :id => current_ways(:used_way).id
+ assert_response :precondition_failed,
+ "shouldn't be able to delete a way used in a relation (#{@response.body})"
+ assert_equal "Precondition failed: Way 3 is still used by relations 1.", @response.body
+
# this won't work since the way never existed
delete :delete, :id => 0
assert_response :not_found
end
+ # ------------------------------------------------------------
+ # test tags handling
+ # ------------------------------------------------------------
+
+ ##
+ # Try adding a duplicate of an existing tag to a way
+ def test_add_duplicate_tags
+ ## Try with the non-public user
+ # setup auth
+ basic_authorization(users(:normal_user).email, "test")
+
+ # add an identical tag to the way
+ tag_xml = XML::Node.new("tag")
+ tag_xml['k'] = current_way_tags(:t1).k
+ tag_xml['v'] = current_way_tags(:t1).v
+
+ # add the tag into the existing xml
+ way_xml = current_ways(:visible_way).to_xml
+ way_xml.find("//osm/way").first << tag_xml
+
+ # try and upload it
+ content way_xml
+ put :update, :id => current_ways(:visible_way).id
+ assert_response :forbidden,
+ "adding a duplicate tag to a way for a non-public should fail with 'forbidden'"
+
+ ## Now try with the public user
+ # setup auth
+ basic_authorization(users(:public_user).email, "test")
+
+ # add an identical tag to the way
+ tag_xml = XML::Node.new("tag")
+ tag_xml['k'] = current_way_tags(:t1).k
+ tag_xml['v'] = current_way_tags(:t1).v
+
+ # add the tag into the existing xml
+ way_xml = current_ways(:visible_way).to_xml
+ way_xml.find("//osm/way").first << tag_xml
+
+ # try and upload it
+ content way_xml
+ put :update, :id => current_ways(:visible_way).id
+ assert_response :bad_request,
+ "adding a duplicate tag to a way should fail with 'bad request'"
+ assert_equal "Element way/#{current_ways(:visible_way).id} has duplicate tags with key #{current_way_tags(:t1).k}", @response.body
+ end
+
+ ##
+ # Try adding a new duplicate tags to a way
+ def test_new_duplicate_tags
+ ## First test with the non-public user so should be rejected
+ # setup auth
+ basic_authorization(users(:normal_user).email, "test")
+
+ # create duplicate tag
+ tag_xml = XML::Node.new("tag")
+ tag_xml['k'] = "i_am_a_duplicate"
+ tag_xml['v'] = "foobar"
+
+ # add the tag into the existing xml
+ way_xml = current_ways(:visible_way).to_xml
+
+ # add two copies of the tag
+ way_xml.find("//osm/way").first << tag_xml.copy(true) << tag_xml
+
+ # try and upload it
+ content way_xml
+ put :update, :id => current_ways(:visible_way).id
+ assert_response :forbidden,
+ "adding new duplicate tags to a way using a non-public user should fail with 'forbidden'"
+
+ ## Now test with the public user
+ # setup auth
+ basic_authorization(users(:public_user).email, "test")
+
+ # create duplicate tag
+ tag_xml = XML::Node.new("tag")
+ tag_xml['k'] = "i_am_a_duplicate"
+ tag_xml['v'] = "foobar"
+
+ # add the tag into the existing xml
+ way_xml = current_ways(:visible_way).to_xml
+
+ # add two copies of the tag
+ way_xml.find("//osm/way").first << tag_xml.copy(true) << tag_xml
+
+ # try and upload it
+ content way_xml
+ put :update, :id => current_ways(:visible_way).id
+ assert_response :bad_request,
+ "adding new duplicate tags to a way should fail with 'bad request'"
+ assert_equal "Element way/#{current_ways(:visible_way).id} has duplicate tags with key i_am_a_duplicate", @response.body
+
+ end
+
+ ##
+ # Try adding a new duplicate tags to a way.
+ # But be a bit subtle - use unicode decoding ambiguities to use different
+ # binary strings which have the same decoding.
+ def test_invalid_duplicate_tags
+ ## First make sure that you can't with a non-public user
+ # setup auth
+ basic_authorization(users(:normal_user).email, "test")
+
+ # add the tag into the existing xml
+ way_str = "<osm><way changeset='1'>"
+ way_str << "<tag k='addr:housenumber' v='1'/>"
+ way_str << "<tag k='addr:housenumber' v='2'/>"
+ way_str << "</way></osm>";
+
+ # try and upload it
+ content way_str
+ put :create
+ assert_response :forbidden,
+ "adding new duplicate tags to a way with a non-public user should fail with 'forbidden'"
+
+ ## Now do it with a public user
+ # setup auth
+ basic_authorization(users(:public_user).email, "test")
+
+ # add the tag into the existing xml
+ way_str = "<osm><way changeset='1'>"
+ way_str << "<tag k='addr:housenumber' v='1'/>"
+ way_str << "<tag k='addr:housenumber' v='2'/>"
+ way_str << "</way></osm>";
+
+ # try and upload it
+ content way_str
+ put :create
+ assert_response :bad_request,
+ "adding new duplicate tags to a way should fail with 'bad request'"
+ assert_equal "Element way/ has duplicate tags with key addr:housenumber", @response.body
+ end
+
+ ##
+ # test that a call to ways_for_node returns all ways that contain the node
+ # and none that don't.
+ def test_ways_for_node
+ # in current fixtures ways 1 and 3 all use node 3. ways 2 and 4
+ # *used* to use it but doesn't.
+ get :ways_for_node, :id => current_nodes(:used_node_1).id
+ assert_response :success
+ ways_xml = XML::Parser.string(@response.body).parse
+ assert_not_nil ways_xml, "failed to parse ways_for_node response"
+
+ # check that the set of IDs match expectations
+ expected_way_ids = [ current_ways(:visible_way).id,
+ current_ways(:used_way).id
+ ]
+ found_way_ids = ways_xml.find("//osm/way").collect { |w| w["id"].to_i }
+ assert_equal expected_way_ids.sort, found_way_ids.sort,
+ "expected ways for node #{current_nodes(:used_node_1).id} did not match found"
+
+ # check the full ways to ensure we're not missing anything
+ expected_way_ids.each do |id|
+ way_xml = ways_xml.find("//osm/way[@id=#{id}]").first
+ assert_ways_are_equal(Way.find(id),
+ Way.from_xml_node(way_xml))
+ end
+ end
+
+ ##
+ # update the changeset_id of a node element
+ def update_changeset(xml, changeset_id)
+ xml_attr_rewrite(xml, 'changeset', changeset_id)
+ end
+
+ ##
+ # update an attribute in the node element
+ def xml_attr_rewrite(xml, name, value)
+ xml.find("//osm/way").first[name] = value.to_s
+ return xml
+ end
end