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
 155       get api_node_version_path(node, 1, :show_redactions => "true")
 156
 157       assert_response :forbidden, "Redacted node shouldn't be visible via the version API when passing flag."
 158     end
 159
 160     def test_show_redacted_normal_user
 161       node = create(:node, :with_history, :version => 2)
 162       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
 163
 164       get api_node_version_path(node, 1), :headers => bearer_authorization_header
 165
 166       assert_response :forbidden, "Redacted node shouldn't be visible via the version API, even when logged in."
 167
 168       get api_node_version_path(node, 1, :show_redactions => "true"), :headers => bearer_authorization_header
 169
 170       assert_response :forbidden, "Redacted node shouldn't be visible via the version API, even when logged in and passing flag."
 171     end
 172
 173     def test_show_redacted_moderator
 174       node = create(:node, :with_history, :version => 2)
 175       node.old_nodes.find_by(:version => 1).redact!(create(:redaction))
 176       auth_header = bearer_authorization_header create(:moderator_user)
 177
 178       get api_node_version_path(node, 1), :headers => auth_header
 179
 180       assert_response :forbidden, "Redacted node should be gone for moderator, when flag not passed."
 181
 182       get api_node_version_path(node, 1, :show_redactions => "true"), :headers => auth_header
 183
 184       assert_response :success, "Redacted node should not be gone for moderator, when flag passed."
 185     end
 186
 187     # Ensure the lat/lon is formatted as a decimal e.g. not 4.0e-05
 188     def test_lat_lon_xml_format
 189       old_node = create(:old_node, :latitude => (0.00004 * OldNode::SCALE).to_i, :longitude => (0.00008 * OldNode::SCALE).to_i)
 190
 191       get api_node_versions_path(old_node.node_id)
 192       assert_match(/lat="0.0000400"/, response.body)
 193       assert_match(/lon="0.0000800"/, response.body)
 194     end
 195
 196     ##
 197     # test the redaction of an old version of a node, while not being
 198     # authorised.
 199     def test_redact_node_unauthorised
 200       node = create(:node, :with_history, :version => 4)
 201       node_v3 = node.old_nodes.find_by(:version => 3)
 202
 203       do_redact_node(node_v3,
 204                      create(:redaction))
 205       assert_response :unauthorized, "should need to be authenticated to redact."
 206     end
 207
 208     ##
 209     # test the redaction of an old version of a node, while being
 210     # authorised as a normal user.
 211     def test_redact_node_normal_user
 212       auth_header = bearer_authorization_header
 213
 214       node = create(:node, :with_history, :version => 4)
 215       node_v3 = node.old_nodes.find_by(:version => 3)
 216
 217       do_redact_node(node_v3,
 218                      create(:redaction),
 219                      auth_header)
 220       assert_response :forbidden, "should need to be moderator to redact."
 221     end
 222
 223     ##
 224     # test that, even as moderator, the current version of a node
 225     # can't be redacted.
 226     def test_redact_node_current_version
 227       auth_header = bearer_authorization_header create(:moderator_user)
 228
 229       node = create(:node, :with_history, :version => 4)
 230       node_v4 = node.old_nodes.find_by(:version => 4)
 231
 232       do_redact_node(node_v4,
 233                      create(:redaction),
 234                      auth_header)
 235       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
 236     end
 237
 238     def test_redact_node_by_regular_without_write_redactions_scope
 239       auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api])
 240       do_redact_redactable_node(auth_header)
 241       assert_response :forbidden, "should need to be moderator to redact."
 242     end
 243
 244     def test_redact_node_by_regular_with_write_redactions_scope
 245       auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions])
 246       do_redact_redactable_node(auth_header)
 247       assert_response :forbidden, "should need to be moderator to redact."
 248     end
 249
 250     def test_redact_node_by_moderator_without_write_redactions_scope
 251       auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api])
 252       do_redact_redactable_node(auth_header)
 253       assert_response :forbidden, "should need to have write_redactions scope to redact."
 254     end
 255
 256     def test_redact_node_by_moderator_with_write_redactions_scope
 257       auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions])
 258       do_redact_redactable_node(auth_header)
 259       assert_response :success, "should be OK to redact old version as moderator with write_redactions scope."
 260     end
 261
 262     ##
 263     # test the redaction of an old version of a node, while being
 264     # authorised as a moderator.
 265     def test_redact_node_moderator
 266       node = create(:node, :with_history, :version => 4)
 267       node_v3 = node.old_nodes.find_by(:version => 3)
 268       auth_header = bearer_authorization_header create(:moderator_user)
 269
 270       do_redact_node(node_v3, create(:redaction), auth_header)
 271
 272       assert_response :success, "should be OK to redact old version as moderator."
 273       assert_predicate node_v3.reload, :redacted?
 274     end
 275
 276     ##
 277     # test the unredaction of an old version of a node, while not being
 278     # authorised.
 279     def test_unredact_node_unauthorised
 280       node = create(:node, :with_history, :version => 2)
 281       node_v1 = node.old_nodes.find_by(:version => 1)
 282       node_v1.redact!(create(:redaction))
 283
 284       post node_version_redact_path(node_v1.node_id, node_v1.version)
 285       assert_response :unauthorized, "should need to be authenticated to unredact."
 286     end
 287
 288     ##
 289     # test the unredaction of an old version of a node, while being
 290     # authorised as a normal user.
 291     def test_unredact_node_normal_user
 292       user = create(:user)
 293       node = create(:node, :with_history, :version => 2)
 294       node_v1 = node.old_nodes.find_by(:version => 1)
 295       node_v1.redact!(create(:redaction))
 296
 297       auth_header = bearer_authorization_header user
 298
 299       post node_version_redact_path(node_v1.node_id, node_v1.version), :headers => auth_header
 300       assert_response :forbidden, "should need to be moderator to unredact."
 301     end
 302
 303     ##
 304     # test the unredaction of an old version of a node, while being
 305     # authorised as a moderator.
 306     def test_unredact_node_moderator
 307       moderator_user = create(:moderator_user)
 308       node = create(:node, :with_history, :version => 2)
 309       node_v1 = node.old_nodes.find_by(:version => 1)
 310       node_v1.redact!(create(:redaction))
 311
 312       auth_header = bearer_authorization_header moderator_user
 313
 314       post node_version_redact_path(node_v1.node_id, node_v1.version), :headers => auth_header
 315       assert_response :success, "should be OK to unredact old version as moderator."
 316
 317       # check moderator can now see the redacted data, when not
 318       # passing the aspecial flag
 319       get api_node_version_path(node_v1.node_id, node_v1.version), :headers => auth_header
 320       assert_response :success, "After unredaction, node should not be gone for moderator."
 321
 322       # and when accessed via history
 323       get api_node_versions_path(node)
 324       assert_response :success, "Unredaction shouldn't have stopped history working."
 325       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 326                     "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for moderators without passing flag."
 327
 328       auth_header = bearer_authorization_header
 329
 330       # check normal user can now see the redacted data
 331       get api_node_version_path(node_v1.node_id, node_v1.version), :headers => auth_header
 332       assert_response :success, "After unredaction, node should be visible to normal users."
 333
 334       # and when accessed via history
 335       get api_node_versions_path(node)
 336       assert_response :success, "Unredaction shouldn't have stopped history working."
 337       assert_select "osm node[id='#{node_v1.node_id}'][version='#{node_v1.version}']", 1,
 338                     "node #{node_v1.node_id} version #{node_v1.version} should now be present in the history for normal users without passing flag."
 339     end
 340
 341     private
 342
 343     def do_redact_redactable_node(headers = {})
 344       node = create(:node, :with_history, :version => 4)
 345       node_v3 = node.old_nodes.find_by(:version => 3)
 346       do_redact_node(node_v3, create(:redaction), headers)
 347     end
 348
 349     def do_redact_node(node, redaction, headers = {})
 350       get api_node_version_path(node.node_id, node.version), :headers => headers
 351       assert_response :success, "should be able to get version #{node.version} of node #{node.node_id}."
 352
 353       # now redact it
 354       post node_version_redact_path(node.node_id, node.version), :params => { :redaction => redaction.id }, :headers => headers
 355     end
 356
 357     def check_not_found_id_version(id, version)
 358       get api_node_version_path(id, version)
 359       assert_response :not_found
 360     rescue ActionController::UrlGenerationError => e
 361       assert_match(/No route matches/, e.to_s)
 362     end
 363   end
 364 end