]> git.openstreetmap.org Git - rails.git/blobdiff - test/functional/relation_controller_test.rb
Adding more tests for updating relation tags.
[rails.git] / test / functional / relation_controller_test.rb
index ed595136561bdb9c255dd0b3b03cab77be548487..9ecac826cb441af6398be1f8fb8840480c1cdde2 100644 (file)
@@ -4,14 +4,6 @@ require 'relation_controller'
 class RelationControllerTest < ActionController::TestCase
   api_fixtures
 
-  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
-  end
-
   # -------------------------------------
   # Test reading relations.
   # -------------------------------------
@@ -117,10 +109,45 @@ class RelationControllerTest < ActionController::TestCase
     assert_response :success
 
 
+    ###
     # create an relation with a node as member
+    # This time try with a role attribute in the relation
     nid = current_nodes(:used_node_1).id
     content "<osm><relation changeset='#{changeset_id}'>" +
-      "<member type='node' ref='#{nid}' role='some'/>" +
+      "<member  ref='#{nid}' type='node' role='some'/>" +
+      "<tag k='test' v='yes' /></relation></osm>"
+    put :create
+    # hope for success
+    assert_response :success, 
+        "relation upload did not return success status"
+    # read id of created relation and search for it
+    relationid = @response.body
+    checkrelation = Relation.find(relationid)
+    assert_not_nil checkrelation, 
+        "uploaded relation not found in data base after upload"
+    # compare values
+    assert_equal checkrelation.members.length, 1, 
+        "saved relation does not contain exactly one member"
+    assert_equal checkrelation.tags.length, 1, 
+        "saved relation does not contain exactly one tag"
+    assert_equal changeset_id, checkrelation.changeset.id,
+        "saved relation does not belong in the changeset it was assigned to"
+    assert_equal users(:normal_user).id, checkrelation.changeset.user_id, 
+        "saved relation does not belong to user that created it"
+    assert_equal true, checkrelation.visible, 
+        "saved relation is not visible"
+    # ok the relation is there but can we also retrieve it?
+    
+    get :read, :id => relationid
+    assert_response :success
+    
+    
+    ###
+    # create an relation with a node as member, this time test that we don't 
+    # need a role attribute to be included
+    nid = current_nodes(:used_node_1).id
+    content "<osm><relation changeset='#{changeset_id}'>" +
+      "<member  ref='#{nid}' type='node'/>"+
       "<tag k='test' v='yes' /></relation></osm>"
     put :create
     # hope for success
@@ -147,6 +174,7 @@ class RelationControllerTest < ActionController::TestCase
     get :read, :id => relationid
     assert_response :success
 
+    ###
     # create an relation with a way and a node as members
     nid = current_nodes(:used_node_1).id
     wid = current_ways(:used_way).id
@@ -180,6 +208,68 @@ class RelationControllerTest < ActionController::TestCase
 
   end
 
+  # ------------------------------------
+  # Test updating relations
+  # ------------------------------------
+
+  ##
+  # test that, when tags are updated on a relation, the correct things
+  # happen to the correct tables and the API gives sensible results. 
+  # this is to test a case that gregory marler noticed and posted to
+  # josm-dev.
+  def test_update_relation_tags
+    basic_authorization "test@example.com", "test"
+    rel_id = current_relations(:multi_tag_relation).id
+    cs_id = changesets(:public_user_first_change).id
+
+    with_relation(rel_id) do |rel|
+      # alter one of the tags
+      tag = rel.find("//osm/relation/tag").first
+      tag['v'] = 'some changed value'
+      update_changeset(rel, cs_id)
+
+      # check that the downloaded tags are the same as the uploaded tags...
+      new_version = with_update(rel) do |new_rel|
+        assert_tags_equal rel, new_rel
+      end
+
+      # check the original one in the current_* table again
+      with_relation(rel_id) { |r| assert_tags_equal rel, r }
+
+      # now check the version in the history
+      with_relation(rel_id, new_version) { |r| assert_tags_equal rel, r }
+    end
+  end
+
+  ##
+  # test that, when tags are updated on a relation when using the diff
+  # upload function, the correct things happen to the correct tables 
+  # and the API gives sensible results. this is to test a case that 
+  # gregory marler noticed and posted to josm-dev.
+  def test_update_relation_tags_via_upload
+    basic_authorization "test@example.com", "test"
+    rel_id = current_relations(:multi_tag_relation).id
+    cs_id = changesets(:public_user_first_change).id
+
+    with_relation(rel_id) do |rel|
+      # alter one of the tags
+      tag = rel.find("//osm/relation/tag").first
+      tag['v'] = 'some changed value'
+      update_changeset(rel, cs_id)
+
+      # check that the downloaded tags are the same as the uploaded tags...
+      new_version = with_update_diff(rel) do |new_rel|
+        assert_tags_equal rel, new_rel
+      end
+
+      # check the original one in the current_* table again
+      with_relation(rel_id) { |r| assert_tags_equal rel, r }
+
+      # now check the version in the history
+      with_relation(rel_id, new_version) { |r| assert_tags_equal rel, r }
+    end
+  end
+
   # -------------------------------------
   # Test creating some invalid relations.
   # -------------------------------------
