]> git.openstreetmap.org Git - rails.git/blobdiff - test/controllers/api/relations_controller_test.rb
Add tests for API change rate limits
[rails.git] / test / controllers / api / relations_controller_test.rb
index cff8d65e1fb0771914453b2ef362054531c7f2d8..e6f507d3a84169446370854db4164e96bee033e0 100644 (file)
@@ -102,7 +102,7 @@ module Api
       second_relation = create(:relation_member, :member => node).relation
       _super_relation = create(:relation_member, :member => second_relation).relation
       # should combine multiple relation_member references into just one relation entry
-      create(:relation_member, :member => node, :relation => relation_with_node, :sequence_id => 2)
+      create(:relation_member, :member => node, :relation => relation_with_node)
       # should not include deleted relations
       deleted_relation = create(:relation, :deleted)
       create(:relation_member, :member => node, :relation => deleted_relation)
@@ -122,7 +122,7 @@ module Api
       second_relation = create(:relation_member, :member => way).relation
       _super_relation = create(:relation_member, :member => second_relation).relation
       # should combine multiple relation_member references into just one relation entry
-      create(:relation_member, :member => way, :relation => relation_with_way, :sequence_id => 2)
+      create(:relation_member, :member => way, :relation => relation_with_way)
       # should not include deleted relations
       deleted_relation = create(:relation, :deleted)
       create(:relation_member, :member => way, :relation => deleted_relation)
@@ -142,7 +142,7 @@ module Api
       second_relation = create(:relation_member, :member => relation).relation
       _super_relation = create(:relation_member, :member => second_relation).relation
       # should combine multiple relation_member references into just one relation entry
-      create(:relation_member, :member => relation, :relation => relation_with_relation, :sequence_id => 2)
+      create(:relation_member, :member => relation, :relation => relation_with_relation)
       # should not include deleted relations
       deleted_relation = create(:relation, :deleted)
       create(:relation_member, :member => relation, :relation => deleted_relation)
@@ -151,25 +151,6 @@ module Api
                                   [relation_with_relation, second_relation])
     end
 
-    def check_relations_for_element(path, type, id, expected_relations)
-      # check the "relations for relation" mode
-      get path
-      assert_response :success
-
-      # count one osm element
-      assert_select "osm[version='#{Settings.api_version}'][generator='OpenStreetMap server']", 1
-
-      # we should have only the expected number of relations
-      assert_select "osm>relation", expected_relations.size
-
-      # and each of them should contain the element we originally searched for
-      expected_relations.each do |relation|
-        # The relation should appear once, but the element could appear multiple times
-        assert_select "osm>relation[id='#{relation.id}']", 1
-        assert_select "osm>relation[id='#{relation.id}']>member[type='#{type}'][ref='#{id}']"
-      end
-    end
-
     def test_full
       # check the "full" mode
       get relation_full_path(:id => 999999)
@@ -264,7 +245,7 @@ module Api
       # create an relation with a node as member, this time test that we don't
       # need a role attribute to be included
       xml = "<osm><relation changeset='#{private_changeset.id}'>" \
-            "<member  ref='#{node.id}' type='node'/>" + "<tag k='test' v='yes' /></relation></osm>"
+            "<member  ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>"
       put relation_create_path, :params => xml, :headers => auth_header
       # hope for forbidden due to user
       assert_response :forbidden,
@@ -296,10 +277,8 @@ module Api
       assert_not_nil checkrelation,
                      "uploaded relation not found in data base after upload"
       # compare values
