test/controllers/api/old_relations_controller_test.rb

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