X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/026d7775d25515e41386a209fbb8674df84108ec..618b09a8ab6aa12b86e9702185740a9be6260e18:/test/functional/amf_controller_test.rb

diff --git a/test/functional/amf_controller_test.rb b/test/functional/amf_controller_test.rb
index 0ca506f36..757acf6ac 100644
--- a/test/functional/amf_controller_test.rb
+++ b/test/functional/amf_controller_test.rb
@@ -5,6 +5,19 @@ include Potlatch
 class AmfControllerTest < ActionController::TestCase
   api_fixtures
 
+  ##
+  # test all routes which lead to this controller
+  def test_routes
+    assert_routing(
+      { :path => "/api/0.6/amf/read", :method => :post },
+      { :controller => "amf", :action => "amf_read" }
+    )
+    assert_routing(
+      { :path => "/api/0.6/amf/write", :method => :post },
+      { :controller => "amf", :action => "amf_write" }
+    )
+  end
+
   def test_getway
     # check a visible way
     id = current_ways(:visible_way).id
@@ -12,7 +25,9 @@ class AmfControllerTest < ActionController::TestCase
     post :amf_read
     assert_response :success
     amf_parse_response                                         
-    assert_equal amf_result("/1")[0], id
+    way = amf_result("/1")
+    assert_equal way[0], 0
+    assert_equal way[2], id
   end
 
   def test_getway_invisible
@@ -23,8 +38,10 @@ class AmfControllerTest < ActionController::TestCase
     assert_response :success
     amf_parse_response
     way = amf_result("/1")
-    assert_equal way[0], id
-    assert way[1].empty? and way[2].empty?
+    assert_equal way[0], -4
+    assert_equal way[1], "way"
+    assert_equal way[2], id
+    assert way[3].nil? and way[4].nil?
   end
 
   def test_getway_nonexistent
@@ -34,8 +51,10 @@ class AmfControllerTest < ActionController::TestCase
     assert_response :success
     amf_parse_response
     way = amf_result("/1")
-    assert_equal way[0], 0
-    assert way[1].empty? and way[2].empty?
+    assert_equal way[0], -4
+    assert_equal way[1], "way"
+    assert_equal way[2], 0
+    assert way[3].nil? and way[4].nil?
   end
 
   def test_whichways
@@ -52,19 +71,20 @@ class AmfControllerTest < ActionController::TestCase
     # check contents of message
     map = amf_result "/1"
     assert_equal 0, map[0], 'map error code should be 0'
+    assert_equal "", map[1], 'map error text should be empty'
 
     # check the formatting of the message
-    assert_equal 4, map.length, 'map should have length 4'
-    assert_equal Array, map[1].class, 'map "ways" element should be an array'
-    assert_equal Array, map[2].class, 'map "nodes" element should be an array'
-    assert_equal Array, map[3].class, 'map "relations" element should be an array'
-    map[1].each do |w|
+    assert_equal 5, map.length, 'map should have length 5'
+    assert_equal Array, map[2].class, 'map "ways" element should be an array'
+    assert_equal Array, map[3].class, 'map "nodes" element should be an array'
+    assert_equal Array, map[4].class, 'map "relations" element should be an array'
+    map[2].each do |w|
       assert_equal 2, w.length, 'way should be (id, version) pair'
       assert w[0] == w[0].floor, 'way ID should be an integer'
       assert w[1] == w[1].floor, 'way version should be an integer'
     end
 
-    map[2].each do |n|
+    map[3].each do |n|
       assert_equal 5, w.length, 'node should be (id, lat, lon, [tags], version) tuple'
       assert n[0] == n[0].floor, 'node ID should be an integer'
       assert n[1] >= minlat - 0.01, 'node lat should be greater than min'
@@ -75,7 +95,7 @@ class AmfControllerTest < ActionController::TestCase
       assert n[4] == n[4].floor, 'node version should be an integer'
     end
 
-    map[3].each do |r|
+    map[4].each do |r|
       assert_equal 2, r.length, 'relation should be (id, version) pair'
       assert r[0] == r[0].floor, 'relation ID should be an integer'
       assert r[1] == r[1].floor, 'relation version should be an integer'
