X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/7df13ff2d3b369b571b6d85fd1a2997290c5541f..319c9af97553f2a37d10097bf1017740ebfdbf12:/test/controllers/api/old_ways_controller_test.rb diff --git a/test/controllers/api/old_ways_controller_test.rb b/test/controllers/api/old_ways_controller_test.rb index c6596ec34..e879c42a9 100644 --- a/test/controllers/api/old_ways_controller_test.rb +++ b/test/controllers/api/old_ways_controller_test.rb @@ -7,242 +7,269 @@ module Api def test_routes assert_routing( { :path => "/api/0.6/way/1/history", :method => :get }, - { :controller => "api/old_ways", :action => "history", :id => "1" } + { :controller => "api/old_ways", :action => "index", :way_id => "1" } ) assert_routing( - { :path => "/api/0.6/way/1/2", :method => :get }, - { :controller => "api/old_ways", :action => "show", :id => "1", :version => "2" } + { :path => "/api/0.6/way/1/history.json", :method => :get }, + { :controller => "api/old_ways", :action => "index", :way_id => "1", :format => "json" } ) assert_routing( - { :path => "/api/0.6/way/1/history.json", :method => :get }, - { :controller => "api/old_ways", :action => "history", :id => "1", :format => "json" } + { :path => "/api/0.6/way/1/2", :method => :get }, + { :controller => "api/old_ways", :action => "show", :way_id => "1", :version => "2" } ) assert_routing( { :path => "/api/0.6/way/1/2.json", :method => :get }, - { :controller => "api/old_ways", :action => "show", :id => "1", :version => "2", :format => "json" } + { :controller => "api/old_ways", :action => "show", :way_id => "1", :version => "2", :format => "json" } ) assert_routing( { :path => "/api/0.6/way/1/2/redact", :method => :post }, - { :controller => "api/old_ways", :action => "redact", :id => "1", :version => "2" } + { :controller => "api/old_ways", :action => "redact", :way_id => "1", :version => "2" } ) end - # ------------------------------------- - # Test reading old ways. - # ------------------------------------- + ## + # check that a visible way is returned properly + def test_index + way = create(:way, :with_history, :version => 2) + + get api_way_versions_path(way) - def test_history_visible - # check that a visible way is returned properly - get api_way_history_path(create(:way, :with_history)) assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> way", 2 do |dom_ways| + assert_dom dom_ways[0], "> @id", way.id.to_s + assert_dom dom_ways[0], "> @version", "1" + + assert_dom dom_ways[1], "> @id", way.id.to_s + assert_dom dom_ways[1], "> @version", "2" + end + end end - def test_history_invisible - # check that an invisible way's history is returned properly - get api_way_history_path(create(:way, :with_history, :deleted)) + ## + # check that an invisible way's history is returned properly + def test_index_invisible + get api_way_versions_path(create(:way, :with_history, :deleted)) assert_response :success end - def test_history_invalid - # check chat a non-existent way is not returned - get api_way_history_path(0) + ## + # check chat a non-existent way is not returned + def test_index_invalid + get api_way_versions_path(0) assert_response :not_found end ## - # check that we can retrieve versions of a way - def test_version - way = create(:way, :with_history) - used_way = create(:way, :with_history) - create(:relation_member, :member => used_way) - way_with_versions = create(:way, :with_history, :version => 4) + # test that redacted ways aren't visible in the history + def test_index_redacted_unauthorised + way = create(:way, :with_history, :version => 2) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) - create(:way_tag, :way => way) - create(:way_tag, :way => used_way) - create(:way_tag, :way => way_with_versions) - propagate_tags(way, way.old_ways.last) - propagate_tags(used_way, used_way.old_ways.last) - propagate_tags(way_with_versions, way_with_versions.old_ways.last) + get api_way_versions_path(way) - check_current_version(way.id) - check_current_version(used_way.id) - check_current_version(way_with_versions.id) - end + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm way[id='#{way.id}'][version='1']", 0, + "redacted way #{way.id} version 1 shouldn't be present in the history." - ## - # check that returned history is the same as getting all - # versions of a way from the api. - def test_history_equals_versions - way = create(:way, :with_history) - used_way = create(:way, :with_history) - create(:relation_member, :member => used_way) - way_with_versions = create(:way, :with_history, :version => 4) + get api_way_versions_path(way, :show_redactions => "true") - check_history_equals_versions(way.id) - check_history_equals_versions(used_way.id) - check_history_equals_versions(way_with_versions.id) + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm way[id='#{way.id}'][version='1']", 0, + "redacted way #{way.id} version 1 shouldn't be present in the history when passing flag." end - ## - # test the redaction of an old version of a way, while not being - # authorised. - def test_redact_way_unauthorised - way = create(:way, :with_history, :version => 4) - way_v3 = way.old_ways.find_by(:version => 3) + def test_index_redacted_normal_user + way = create(:way, :with_history, :version => 2) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) - do_redact_way(way_v3, create(:redaction)) - assert_response :unauthorized, "should need to be authenticated to redact." - end + get api_way_versions_path(way), :headers => bearer_authorization_header - ## - # test the redaction of an old version of a way, while being - # authorised as a normal user. - def test_redact_way_normal_user - auth_header = bearer_authorization_header - way = create(:way, :with_history, :version => 4) - way_v3 = way.old_ways.find_by(:version => 3) + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm way[id='#{way.id}'][version='1']", 0, + "redacted node #{way.id} version 1 shouldn't be present in the history, even when logged in." - do_redact_way(way_v3, create(:redaction), auth_header) - assert_response :forbidden, "should need to be moderator to redact." + get api_way_versions_path(way, :show_redactions => "true"), :headers => bearer_authorization_header + + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm way[id='#{way.id}'][version='1']", 0, + "redacted node #{way.id} version 1 shouldn't be present in the history, even when logged in and passing flag." end - ## - # test that, even as moderator, the current version of a way - # can't be redacted. - def test_redact_way_current_version + def test_index_redacted_moderator + way = create(:way, :with_history, :version => 2) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) auth_header = bearer_authorization_header create(:moderator_user) - way = create(:way, :with_history, :version => 4) - way_latest = way.old_ways.last - do_redact_way(way_latest, create(:redaction), auth_header) - assert_response :bad_request, "shouldn't be OK to redact current version as moderator." - end + get api_way_versions_path(way), :headers => auth_header - def test_redact_way_by_regular_with_read_prefs_scope - auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs]) - do_redact_redactable_way(auth_header) - assert_response :forbidden, "should need to be moderator to redact." - end + assert_response :success, "Redaction shouldn't have stopped history working." + assert_dom "osm way[id='#{way.id}'][version='1']", 0, + "way #{way.id} version 1 should not be present in the history for moderators when not passing flag." - def test_redact_way_by_regular_with_write_api_scope - auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_api]) - do_redact_redactable_way(auth_header) - assert_response :forbidden, "should need to be moderator to redact." - end + get api_way_versions_path(way, :show_redactions => "true"), :headers => auth_header - def test_redact_way_by_regular_with_write_redactions_scope - auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions]) - do_redact_redactable_way(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 way[id='#{way.id}'][version='1']", 1, + "way #{way.id} version 1 should still be present in the history for moderators when passing flag." end - def test_redact_way_by_moderator_with_read_prefs_scope - auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs]) - do_redact_redactable_way(auth_header) - assert_response :forbidden, "should need to have write_redactions scope to redact." - end + def test_show + way = create(:way, :with_history, :version => 2) - def test_redact_way_by_moderator_with_write_api_scope - auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_api]) - do_redact_redactable_way(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." - end + get api_way_version_path(way, 1) - def test_redact_way_by_moderator_with_write_redactions_scope - auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions]) - do_redact_redactable_way(auth_header) - assert_response :success, "should be OK to redact old version as moderator with write_redactions scope." + assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> way", 1 do + assert_dom "> @id", way.id.to_s + assert_dom "> @version", "1" + end + end + + get api_way_version_path(way, 2) + + assert_response :success + assert_dom "osm:root", 1 do + assert_dom "> way", 1 do + assert_dom "> @id", way.id.to_s + assert_dom "> @version", "2" + end + end end ## # test that redacted ways aren't visible, regardless of # authorisation except as moderator... - def test_version_redacted + def test_show_redacted_unauthorised way = create(:way, :with_history, :version => 2) - way_v1 = way.old_ways.find_by(:version => 1) - way_v1.redact!(create(:redaction)) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) + + get api_way_version_path(way, 1) - get api_old_way_path(way_v1.way_id, way_v1.version) assert_response :forbidden, "Redacted way shouldn't be visible via the version API." - # not even to a logged-in user - auth_header = bearer_authorization_header - get api_old_way_path(way_v1.way_id, way_v1.version), :headers => auth_header + get api_way_version_path(way, 1, :show_redactions => "true") + + assert_response :forbidden, "Redacted way shouldn't be visible via the version API when passing flag." + end + + def test_show_redacted_normal_user + way = create(:way, :with_history, :version => 2) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) + + get api_way_version_path(way, 1), :headers => bearer_authorization_header + assert_response :forbidden, "Redacted way shouldn't be visible via the version API, even when logged in." + + get api_way_version_path(way, 1, :show_redactions => "true"), :headers => bearer_authorization_header + + assert_response :forbidden, "Redacted way shouldn't be visible via the version API, even when logged in and passing flag." end - ## - # test that redacted ways aren't visible in the history - def test_history_redacted + def test_show_redacted_moderator way = create(:way, :with_history, :version => 2) - way_v1 = way.old_ways.find_by(:version => 1) - way_v1.redact!(create(:redaction)) + way.old_ways.find_by(:version => 1).redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) - get api_way_history_path(way) - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0, - "redacted way #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history." + get api_way_version_path(way, 1), :headers => auth_header - # not even to a logged-in user - auth_header = bearer_authorization_header - get api_way_history_path(way), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0, - "redacted node #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history, even when logged in." + assert_response :forbidden, "Redacted node should be gone for moderator, when flag not passed." + + get api_way_version_path(way, 1, :show_redactions => "true"), :headers => auth_header + + assert_response :success, "Redacted node should not be gone for moderator, when flag passed." end ## - # test the redaction of an old version of a way, while being - # authorised as a moderator. - def test_redact_way_moderator - way = create(:way, :with_history, :version => 4) - way_v3 = way.old_ways.find_by(:version => 3) + # check that returned history is the same as getting all + # versions of a way from the api. + def test_history_equals_versions + way = create(:way, :with_history) + used_way = create(:way, :with_history) + create(:relation_member, :member => used_way) + way_with_versions = create(:way, :with_history, :version => 4) + + check_history_equals_versions(way.id) + check_history_equals_versions(used_way.id) + check_history_equals_versions(way_with_versions.id) + end + + ## + # test that, even as moderator, the current version of a way + # can't be redacted. + def test_redact_way_current_version + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 2) + redaction = create(:redaction) auth_header = bearer_authorization_header create(:moderator_user) - do_redact_way(way_v3, create(:redaction), auth_header) - assert_response :success, "should be OK to redact old version as moderator." + post way_version_redact_path(*old_way.id), :params => { :redaction => redaction.id }, :headers => auth_header - # check moderator can still see the redacted data, when passing - # the appropriate flag - get api_old_way_path(way_v3.way_id, way_v3.version), :headers => auth_header - assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed." - get api_old_way_path(way_v3.way_id, way_v3.version, :show_redactions => "true"), :headers => auth_header - assert_response :success, "After redaction, node should not be gone for moderator, when flag passed." + assert_response :bad_request, "shouldn't be OK to redact current version as moderator." + assert_nil old_way.reload.redaction + end - # and when accessed via history - get api_way_history_path(way), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0, - "way #{way_v3.way_id} version #{way_v3.version} should not be present in the history for moderators when not passing flag." - get api_way_history_path(way, :show_redactions => "true"), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 1, - "way #{way_v3.way_id} version #{way_v3.version} should still be present in the history for moderators when passing flag." + ## + # test the redaction of an old version of a way, while not being + # authorised. + def test_redact_way_unauthorised + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + + post way_version_redact_path(*old_way.id), :params => { :redaction => redaction.id } + + assert_response :unauthorized, "should need to be authenticated to redact." + assert_nil old_way.reload.redaction end - # testing that if the moderator drops auth, he can't see the - # redacted stuff any more. - def test_redact_way_is_redacted - way = create(:way, :with_history, :version => 4) - way_v3 = way.old_ways.find_by(:version => 3) - auth_header = bearer_authorization_header create(:moderator_user) + def test_redact_way_by_regular_without_write_redactions_scope + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api]) - do_redact_way(way_v3, create(:redaction), auth_header) - assert_response :success, "should be OK to redact old version as moderator." + post way_version_redact_path(*old_way.id), :params => { :redaction => redaction.id }, :headers => auth_header - # re-auth as non-moderator - auth_header = bearer_authorization_header + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_way.reload.redaction + end + + def test_redact_way_by_regular_with_write_redactions_scope + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions]) - # check can't see the redacted data - get api_old_way_path(way_v3.way_id, way_v3.version), :headers => auth_header - assert_response :forbidden, "Redacted node shouldn't be visible via the version API." + post way_version_redact_path(*old_way.id), :params => { :redaction => redaction.id }, :headers => auth_header - # and when accessed via history - get api_way_history_path(way), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0, - "redacted way #{way_v3.way_id} version #{way_v3.version} shouldn't be present in the history." + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_way.reload.redaction + end + + def test_redact_way_by_moderator_without_write_redactions_scope + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api]) + + post way_version_redact_path(*old_way.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :forbidden, "should need to have write_redactions scope to redact." + assert_nil old_way.reload.redaction + end + + def test_redact_way_by_moderator_with_write_redactions_scope + way = create(:way, :with_history, :version => 2) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions]) + + post way_version_redact_path(*old_way.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_way.reload.redaction end ## @@ -250,11 +277,14 @@ module Api # authorised. def test_unredact_way_unauthorised way = create(:way, :with_history, :version => 2) - way_v1 = way.old_ways.find_by(:version => 1) - way_v1.redact!(create(:redaction)) + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + old_way.redact!(redaction) + + post way_version_redact_path(*old_way.id) - post way_version_redact_path(way_v1.way_id, way_v1.version) assert_response :unauthorized, "should need to be authenticated to unredact." + assert_equal redaction, old_way.reload.redaction end ## @@ -262,13 +292,15 @@ module Api # authorised as a normal user. def test_unredact_way_normal_user way = create(:way, :with_history, :version => 2) - way_v1 = way.old_ways.find_by(:version => 1) - way_v1.redact!(create(:redaction)) - + old_way = way.old_ways.find_by(:version => 1) + redaction = create(:redaction) + old_way.redact!(redaction) auth_header = bearer_authorization_header - post way_version_redact_path(way_v1.way_id, way_v1.version), :headers => auth_header + post way_version_redact_path(*old_way.id), :headers => auth_header + assert_response :forbidden, "should need to be moderator to unredact." + assert_equal redaction, old_way.reload.redaction end ## @@ -277,66 +309,23 @@ module Api def test_unredact_way_moderator moderator_user = create(:moderator_user) way = create(:way, :with_history, :version => 2) - way_v1 = way.old_ways.find_by(:version => 1) - way_v1.redact!(create(:redaction)) - + old_way = way.old_ways.find_by(:version => 1) + old_way.redact!(create(:redaction)) auth_header = bearer_authorization_header moderator_user - post way_version_redact_path(way_v1.way_id, way_v1.version), :headers => auth_header - assert_response :success, "should be OK to unredact old version as moderator." + post way_version_redact_path(*old_way.id), :headers => auth_header - # check moderator can still see the unredacted data, without passing - # the appropriate flag - get api_old_way_path(way_v1.way_id, way_v1.version), :headers => auth_header - assert_response :success, "After unredaction, node should not be gone for moderator." - - # and when accessed via history - get api_way_history_path(way), :headers => auth_header - assert_response :success, "Unredaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1, - "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for moderators." - - auth_header = bearer_authorization_header - - # check normal user can now see the unredacted data - get api_old_way_path(way_v1.way_id, way_v1.version), :headers => auth_header - assert_response :success, "After redaction, node should not be gone for moderator, when flag passed." - - # and when accessed via history - get api_way_history_path(way), :headers => auth_header - assert_response :success, "Redaction shouldn't have stopped history working." - assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1, - "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for normal users." + assert_response :success, "should be OK to unredact old version as moderator." + assert_nil old_way.reload.redaction end private - ## - # check that the current version of a way is equivalent to the - # version which we're getting from the versions call. - def check_current_version(way_id) - # get the current version - current_way = with_controller(WaysController.new) do - get api_way_path(way_id) - assert_response :success, "can't get current way #{way_id}" - Way.from_xml(@response.body) - end - assert_not_nil current_way, "getting way #{way_id} returned nil" - - # get the "old" version of the way from the version method - get api_old_way_path(way_id, current_way.version) - assert_response :success, "can't get old way #{way_id}, v#{current_way.version}" - old_way = Way.from_xml(@response.body) - - # check that the ways are identical - assert_ways_are_equal current_way, old_way - end - ## # look at all the versions of the way in the history and get each version from # the versions call. check that they're the same. def check_history_equals_versions(way_id) - get api_way_history_path(way_id) + get api_way_versions_path(way_id) assert_response :success, "can't get way #{way_id} from API" history_doc = XML::Parser.string(@response.body).parse assert_not_nil history_doc, "parsing way #{way_id} history failed" @@ -345,7 +334,7 @@ module Api history_way = Way.from_xml_node(way_doc) assert_not_nil history_way, "parsing way #{way_id} version failed" - get api_old_way_path(way_id, history_way.version) + get api_way_version_path(way_id, history_way.version) assert_response :success, "couldn't get way #{way_id}, v#{history_way.version}" version_way = Way.from_xml(@response.body) assert_not_nil version_way, "failed to parse #{way_id}, v#{history_way.version}" @@ -353,25 +342,5 @@ module Api assert_ways_are_equal history_way, version_way end end - - def do_redact_redactable_way(headers = {}) - way = create(:way, :with_history, :version => 4) - way_v3 = way.old_ways.find_by(:version => 3) - do_redact_way(way_v3, create(:redaction), headers) - end - - def do_redact_way(way, redaction, headers = {}) - get api_old_way_path(way.way_id, way.version) - assert_response :success, "should be able to get version #{way.version} of way #{way.way_id}." - - # now redact it - post way_version_redact_path(way.way_id, way.version), :params => { :redaction => redaction.id }, :headers => headers - end - - def propagate_tags(way, old_way) - way.tags.each do |k, v| - create(:old_way_tag, :old_way => old_way, :k => k, :v => v) - end - end end end