test/controllers/api/old_nodes_controller_test.rb

   1 require "test_helper"
   2
   3 module Api
   4   class OldNodesControllerTest < ActionDispatch::IntegrationTest
   5     ##
   6     # test all routes which lead to this controller
   7     def test_routes
   8       assert_routing(
   9         { :path => "/api/0.6/node/1/history", :method => :get },
  10         { :controller => "api/old_nodes", :action => "index", :node_id => "1" }
  11       )
  12       assert_routing(
  13         { :path => "/api/0.6/node/1/history.json", :method => :get },
  14         { :controller => "api/old_nodes", :action => "index", :node_id => "1", :format => "json" }
  15       )
  16       assert_routing(
  17         { :path => "/api/0.6/node/1/2", :method => :get },
  18         { :controller => "api/old_nodes", :action => "show", :node_id => "1", :version => "2" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/node/1/2.json", :method => :get },
  22         { :controller => "api/old_nodes", :action => "show", :node_id => "1", :version => "2", :format => "json" }
  23       )
  24       assert_routing(
  25         { :path => "/api/0.6/node/1/2/redact", :method => :post },
  26         { :controller => "api/old_nodes", :action => "redact", :node_id => "1", :version => "2" }
  27       )
  28     end
  29
  30     def test_index
  31       node = create(:node, :version => 2)
  32       create(:old_node, :node_id => node.id, :version => 1, :latitude => 60 * OldNode::SCALE, :longitude => 30 * OldNode::SCALE)
  33       create(:old_node, :node_id => node.id, :version => 2, :latitude => 61 * OldNode::SCALE, :longitude => 31 * OldNode::SCALE)
  34
  35       get api_node_versions_path(node)
  36
  37       assert_response :success
  38       assert_dom "osm:root", 1 do
  39         assert_dom "> node", 2 do |dom_nodes|
  40           assert_dom dom_nodes[0], "> @id", node.id.to_s
  41           assert_dom dom_nodes[0], "> @version", "1"
  42           assert_dom dom_nodes[0], "> @lat", "60.0000000"
  43           assert_dom dom_nodes[0], "> @lon", "30.0000000"
  44
  45           assert_dom dom_nodes[1], "> @id", node.id.to_s
  46           assert_dom dom_nodes[1], "> @version", "2"
  47           assert_dom dom_nodes[1], "> @lat", "61.0000000"
  48           assert_dom dom_nodes[1], "> @lon", "31.0000000"
  49         end
  50       end
  51     end
  52
  53     ##
  54     # test that redacted nodes aren't visible in the history
  55     def test_index_redacted_unauthorised
  56       node = create(:node, :with_history, :version => 2)
  57       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
  58
  59       get api_node_versions_path(node)
  60
  61       assert_response :success, "Redaction shouldn't have stopped history working."
  62       assert_dom "osm node[id='#{node.id}'][version='1']", 0,
  63                  "redacted node #{node.id} version 1 shouldn't be present in the history."
  64
  65       get api_node_versions_path(node, :show_redactions => "true")
  66
  67       assert_response :success, "Redaction shouldn't have stopped history working."
  68       assert_dom "osm node[id='#{node.id}'][version='1']", 0,
  69                  "redacted node #{node.id} version 1 shouldn't be present in the history when passing flag."
  70     end
  71
  72     def test_index_redacted_normal_user
  73       node = create(:node, :with_history, :version => 2)
  74       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
  75
  76       get api_node_versions_path(node), :headers => bearer_authorization_header
  77
  78       assert_response :success, "Redaction shouldn't have stopped history working."
  79       assert_dom "osm node[id='#{node.id}'][version='1']", 0,
  80                  "redacted node #{node.id} version 1 shouldn't be present in the history, even when logged in."
  81
  82       get api_node_versions_path(node, :show_redactions => "true"), :headers => bearer_authorization_header
  83
  84       assert_response :success, "Redaction shouldn't have stopped history working."
  85       assert_dom "osm node[id='#{node.id}'][version='1']", 0,
  86                  "redacted node #{node.id} version 1 shouldn't be present in the history, even when logged in and passing flag."
  87     end
  88
  89     def test_index_redacted_moderator
  90       node = create(:node, :with_history, :version => 2)
  91       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
  92       auth_header = bearer_authorization_header create(:moderator_user)
  93
  94       get api_node_versions_path(node), :headers => auth_header
  95
  96       assert_response :success, "Redaction shouldn't have stopped history working."
  97       assert_dom "osm node[id='#{node.id}'][version='1']", 0,
  98                  "node #{node.id} version 1 should not be present in the history for moderators when not passing flag."
  99
 100       get api_node_versions_path(node, :show_redactions => "true"), :headers => auth_header
 101
 102       assert_response :success, "Redaction shouldn't have stopped history working."
 103       assert_dom "osm node[id='#{node.id}'][version='1']", 1,
 104                  "node #{node.id} version 1 should still be present in the history for moderators when passing flag."
 105     end
 106
 107     def test_show
 108       node = create(:node, :version => 2)
 109       create(:old_node, :node_id => node.id, :version => 1, :latitude => 60 * OldNode::SCALE, :longitude => 30 * OldNode::SCALE)
 110       create(:old_node, :node_id => node.id, :version => 2, :latitude => 61 * OldNode::SCALE, :longitude => 31 * OldNode::SCALE)
 111
 112       get api_node_version_path(node, 1)
 113
 114       assert_response :success
 115       assert_dom "osm:root", 1 do
 116         assert_dom "> node", 1 do
 117           assert_dom "> @id", node.id.to_s
 118           assert_dom "> @version", "1"
 119           assert_dom "> @lat", "60.0000000"
 120           assert_dom "> @lon", "30.0000000"
 121         end
 122       end
 123
 124       get api_node_version_path(node, 2)
 125
 126       assert_response :success
 127       assert_dom "osm:root", 1 do
 128         assert_dom "> node", 1 do
 129           assert_dom "> @id", node.id.to_s
 130           assert_dom "> @version", "2"
 131           assert_dom "> @lat", "61.0000000"
 132           assert_dom "> @lon", "31.0000000"
 133         end
 134       end
 135     end
 136
 137     def test_show_not_found
 138       check_not_found_id_version(70000, 312344)
 139       check_not_found_id_version(-1, -13)
 140       check_not_found_id_version(create(:node).id, 24354)
 141       check_not_found_id_version(24356, create(:node).version)
 142     end
 143
 144     ##
 145     # test that redacted nodes aren't visible, regardless of
 146     # authorisation except as moderator...
 147     def test_show_redacted_unauthorised
 148       node = create(:node, :with_history, :version => 2)
 149       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
 150
 151       get api_node_version_path(node, 1)
 152
 153       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 154     end
 155
 156     def test_show_redacted_normal_user
 157       node = create(:node, :with_history, :version => 2)
 158       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
 159
 160       get api_node_version_path(node, 1), :headers => bearer_authorization_header
 161
 162       assert_response :forbidden, "Redacted node shouldn't be visible via the version API, even when logged in."
 163     end
 164
 165     # Ensure the lat/lon is formatted as a decimal e.g. not 4.0e-05
 166     def test_lat_lon_xml_format
 167       old_node = create(:old_node, :latitude => (0.00004 * OldNode::SCALE).to_i, :longitude => (0.00008 * OldNode::SCALE).to_i)
 168
 169       get api_node_versions_path(old_node.node_id)
 170       assert_match(/lat="0.0000400"/, response.body)
 171       assert_match(/lon="0.0000800"/, response.body)
 172     end
 173
 174     ##
 175     # test the redaction of an old version of a node, while not being
 176     # authorised.
 177     def test_redact_node_unauthorised
 178       node = create(:node, :with_history, :version => 4)
 179       node_v3 = node.old_nodes.find_by(:version => 3)
 180
 181       do_redact_node(node_v3,
 182                      create(:redaction))
 183       assert_response :unauthorized, "should need to be authenticated to redact."
 184     end
 185
 186     ##
 187     # test the redaction of an old version of a node, while being
 188     # authorised as a normal user.
 189     def test_redact_node_normal_user
 190       auth_header = bearer_authorization_header
 191
 192       node = create(:node, :with_history, :version => 4)
 193       node_v3 = node.old_nodes.find_by(:version => 3)
 194
 195       do_redact_node(node_v3,
 196                      create(:redaction),
 197                      auth_header)
 198       assert_response :forbidden, "should need to be moderator to redact."
 199     end
 200
 201     ##
 202     # test that, even as moderator, the current version of a node
 203     # can't be redacted.
 204     def test_redact_node_current_version
 205       auth_header = bearer_authorization_header create(:moderator_user)
 206
 207       node = create(:node, :with_history, :version => 4)
 208       node_v4 = node.old_nodes.find_by(:version => 4)
 209
 210       do_redact_node(node_v4,
 211                      create(:redaction),
 212                      auth_header)
 213       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
 214     end
 215
 216     def test_redact_node_by_regular_without_write_redactions_scope
 217       auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api])
 218       do_redact_redactable_node(auth_header)
 219       assert_response :forbidden, "should need to be moderator to redact."
 220     end
 221
 222     def test_redact_node_by_regular_with_write_redactions_scope
 223       auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions])
 224       do_redact_redactable_node(auth_header)
 225       assert_response :forbidden, "should need to be moderator to redact."
 226     end
 227
 228     def test_redact_node_by_moderator_without_write_redactions_scope
 229       auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api])
 230       do_redact_redactable_node(auth_header)
 231       assert_response :forbidden, "should need to have write_redactions scope to redact."
 232     end
 233
 234     def test_redact_node_by_moderator_with_write_redactions_scope
 235       auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions])
 236       do_redact_redactable_node(auth_header)
 237       assert_response :success, "should be OK to redact old version as moderator with write_redactions scope."
 238     end
 239
 240     ##
 241     # test the redaction of an old version of a node, while being
 242     # authorised as a moderator.
 243     def test_redact_node_moderator
 244       node = create(:node, :with_history, :version => 4)
 245       node_v3 = node.old_nodes.find_by(:version => 3)
 246       auth_header = bearer_authorization_header create(:moderator_user)
 247
 248       do_redact_node(node_v3, create(:redaction), auth_header)
 249
 250       assert_response :success, "should be OK to redact old version as moderator."
 251       assert_predicate node_v3.reload, :redacted?
 252
 253       # check moderator can still see the redacted data, when passing
 254       # the appropriate flag
 255       get api_node_version_path(node_v3.node_id, node_v3.version), :headers => auth_header
 256       assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed."
 257       get api_node_version_path(node_v3.node_id, node_v3.version, :show_redactions => "true"), :headers => auth_header
 258       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 259     end
 260
 261     # testing that if the moderator drops auth, he can't see the
 262     # redacted stuff any more.
 263     def test_redact_node_is_redacted
 264       node = create(:node, :with_history, :version => 4)
 265       node_v3 = node.old_nodes.find_by(:version => 3)
 266       auth_header = bearer_authorization_header create(:moderator_user)
 267
 268       do_redact_node(node_v3, create(:redaction), auth_header)
 269       assert_response :success, "should be OK to redact old version as moderator."
 270
 271       # re-auth as non-moderator
 272       auth_header = bearer_authorization_header
 273
 274       # check can't see the redacted data
 275       get api_node_version_path(node_v3.node_id, node_v3.version), :headers => auth_header
 276       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 277     end
 278
 279     ##
 280     # test the unredaction of an old version of a node, while not being
 281     # authorised.
 282     def test_unredact_node_unauthorised
 283       node = create(:node, :with_history, :version => 2)
 284       node_v1 = node.old_nodes.find_by(:version => 1)
 285       node_v1.redact!(create(:redaction))
 286
 287       post node_version_redact_path(node_v1.node_id, node_v1.version)
 288       assert_response :unauthorized, "should need to be authenticated to unredact."
 289     end
 290
 291     ##
 292     # test the unredaction of an old version of a node, while being
 293     # authorised as a normal user.
 294     def test_unredact_node_normal_user
 295       user = create(:user)
 296       node = create(:node, :with_history, :version => 2)
 297       node_v1 = node.old_nodes.find_by(:version => 1)
 298       node_v1.redact!(create(:redaction))
 299
 300       auth_header = bearer_authorization_header user
 301
 302       post node_version_redact_path(node_v1.node_id, node_v1.version), :headers => auth_header
 303       assert_response :forbidden, "should need to be moderator to unredact."
 304     end
 305
 306     ##
 307     # test the unredaction of an old version of a node, while being
 308     # authorised as a moderator.
 309     def test_unredact_node_moderator
 310       moderator_user = create(:moderator_user)
 311       node = create(:node, :with_history, :version => 2)
 312       node_v1 = node.old_nodes.find_by(:version => 1)
 313       node_v1.redact!(create(:redaction))
 314
 315       auth_header = bearer_authorization_header moderator_user
 316
 317       post node_version_redact_path(node_v1.node_id, node_v1.version), :headers => auth_header
 318       assert_response :success, "should be OK to unredact old version as moderator."
 319
 320       # check moderator can now see the redacted data, when not
 321       # passing the aspecial flag
 322       get api_node_version_path(node_v1.node_id, node_v1.version), :headers => auth_header
 323       assert_response :success, "After unredaction, node should not be gone for moderator."
 324
 325       # and when accessed via history
 326       get api_node_versions_path(node)
 327       assert_response :success, "Unredaction shouldn't have stopped history working."
 328       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 329                     "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for moderators without passing flag."
 330
 331       auth_header = bearer_authorization_header
 332
 333       # check normal user can now see the redacted data
 334       get api_node_version_path(node_v1.node_id, node_v1.version), :headers => auth_header
 335       assert_response :success, "After unredaction, node should be visible to normal users."
 336
 337       # and when accessed via history
 338       get api_node_versions_path(node)
 339       assert_response :success, "Unredaction shouldn't have stopped history working."
 340       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 341                     "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for normal users without passing flag."
 342     end
 343
 344     private
 345
 346     def do_redact_redactable_node(headers = {})
 347       node = create(:node, :with_history, :version => 4)
 348       node_v3 = node.old_nodes.find_by(:version => 3)
 349       do_redact_node(node_v3, create(:redaction), headers)
 350     end
 351
 352     def do_redact_node(node, redaction, headers = {})
 353       get api_node_version_path(node.node_id, node.version), :headers => headers
 354       assert_response :success, "should be able to get version #{node.version} of node #{node.node_id}."
 355
 356       # now redact it
 357       post node_version_redact_path(node.node_id, node.version), :params => { :redaction => redaction.id }, :headers => headers
 358     end
 359
 360     def check_not_found_id_version(id, version)
 361       get api_node_version_path(id, version)
 362       assert_response :not_found
 363     rescue ActionController::UrlGenerationError => e
 364       assert_match(/No route matches/, e.to_s)
 365     end
 366   end
 367 end