@@ -200,6 +290,27 @@ class RelationControllerTest < ActionController::TestCase
         "relation upload with invalid node did not return 'precondition failed'"
   end
 
+  # -------------------------------------
+  # Test creating a relation, with some invalid XML
+  # -------------------------------------
+  def test_create_invalid_xml
+    basic_authorization "test@openstreetmap.org", "test"
+    
+    # put the relation in a dummy fixture changeset that works
+    changeset_id = changesets(:normal_user_first_change).id
+    
+    # create some xml that should return an error
+    content "<osm><relation changeset='#{changeset_id}'>" +
+    "<member type='type' ref='#{current_nodes(:used_node_1).id}' role=''/>" +
+    "<tag k='tester' v='yep'/></relation></osm>"
+    put :create
+    # expect failure
+    assert_response :bad_request
+    assert_match(/Cannot parse valid relation from xml string/, @response.body)
+    assert_match(/The type is not allowed only, /, @response.body)
+  end
+  
+  
   # -------------------------------------
   # Test deleting relations.
   # -------------------------------------
@@ -219,7 +330,8 @@ class RelationControllerTest < ActionController::TestCase
     # try to delete without specifying a changeset
     content "<osm><relation id='#{current_relations(:visible_relation).id}'/></osm>"
     delete :delete, :id => current_relations(:visible_relation).id
