test/controllers/api/old_nodes_controller_test.rb

   1 require "test_helper"
   2
   3 module Api
   4   class OldNodesControllerTest < ActionDispatch::IntegrationTest
   5     #
   6     # TODO: test history
   7     #
   8
   9     ##
  10     # test all routes which lead to this controller
  11     def test_routes
  12       assert_routing(
  13         { :path => "/api/0.6/node/1/history", :method => :get },
  14         { :controller => "api/old_nodes", :action => "history", :id => "1" }
  15       )
  16       assert_routing(
  17         { :path => "/api/0.6/node/1/2", :method => :get },
  18         { :controller => "api/old_nodes", :action => "version", :id => "1", :version => "2" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/node/1/history.json", :method => :get },
  22         { :controller => "api/old_nodes", :action => "history", :id => "1", :format => "json" }
  23       )
  24       assert_routing(
  25         { :path => "/api/0.6/node/1/2.json", :method => :get },
  26         { :controller => "api/old_nodes", :action => "version", :id => "1", :version => "2", :format => "json" }
  27       )
  28       assert_routing(
  29         { :path => "/api/0.6/node/1/2/redact", :method => :post },
  30         { :controller => "api/old_nodes", :action => "redact", :id => "1", :version => "2" }
  31       )
  32     end
  33
  34     ##
  35     # test the version call by submitting several revisions of a new node
  36     # to the API and ensuring that later calls to version return the
  37     # matching versions of the object.
  38     #
  39     ##
  40     # FIXME: Move this test to being an integration test since it spans multiple controllers
  41     def test_version
  42       private_user = create(:user, :data_public => false)
  43       private_node = create(:node, :with_history, :version => 4, :changeset => create(:changeset, :user => private_user))
  44       user = create(:user)
  45       node = create(:node, :with_history, :version => 4, :changeset => create(:changeset, :user => user))
  46       create_list(:node_tag, 2, :node => node)
  47       # Ensure that the current tags are propagated to the history too
  48       propagate_tags(node, node.old_nodes.last)
  49
  50       ## First try this with a non-public user
  51       auth_header = basic_authorization_header private_user.email, "test"
  52
  53       # setup a simple XML node
  54       xml_doc = xml_for_node(private_node)
  55       xml_node = xml_doc.find("//osm/node").first
  56       nodeid = private_node.id
  57
  58       # keep a hash of the versions => string, as we'll need something
  59       # to test against later
  60       versions = {}
  61
  62       # save a version for later checking
  63       versions[xml_node["version"]] = xml_doc.to_s
  64
  65       # randomly move the node about
  66       3.times do
  67         # move the node somewhere else
  68         xml_node["lat"] = precision(rand * 180 - 90).to_s
  69         xml_node["lon"] = precision(rand * 360 - 180).to_s
  70         with_controller(NodesController.new) do
  71           put api_node_path(:id => nodeid), :params => xml_doc.to_s, :headers => auth_header
  72           assert_response :forbidden, "Should have rejected node update"
  73           xml_node["version"] = @response.body.to_s
  74         end
  75         # save a version for later checking
  76         versions[xml_node["version"]] = xml_doc.to_s
  77       end
  78
  79       # add a bunch of random tags
  80       3.times do
  81         xml_tag = XML::Node.new("tag")
  82         xml_tag["k"] = random_string
  83         xml_tag["v"] = random_string
  84         xml_node << xml_tag
  85         with_controller(NodesController.new) do
  86           put api_node_path(:id => nodeid), :params => xml_doc.to_s, :headers => auth_header
  87           assert_response :forbidden,
  88                           "should have rejected node #{nodeid} (#{@response.body}) with forbidden"
  89           xml_node["version"] = @response.body.to_s
  90         end
  91         # save a version for later checking
  92         versions[xml_node["version"]] = xml_doc.to_s
  93       end
  94
  95       # probably should check that they didn't get written to the database
  96
  97       ## Now do it with the public user
  98       auth_header = basic_authorization_header user.email, "test"
  99
 100       # setup a simple XML node
 101
 102       xml_doc = xml_for_node(node)
 103       xml_node = xml_doc.find("//osm/node").first
 104       nodeid = node.id
 105
 106       # keep a hash of the versions => string, as we'll need something
 107       # to test against later
 108       versions = {}
 109
 110       # save a version for later checking
 111       versions[xml_node["version"]] = xml_doc.to_s
 112
 113       # randomly move the node about
 114       3.times do
 115         # move the node somewhere else
 116         xml_node["lat"] = precision(rand * 180 - 90).to_s
 117         xml_node["lon"] = precision(rand * 360 - 180).to_s
 118         with_controller(NodesController.new) do
 119           put api_node_path(:id => nodeid), :params => xml_doc.to_s, :headers => auth_header
 120           assert_response :success
 121           xml_node["version"] = @response.body.to_s
 122         end
 123         # save a version for later checking
 124         versions[xml_node["version"]] = xml_doc.to_s
 125       end
 126
 127       # add a bunch of random tags
 128       3.times do
 129         xml_tag = XML::Node.new("tag")
 130         xml_tag["k"] = random_string
 131         xml_tag["v"] = random_string
 132         xml_node << xml_tag
 133         with_controller(NodesController.new) do
 134           put api_node_path(:id => nodeid), :params => xml_doc.to_s, :headers => auth_header
 135           assert_response :success,
 136                           "couldn't update node #{nodeid} (#{@response.body})"
 137           xml_node["version"] = @response.body.to_s
 138         end
 139         # save a version for later checking
 140         versions[xml_node["version"]] = xml_doc.to_s
 141       end
 142
 143       # check all the versions
 144       versions.each_key do |key|
 145         get node_version_path(:id => nodeid, :version => key.to_i)
 146
 147         assert_response :success,
 148                         "couldn't get version #{key.to_i} of node #{nodeid}"
 149
 150         check_node = Node.from_xml(versions[key])
 151         api_node = Node.from_xml(@response.body.to_s)
 152
 153         assert_nodes_are_equal check_node, api_node
 154       end
 155     end
 156
 157     def test_not_found_version
 158       check_not_found_id_version(70000, 312344)
 159       check_not_found_id_version(-1, -13)
 160       check_not_found_id_version(create(:node).id, 24354)
 161       check_not_found_id_version(24356, create(:node).version)
 162     end
 163
 164     def check_not_found_id_version(id, version)
 165       get node_version_path(:id => id, :version => version)
 166       assert_response :not_found
 167     rescue ActionController::UrlGenerationError => e
 168       assert_match(/No route matches/, e.to_s)
 169     end
 170
 171     ##
 172     # Test that getting the current version is identical to picking
 173     # that version with the version URI call.
 174     def test_current_version
 175       node = create(:node, :with_history)
 176       used_node = create(:node, :with_history)
 177       create(:way_node, :node => used_node)
 178       node_used_by_relationship = create(:node, :with_history)
 179       create(:relation_member, :member => node_used_by_relationship)
 180       node_with_versions = create(:node, :with_history, :version => 4)
 181
 182       create(:node_tag, :node => node)
 183       create(:node_tag, :node => used_node)
 184       create(:node_tag, :node => node_used_by_relationship)
 185       create(:node_tag, :node => node_with_versions)
 186       propagate_tags(node, node.old_nodes.last)
 187       propagate_tags(used_node, used_node.old_nodes.last)
 188       propagate_tags(node_used_by_relationship, node_used_by_relationship.old_nodes.last)
 189       propagate_tags(node_with_versions, node_with_versions.old_nodes.last)
 190
 191       check_current_version(node)
 192       check_current_version(used_node)
 193       check_current_version(node_used_by_relationship)
 194       check_current_version(node_with_versions)
 195     end
 196
 197     ##
 198     # test the redaction of an old version of a node, while not being
 199     # authorised.
 200     def test_redact_node_unauthorised
 201       node = create(:node, :with_history, :version => 4)
 202       node_v3 = node.old_nodes.find_by(:version => 3)
 203
 204       do_redact_node(node_v3,
 205                      create(:redaction))
 206       assert_response :unauthorized, "should need to be authenticated to redact."
 207     end
 208
 209     ##
 210     # test the redaction of an old version of a node, while being
 211     # authorised as a normal user.
 212     def test_redact_node_normal_user
 213       auth_header = basic_authorization_header create(:user).email, "test"
 214
 215       node = create(:node, :with_history, :version => 4)
 216       node_v3 = node.old_nodes.find_by(:version => 3)
 217
 218       do_redact_node(node_v3,
 219                      create(:redaction),
 220                      auth_header)
 221       assert_response :forbidden, "should need to be moderator to redact."
 222     end
 223
 224     ##
 225     # test that, even as moderator, the current version of a node
 226     # can't be redacted.
 227     def test_redact_node_current_version
 228       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 229
 230       node = create(:node, :with_history, :version => 4)
 231       node_v4 = node.old_nodes.find_by(:version => 4)
 232
 233       do_redact_node(node_v4,
 234                      create(:redaction),
 235                      auth_header)
 236       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
 237     end
 238
 239     ##
 240     # test that redacted nodes aren't visible, regardless of
 241     # authorisation except as moderator...
 242     def test_version_redacted
 243       node = create(:node, :with_history, :version => 2)
 244       node_v1 = node.old_nodes.find_by(:version => 1)
 245       node_v1.redact!(create(:redaction))
 246
 247       get node_version_path(:id => node_v1.node_id, :version => node_v1.version)
 248       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 249
 250       # not even to a logged-in user
 251       auth_header = basic_authorization_header create(:user).email, "test"
 252       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 253       assert_response :forbidden, "Redacted node shouldn't be visible via the version API, even when logged in."
 254     end
 255
 256     ##
 257     # test that redacted nodes aren't visible in the history
 258     def test_history_redacted
 259       node = create(:node, :with_history, :version => 2)
 260       node_v1 = node.old_nodes.find_by(:version => 1)
 261       node_v1.redact!(create(:redaction))
 262
 263       get api_node_history_path(:id => node_v1.node_id)
 264       assert_response :success, "Redaction shouldn't have stopped history working."
 265       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 0, "redacted node #{node_v1.node_id} version #{node_v1.version} shouldn't be present in the history."
 266
 267       # not even to a logged-in user
 268       auth_header = basic_authorization_header create(:user).email, "test"
 269       get api_node_history_path(:id => node_v1.node_id), :headers => auth_header
 270       assert_response :success, "Redaction shouldn't have stopped history working."
 271       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 0, "redacted node #{node_v1.node_id} version #{node_v1.version} shouldn't be present in the history, even when logged in."
 272     end
 273
 274     ##
 275     # test the redaction of an old version of a node, while being
 276     # authorised as a moderator.
 277     def test_redact_node_moderator
 278       node = create(:node, :with_history, :version => 4)
 279       node_v3 = node.old_nodes.find_by(:version => 3)
 280       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 281
 282       do_redact_node(node_v3, create(:redaction), auth_header)
 283       assert_response :success, "should be OK to redact old version as moderator."
 284
 285       # check moderator can still see the redacted data, when passing
 286       # the appropriate flag
 287       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :headers => auth_header
 288       assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed."
 289       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :params => { :show_redactions => "true" }, :headers => auth_header
 290       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 291
 292       # and when accessed via history
 293       get api_node_history_path(:id => node_v3.node_id)
 294       assert_response :success, "Redaction shouldn't have stopped history working."
 295       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 0, "node #{node_v3.node_id} version #{node_v3.version} should not be present in the history for moderators when not passing flag."
 296       get api_node_history_path(:id => node_v3.node_id), :params => { :show_redactions => "true" }, :headers => auth_header
 297       assert_response :success, "Redaction shouldn't have stopped history working."
 298       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 1, "node #{node_v3.node_id} version #{node_v3.version} should still be present in the history for moderators when passing flag."
 299     end
 300
 301     # testing that if the moderator drops auth, he can't see the
 302     # redacted stuff any more.
 303     def test_redact_node_is_redacted
 304       node = create(:node, :with_history, :version => 4)
 305       node_v3 = node.old_nodes.find_by(:version => 3)
 306       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 307
 308       do_redact_node(node_v3, create(:redaction), auth_header)
 309       assert_response :success, "should be OK to redact old version as moderator."
 310
 311       # re-auth as non-moderator
 312       auth_header = basic_authorization_header create(:user).email, "test"
 313
 314       # check can't see the redacted data
 315       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :headers => auth_header
 316       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 317
 318       # and when accessed via history
 319       get api_node_history_path(:id => node_v3.node_id), :headers => auth_header
 320       assert_response :success, "Redaction shouldn't have stopped history working."
 321       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 0, "redacted node #{node_v3.node_id} version #{node_v3.version} shouldn't be present in the history."
 322     end
 323
 324     ##
 325     # test the unredaction of an old version of a node, while not being
 326     # authorised.
 327     def test_unredact_node_unauthorised
 328       node = create(:node, :with_history, :version => 2)
 329       node_v1 = node.old_nodes.find_by(:version => 1)
 330       node_v1.redact!(create(:redaction))
 331
 332       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version)
 333       assert_response :unauthorized, "should need to be authenticated to unredact."
 334     end
 335
 336     ##
 337     # test the unredaction of an old version of a node, while being
 338     # authorised as a normal user.
 339     def test_unredact_node_normal_user
 340       user = create(:user)
 341       node = create(:node, :with_history, :version => 2)
 342       node_v1 = node.old_nodes.find_by(:version => 1)
 343       node_v1.redact!(create(:redaction))
 344
 345       auth_header = basic_authorization_header user.email, "test"
 346
 347       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 348       assert_response :forbidden, "should need to be moderator to unredact."
 349     end
 350
 351     ##
 352     # test the unredaction of an old version of a node, while being
 353     # authorised as a moderator.
 354     def test_unredact_node_moderator
 355       moderator_user = create(:moderator_user)
 356       node = create(:node, :with_history, :version => 2)
 357       node_v1 = node.old_nodes.find_by(:version => 1)
 358       node_v1.redact!(create(:redaction))
 359
 360       auth_header = basic_authorization_header moderator_user.email, "test"
 361
 362       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 363       assert_response :success, "should be OK to unredact old version as moderator."
 364
 365       # check moderator can now see the redacted data, when not
 366       # passing the aspecial flag
 367       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 368       assert_response :success, "After unredaction, node should not be gone for moderator."
 369
 370       # and when accessed via history
 371       get api_node_history_path(:id => node_v1.node_id)
 372       assert_response :success, "Unredaction shouldn't have stopped history working."
 373       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1, "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for moderators without passing flag."
 374
 375       auth_header = basic_authorization_header create(:user).email, "test"
 376
 377       # check normal user can now see the redacted data
 378       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 379       assert_response :success, "After unredaction, node should be visible to normal users."
 380
 381       # and when accessed via history
 382       get api_node_history_path(:id => node_v1.node_id)
 383       assert_response :success, "Unredaction shouldn't have stopped history working."
 384       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1, "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for normal users without passing flag."
 385     end
 386
 387     private
 388
 389     def do_redact_node(node, redaction, headers = {})
 390       get node_version_path(:id => node.node_id, :version => node.version), :headers => headers
 391       assert_response :success, "should be able to get version #{node.version} of node #{node.node_id}."
 392
 393       # now redact it
 394       post node_version_redact_path(:id => node.node_id, :version => node.version), :params => { :redaction => redaction.id }, :headers => headers
 395     end
 396
 397     def check_current_version(node_id)
 398       # get the current version of the node
 399       current_node = with_controller(NodesController.new) do
 400         get api_node_path(:id => node_id)
 401         assert_response :success, "cant get current node #{node_id}"
 402         Node.from_xml(@response.body)
 403       end
 404       assert_not_nil current_node, "getting node #{node_id} returned nil"
 405
 406       # get the "old" version of the node from the old_node interface
 407       get node_version_path(:id => node_id, :version => current_node.version)
 408       assert_response :success, "cant get old node #{node_id}, v#{current_node.version}"
 409       old_node = Node.from_xml(@response.body)
 410
 411       # check the nodes are the same
 412       assert_nodes_are_equal current_node, old_node
 413     end
 414
 415     ##
 416     # returns a 16 character long string with some nasty characters in it.
 417     # this ought to stress-test the tag handling as well as the versioning.
 418     def random_string
 419       letters = [["!", '"', "$", "&", ";", "@"],
 420                  ("a".."z").to_a,
 421                  ("A".."Z").to_a,
 422                  ("0".."9").to_a].flatten
 423       (1..16).map { |_i| letters[rand(letters.length)] }.join
 424     end
 425
 426     ##
 427     # truncate a floating point number to the scale that it is stored in
 428     # the database. otherwise rounding errors can produce failing unit
 429     # tests when they shouldn't.
 430     def precision(f)
 431       (f * GeoRecord::SCALE).round.to_f / GeoRecord::SCALE
 432     end
 433
 434     def propagate_tags(node, old_node)
 435       node.tags.each do |k, v|
 436         create(:old_node_tag, :old_node => old_node, :k => k, :v => v)
 437       end
 438     end
 439   end
 440 end