@@ -83,7 +103,7 @@ class AmfControllerTest < ActionController::TestCase
 
     # TODO: looks like amf_controller changed since this test was written
     # so someone who knows what they're doing should check this!
-    ways = map[1].collect { |x| x[0] }
+    ways = map[2].collect { |x| x[0] }
     assert ways.include?(current_ways(:used_way).id),
       "map should include used way"
     assert !ways.include?(current_ways(:invisible_way).id),
@@ -136,12 +156,13 @@ class AmfControllerTest < ActionController::TestCase
     # check contents of message
     map = amf_result "/1"
     assert_equal 0, map[0], 'first map element should be 0'
-    assert_equal Array, map[1].class, 'second map element should be an array'
+    assert_equal "", map[1], 'second map element should be an empty string'
+    assert_equal Array, map[2].class, 'third map element should be an array'
     # TODO: looks like amf_controller changed since this test was written
     # so someone who knows what they're doing should check this!
-    assert !map[1].include?(current_ways(:used_way).id),
+    assert !map[2].include?(current_ways(:used_way).id),
       "map should not include used way"
-    assert map[1].include?(current_ways(:invisible_way).id),
+    assert map[2].include?(current_ways(:invisible_way).id),
       'map should include deleted way'
   end
 
@@ -153,7 +174,7 @@ class AmfControllerTest < ActionController::TestCase
     amf_parse_response 
 
     map = amf_result "/1"
-    assert_boundary_error map, " The server said: The maximum bbox size is 0.25, and your request was too large. Either request a smaller area, or use planet.osm"
+    assert_deleted_boundary_error map, " The server said: The maximum bbox size is 0.25, and your request was too large. Either request a smaller area, or use planet.osm"
   end
 
   def test_getrelation
@@ -162,7 +183,9 @@ class AmfControllerTest < ActionController::TestCase
     post :amf_read
     assert_response :success
     amf_parse_response
-    assert_equal amf_result("/1")[0], id
+    rel = amf_result("/1")
+    assert_equal rel[0], 0
+    assert_equal rel[2], id
   end
 
   def test_getrelation_invisible
@@ -172,8 +195,10 @@ class AmfControllerTest < ActionController::TestCase
     assert_response :success
     amf_parse_response
     rel = amf_result("/1")
-    assert_equal rel[0], id
-    assert rel[1].empty? and rel[2].empty?
+    assert_equal rel[0], -4
+    assert_equal rel[1], "relation"
+    assert_equal rel[2], id
+    assert rel[3].nil? and rel[4].nil?
   end
 
   def test_getrelation_nonexistent
@@ -183,8 +208,10 @@ class AmfControllerTest < ActionController::TestCase
     assert_response :success
     amf_parse_response
     rel = amf_result("/1")
-    assert_equal rel[0], id
-    assert rel[1].empty? and rel[2].empty?
+    assert_equal rel[0], -4
+    assert_equal rel[1], "relation"
+    assert_equal rel[2], id
+    assert rel[3].nil? and rel[4].nil?
   end
 
   def test_getway_old
@@ -194,17 +221,18 @@ class AmfControllerTest < ActionController::TestCase
     # instead of a version number...
     # try to get version 1
     v1 = ways(:way_with_versions_v1)
-    { latest => '', 
-      v1 => v1.timestamp.strftime("%d %b %Y, %H:%M:%S")
-    }.each do |way, t|
-      amf_content "getway_old", "/1", [way.id, t]
+    { latest.id => '', 
+      v1.way_id => v1.timestamp.strftime("%d %b %Y, %H:%M:%S")
+    }.each do |id, t|
+      amf_content "getway_old", "/1", [id, t]
       post :amf_read      
       assert_response :success
       amf_parse_response
       returned_way = amf_result("/1")
-      assert_equal way.id, returned_way[1]
+      assert_equal 0, returned_way[0]
+      assert_equal id, returned_way[2]
       # API returns the *latest* version, even for old ways...
-      assert_equal latest.version, returned_way[4]
+      assert_equal latest.version, returned_way[5]
     end
   end
   
