test/controllers/api/changeset_comments_controller_test.rb

   1 require "test_helper"
   2
   3 module Api
   4   class ChangesetCommentsControllerTest < ActionDispatch::IntegrationTest
   5     ##
   6     # test all routes which lead to this controller
   7     def test_routes
   8       assert_routing(
   9         { :path => "/api/0.6/changeset_comments", :method => :get },
  10         { :controller => "api/changeset_comments", :action => "index" }
  11       )
  12       assert_routing(
  13         { :path => "/api/0.6/changeset_comments.json", :method => :get },
  14         { :controller => "api/changeset_comments", :action => "index", :format => "json" }
  15       )
  16       assert_routing(
  17         { :path => "/api/0.6/changeset/1/comment", :method => :post },
  18         { :controller => "api/changeset_comments", :action => "create", :id => "1" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/changeset/1/comment.json", :method => :post },
  22         { :controller => "api/changeset_comments", :action => "create", :id => "1", :format => "json" }
  23       )
  24       assert_routing(
  25         { :path => "/api/0.6/changeset/comment/1/hide", :method => :post },
  26         { :controller => "api/changeset_comments", :action => "destroy", :id => "1" }
  27       )
  28       assert_routing(
  29         { :path => "/api/0.6/changeset/comment/1/hide.json", :method => :post },
  30         { :controller => "api/changeset_comments", :action => "destroy", :id => "1", :format => "json" }
  31       )
  32       assert_routing(
  33         { :path => "/api/0.6/changeset/comment/1/unhide", :method => :post },
  34         { :controller => "api/changeset_comments", :action => "restore", :id => "1" }
  35       )
  36       assert_routing(
  37         { :path => "/api/0.6/changeset/comment/1/unhide.json", :method => :post },
  38         { :controller => "api/changeset_comments", :action => "restore", :id => "1", :format => "json" }
  39       )
  40     end
  41
  42     def test_index
  43       user1 = create(:user)
  44       user2 = create(:user)
  45       changeset1 = create(:changeset, :closed, :user => user2)
  46       comment11 = create(:changeset_comment, :changeset => changeset1, :author => user1, :created_at => "2023-01-01", :body => "changeset 1 question")
  47       comment12 = create(:changeset_comment, :changeset => changeset1, :author => user2, :created_at => "2023-02-01", :body => "changeset 1 answer")
  48       changeset2 = create(:changeset, :closed, :user => user1)
  49       comment21 = create(:changeset_comment, :changeset => changeset2, :author => user1, :created_at => "2023-03-01", :body => "changeset 2 note")
  50       comment22 = create(:changeset_comment, :changeset => changeset2, :author => user1, :created_at => "2023-04-01", :body => "changeset 2 extra note")
  51       comment23 = create(:changeset_comment, :changeset => changeset2, :author => user2, :created_at => "2023-05-01", :body => "changeset 2 review")
  52
  53       get api_changeset_comments_path
  54       assert_response :success
  55       assert_comments_in_order [comment23, comment22, comment21, comment12, comment11]
  56
  57       get api_changeset_comments_path(:limit => 3)
  58       assert_response :success
  59       assert_comments_in_order [comment23, comment22, comment21]
  60
  61       get api_changeset_comments_path(:from => "2023-03-15T00:00:00Z")
  62       assert_response :success
  63       assert_comments_in_order [comment23, comment22]
  64
  65       get api_changeset_comments_path(:from => "2023-01-15T00:00:00Z", :to => "2023-04-15T00:00:00Z")
  66       assert_response :success
  67       assert_comments_in_order [comment22, comment21, comment12]
  68
  69       get api_changeset_comments_path(:user => user1.id)
  70       assert_response :success
  71       assert_comments_in_order [comment22, comment21, comment11]
  72
  73       get api_changeset_comments_path(:from => "2023-03-15T00:00:00Z", :format => "json")
  74       assert_response :success
  75       js = ActiveSupport::JSON.decode(@response.body)
  76       assert_not_nil js
  77       assert_equal 2, js["comments"].count
  78       assert_equal comment23.id, js["comments"][0]["id"]
  79       assert_equal comment22.id, js["comments"][1]["id"]
  80     end
  81
  82     def test_create_by_unauthorized
  83       assert_no_difference "ChangesetComment.count" do
  84         post changeset_comment_path(create(:changeset, :closed), :text => "This is a comment")
  85         assert_response :unauthorized
  86       end
  87     end
  88
  89     def test_create_on_missing_changeset
  90       assert_no_difference "ChangesetComment.count" do
  91         post changeset_comment_path(999111, :text => "This is a comment"), :headers => bearer_authorization_header
  92         assert_response :not_found
  93       end
  94     end
  95
  96     def test_create_on_open_changeset
  97       assert_no_difference "ChangesetComment.count" do
  98         post changeset_comment_path(create(:changeset), :text => "This is a comment"), :headers => bearer_authorization_header
  99         assert_response :conflict
 100       end
 101     end
 102
 103     def test_create_without_text
 104       assert_no_difference "ChangesetComment.count" do
 105         post changeset_comment_path(create(:changeset, :closed)), :headers => bearer_authorization_header
 106         assert_response :bad_request
 107       end
 108     end
 109
 110     def test_create_with_empty_text
 111       assert_no_difference "ChangesetComment.count" do
 112         post changeset_comment_path(create(:changeset, :closed), :text => ""), :headers => bearer_authorization_header
 113         assert_response :bad_request
 114       end
 115     end
 116
 117     def test_create_when_not_agreed_to_terms
 118       user = create(:user, :terms_agreed => nil)
 119       auth_header = bearer_authorization_header user
 120       changeset = create(:changeset, :closed)
 121
 122       assert_difference "ChangesetComment.count", 0 do
 123         post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header
 124         assert_response :forbidden
 125       end
 126     end
 127
 128     def test_create_without_required_scope
 129       user = create(:user)
 130       auth_header = bearer_authorization_header user, :scopes => %w[read_prefs]
 131       changeset = create(:changeset, :closed)
 132
 133       assert_difference "ChangesetComment.count", 0 do
 134         post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header
 135         assert_response :forbidden
 136       end
 137     end
 138
 139     def test_create_with_write_changeset_comments_scope
 140       user = create(:user)
 141       auth_header = bearer_authorization_header user, :scopes => %w[write_changeset_comments]
 142       changeset = create(:changeset, :closed)
 143
 144       assert_difference "ChangesetComment.count", 1 do
 145         post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header
 146         assert_response :success
 147       end
 148
 149       comment = ChangesetComment.last
 150       assert_equal changeset.id, comment.changeset_id
 151       assert_equal user.id, comment.author_id
 152       assert_equal "This is a comment", comment.body
 153       assert comment.visible
 154     end
 155
 156     def test_create_with_write_api_scope
 157       user = create(:user)
 158       auth_header = bearer_authorization_header user, :scopes => %w[write_api]
 159       changeset = create(:changeset, :closed)
 160
 161       assert_difference "ChangesetComment.count", 1 do
 162         post changeset_comment_path(changeset), :params => { :text => "This is a comment" }, :headers => auth_header
 163         assert_response :success
 164       end
 165
 166       comment = ChangesetComment.last
 167       assert_equal changeset.id, comment.changeset_id
 168       assert_equal user.id, comment.author_id
 169       assert_equal "This is a comment", comment.body
 170       assert comment.visible
 171     end
 172
 173     def test_create_on_changeset_with_no_subscribers
 174       changeset = create(:changeset, :closed)
 175       auth_header = bearer_authorization_header
 176
 177       assert_difference "ChangesetComment.count", 1 do
 178         assert_no_difference "ActionMailer::Base.deliveries.size" do
 179           perform_enqueued_jobs do
 180             post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header
 181             assert_response :success
 182           end
 183         end
 184       end
 185     end
 186
 187     def test_create_on_changeset_with_commenter_subscriber
 188       user = create(:user)
 189       changeset = create(:changeset, :closed, :user => user)
 190       changeset.subscribers << user
 191       auth_header = bearer_authorization_header user
 192
 193       assert_difference "ChangesetComment.count", 1 do
 194         assert_no_difference "ActionMailer::Base.deliveries.size" do
 195           perform_enqueued_jobs do
 196             post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header
 197             assert_response :success
 198           end
 199         end
 200       end
 201     end
 202
 203     def test_create_on_changeset_with_invisible_subscribers
 204       changeset = create(:changeset, :closed)
 205       changeset.subscribers << create(:user, :suspended)
 206       changeset.subscribers << create(:user, :deleted)
 207       auth_header = bearer_authorization_header
 208
 209       assert_difference "ChangesetComment.count", 1 do
 210         assert_no_difference "ActionMailer::Base.deliveries.size" do
 211           perform_enqueued_jobs do
 212             post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header
 213             assert_response :success
 214           end
 215         end
 216       end
 217     end
 218
 219     def test_create_on_changeset_with_changeset_creator_subscriber
 220       creator_user = create(:user)
 221       changeset = create(:changeset, :closed, :user => creator_user)
 222       changeset.subscribers << creator_user
 223       commenter_user = create(:user)
 224       auth_header = bearer_authorization_header commenter_user
 225
 226       assert_difference "ChangesetComment.count", 1 do
 227         assert_difference "ActionMailer::Base.deliveries.size", 1 do
 228           perform_enqueued_jobs do
 229             post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header
 230             assert_response :success
 231           end
 232         end
 233       end
 234
 235       email = ActionMailer::Base.deliveries.first
 236       assert_equal 1, email.to.length
 237       assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on one of your changesets", email.subject
 238       assert_equal creator_user.email, email.to.first
 239
 240       ActionMailer::Base.deliveries.clear
 241     end
 242
 243     def test_create_on_changeset_with_changeset_creator_and_other_user_subscribers
 244       creator_user = create(:user)
 245       changeset = create(:changeset, :closed, :user => creator_user)
 246       changeset.subscribers << creator_user
 247       other_user = create(:user)
 248       changeset.subscribers << other_user
 249       commenter_user = create(:user)
 250       auth_header = bearer_authorization_header commenter_user
 251
 252       assert_difference "ChangesetComment.count", 1 do
 253         assert_difference "ActionMailer::Base.deliveries.size", 2 do
 254           perform_enqueued_jobs do
 255             post changeset_comment_path(changeset, :text => "This is a comment"), :headers => auth_header
 256             assert_response :success
 257           end
 258         end
 259       end
 260
 261       email = ActionMailer::Base.deliveries.find { |e| e.to.first == creator_user.email }
 262       assert_not_nil email
 263       assert_equal 1, email.to.length
 264       assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on one of your changesets", email.subject
 265
 266       email = ActionMailer::Base.deliveries.find { |e| e.to.first == other_user.email }
 267       assert_not_nil email
 268       assert_equal 1, email.to.length
 269       assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on a changeset you are interested in", email.subject
 270
 271       ActionMailer::Base.deliveries.clear
 272     end
 273
 274     ##
 275     # create comment rate limit for new users
 276     def test_create_by_new_user_with_rate_limit
 277       changeset = create(:changeset, :closed)
 278       user = create(:user)
 279
 280       auth_header = bearer_authorization_header user
 281
 282       assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour do
 283         1.upto(Settings.initial_changeset_comments_per_hour) do |count|
 284           post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 285           assert_response :success
 286         end
 287       end
 288
 289       assert_no_difference "ChangesetComment.count" do
 290         post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header
 291         assert_response :too_many_requests
 292       end
 293     end
 294
 295     ##
 296     # create comment rate limit for experienced users
 297     def test_create_by_experienced_user_with_rate_limit
 298       changeset = create(:changeset, :closed)
 299       user = create(:user)
 300       create_list(:changeset_comment, Settings.comments_to_max_changeset_comments, :author_id => user.id, :created_at => Time.now.utc - 1.day)
 301
 302       auth_header = bearer_authorization_header user
 303
 304       assert_difference "ChangesetComment.count", Settings.max_changeset_comments_per_hour do
 305         1.upto(Settings.max_changeset_comments_per_hour) do |count|
 306           post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 307           assert_response :success
 308         end
 309       end
 310
 311       assert_no_difference "ChangesetComment.count" do
 312         post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header
 313         assert_response :too_many_requests
 314       end
 315     end
 316
 317     ##
 318     # create comment rate limit for reported users
 319     def test_create_by_reported_user_with_rate_limit
 320       changeset = create(:changeset, :closed)
 321       user = create(:user)
 322       create(:issue_with_reports, :reportable => user, :reported_user => user)
 323
 324       auth_header = bearer_authorization_header user
 325
 326       assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour / 2 do
 327         1.upto(Settings.initial_changeset_comments_per_hour / 2) do |count|
 328           post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 329           assert_response :success
 330         end
 331       end
 332
 333       assert_no_difference "ChangesetComment.count" do
 334         post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header
 335         assert_response :too_many_requests
 336       end
 337     end
 338
 339     ##
 340     # create comment rate limit for moderator users
 341     def test_create_by_moderator_user_with_rate_limit
 342       changeset = create(:changeset, :closed)
 343       user = create(:moderator_user)
 344
 345       auth_header = bearer_authorization_header user
 346
 347       assert_difference "ChangesetComment.count", Settings.moderator_changeset_comments_per_hour do
 348         1.upto(Settings.moderator_changeset_comments_per_hour) do |count|
 349           post changeset_comment_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 350           assert_response :success
 351         end
 352       end
 353
 354       assert_no_difference "ChangesetComment.count" do
 355         post changeset_comment_path(changeset, :text => "One comment too many"), :headers => auth_header
 356         assert_response :too_many_requests
 357       end
 358     end
 359
 360     def test_hide_by_unauthorized
 361       comment = create(:changeset_comment)
 362
 363       post changeset_comment_hide_path(comment)
 364
 365       assert_response :unauthorized
 366       assert comment.reload.visible
 367     end
 368
 369     def test_hide_by_normal_user
 370       comment = create(:changeset_comment)
 371       auth_header = bearer_authorization_header
 372
 373       post changeset_comment_hide_path(comment), :headers => auth_header
 374
 375       assert_response :forbidden
 376       assert comment.reload.visible
 377     end
 378
 379     def test_hide_missing_comment
 380       auth_header = bearer_authorization_header create(:moderator_user)
 381
 382       post changeset_comment_hide_path(999111), :headers => auth_header
 383
 384       assert_response :not_found
 385     end
 386
 387     def test_hide_without_required_scope
 388       comment = create(:changeset_comment)
 389       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs]
 390
 391       post changeset_comment_hide_path(comment), :headers => auth_header
 392
 393       assert_response :forbidden
 394       assert comment.reload.visible
 395     end
 396
 397     def test_hide_with_write_changeset_comments_scope
 398       comment = create(:changeset_comment)
 399       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 400
 401       post changeset_comment_hide_path(comment), :headers => auth_header
 402
 403       assert_response :success
 404       assert_not comment.reload.visible
 405     end
 406
 407     def test_hide_with_write_api_scope
 408       comment = create(:changeset_comment)
 409       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 410
 411       post changeset_comment_hide_path(comment), :headers => auth_header
 412
 413       assert_response :success
 414       assert_not comment.reload.visible
 415     end
 416
 417     def test_unhide_by_unauthorized
 418       comment = create(:changeset_comment, :visible => false)
 419
 420       post changeset_comment_unhide_path(comment)
 421
 422       assert_response :unauthorized
 423       assert_not comment.reload.visible
 424     end
 425
 426     def test_unhide_by_normal_user
 427       comment = create(:changeset_comment, :visible => false)
 428       auth_header = bearer_authorization_header
 429
 430       post changeset_comment_unhide_path(comment), :headers => auth_header
 431
 432       assert_response :forbidden
 433       assert_not comment.reload.visible
 434     end
 435
 436     def test_unhide_missing_comment
 437       auth_header = bearer_authorization_header create(:moderator_user)
 438
 439       post changeset_comment_unhide_path(999111), :headers => auth_header
 440
 441       assert_response :not_found
 442     end
 443
 444     def test_unhide_without_required_scope
 445       comment = create(:changeset_comment, :visible => false)
 446       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs]
 447
 448       post changeset_comment_unhide_path(comment), :headers => auth_header
 449
 450       assert_response :forbidden
 451       assert_not comment.reload.visible
 452     end
 453
 454     def test_unhide_with_write_changeset_comments_scope
 455       comment = create(:changeset_comment, :visible => false)
 456       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 457
 458       post changeset_comment_unhide_path(comment), :headers => auth_header
 459
 460       assert_response :success
 461       assert comment.reload.visible
 462     end
 463
 464     def test_unhide_with_write_api_scope
 465       comment = create(:changeset_comment, :visible => false)
 466       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 467
 468       post changeset_comment_unhide_path(comment), :headers => auth_header
 469
 470       assert_response :success
 471       assert comment.reload.visible
 472     end
 473
 474     private
 475
 476     ##
 477     # check that certain comments exist in the output in the specified order
 478     def assert_comments_in_order(comments)
 479       assert_dom "osm > comment", comments.size do |dom_comments|
 480         comments.zip(dom_comments).each do |comment, dom_comment|
 481           assert_dom dom_comment, "> @id", comment.id.to_s
 482           assert_dom dom_comment, "> @uid", comment.author.id.to_s
 483           assert_dom dom_comment, "> @user", comment.author.display_name
 484           assert_dom dom_comment, "> text", comment.body
 485         end
 486       end
 487     end
 488   end
 489 end