X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/12920987f560a074381d4c8bae2c756db16647d8..075f8df94afd8ad7b8d4ee684d844e25da5349c2:/test/controllers/api/changeset_comments_controller_test.rb?ds=sidebyside diff --git a/test/controllers/api/changeset_comments_controller_test.rb b/test/controllers/api/changeset_comments_controller_test.rb index e456a3ca4..b16ea4502 100644 --- a/test/controllers/api/changeset_comments_controller_test.rb +++ b/test/controllers/api/changeset_comments_controller_test.rb @@ -6,62 +6,94 @@ module Api # test all routes which lead to this controller def test_routes assert_routing( - { :path => "/api/0.6/changeset/1/comment", :method => :post }, - { :controller => "api/changeset_comments", :action => "create", :id => "1" } - ) - assert_routing( - { :path => "/api/0.6/changeset/1/comment.json", :method => :post }, - { :controller => "api/changeset_comments", :action => "create", :id => "1", :format => "json" } - ) - assert_routing( - { :path => "/api/0.6/changeset/comment/1/hide", :method => :post }, - { :controller => "api/changeset_comments", :action => "destroy", :id => "1" } + { :path => "/api/0.6/changeset_comments", :method => :get }, + { :controller => "api/changeset_comments", :action => "index" } ) assert_routing( - { :path => "/api/0.6/changeset/comment/1/hide.json", :method => :post }, - { :controller => "api/changeset_comments", :action => "destroy", :id => "1", :format => "json" } + { :path => "/api/0.6/changeset_comments.json", :method => :get }, + { :controller => "api/changeset_comments", :action => "index", :format => "json" } ) assert_routing( - { :path => "/api/0.6/changeset/comment/1/unhide", :method => :post }, - { :controller => "api/changeset_comments", :action => "restore", :id => "1" } + { :path => "/api/0.6/changeset/1/comment", :method => :post }, + { :controller => "api/changeset_comments", :action => "create", :changeset_id => "1" } ) assert_routing( - { :path => "/api/0.6/changeset/comment/1/unhide.json", :method => :post }, - { :controller => "api/changeset_comments", :action => "restore", :id => "1", :format => "json" } + { :path => "/api/0.6/changeset/1/comment.json", :method => :post }, + { :controller => "api/changeset_comments", :action => "create", :changeset_id => "1", :format => "json" } ) end + def test_index + user1 = create(:user) + user2 = create(:user) + changeset1 = create(:changeset, :closed, :user => user2) + comment11 = create(:changeset_comment, :changeset => changeset1, :author => user1, :created_at => "2023-01-01", :body => "changeset 1 question") + comment12 = create(:changeset_comment, :changeset => changeset1, :author => user2, :created_at => "2023-02-01", :body => "changeset 1 answer") + changeset2 = create(:changeset, :closed, :user => user1) + comment21 = create(:changeset_comment, :changeset => changeset2, :author => user1, :created_at => "2023-03-01", :body => "changeset 2 note") + comment22 = create(:changeset_comment, :changeset => changeset2, :author => user1, :created_at => "2023-04-01", :body => "changeset 2 extra note") + comment23 = create(:changeset_comment, :changeset => changeset2, :author => user2, :created_at => "2023-05-01", :body => "changeset 2 review") + + get api_changeset_comments_path + assert_response :success + assert_comments_in_order [comment23, comment22, comment21, comment12, comment11] + + get api_changeset_comments_path(:limit => 3) + assert_response :success + assert_comments_in_order [comment23, comment22, comment21] + + get api_changeset_comments_path(:from => "2023-03-15T00:00:00Z") + assert_response :success + assert_comments_in_order [comment23, comment22] + + get api_changeset_comments_path(:from => "2023-01-15T00:00:00Z", :to => "2023-04-15T00:00:00Z") + assert_response :success + assert_comments_in_order [comment22, comment21, comment12] + + get api_changeset_comments_path(:user => user1.id) + assert_response :success + assert_comments_in_order [comment22, comment21, comment11] + + get api_changeset_comments_path(:from => "2023-03-15T00:00:00Z", :format => "json") + assert_response :success + js = ActiveSupport::JSON.decode(@response.body) + assert_not_nil js + assert_equal 2, js["comments"].count + assert_equal comment23.id, js["comments"][0]["id"] + assert_equal comment22.id, js["comments"][1]["id"] + end + def test_create_by_unauthorized assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(create(:changeset, :closed), :text => "This is a comment") + post api_changeset_changeset_comments_path(create(:changeset, :closed), :text => "This is a comment") assert_response :unauthorized end end def test_create_on_missing_changeset assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(999111, :text => "This is a comment"), :headers => bearer_authorization_header + post api_changeset_changeset_comments_path(999111, :text => "This is a comment"), :headers => bearer_authorization_header assert_response :not_found end end def test_create_on_open_changeset assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(create(:changeset), :text => "This is a comment"), :headers => bearer_authorization_header + post api_changeset_changeset_comments_path(create(:changeset), :text => "This is a comment"), :headers => bearer_authorization_header assert_response :conflict end end def test_create_without_text assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(create(:changeset, :closed)), :headers => bearer_authorization_header + post api_changeset_changeset_comments_path(create(:changeset, :closed)), :headers => bearer_authorization_header assert_response :bad_request end end def test_create_with_empty_text assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(create(:changeset, :closed), :text => ""), :headers => bearer_authorization_header + post api_changeset_changeset_comments_path(create(:changeset, :closed), :text => ""), :headers => bearer_authorization_header assert_response :bad_request end end @@ -72,7 +104,7 @@ module Api changeset = create(:changeset, :closed) assert_difference "ChangesetComment.count", 0 do - post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header + post api_changeset_changeset_comments_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header assert_response :forbidden end end @@ -83,7 +115,7 @@ module Api changeset = create(:changeset, :closed) assert_difference "ChangesetComment.count", 0 do - post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header + post api_changeset_changeset_comments_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header assert_response :forbidden end end @@ -94,7 +126,7 @@ module Api changeset = create(:changeset, :closed) assert_difference "ChangesetComment.count", 1 do - post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header + post api_changeset_changeset_comments_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header assert_response :success end @@ -111,7 +143,7 @@ module Api changeset = create(:changeset, :closed) assert_difference "ChangesetComment.count", 1 do - post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header + post api_changeset_changeset_comments_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header assert_response :success end @@ -129,7 +161,7 @@ module Api assert_difference "ChangesetComment.count", 1 do assert_no_difference "ActionMailer::Base.deliveries.size" do perform_enqueued_jobs do - post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header assert_response :success end end @@ -145,7 +177,7 @@ module Api assert_difference "ChangesetComment.count", 1 do assert_no_difference "ActionMailer::Base.deliveries.size" do perform_enqueued_jobs do - post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header assert_response :success end end @@ -161,7 +193,7 @@ module Api assert_difference "ChangesetComment.count", 1 do assert_no_difference "ActionMailer::Base.deliveries.size" do perform_enqueued_jobs do - post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header assert_response :success end end @@ -178,7 +210,7 @@ module Api assert_difference "ChangesetComment.count", 1 do assert_difference "ActionMailer::Base.deliveries.size", 1 do perform_enqueued_jobs do - post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header assert_response :success end end @@ -188,8 +220,6 @@ module Api assert_equal 1, email.to.length assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on one of your changesets", email.subject assert_equal creator_user.email, email.to.first - - ActionMailer::Base.deliveries.clear end def test_create_on_changeset_with_changeset_creator_and_other_user_subscribers @@ -204,7 +234,7 @@ module Api assert_difference "ChangesetComment.count", 1 do assert_difference "ActionMailer::Base.deliveries.size", 2 do perform_enqueued_jobs do - post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header assert_response :success end end @@ -219,8 +249,6 @@ module Api assert_not_nil email assert_equal 1, email.to.length assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on a changeset you are interested in", email.subject - - ActionMailer::Base.deliveries.clear end ## @@ -233,13 +261,13 @@ module Api assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour do 1.upto(Settings.initial_changeset_comments_per_hour) do |count| - post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header assert_response :success end end assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header assert_response :too_many_requests end end @@ -255,13 +283,13 @@ module Api assert_difference "ChangesetComment.count", Settings.max_changeset_comments_per_hour do 1.upto(Settings.max_changeset_comments_per_hour) do |count| - post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header assert_response :success end end assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header assert_response :too_many_requests end end @@ -277,13 +305,13 @@ module Api assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour / 2 do 1.upto(Settings.initial_changeset_comments_per_hour / 2) do |count| - post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header assert_response :success end end assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header assert_response :too_many_requests end end @@ -298,129 +326,30 @@ module Api assert_difference "ChangesetComment.count", Settings.moderator_changeset_comments_per_hour do 1.upto(Settings.moderator_changeset_comments_per_hour) do |count| - post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header assert_response :success end end assert_no_difference "ChangesetComment.count" do - post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header + post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header assert_response :too_many_requests end end - def test_hide_by_unauthorized - comment = create(:changeset_comment) - - post changeset_comment_hide_path(comment) - - assert_response :unauthorized - assert comment.reload.visible - end - - def test_hide_by_normal_user - comment = create(:changeset_comment) - auth_header = bearer_authorization_header - - post changeset_comment_hide_path(comment), :headers => auth_header - - assert_response :forbidden - assert comment.reload.visible - end - - def test_hide_missing_comment - auth_header = bearer_authorization_header create(:moderator_user) - - post changeset_comment_hide_path(999111), :headers => auth_header - - assert_response :not_found - end - - def test_hide_without_required_scope - comment = create(:changeset_comment) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs] - - post changeset_comment_hide_path(comment), :headers => auth_header - - assert_response :forbidden - assert comment.reload.visible - end + private - def test_hide_with_write_changeset_comments_scope - comment = create(:changeset_comment) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments] - - post changeset_comment_hide_path(comment), :headers => auth_header - - assert_response :success - assert_not comment.reload.visible - end - - def test_hide_with_write_api_scope - comment = create(:changeset_comment) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api] - - post changeset_comment_hide_path(comment), :headers => auth_header - - assert_response :success - assert_not comment.reload.visible - end - - def test_unhide_by_unauthorized - comment = create(:changeset_comment, :visible => false) - - post changeset_comment_unhide_path(comment) - - assert_response :unauthorized - assert_not comment.reload.visible - end - - def test_unhide_by_normal_user - comment = create(:changeset_comment, :visible => false) - auth_header = bearer_authorization_header - - post changeset_comment_unhide_path(comment), :headers => auth_header - - assert_response :forbidden - assert_not comment.reload.visible - end - - def test_unhide_missing_comment - auth_header = bearer_authorization_header create(:moderator_user) - - post changeset_comment_unhide_path(999111), :headers => auth_header - - assert_response :not_found - end - - def test_unhide_without_required_scope - comment = create(:changeset_comment, :visible => false) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs] - - post changeset_comment_unhide_path(comment), :headers => auth_header - - assert_response :forbidden - assert_not comment.reload.visible - end - - def test_unhide_with_write_changeset_comments_scope - comment = create(:changeset_comment, :visible => false) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments] - - post changeset_comment_unhide_path(comment), :headers => auth_header - - assert_response :success - assert comment.reload.visible - end - - def test_unhide_with_write_api_scope - comment = create(:changeset_comment, :visible => false) - auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api] - - post changeset_comment_unhide_path(comment), :headers => auth_header - - assert_response :success - assert comment.reload.visible + ## + # check that certain comments exist in the output in the specified order + def assert_comments_in_order(comments) + assert_dom "osm > comment", comments.size do |dom_comments| + comments.zip(dom_comments).each do |comment, dom_comment| + assert_dom dom_comment, "> @id", comment.id.to_s + assert_dom dom_comment, "> @uid", comment.author.id.to_s + assert_dom dom_comment, "> @user", comment.author.display_name + assert_dom dom_comment, "> text", comment.body + end + end end end end