@@ -224,9 +252,10 @@ class AmfControllerTest < ActionController::TestCase
       assert_response :success
       amf_parse_response
       returned_way = amf_result("/1")
-      assert returned_way[2].empty?
-      assert returned_way[3].empty?
-      assert returned_way[4] < 0
+      assert_equal -1, returned_way[0]
+      assert returned_way[3].nil?
+      assert returned_way[4].nil?
+      assert returned_way[5].nil?
     end
   end
 
@@ -235,18 +264,19 @@ class AmfControllerTest < ActionController::TestCase
     v1 = ways(:way_with_versions_v1)
     # try to get last visible version of non-existent way
     # try to get specific version of non-existent way
-    [[nil, ''], 
-     [nil, '1 Jan 1970, 00:00:00'], 
-     [v1, (v1.timestamp - 10).strftime("%d %b %Y, %H:%M:%S")]
-    ].each do |way, t|
-      amf_content "getway_old", "/1", [way.nil? ? 0 : way.id, t]
+    [[0, ''], 
+     [0, '1 Jan 1970, 00:00:00'], 
+     [v1.way_id, (v1.timestamp - 10).strftime("%d %b %Y, %H:%M:%S")]
+    ].each do |id, t|
+      amf_content "getway_old", "/1", [id, t]
       post :amf_read
       assert_response :success
       amf_parse_response
       returned_way = amf_result("/1")
-      assert returned_way[2].empty?
-      assert returned_way[3].empty?
-      assert returned_way[4] < 0
+      assert_equal -1, returned_way[0]
+      assert returned_way[3].nil?
+      assert returned_way[4].nil?
+      assert returned_way[5].nil?
     end
   end
 
@@ -263,10 +293,12 @@ class AmfControllerTest < ActionController::TestCase
     # ['way',wayid,history]
     assert_equal 'way', history[0]
     assert_equal latest.id, history[1] 
-    # for some reason undocumented, the potlatch API now prefers dates
-    # over version numbers. presumably no-one edits concurrently any more?
-    assert_equal latest.timestamp.strftime("%d %b %Y, %H:%M:%S"), history[2].first[0]
-    assert_equal oldest.timestamp.strftime("%d %b %Y, %H:%M:%S"), history[2].last[0]
+    # We use dates rather than version numbers here, because you might
+    # have moved a node within a way (i.e. way version not incremented).
+    # The timestamp is +1 because we say "give me the revision of 15:33:02",
+    # but that might actually include changes at 15:33:02.457.
+    assert_equal (latest.timestamp + 1).strftime("%d %b %Y, %H:%M:%S"), history[2].first[0]
+    assert_equal (oldest.timestamp + 1).strftime("%d %b %Y, %H:%M:%S"), history[2].last[0]
   end
 
   def test_getway_history_nonexistent
@@ -291,21 +323,18 @@ class AmfControllerTest < ActionController::TestCase
     history = amf_result("/1")
 
     # ['node',nodeid,history]
+    # note that (as per getway_history) we actually round up
+    # to the next second
     assert_equal history[0], 'node', 
       'first element should be "node"'
     assert_equal history[1], latest.id,
       'second element should be the input node ID'
-    # NOTE: changed this test to match what amf_controller actually 
-    # outputs - which may or may not be what potlatch is expecting.
-    # someone who knows potlatch (i.e: richard f) should review this.
-    # NOTE2: wow - this is the second time this has changed in the
-    # API and the tests are being patched up. 
     assert_equal history[2].first[0], 
-      latest.timestamp.strftime("%d %b %Y, %H:%M:%S"),
-      'first part of third element should be the latest version'
+      (latest.timestamp + 1).strftime("%d %b %Y, %H:%M:%S"),
+      'first element in third element (array) should be the latest version'
     assert_equal history[2].last[0], 
-      nodes(:node_with_versions_v1).timestamp.strftime("%d %b %Y, %H:%M:%S"),
-      'second part of third element should be the initial version'
+      (nodes(:node_with_versions_v1).timestamp + 1).strftime("%d %b %Y, %H:%M:%S"),
+      'last element in third element (array) should be the initial version'
   end
 
   def test_getnode_history_nonexistent