-    assert_response :conflict
+    assert_response :bad_request
+    assert_match(/You are missing the required changeset in the relation/, @response.body)
 
     # try to delete with an invalid (closed) changeset
     content update_changeset(current_relations(:visible_relation).to_xml,
@@ -265,6 +377,302 @@ class RelationControllerTest < ActionController::TestCase
     assert_response :not_found
   end
 
+  ##
+  # when a relation's tag is modified then it should put the bounding
+  # box of all its members into the changeset.
+  def test_tag_modify_bounding_box
+    # in current fixtures, relation 5 contains nodes 3 and 5 (node 3
+    # indirectly via way 3), so the bbox should be [3,3,5,5].
+    check_changeset_modify([3,3,5,5]) do |changeset_id|
+      # add a tag to an existing relation
+      relation_xml = current_relations(:visible_relation).to_xml
+      relation_element = relation_xml.find("//osm/relation").first
+      new_tag = XML::Node.new("tag")
+      new_tag['k'] = "some_new_tag"
+      new_tag['v'] = "some_new_value"
+      relation_element << new_tag
+      
+      # update changeset ID to point to new changeset
+      update_changeset(relation_xml, changeset_id)
+      
+      # upload the change
+      content relation_xml
+      put :update, :id => current_relations(:visible_relation).id
+      assert_response :success, "can't update relation for tag/bbox test"
+    end
+  end
+
+  ##
+  # add a member to a relation and check the bounding box is only that
+  # element.
+  def test_add_member_bounding_box
+    check_changeset_modify([4,4,4,4]) do |changeset_id|
+      # add node 4 (4,4) to an existing relation
+      relation_xml = current_relations(:visible_relation).to_xml
+      relation_element = relation_xml.find("//osm/relation").first
+      new_member = XML::Node.new("member")
+      new_member['ref'] = current_nodes(:used_node_2).id.to_s
+      new_member['type'] = "node"
+      new_member['role'] = "some_role"
+      relation_element << new_member
+      
+      # update changeset ID to point to new changeset
+      update_changeset(relation_xml, changeset_id)
+      
+      # upload the change
+      content relation_xml
+      put :update, :id => current_relations(:visible_relation).id
+      assert_response :success, "can't update relation for add node/bbox test"
+    end
+  end
+  
+  ##
+  # remove a member from a relation and check the bounding box is 
+  # only that element.
+  def test_remove_member_bounding_box
+    check_changeset_modify([5,5,5,5]) do |changeset_id|
+      # remove node 5 (5,5) from an existing relation
+      relation_xml = current_relations(:visible_relation).to_xml
+      relation_xml.
+        find("//osm/relation/member[@type='node'][@ref='5']").
+        first.remove!
+      
+      # update changeset ID to point to new changeset
+      update_changeset(relation_xml, changeset_id)
+      
+      # upload the change
+      content relation_xml
+      put :update, :id => current_relations(:visible_relation).id
+      assert_response :success, "can't update relation for remove node/bbox test"
+    end
+  end
+  
+  ##
+  # check that relations are ordered
+  def test_relation_member_ordering
+    basic_authorization("test@openstreetmap.org", "test");  
+
+    doc_str = <<OSM
+<osm>
+ <relation changeset='1'>
+  <member ref='1' type='node' role='first'/>
+  <member ref='3' type='node' role='second'/>
+  <member ref='1' type='way' role='third'/>
+  <member ref='3' type='way' role='fourth'/>
+ </relation>
+</osm>
+OSM
+    doc = XML::Parser.string(doc_str).parse
+
+    content doc
+    put :create
+    assert_response :success, "can't create a relation: #{@response.body}"
+    relation_id = @response.body.to_i
+
+    # get it back and check the ordering
+    get :read, :id => relation_id
+    assert_response :success, "can't read back the relation: #{@response.body}"
+    check_ordering(doc, @response.body)
+
+    # insert a member at the front
+    new_member = XML::Node.new "member"
+    new_member['ref'] = 5.to_s
+    new_member['type'] = 'node'
+    new_member['role'] = 'new first'
+    doc.find("//osm/relation").first.child.prev = new_member
+    # update the version, should be 1?
+    doc.find("//osm/relation").first['id'] = relation_id.to_s
+    doc.find("//osm/relation").first['version'] = 1.to_s
+
+    # upload the next version of the relation
+    content doc
+    put :update, :id => relation_id
+    assert_response :success, "can't update relation: #{@response.body}"
+    new_version = @response.body.to_i
+
+    # get it back again and check the ordering again
+    get :read, :id => relation_id
+    assert_response :success, "can't read back the relation: #{@response.body}"
+    check_ordering(doc, @response.body)
+  end
+
+  ## 
+  # check that relations can contain duplicate members
+  def test_relation_member_duplicates
+    basic_authorization("test@openstreetmap.org", "test");  
+
+    doc_str = <<OSM
+<osm>
+ <relation changeset='1'>
+  <member ref='1' type='node' role='forward'/>
+  <member ref='3' type='node' role='forward'/>
+  <member ref='1' type='node' role='forward'/>
+  <member ref='3' type='node' role='forward'/>
+ </relation>
+</osm>
+OSM
+    doc = XML::Parser.string(doc_str).parse
+
+    content doc
+    put :create
+    assert_response :success, "can't create a relation: #{@response.body}"
+    relation_id = @response.body.to_i
+
+    # get it back and check the ordering
+    get :read, :id => relation_id
+    assert_response :success, "can't read back the relation: #{@response.body}"
+    check_ordering(doc, @response.body)
+  end
+
+  # ============================================================
+  # utility functions
+  # ============================================================
+
+  ##
+  # checks that the XML document and the string arguments have
+  # members in the same order.
+  def check_ordering(doc, xml)
+    new_doc = XML::Parser.string(xml).parse
+
+    doc_members = doc.find("//osm/relation/member").collect do |m|
+      [m['ref'].to_i, m['type'].to_sym, m['role']]
+    end
+
+    new_members = new_doc.find("//osm/relation/member").collect do |m|
+      [m['ref'].to_i, m['type'].to_sym, m['role']]
+    end
+
+    doc_members.zip(new_members).each do |d, n|
+      assert_equal d, n, "members are not equal - ordering is wrong? (#{doc}, #{xml})"
+    end
+  end
+
+  ##
+  # create a changeset and yield to the caller to set it up, then assert
+  # that the changeset bounding box is +bbox+.
+  def check_changeset_modify(bbox)
+    basic_authorization("test@openstreetmap.org", "test");  
+
+    # create a new changeset for this operation, so we are assured
+    # that the bounding box will be newly-generated.
+    changeset_id = with_controller(ChangesetController.new) do
+      content "<osm><changeset/></osm>"
+      put :create
+      assert_response :success, "couldn't create changeset for modify test"
+      @response.body.to_i
+    end
+
+    # go back to the block to do the actual modifies
+    yield changeset_id
+
+    # now download the changeset to check its bounding box
+    with_controller(ChangesetController.new) do
+      get :read, :id => changeset_id
+      assert_response :success, "can't re-read changeset for modify test"
+      assert_select "osm>changeset", 1
+      assert_select "osm>changeset[id=#{changeset_id}]", 1
+      assert_select "osm>changeset[min_lon=#{bbox[0].to_f}]", 1
+      assert_select "osm>changeset[min_lat=#{bbox[1].to_f}]", 1
+      assert_select "osm>changeset[max_lon=#{bbox[2].to_f}]", 1
+      assert_select "osm>changeset[max_lat=#{bbox[3].to_f}]", 1
+    end
+  end
+
+  ##
+  # yields the relation with the given +id+ (and optional +version+
+  # to read from the history tables) into the block. the parsed XML
+  # doc is returned.
+  def with_relation(id, ver = nil)
+    if ver.nil?
+      get :read, :id => id
+    else
+      with_controller(OldRelationController.new) do
+        get :version, :id => id, :version => ver
+      end
+    end
+    assert_response :success
+    yield xml_parse(@response.body)
+  end
+
+  ##
+  # updates the relation (XML) +rel+ and 
+  # yields the new version of that relation into the block. 
+  # the parsed XML doc is retured.
+  def with_update(rel)
+    rel_id = rel.find("//osm/relation").first["id"].to_i
+    content rel
+    put :update, :id => rel_id
+    assert_response :success, "can't update relation: #{@response.body}"
+    version = @response.body.to_i
+
+    # now get the new version
+    get :read, :id => rel_id
+    assert_response :success
+    new_rel = xml_parse(@response.body)
+
+    yield new_rel
+
+    return version
+  end
+
+  ##
+  # updates the relation (XML) +rel+ via the diff-upload API and
+  # yields the new version of that relation into the block. 
+  # the parsed XML doc is retured.
+  def with_update_diff(rel)
+    rel_id = rel.find("//osm/relation").first["id"].to_i
+    cs_id = rel.find("//osm/relation").first['changeset'].to_i
+    version = nil
+
+    with_controller(ChangesetController.new) do
+      doc = OSM::API.new.get_xml_doc
+      change = XML::Node.new 'osmChange'
+      doc.root = change
+      modify = XML::Node.new 'modify'
+      change << modify
+      modify << doc.import(rel.find("//osm/relation").first)
+
+      content doc.to_s
+      post :upload, :id => cs_id
+      assert_response :success, "can't upload diff relation: #{@response.body}"
+      version = xml_parse(@response.body).find("//diffResult/relation").first["new_version"].to_i
+    end      
+    
+    # now get the new version
+    get :read, :id => rel_id
+    assert_response :success
+    new_rel = xml_parse(@response.body)
+    
+    yield new_rel
+    
+    return version
+  end
+
+  ##
+  # returns a k->v hash of tags from an xml doc
+  def get_tags_as_hash(a) 
+    a.find("//osm/relation/tag").inject({}) do |h,v|
+      h[v['k']] = v['v']
+      h
+    end
+  end
+  
+  ##
+  # assert that all tags on relation documents +a+ and +b+ 
+  # are equal
+  def assert_tags_equal(a, b)
+    # turn the XML doc into tags hashes
+    a_tags = get_tags_as_hash(a)
+    b_tags = get_tags_as_hash(b)
+
+    assert_equal a_tags.keys, b_tags.keys, "Tag keys should be identical."
+    a_tags.each do |k, v|
+      assert_equal v, b_tags[k], 
+        "Tags which were not altered should be the same. " +
+        "#{a_tags.inspect} != #{b_tags.inspect}"
+    end
+  end
+
   ##
   # update the changeset_id of a node element
   def update_changeset(xml, changeset_id)
@@ -281,8 +689,7 @@ class RelationControllerTest < ActionController::TestCase
   ##
   # parse some xml
   def xml_parse(xml)
-    parser = XML::Parser.new
-    parser.string = xml
+    parser = XML::Parser.string(xml)
     parser.parse
   end
 end