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     ##
 165     # Test that getting the current version is identical to picking
 166     # that version with the version URI call.
 167     def test_current_version
 168       node = create(:node, :with_history)
 169       used_node = create(:node, :with_history)
 170       create(:way_node, :node => used_node)
 171       node_used_by_relationship = create(:node, :with_history)
 172       create(:relation_member, :member => node_used_by_relationship)
 173       node_with_versions = create(:node, :with_history, :version => 4)
 174
 175       create(:node_tag, :node => node)
 176       create(:node_tag, :node => used_node)
 177       create(:node_tag, :node => node_used_by_relationship)
 178       create(:node_tag, :node => node_with_versions)
 179       propagate_tags(node, node.old_nodes.last)
 180       propagate_tags(used_node, used_node.old_nodes.last)
 181       propagate_tags(node_used_by_relationship, node_used_by_relationship.old_nodes.last)
 182       propagate_tags(node_with_versions, node_with_versions.old_nodes.last)
 183
 184       check_current_version(node)
 185       check_current_version(used_node)
 186       check_current_version(node_used_by_relationship)
 187       check_current_version(node_with_versions)
 188     end
 189
 190     ##
 191     # test the redaction of an old version of a node, while not being
 192     # authorised.
 193     def test_redact_node_unauthorised
 194       node = create(:node, :with_history, :version => 4)
 195       node_v3 = node.old_nodes.find_by(:version => 3)
 196
 197       do_redact_node(node_v3,
 198                      create(:redaction))
 199       assert_response :unauthorized, "should need to be authenticated to redact."
 200     end
 201
 202     ##
 203     # test the redaction of an old version of a node, while being
 204     # authorised as a normal user.
 205     def test_redact_node_normal_user
 206       auth_header = basic_authorization_header create(:user).email, "test"
 207
 208       node = create(:node, :with_history, :version => 4)
 209       node_v3 = node.old_nodes.find_by(:version => 3)
 210
 211       do_redact_node(node_v3,
 212                      create(:redaction),
 213                      auth_header)
 214       assert_response :forbidden, "should need to be moderator to redact."
 215     end
 216
 217     ##
 218     # test that, even as moderator, the current version of a node
 219     # can't be redacted.
 220     def test_redact_node_current_version
 221       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 222
 223       node = create(:node, :with_history, :version => 4)
 224       node_v4 = node.old_nodes.find_by(:version => 4)
 225
 226       do_redact_node(node_v4,
 227                      create(:redaction),
 228                      auth_header)
 229       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
 230     end
 231
 232     ##
 233     # test that redacted nodes aren't visible, regardless of
 234     # authorisation except as moderator...
 235     def test_version_redacted
 236       node = create(:node, :with_history, :version => 2)
 237       node_v1 = node.old_nodes.find_by(:version => 1)
 238       node_v1.redact!(create(:redaction))
 239
 240       get node_version_path(:id => node_v1.node_id, :version => node_v1.version)
 241       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 242
 243       # not even to a logged-in user
 244       auth_header = basic_authorization_header create(:user).email, "test"
 245       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 246       assert_response :forbidden, "Redacted node shouldn't be visible via the version API, even when logged in."
 247     end
 248
 249     ##
 250     # test that redacted nodes aren't visible in the history
 251     def test_history_redacted
 252       node = create(:node, :with_history, :version => 2)
 253       node_v1 = node.old_nodes.find_by(:version => 1)
 254       node_v1.redact!(create(:redaction))
 255
 256       get api_node_history_path(:id => node_v1.node_id)
 257       assert_response :success, "Redaction shouldn't have stopped history working."
 258       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 0,
 259                     "redacted node #{node_v1.node_id} version #{node_v1.version} shouldn't be present in the history."
 260
 261       # not even to a logged-in user
 262       auth_header = basic_authorization_header create(:user).email, "test"
 263       get api_node_history_path(:id => node_v1.node_id), :headers => auth_header
 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,
 266                     "redacted node #{node_v1.node_id} version #{node_v1.version} shouldn't be present in the history, even when logged in."
 267     end
 268
 269     ##
 270     # test the redaction of an old version of a node, while being
 271     # authorised as a moderator.
 272     def test_redact_node_moderator
 273       node = create(:node, :with_history, :version => 4)
 274       node_v3 = node.old_nodes.find_by(:version => 3)
 275       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 276
 277       do_redact_node(node_v3, create(:redaction), auth_header)
 278       assert_response :success, "should be OK to redact old version as moderator."
 279
 280       # check moderator can still see the redacted data, when passing
 281       # the appropriate flag
 282       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :headers => auth_header
 283       assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed."
 284       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :params => { :show_redactions => "true" }, :headers => auth_header
 285       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 286
 287       # and when accessed via history
 288       get api_node_history_path(:id => node_v3.node_id)
 289       assert_response :success, "Redaction shouldn't have stopped history working."
 290       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 0,
 291                     "node #{node_v3.node_id} version #{node_v3.version} should not be present in the history for moderators when not passing flag."
 292       get api_node_history_path(:id => node_v3.node_id), :params => { :show_redactions => "true" }, :headers => auth_header
 293       assert_response :success, "Redaction shouldn't have stopped history working."
 294       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 1,
 295                     "node #{node_v3.node_id} version #{node_v3.version} should still be present in the history for moderators when passing flag."
 296     end
 297
 298     # testing that if the moderator drops auth, he can't see the
 299     # redacted stuff any more.
 300     def test_redact_node_is_redacted
 301       node = create(:node, :with_history, :version => 4)
 302       node_v3 = node.old_nodes.find_by(:version => 3)
 303       auth_header = basic_authorization_header create(:moderator_user).email, "test"
 304
 305       do_redact_node(node_v3, create(:redaction), auth_header)
 306       assert_response :success, "should be OK to redact old version as moderator."
 307
 308       # re-auth as non-moderator
 309       auth_header = basic_authorization_header create(:user).email, "test"
 310
 311       # check can't see the redacted data
 312       get node_version_path(:id => node_v3.node_id, :version => node_v3.version), :headers => auth_header
 313       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 314
 315       # and when accessed via history
 316       get api_node_history_path(:id => node_v3.node_id), :headers => auth_header
 317       assert_response :success, "Redaction shouldn't have stopped history working."
 318       assert_select "osm node[id='#{node_v3.node_id}'][version='#{node_v3.version}']", 0,
 319                     "redacted node #{node_v3.node_id} version #{node_v3.version} shouldn't be present in the history."
 320     end
 321
 322     ##
 323     # test the unredaction of an old version of a node, while not being
 324     # authorised.
 325     def test_unredact_node_unauthorised
 326       node = create(:node, :with_history, :version => 2)
 327       node_v1 = node.old_nodes.find_by(:version => 1)
 328       node_v1.redact!(create(:redaction))
 329
 330       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version)
 331       assert_response :unauthorized, "should need to be authenticated to unredact."
 332     end
 333
 334     ##
 335     # test the unredaction of an old version of a node, while being
 336     # authorised as a normal user.
 337     def test_unredact_node_normal_user
 338       user = create(:user)
 339       node = create(:node, :with_history, :version => 2)
 340       node_v1 = node.old_nodes.find_by(:version => 1)
 341       node_v1.redact!(create(:redaction))
 342
 343       auth_header = basic_authorization_header user.email, "test"
 344
 345       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 346       assert_response :forbidden, "should need to be moderator to unredact."
 347     end
 348
 349     ##
 350     # test the unredaction of an old version of a node, while being
 351     # authorised as a moderator.
 352     def test_unredact_node_moderator
 353       moderator_user = create(:moderator_user)
 354       node = create(:node, :with_history, :version => 2)
 355       node_v1 = node.old_nodes.find_by(:version => 1)
 356       node_v1.redact!(create(:redaction))
 357
 358       auth_header = basic_authorization_header moderator_user.email, "test"
 359
 360       post node_version_redact_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 361       assert_response :success, "should be OK to unredact old version as moderator."
 362
 363       # check moderator can now see the redacted data, when not
 364       # passing the aspecial flag
 365       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 366       assert_response :success, "After unredaction, node should not be gone for moderator."
 367
 368       # and when accessed via history
 369       get api_node_history_path(:id => node_v1.node_id)
 370       assert_response :success, "Unredaction shouldn't have stopped history working."
 371       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 372                     "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for moderators without passing flag."
 373
 374       auth_header = basic_authorization_header create(:user).email, "test"
 375
 376       # check normal user can now see the redacted data
 377       get node_version_path(:id => node_v1.node_id, :version => node_v1.version), :headers => auth_header
 378       assert_response :success, "After unredaction, node should be visible to normal users."
 379
 380       # and when accessed via history
 381       get api_node_history_path(:id => node_v1.node_id)
 382       assert_response :success, "Unredaction shouldn't have stopped history working."
 383       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 384                     "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     def check_not_found_id_version(id, version)
 416       get node_version_path(:id => id, :version => version)
 417       assert_response :not_found
 418     rescue ActionController::UrlGenerationError => e
 419       assert_match(/No route matches/, e.to_s)
 420     end
 421
 422     ##
 423     # returns a 16 character long string with some nasty characters in it.
 424     # this ought to stress-test the tag handling as well as the versioning.
 425     def random_string
 426       letters = [["!", '"', "$", "&", ";", "@"],
 427                  ("a".."z").to_a,
 428                  ("A".."Z").to_a,
 429                  ("0".."9").to_a].flatten
 430       (1..16).map { |_i| letters[rand(letters.length)] }.join
 431     end
 432
 433     ##
 434     # truncate a floating point number to the scale that it is stored in
 435     # the database. otherwise rounding errors can produce failing unit
 436     # tests when they shouldn't.
 437     def precision(f)
 438       (f * GeoRecord::SCALE).round.to_f / GeoRecord::SCALE
 439     end
 440
 441     def propagate_tags(node, old_node)
 442       node.tags.each do |k, v|
 443         create(:old_node_tag, :old_node => old_node, :k => k, :v => v)
 444       end
 445     end
 446   end
 447 end