@@ -325,30 +354,33 @@ class AmfControllerTest < ActionController::TestCase
   # AMF Write tests
   def test_putpoi_update_valid
     nd = current_nodes(:visible_node)
-    amf_content "putpoi", "/1", ["test@openstreetmap.org:test", nd.changeset_id, nd.version, nd.id, nd.lon, nd.lat, nd.tags, nd.visible]
+    cs_id = changesets(:public_user_first_change).id
+    amf_content "putpoi", "/1", ["test@example.com:test", cs_id, nd.version, nd.id, nd.lon, nd.lat, nd.tags, nd.visible]
     post :amf_write
     assert_response :success
     amf_parse_response
     result = amf_result("/1")
     
     assert_equal 0, result[0]
-    assert_equal nd.id, result[1]
+    assert_equal "", result[1]
     assert_equal nd.id, result[2]
-    assert_equal nd.version+1, result[3]
+    assert_equal nd.id, result[3]
+    assert_equal nd.version+1, result[4]
     
     # Now try to update again, with a different lat/lon, using the updated version number
     lat = nd.lat+0.1
     lon = nd.lon-0.1
-    amf_content "putpoi", "/2", ["test@openstreetmap.org:test", nd.changeset_id, nd.version+1, nd.id, lon, lat, nd.tags, nd.visible]
+    amf_content "putpoi", "/2", ["test@example.com:test", cs_id, nd.version+1, nd.id, lon, lat, nd.tags, nd.visible]
     post :amf_write
     assert_response :success
     amf_parse_response
     result = amf_result("/2")
     
     assert_equal 0, result[0]
-    assert_equal nd.id, result[1]
+    assert_equal "", result[1]
     assert_equal nd.id, result[2]
-    assert_equal nd.version+2, result[3]
+    assert_equal nd.id, result[3]
+    assert_equal nd.version+2, result[4]
   end
   
   # Check that we can create a no valid poi
@@ -360,37 +392,37 @@ class AmfControllerTest < ActionController::TestCase
     lat = rand(100)-50 + rand
     lon = rand(100)-50 + rand
     # normal user has a changeset open
-    changeset = changesets(:normal_user_first_change)
+    changeset = changesets(:public_user_first_change)
     
-    amf_content "putpoi", "/1", ["test@openstreetmap.org:test", changeset.id, nil, nil, lon, lat, {}, nil]
+    amf_content "putpoi", "/1", ["test@example.com:test", changeset.id, nil, nil, lon, lat, {}, nil]
     post :amf_write
     assert_response :success
     amf_parse_response
     result = amf_result("/1")
     
     # check the array returned by the amf
-    assert_equal 4, result.size
+    assert_equal 5, result.size
     assert_equal 0, result[0], "expected to get the status ok from the amf"
-    assert_equal 0, result[1], "The old id should be 0"
-    assert result[2] > 0, "The new id should be greater than 0"
-    assert_equal 1, result[3], "The new version should be 1"
+    assert_equal 0, result[2], "The old id should be 0"
+    assert result[3] > 0, "The new id should be greater than 0"
+    assert_equal 1, result[4], "The new version should be 1"
     
     # Finally check that the node that was saved has saved the data correctly 
     # in both the current and history tables
     # First check the current table
-    current_node = Node.find(result[2])
+    current_node = Node.find(result[3].to_i)
     assert_in_delta lat, current_node.lat, 0.00001, "The latitude was not retreieved correctly"
     assert_in_delta lon, current_node.lon, 0.00001, "The longitude was not retreived correctly"
     assert_equal 0, current_node.tags.size, "There seems to be a tag that has been added to the node"
-    assert_equal result[3], current_node.version, "The version returned, is different to the one returned by the amf"
+    assert_equal result[4], current_node.version, "The version returned, is different to the one returned by the amf"
     # Now check the history table
-    historic_nodes = Node.find(:all, :conditions => { :id => result[2] })
+    historic_nodes = Node.find(:all, :conditions => { :id => result[3] })
     assert_equal 1, historic_nodes.size, "There should only be one historic node created"
     first_historic_node = historic_nodes.first
     assert_in_delta lat, first_historic_node.lat, 0.00001, "The latitude was not retreived correctly"
     assert_in_delta lon, first_historic_node.lon, 0.00001, "The longitude was not retreuved correctly"
     assert_equal 0, first_historic_node.tags.size, "There seems to be a tag that have been attached to this node"
