Test some missing cases in the way controller
authorTom Hughes <tom@compton.nu>
Sun, 8 Mar 2015 18:01:19 +0000 (18:01 +0000)
committerTom Hughes <tom@compton.nu>
Sun, 8 Mar 2015 18:01:19 +0000 (18:01 +0000)
app/controllers/node_controller.rb
app/controllers/relation_controller.rb
app/controllers/way_controller.rb
test/controllers/way_controller_test.rb

index 4880c46..a077916 100644 (file)
@@ -43,6 +43,7 @@ class NodeController < ApplicationController
     unless new_node && new_node.id == node.id
       fail OSM::APIBadUserInput.new("The id in the url (#{node.id}) is not the same as provided in the xml (#{new_node.id})")
     end
+
     node.update_from(new_node, @user)
     render :text => node.version.to_s, :content_type => "text/plain"
   end
index 42b8c70..2f8a477 100644 (file)
@@ -14,14 +14,9 @@ class RelationController < ApplicationController
 
     relation = Relation.from_xml(request.raw_post, true)
 
-    # We assume that an exception has been thrown if there was an error
-    # generating the relation
-    # if relation
+    # Assume that Relation.from_xml has thrown an exception if there is an error parsing the xml
     relation.create_with_history @user
     render :text => relation.id.to_s, :content_type => "text/plain"
-    # else
-    # render :text => "Couldn't get turn the input into a relation.", :status => :bad_request
-    # end
   end
 
   def read
@@ -40,12 +35,12 @@ class RelationController < ApplicationController
     relation = Relation.find(params[:id])
     new_relation = Relation.from_xml(request.raw_post)
 
-    if new_relation && new_relation.id == relation.id
-      relation.update_from new_relation, @user
-      render :text => relation.version.to_s, :content_type => "text/plain"
-    else
-      render :text => "", :status => :bad_request
+    unless new_relation && new_relation.id == relation.id
+      fail OSM::APIBadUserInput.new("The id in the url (#{relation.id}) is not the same as provided in the xml (#{new_relation.id})")
     end
+
+    relation.update_from new_relation, @user
+    render :text => relation.version.to_s, :content_type => "text/plain"
   end
 
   def delete
index dd9b65f..e7a968a 100644 (file)
@@ -14,12 +14,9 @@ class WayController < ApplicationController
 
     way = Way.from_xml(request.raw_post, true)
 
-    if way
-      way.create_with_history @user
-      render :text => way.id.to_s, :content_type => "text/plain"
-    else
-      render :text => "", :status => :bad_request
-    end
+    # Assume that Way.from_xml has thrown an exception if there is an error parsing the xml
+    way.create_with_history @user
+    render :text => way.id.to_s, :content_type => "text/plain"
   end
 
   def read
@@ -38,12 +35,12 @@ class WayController < ApplicationController
     way = Way.find(params[:id])
     new_way = Way.from_xml(request.raw_post)
 
-    if new_way && new_way.id == way.id
-      way.update_from(new_way, @user)
-      render :text => way.version.to_s, :content_type => "text/plain"
-    else
-      render :text => "", :status => :bad_request
+    unless new_way && new_way.id == way.id
+      fail OSM::APIBadUserInput.new("The id in the url (#{way.id}) is not the same as provided in the xml (#{new_way.id})")
     end
+
+    way.update_from(new_way, @user)
+    render :text => way.version.to_s, :content_type => "text/plain"
   end
 
   # This is the API call to delete a way
index ee68338..8226f43 100644 (file)
@@ -356,10 +356,181 @@ class WayControllerTest < ActionController::TestCase
     assert_response :not_found
   end
 