-      assert_equal checkrelation.members.length, 0,
-                   "saved relation contains members but should not"
-      assert_equal checkrelation.tags.length, 1,
-                   "saved relation does not contain exactly one tag"
+      assert_equal(0, checkrelation.members.length, "saved relation contains members but should not")
+      assert_equal(1, checkrelation.tags.length, "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 user.id, checkrelation.changeset.user_id,
@@ -326,10 +305,8 @@ module Api
       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(1, checkrelation.members.length, "saved relation does not contain exactly one member")
+      assert_equal(1, checkrelation.tags.length, "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 user.id, checkrelation.changeset.user_id,
@@ -345,7 +322,7 @@ module Api
       # create an relation with a node as member, this time test that we don't
       # need a role attribute to be included
       xml = "<osm><relation changeset='#{changeset.id}'>" \
-            "<member  ref='#{node.id}' type='node'/>" + "<tag k='test' v='yes' /></relation></osm>"
+            "<member  ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>"
       put relation_create_path, :params => xml, :headers => auth_header
       # hope for success
       assert_response :success,
@@ -356,10 +333,8 @@ module Api
       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(1, checkrelation.members.length, "saved relation does not contain exactly one member")
+      assert_equal(1, checkrelation.tags.length, "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 user.id, checkrelation.changeset.user_id,
@@ -387,10 +362,8 @@ module Api
       assert_not_nil checkrelation,
                      "uploaded relation not found in data base after upload"
       # compare values
-      assert_equal checkrelation.members.length, 2,
-                   "saved relation does not have exactly two members"
-      assert_equal checkrelation.tags.length, 1,
-                   "saved relation does not contain exactly one tag"
+      assert_equal(2, checkrelation.members.length, "saved relation does not have exactly two members")
+      assert_equal(1, checkrelation.tags.length, "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 user.id, checkrelation.changeset.user_id,
@@ -639,8 +612,7 @@ module Api
 
       # valid delete should return the new version number, which should
       # be greater than the old version number
-      assert @response.body.to_i > multi_tag_relation.version,
-             "delete request should return a new version number for relation"
+      assert_operator @response.body.to_i, :>, multi_tag_relation.version, "delete request should return a new version number for relation"
 
       # this won't work since the relation is already deleted
       xml = update_changeset(xml_for_relation(deleted_relation), changeset.id)
@@ -934,9 +906,137 @@ module Api
       end
     end
 
-    # ============================================================
-    # utility functions
-    # ============================================================
+    ##
+    # test initial rate limit
+    def test_initial_rate_limit
+      # create a user
+      user = create(:user)
+
+      # create some nodes
+      node1 = create(:node)
+      node2 = create(:node)
+
+      # create a changeset that puts us near the initial rate limit
+      changeset = create(:changeset, :user => user,
+                                     :created_at => Time.now.utc - 5.minutes,
+                                     :num_changes => Settings.initial_changes_per_hour - 1)
+
+      # create authentication header
+      auth_header = basic_authorization_header user.email, "test"
+
+      # try creating a relation
+      xml = "<osm><relation changeset='#{changeset.id}'>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put relation_create_path, :params => xml, :headers => auth_header
+      assert_response :success, "relation create did not return success status"
+
+      # get the id of the relation we created
+      relationid = @response.body
+
+      # try updating the relation, which should be rate limited
+      xml = "<osm><relation id='#{relationid}' version='1' changeset='#{changeset.id}'>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put api_relation_path(relationid), :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation update did not hit rate limit"
+
+      # try deleting the relation, which should be rate limited
+      xml = "<osm><relation id='#{relationid}' version='2' changeset='#{changeset.id}'/></osm>"
+      delete api_relation_path(relationid), :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation delete did not hit rate limit"
+
+      # try creating a relation, which should be rate limited
+      xml = "<osm><relation changeset='#{changeset.id}'>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put relation_create_path, :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation create did not hit rate limit"
+    end
+
+    ##
+    # test maximum rate limit
+    def test_maximum_rate_limit
+      # create a user
+      user = create(:user)
+
+      # create some nodes
+      node1 = create(:node)
+      node2 = create(:node)
+
+      # create a changeset to establish our initial edit time
+      changeset = create(:changeset, :user => user,
+                                     :created_at => Time.now.utc - 28.days)
+
+      # create changeset to put us near the maximum rate limit
+      total_changes = Settings.max_changes_per_hour - 1
+      while total_changes.positive?
+        changes = [total_changes, Changeset::MAX_ELEMENTS].min
+        changeset = create(:changeset, :user => user,
+                                       :created_at => Time.now.utc - 5.minutes,
+                                       :num_changes => changes)
+        total_changes -= changes
+      end
+
+      # create authentication header
+      auth_header = basic_authorization_header user.email, "test"
+
+      # try creating a relation
+      xml = "<osm><relation changeset='#{changeset.id}'>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put relation_create_path, :params => xml, :headers => auth_header
+      assert_response :success, "relation create did not return success status"
+
+      # get the id of the relation we created
+      relationid = @response.body
+
+      # try updating the relation, which should be rate limited
+      xml = "<osm><relation id='#{relationid}' version='1' changeset='#{changeset.id}'>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put api_relation_path(relationid), :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation update did not hit rate limit"
+
+      # try deleting the relation, which should be rate limited
+      xml = "<osm><relation id='#{relationid}' version='2' changeset='#{changeset.id}'/></osm>"
+      delete api_relation_path(relationid), :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation delete did not hit rate limit"
+
+      # try creating a relation, which should be rate limited
+      xml = "<osm><relation changeset='#{changeset.id}'>" \
+            "<member  ref='#{node1.id}' type='node' role='some'/>" \
+            "<member  ref='#{node2.id}' type='node' role='some'/>" \
+            "<tag k='test' v='yes' /></relation></osm>"
+      put relation_create_path, :params => xml, :headers => auth_header
+      assert_response :too_many_requests, "relation create did not hit rate limit"
+    end
+
+    private
+
+    def check_relations_for_element(path, type, id, expected_relations)
+      # check the "relations for relation" mode
+      get path
+      assert_response :success
+
+      # count one osm element
+      assert_select "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
+
+      # we should have only the expected number of relations
+      assert_select "osm>relation", expected_relations.size
+
+      # and each of them should contain the element we originally searched for
+      expected_relations.each do |relation|
+        # The relation should appear once, but the element could appear multiple times
+        assert_select "osm>relation[id='#{relation.id}']", 1
+        assert_select "osm>relation[id='#{relation.id}']>member[type='#{type}'][ref='#{id}']"
+      end
+    end
 
     ##
     # checks that the XML document and the string arguments have
@@ -993,10 +1093,10 @@ module Api
         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}"
-        assert_select "osm>changeset[min_lon='#{format('%.7f', bbox.min_lon)}']", 1, "Changeset min_lon wrong in #{@response.body}"
-        assert_select "osm>changeset[min_lat='#{format('%.7f', bbox.min_lat)}']", 1, "Changeset min_lat wrong in #{@response.body}"
-        assert_select "osm>changeset[max_lon='#{format('%.7f', bbox.max_lon)}']", 1, "Changeset max_lon wrong in #{@response.body}"
-        assert_select "osm>changeset[max_lat='#{format('%.7f', bbox.max_lat)}']", 1, "Changeset max_lat wrong in #{@response.body}"
+        assert_select "osm>changeset[min_lon='#{format('%<lon>.7f', :lon => bbox.min_lon)}']", 1, "Changeset min_lon wrong in #{@response.body}"
+        assert_select "osm>changeset[min_lat='#{format('%<lat>.7f', :lat => bbox.min_lat)}']", 1, "Changeset min_lat wrong in #{@response.body}"
+        assert_select "osm>changeset[max_lon='#{format('%<lon>.7f', :lon => bbox.max_lon)}']", 1, "Changeset max_lon wrong in #{@response.body}"
+        assert_select "osm>changeset[max_lat='#{format('%<lat>.7f', :lat => bbox.max_lat)}']", 1, "Changeset max_lat wrong in #{@response.body}"
       end
     end
 
@@ -1019,7 +1119,7 @@ module Api
     ##
     # updates the relation (XML) +rel+ and
     # yields the new version of that relation into the block.
-    # the parsed XML doc is retured.
+    # the parsed XML doc is returned.
     def with_update(rel, headers)
       rel_id = rel.find("//osm/relation").first["id"].to_i
       put api_relation_path(:id => rel_id), :params => rel.to_s, :headers => headers
@@ -1039,14 +1139,14 @@ module Api
     ##
     # 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.
+    # the parsed XML doc is returned.
     def with_update_diff(rel, headers)
       rel_id = rel.find("//osm/relation").first["id"].to_i
       cs_id = rel.find("//osm/relation").first["changeset"].to_i
       version = nil
 
       with_controller(Api::ChangesetsController.new) do
-        doc = OSM::API.new.get_xml_doc
+        doc = OSM::API.new.xml_doc
         change = XML::Node.new "osmChange"
         doc.root = change
         modify = XML::Node.new "modify"