-    assert_equal result[3], first_historic_node.version, "The version returned, is different to the one returned by the amf"
+    assert_equal result[4], first_historic_node.version, "The version returned, is different to the one returned by the amf"
     
     ####
     # This node has some tags
@@ -399,41 +431,100 @@ class AmfControllerTest < ActionController::TestCase
     lat = rand(100)-50 + rand
     lon = rand(100)-50 + rand
     # normal user has a changeset open
-    changeset = changesets(:normal_user_first_change)
+    changeset = changesets(:public_user_first_change)
     
-    amf_content "putpoi", "/2", ["test@openstreetmap.org:test", changeset.id, nil, nil, lon, lat, { "key" => "value", "ping" => "pong" }, nil]
+    amf_content "putpoi", "/2", ["test@example.com:test", changeset.id, nil, nil, lon, lat, { "key" => "value", "ping" => "pong" }, nil]
     post :amf_write
     assert_response :success
     amf_parse_response
     result = amf_result("/2")
 
     # check the array returned by the amf
-    assert_equal 4, result.size
+    assert_equal 5, result.size
     assert_equal 0, result[0], "Expected to get the status ok in the amf"
-    assert_equal 0, result[1], "The old id should be 0"
-    assert result[2] > 0, "The new id should be greater than 0"
-    assert_equal 1, result[3], "The new version should be 1"
+    assert_equal 0, result[2], "The old id should be 0"
+    assert result[3] > 0, "The new id should be greater than 0"
+    assert_equal 1, result[4], "The new version should be 1"
     
     # Finally check that the node that was saved has saved the data correctly 
     # in both the current and history tables
     # First check the current table
-    current_node = Node.find(result[2])
+    current_node = Node.find(result[3].to_i)
     assert_in_delta lat, current_node.lat, 0.00001, "The latitude was not retreieved correctly"
     assert_in_delta lon, current_node.lon, 0.00001, "The longitude was not retreived correctly"
     assert_equal 2, current_node.tags.size, "There seems to be a tag that has been added to the node"
     assert_equal({ "key" => "value", "ping" => "pong" }, current_node.tags, "tags are different")
-    assert_equal result[3], current_node.version, "The version returned, is different to the one returned by the amf"
+    assert_equal result[4], current_node.version, "The version returned, is different to the one returned by the amf"
     # Now check the history table
-    historic_nodes = Node.find(:all, :conditions => { :id => result[2] })
+    historic_nodes = Node.find(:all, :conditions => { :id => result[3] })
     assert_equal 1, historic_nodes.size, "There should only be one historic node created"
     first_historic_node = historic_nodes.first
     assert_in_delta lat, first_historic_node.lat, 0.00001, "The latitude was not retreived correctly"
     assert_in_delta lon, first_historic_node.lon, 0.00001, "The longitude was not retreuved correctly"
     assert_equal 2, first_historic_node.tags.size, "There seems to be a tag that have been attached to this node"
     assert_equal({ "key" => "value", "ping" => "pong" }, first_historic_node.tags, "tags are different")
-    assert_equal result[3], first_historic_node.version, "The version returned, is different to the one returned by the amf"
+    assert_equal result[4], first_historic_node.version, "The version returned, is different to the one returned by the amf"
   end
   