+  ##
+  # tests whether the API works and prevents incorrect use while trying
+  # to update ways.
+  def test_update
+    ## First test with no user credentials
+    # try and update a way without authorisation
+    # first try to delete way without auth
+    content current_ways(:visible_way).to_xml
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :unauthorized
+
+    ## Second test with the private user
+
+    # setup auth
+    basic_authorization(users(:normal_user).email, "test")
+
+    ## trying to break changesets
+
+    # try and update in someone else's changeset
+    content update_changeset(current_ways(:visible_way).to_xml,
+                             changesets(:public_user_first_change).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data "update with other user's changeset should be forbidden when date isn't public"
+
+    # try and update in a closed changeset
+    content update_changeset(current_ways(:visible_way).to_xml,
+                             changesets(:normal_user_closed_change).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data "update with closed changeset should be forbidden, when data isn't public"
+
+    # try and update in a non-existant changeset
+    content update_changeset(current_ways(:visible_way).to_xml, 0)
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data("update with changeset=0 should be forbidden, when data isn't public")
+
+    ## try and submit invalid updates
+    content xml_replace_node(current_ways(:visible_way).to_xml, 3, 9999)
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data "way with non-existent node should be forbidden, when data isn't public"
+
+    content xml_replace_node(current_ways(:visible_way).to_xml, 3, current_nodes(:invisible_node).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data "way with deleted node should be forbidden, when data isn't public"
+
+    ## finally, produce a good request which should work
+    content current_ways(:visible_way).to_xml
+    put :update, :id => current_ways(:visible_way).id
+    assert_require_public_data "should have failed with a forbidden when data isn't public"
+
+    ## Finally test with the public user
+
+    # try and update a way without authorisation
+    # first try to delete way without auth
+    content current_ways(:visible_way).to_xml
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :forbidden
+
+    # setup auth
+    basic_authorization(users(:public_user).email, "test")
+
+    ## trying to break changesets
+
+    # try and update in someone else's changeset
+    content update_changeset(current_ways(:visible_way).to_xml,
+                             changesets(:normal_user_first_change).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict, "update with other user's changeset should be rejected"
+
+    # try and update in a closed changeset
+    content update_changeset(current_ways(:visible_way).to_xml,
+                             changesets(:normal_user_closed_change).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict, "update with closed changeset should be rejected"
+
+    # try and update in a non-existant changeset
+    content update_changeset(current_ways(:visible_way).to_xml, 0)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict, "update with changeset=0 should be rejected"
+
+    ## try and submit invalid updates
+    content xml_replace_node(current_ways(:visible_way).to_xml, 3, 9999)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :precondition_failed, "way with non-existent node should be rejected"
+
+    content xml_replace_node(current_ways(:visible_way).to_xml, 3, current_nodes(:invisible_node).id)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :precondition_failed, "way with deleted node should be rejected"
+
+    ## next, attack the versioning
+    current_way_version = current_ways(:visible_way).version
+
+    # try and submit a version behind
+    content xml_attr_rewrite(current_ways(:visible_way).to_xml,
+                             "version", current_way_version - 1)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict, "should have failed on old version number"
+
+    # try and submit a version ahead
+    content xml_attr_rewrite(current_ways(:visible_way).to_xml,
+                             "version", current_way_version + 1)
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict, "should have failed on skipped version number"
+
+    # try and submit total crap in the version field
+    content xml_attr_rewrite(current_ways(:visible_way).to_xml,
+                             "version", "p1r4t3s!")
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :conflict,
+                    "should not be able to put 'p1r4at3s!' in the version field"
+
+    ## try an update with the wrong ID
+    content current_ways(:used_way).to_xml
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :bad_request,
+                    "should not be able to update a way with a different ID from the XML"
+
+    ## try an update with a minimal valid XML doc which isn't a well-formed OSM doc.
+    content "<update/>"
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :bad_request,
+                    "should not be able to update a way with non-OSM XML doc."
+
+    ## finally, produce a good request which should work
+    content current_ways(:visible_way).to_xml
+    put :update, :id => current_ways(:visible_way).id
+    assert_response :success, "a valid update request failed"
+  end
+
   # ------------------------------------------------------------
   # test tags handling
   # ------------------------------------------------------------
 
+  ##
+  # Try adding a new tag to a way
+  def test_add_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"] = "new"
+    tag_xml["v"] = "yes"
+
+    # 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"] = "new"
+    tag_xml["v"] = "yes"
+
+    # 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 :success,
+                    "adding a new tag to a way should succeed"
+    assert_equal current_ways(:visible_way).version + 1, @response.body.to_i
+  end
+
   ##
   # Try adding a duplicate of an existing tag to a way
   def test_add_duplicate_tags
@@ -517,15 +688,22 @@ class WayControllerTest < ActionController::TestCase
   end
 
   ##
-  # update the changeset_id of a node element
+  # update the changeset_id of a way element
   def update_changeset(xml, changeset_id)
     xml_attr_rewrite(xml, "changeset", changeset_id)
   end
 
   ##
-  # update an attribute in the node element
+  # update an attribute in the way element
   def xml_attr_rewrite(xml, name, value)
     xml.find("//osm/way").first[name] = value.to_s
     xml
   end
+
+  ##
+  # replace a node in a way element
+  def xml_replace_node(xml, old_node, new_node)
+    xml.find("//osm/way/nd[@ref='#{old_node}']").first["ref"] = new_node.to_s
+    xml
+  end
 end