X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/53817fa9e8d955df0891d156f21b7269b4ed08fc..HEAD:/test/controllers/api/old_relations_controller_test.rb diff --git a/test/controllers/api/old_relations_controller_test.rb b/test/controllers/api/old_relations_controller_test.rb index ea26e5cb7..603499503 100644 --- a/test/controllers/api/old_relations_controller_test.rb +++ b/test/controllers/api/old_relations_controller_test.rb @@ -7,204 +7,258 @@ module Api def test_routes assert_routing( { :path => "/api/0.6/relation/1/history", :method => :get }, - { :controller => "api/old_relations", :action => "history", :id => "1" } + { :controller => "api/old_relations", :action => "index", :relation_id => "1" } ) assert_routing( - { :path => "/api/0.6/relation/1/2", :method => :get }, - { :controller => "api/old_relations", :action => "version", :id => "1", :version => "2" } + { :path => "/api/0.6/relation/1/history.json", :method => :get }, + { :controller => "api/old_relations", :action => "index", :relation_id => "1", :format => "json" } ) assert_routing( - { :path => "/api/0.6/relation/1/history.json", :method => :get }, - { :controller => "api/old_relations", :action => "history", :id => "1", :format => "json" } + { :path => "/api/0.6/relation/1/2", :method => :get }, + { :controller => "api/old_relations", :action => "show", :relation_id => "1", :version => "2" } ) assert_routing( { :path => "/api/0.6/relation/1/2.json", :method => :get }, - { :controller => "api/old_relations", :action => "version", :id => "1", :version => "2", :format => "json" } + { :controller => "api/old_relations", :action => "show", :relation_id => "1", :version => "2", :format => "json" } ) assert_routing( { :path => "/api/0.6/relation/1/2/redact", :method => :post }, - { :controller => "api/old_relations", :action => "redact", :id => "1", :version => "2" } + { :controller => "api/old_relations", :action => "redact", :relation_id => "1", :version => "2" } ) end - # ------------------------------------- - # Test reading old relations. - # ------------------------------------- - def test_history - # check that a visible relations is returned properly - get api_relation_history_path(create(:relation, :with_history)) + ## + # check that a visible relations is returned properly + def test_index + relation = create(:relation, :with_history, :version => 2) + + get api_relation_versions_path(relation) + assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> relation", 2 do |dom_relations| + assert_dom dom_relations[0], "> @id", relation.id.to_s + assert_dom dom_relations[0], "> @version", "1" + + assert_dom dom_relations[1], "> @id", relation.id.to_s + assert_dom dom_relations[1], "> @version", "2" + end + end + end - # check chat a non-existent relations is not returned - get api_relation_history_path(:id => 0) + ## + # check that a non-existent relations is not returned + def test_index_invalid + get api_relation_versions_path(0) assert_response :not_found end ## - # test the redaction of an old version of a relation, while not being - # authorised. - def test_redact_relation_unauthorised - relation = create(:relation, :with_history, :version => 4) - relation_v3 = relation.old_relations.find_by(:version => 3) + # test that redacted relations aren't visible in the history + def test_index_redacted_unauthorised + relation = create(:relation, :with_history, :version => 2) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) - do_redact_relation(relation_v3, create(:redaction)) - assert_response :unauthorized, "should need to be authenticated to redact." - end + get api_relation_versions_path(relation) - ## - # test the redaction of an old version of a relation, while being - # authorised as a normal user. - def test_redact_relation_normal_user - relation = create(:relation, :with_history, :version => 4) - relation_v3 = relation.old_relations.find_by(:version => 3) + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 0, + "redacted relation #{relation.id} version 1 shouldn't be present in the history." - auth_header = basic_authorization_header create(:user).email, "test" + get api_relation_versions_path(relation, :show_redactions => "true") - do_redact_relation(relation_v3, create(:redaction), auth_header) - assert_response :forbidden, "should need to be moderator to redact." + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 0, + "redacted relation #{relation.id} version 1 shouldn't be present in the history when passing flag." end - ## - # test that, even as moderator, the current version of a relation - # can't be redacted. - def test_redact_relation_current_version - relation = create(:relation, :with_history, :version => 4) - relation_latest = relation.old_relations.last + def test_index_redacted_normal_user + relation = create(:relation, :with_history, :version => 2) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) - auth_header = basic_authorization_header create(:moderator_user).email, "test" + get api_relation_versions_path(relation), :headers => bearer_authorization_header - do_redact_relation(relation_latest, create(:redaction), auth_header) - assert_response :bad_request, "shouldn't be OK to redact current version as moderator." - end + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 0, + "redacted relation #{relation.id} version 1 shouldn't be present in the history, even when logged in." - def test_redact_relation_by_regular_with_read_prefs_scope - auth_header = create_bearer_auth_header(create(:user), %w[read_prefs]) - do_redact_redactable_relation(auth_header) - assert_response :forbidden, "should need to be moderator to redact." - end + get api_relation_versions_path(relation, :show_redactions => "true"), :headers => bearer_authorization_header - def test_redact_relation_by_regular_with_write_api_scope - auth_header = create_bearer_auth_header(create(:user), %w[write_api]) - do_redact_redactable_relation(auth_header) - assert_response :forbidden, "should need to be moderator to redact." + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 0, + "redacted relation #{relation.id} version 1 shouldn't be present in the history, even when logged in and passing flag." end - def test_redact_relation_by_regular_with_write_redactions_scope - auth_header = create_bearer_auth_header(create(:user), %w[write_redactions]) - do_redact_redactable_relation(auth_header) - assert_response :forbidden, "should need to be moderator to redact." - end + def test_index_redacted_moderator + relation = create(:relation, :with_history, :version => 2) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) - def test_redact_relation_by_moderator_with_read_prefs_scope - auth_header = create_bearer_auth_header(create(:moderator_user), %w[read_prefs]) - do_redact_redactable_relation(auth_header) - assert_response :forbidden, "should need to have write_redactions scope to redact." - end + get api_relation_versions_path(relation), :headers => auth_header - def test_redact_relation_by_moderator_with_write_api_scope - auth_header = create_bearer_auth_header(create(:moderator_user), %w[write_api]) - do_redact_redactable_relation(auth_header) - assert_response :success, "should be OK to redact old version as moderator with write_api scope." - # assert_response :forbidden, "should need to have write_redactions scope to redact." + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 0, + "relation #{relation.id} version 1 should not be present in the history for moderators when not passing flag." + + get api_relation_versions_path(relation, :show_redactions => "true"), :headers => auth_header + + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm relation[id='#{relation.id}'][version='1']", 1, + "relation #{relation.id} version 1 should still be present in the history for moderators when passing flag." end - def test_redact_relation_by_moderator_with_write_redactions_scope - auth_header = create_bearer_auth_header(create(:moderator_user), %w[write_redactions]) - do_redact_redactable_relation(auth_header) - assert_response :success, "should be OK to redact old version as moderator with write_redactions scope." + def test_show + relation = create(:relation, :with_history, :version => 2) + create(:old_relation_tag, :old_relation => relation.old_relations[0], :k => "k1", :v => "v1") + create(:old_relation_tag, :old_relation => relation.old_relations[1], :k => "k2", :v => "v2") + + get api_relation_version_path(relation, 1) + + assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> relation", 1 do + assert_dom "> @id", relation.id.to_s + assert_dom "> @version", "1" + assert_dom "> tag", 1 do + assert_dom "> @k", "k1" + assert_dom "> @v", "v1" + end + end + end + + get api_relation_version_path(relation, 2) + + assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> relation", 1 do + assert_dom "> @id", relation.id.to_s + assert_dom "> @version", "2" + assert_dom "> tag", 1 do + assert_dom "> @k", "k2" + assert_dom "> @v", "v2" + end + end + end end ## # test that redacted relations aren't visible, regardless of # authorisation except as moderator... - def test_version_redacted + def test_show_redacted_unauthorised relation = create(:relation, :with_history, :version => 2) - relation_v1 = relation.old_relations.find_by(:version => 1) - relation_v1.redact!(create(:redaction)) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) + + get api_relation_version_path(relation, 1) - get relation_version_path(:id => relation_v1.relation_id, :version => relation_v1.version) assert_response :forbidden, "Redacted relation shouldn't be visible via the version API." - # not even to a logged-in user - auth_header = basic_authorization_header create(:user).email, "test" - get relation_version_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header + get api_relation_version_path(relation, 1, :show_redactions => "true") + + assert_response :forbidden, "Redacted relation shouldn't be visible via the version API when passing flag." + end + + def test_show_redacted_normal_user + relation = create(:relation, :with_history, :version => 2) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) + + get api_relation_version_path(relation, 1), :headers => bearer_authorization_header + assert_response :forbidden, "Redacted relation shouldn't be visible via the version API, even when logged in." + + get api_relation_version_path(relation, 1, :show_redactions => "true"), :headers => bearer_authorization_header + + assert_response :forbidden, "Redacted relation shouldn't be visible via the version API, even when logged in and passing flag." + end + + def test_show_redacted_moderator + relation = create(:relation, :with_history, :version => 2) + relation.old_relations.find_by(:version => 1).redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) + + get api_relation_version_path(relation, 1), :headers => auth_header + + assert_response :forbidden, "Redacted relation should be gone for moderator, when flag not passed." + + get api_relation_version_path(relation, 1, :show_redactions => "true"), :headers => auth_header + + assert_response :success, "Redacted relation should not be gone for moderator, when flag passed." end ## - # test that redacted relations aren't visible in the history - def test_history_redacted + # test that, even as moderator, the current version of a relation + # can't be redacted. + def test_redact_relation_current_version relation = create(:relation, :with_history, :version => 2) - relation_v1 = relation.old_relations.find_by(:version => 1) - relation_v1.redact!(create(:redaction)) + old_relation = relation.old_relations.find_by(:version => 2) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:moderator_user) - get api_relation_history_path(:id => relation_v1.relation_id) - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0, - "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history." + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id }, :headers => auth_header - # not even to a logged-in user - auth_header = basic_authorization_header create(:user).email, "test" - get relation_version_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header - get api_relation_history_path(:id => relation_v1.relation_id), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0, - "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history, even when logged in." + assert_response :bad_request, "shouldn't be OK to redact current version as moderator." + assert_nil old_relation.reload.redaction end ## - # test the redaction of an old version of a relation, while being - # authorised as a moderator. - def test_redact_relation_moderator - relation = create(:relation, :with_history, :version => 4) - relation_v3 = relation.old_relations.find_by(:version => 3) + # test the redaction of an old version of a relation, while not being + # authorised. + def test_redact_relation_unauthorised + relation = create(:relation, :with_history, :version => 2) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id } - auth_header = basic_authorization_header create(:moderator_user).email, "test" + assert_response :unauthorized, "should need to be authenticated to redact." + assert_nil old_relation.reload.redaction + end - do_redact_relation(relation_v3, create(:redaction), auth_header) - assert_response :success, "should be OK to redact old version as moderator." + def test_redact_relation_by_regular_without_write_redactions_scope + relation = create(:relation, :with_history, :version => 2) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api]) - # check moderator can still see the redacted data, when passing - # the appropriate flag - get relation_version_path(:id => relation_v3.relation_id, :version => relation_v3.version), :headers => auth_header - assert_response :forbidden, "After redaction, relation should be gone for moderator, when flag not passed." - get relation_version_path(:id => relation_v3.relation_id, :version => relation_v3.version), :params => { :show_redactions => "true" }, :headers => auth_header - assert_response :success, "After redaction, relation should not be gone for moderator, when flag passed." + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id }, :headers => auth_header - # and when accessed via history - get api_relation_history_path(:id => relation_v3.relation_id), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 0, - "relation #{relation_v3.relation_id} version #{relation_v3.version} should not be present in the history for moderators when not passing flag." - get api_relation_history_path(:id => relation_v3.relation_id), :params => { :show_redactions => "true" }, :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 1, - "relation #{relation_v3.relation_id} version #{relation_v3.version} should still be present in the history for moderators when passing flag." + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_relation.reload.redaction end - # testing that if the moderator drops auth, he can't see the - # redacted stuff any more. - def test_redact_relation_is_redacted - relation = create(:relation, :with_history, :version => 4) - relation_v3 = relation.old_relations.find_by(:version => 3) + def test_redact_relation_by_regular_with_write_redactions_scope + relation = create(:relation, :with_history, :version => 2) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions]) - auth_header = basic_authorization_header create(:moderator_user).email, "test" + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id }, :headers => auth_header - do_redact_relation(relation_v3, create(:redaction), auth_header) - assert_response :success, "should be OK to redact old version as moderator." + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_relation.reload.redaction + end - # re-auth as non-moderator - auth_header = basic_authorization_header create(:user).email, "test" + def test_redact_relation_by_moderator_without_write_redactions_scope + relation = create(:relation, :with_history, :version => 2) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api]) - # check can't see the redacted data - get relation_version_path(:id => relation_v3.relation_id, :version => relation_v3.version), :headers => auth_header - assert_response :forbidden, "Redacted relation shouldn't be visible via the version API." + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id }, :headers => auth_header - # and when accessed via history - get api_relation_history_path(:id => relation_v3.relation_id), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 0, - "redacted relation #{relation_v3.relation_id} version #{relation_v3.version} shouldn't be present in the history." + assert_response :forbidden, "should need to have write_redactions scope to redact." + assert_nil old_relation.reload.redaction + end + + def test_redact_relation_by_moderator_with_write_redactions_scope + relation = create(:relation, :with_history, :version => 2) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions]) + + post relation_version_redact_path(*old_relation.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :success, "should be OK to redact old version as moderator with write_redactions scope." + assert_equal redaction, old_relation.reload.redaction end ## @@ -212,11 +266,14 @@ module Api # authorised. def test_unredact_relation_unauthorised relation = create(:relation, :with_history, :version => 2) - relation_v1 = relation.old_relations.find_by(:version => 1) - relation_v1.redact!(create(:redaction)) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + old_relation.redact!(redaction) + + post relation_version_redact_path(*old_relation.id) - post relation_version_redact_path(:id => relation_v1.relation_id, :version => relation_v1.version) assert_response :unauthorized, "should need to be authenticated to unredact." + assert_equal redaction, old_relation.reload.redaction end ## @@ -224,13 +281,15 @@ module Api # authorised as a normal user. def test_unredact_relation_normal_user relation = create(:relation, :with_history, :version => 2) - relation_v1 = relation.old_relations.find_by(:version => 1) - relation_v1.redact!(create(:redaction)) + old_relation = relation.old_relations.find_by(:version => 1) + redaction = create(:redaction) + old_relation.redact!(redaction) + auth_header = bearer_authorization_header - auth_header = basic_authorization_header create(:user).email, "test" + post relation_version_redact_path(*old_relation.id), :headers => auth_header - post relation_version_redact_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header assert_response :forbidden, "should need to be moderator to unredact." + assert_equal redaction, old_relation.reload.redaction end ## @@ -238,102 +297,14 @@ module Api # authorised as a moderator. def test_unredact_relation_moderator relation = create(:relation, :with_history, :version => 2) - relation_v1 = relation.old_relations.find_by(:version => 1) - relation_v1.redact!(create(:redaction)) + old_relation = relation.old_relations.find_by(:version => 1) + old_relation.redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) - auth_header = basic_authorization_header create(:moderator_user).email, "test" + post relation_version_redact_path(*old_relation.id), :headers => auth_header - post relation_version_redact_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header assert_response :success, "should be OK to unredact old version as moderator." - - # check moderator can still see the redacted data, without passing - # the appropriate flag - get relation_version_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header - assert_response :success, "After unredaction, relation should not be gone for moderator." - - # and when accessed via history - get api_relation_history_path(:id => relation_v1.relation_id), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 1, - "relation #{relation_v1.relation_id} version #{relation_v1.version} should still be present in the history for moderators." - - auth_header = basic_authorization_header create(:user).email, "test" - - # check normal user can now see the redacted data - get relation_version_path(:id => relation_v1.relation_id, :version => relation_v1.version), :headers => auth_header - assert_response :success, "After redaction, node should not be gone for normal user." - - # and when accessed via history - get api_relation_history_path(:id => relation_v1.relation_id), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 1, - "relation #{relation_v1.relation_id} version #{relation_v1.version} should still be present in the history for normal users." - end - - private - - ## - # check that the current version of a relation is equivalent to the - # version which we're getting from the versions call. - def check_current_version(relation_id) - # get the current version - current_relation = with_controller(RelationsController.new) do - get :show, :params => { :id => relation_id } - assert_response :success, "can't get current relation #{relation_id}" - Relation.from_xml(@response.body) - end - assert_not_nil current_relation, "getting relation #{relation_id} returned nil" - - # get the "old" version of the relation from the version method - get :version, :params => { :id => relation_id, :version => current_relation.version } - assert_response :success, "can't get old relation #{relation_id}, v#{current_relation.version}" - old_relation = Relation.from_xml(@response.body) - - # check that the relations are identical - assert_relations_are_equal current_relation, old_relation - end - - ## - # look at all the versions of the relation in the history and get each version from - # the versions call. check that they're the same. - def check_history_equals_versions(relation_id) - get :history, :params => { :id => relation_id } - assert_response :success, "can't get relation #{relation_id} from API" - history_doc = XML::Parser.string(@response.body).parse - assert_not_nil history_doc, "parsing relation #{relation_id} history failed" - - history_doc.find("//osm/relation").each do |relation_doc| - history_relation = Relation.from_xml_node(relation_doc) - assert_not_nil history_relation, "parsing relation #{relation_id} version failed" - - get :version, :params => { :id => relation_id, :version => history_relation.version } - assert_response :success, "couldn't get relation #{relation_id}, v#{history_relation.version}" - version_relation = Relation.from_xml(@response.body) - assert_not_nil version_relation, "failed to parse #{relation_id}, v#{history_relation.version}" - - assert_relations_are_equal history_relation, version_relation - end - end - - def create_bearer_auth_header(user, scopes) - token = create(:oauth_access_token, - :resource_owner_id => user.id, - :scopes => scopes) - bearer_authorization_header(token.token) - end - - def do_redact_redactable_relation(headers = {}) - relation = create(:relation, :with_history, :version => 4) - relation_v3 = relation.old_relations.find_by(:version => 3) - do_redact_relation(relation_v3, create(:redaction), headers) - end - - def do_redact_relation(relation, redaction, headers = {}) - get relation_version_path(:id => relation.relation_id, :version => relation.version) - assert_response :success, "should be able to get version #{relation.version} of relation #{relation.relation_id}." - - # now redact it - post relation_version_redact_path(:id => relation.relation_id, :version => relation.version), :params => { :redaction => redaction.id }, :headers => headers + assert_nil old_relation.reload.redaction end end end