+  # try creating a POI with rubbish in the tags
+  def test_putpoi_create_with_control_chars
+    # This node has no tags
+    nd = Node.new
+    # create a node with random lat/lon
+    lat = rand(100)-50 + rand
+    lon = rand(100)-50 + rand
+    # normal user has a changeset open
+    changeset = changesets(:public_user_first_change)
+    
+    mostly_invalid = (0..31).to_a.map {|i| i.chr}.join
+    tags = { "something" => "foo#{mostly_invalid}bar" }
+      
+    amf_content "putpoi", "/1", ["test@example.com:test", changeset.id, nil, nil, lon, lat, tags, nil]
+    post :amf_write
+    assert_response :success
+    amf_parse_response
+    result = amf_result("/1")
+      
+    # check the array returned by the amf
+    assert_equal 5, result.size
+    assert_equal 0, result[0], "Expected to get the status ok in the amf"
+    assert_equal 0, result[2], "The old id should be 0"
+    assert result[3] > 0, "The new id should be greater than 0"
+    assert_equal 1, result[4], "The new version should be 1"
+    
+    # Finally check that the node that was saved has saved the data correctly 
+    # in both the current and history tables
+    # First check the current table
+    current_node = Node.find(result[3].to_i)
+    assert_equal 1, current_node.tags.size, "There seems to be a tag that has been added to the node"
+    assert_equal({ "something" => "foo\t\n\rbar" }, current_node.tags, "tags were not fixed correctly")
+    assert_equal result[4], current_node.version, "The version returned, is different to the one returned by the amf"
+  end
+
+  # try creating a POI with rubbish in the tags
+  def test_putpoi_create_with_invalid_utf8
+    # This node has no tags
+    nd = Node.new
+    # create a node with random lat/lon
+    lat = rand(100)-50 + rand
+    lon = rand(100)-50 + rand
+    # normal user has a changeset open
+    changeset = changesets(:public_user_first_change)
+    
+    invalid = "\xc0\xc0"
+    tags = { "something" => "foo#{invalid}bar" }
+      
+    amf_content "putpoi", "/1", ["test@example.com:test", changeset.id, nil, nil, lon, lat, tags, nil]
+    post :amf_write
+    assert_response :success
+    amf_parse_response
+    result = amf_result("/1")
+
+    assert_equal 2, result.size
+    assert_equal -1, result[0], "Expected to get the status FAIL in the amf"
+    assert_equal "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1.", result[1] 
+  end
+      
   def test_putpoi_delete_valid
     
   end
@@ -450,6 +541,24 @@ class AmfControllerTest < ActionController::TestCase
     
   end
 
+  def test_startchangeset_invalid_xmlchar_comment
+    invalid = "\035\022"
+    comment = "foo#{invalid}bar"
+      
+    amf_content "startchangeset", "/1", ["test@example.com:test", Hash.new, nil, comment, 1]
+    post :amf_write
+    assert_response :success
+    amf_parse_response
+    result = amf_result("/1")
+
+    assert_equal 3, result.size, result.inspect
+    assert_equal 0, result[0]
+    new_cs_id = result[2].to_i
+
+    cs = Changeset.find(new_cs_id)
+    assert_equal "foobar", cs.tags["comment"]
+  end
+
   # ************************************************************
   # AMF Helper functions
 
@@ -480,13 +589,8 @@ class AmfControllerTest < ActionController::TestCase
   # The result is a hash of message_ref => data.
   # The attribute @amf_result is initialised to this hash.
   def amf_parse_response
-    if @response.body.class.to_s == 'Proc'
-      res = StringIO.new()
-      @response.body.call @response, res
-      req = StringIO.new(res.string)
-    else
-      req = StringIO.new(@response.body)
-    end
+    req = StringIO.new(@response.body)
+
     req.read(2)   # version
 
     # parse through any headers
@@ -529,10 +633,17 @@ class AmfControllerTest < ActionController::TestCase
     end
   end
   
-  # this should be what AMF controller returns when the bbox of a request
-  # is invalid or too large.
+  # this should be what AMF controller returns when the bbox of a
+  # whichways request is invalid or too large.
   def assert_boundary_error(map, msg=nil, error_hint=nil)
     expected_map = [-2, "Sorry - I can't get the map for that area.#{msg}"]
     assert_equal expected_map, map, "AMF controller should have returned an error. (#{error_hint})"
   end
+
+  # this should be what AMF controller returns when the bbox of a
+  # whichways_deleted request is invalid or too large.
+  def assert_deleted_boundary_error(map, msg=nil, error_hint=nil)
+    expected_map = [-2, "Sorry - I can't get the map for that area.#{msg}"]
+    assert_equal expected_map, map, "AMF controller should have returned an error. (#{error_hint})"
+  end
 end