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