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", :changeset_id => "1" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/changeset/1/comment.json", :method => :post },
  22         { :controller => "api/changeset_comments", :action => "create", :changeset_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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 api_changeset_changeset_comments_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     end
 240
 241     def test_create_on_changeset_with_changeset_creator_and_other_user_subscribers
 242       creator_user = create(:user)
 243       changeset = create(:changeset, :closed, :user => creator_user)
 244       changeset.subscribers << creator_user
 245       other_user = create(:user)
 246       changeset.subscribers << other_user
 247       commenter_user = create(:user)
 248       auth_header = bearer_authorization_header commenter_user
 249
 250       assert_difference "ChangesetComment.count", 1 do
 251         assert_difference "ActionMailer::Base.deliveries.size", 2 do
 252           perform_enqueued_jobs do
 253             post api_changeset_changeset_comments_path(changeset, :text => "This is a comment"), :headers => auth_header
 254             assert_response :success
 255           end
 256         end
 257       end
 258
 259       email = ActionMailer::Base.deliveries.find { |e| e.to.first == creator_user.email }
 260       assert_not_nil email
 261       assert_equal 1, email.to.length
 262       assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on one of your changesets", email.subject
 263
 264       email = ActionMailer::Base.deliveries.find { |e| e.to.first == other_user.email }
 265       assert_not_nil email
 266       assert_equal 1, email.to.length
 267       assert_equal "[OpenStreetMap] #{commenter_user.display_name} has commented on a changeset you are interested in", email.subject
 268     end
 269
 270     ##
 271     # create comment rate limit for new users
 272     def test_create_by_new_user_with_rate_limit
 273       changeset = create(:changeset, :closed)
 274       user = create(:user)
 275
 276       auth_header = bearer_authorization_header user
 277
 278       assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour do
 279         1.upto(Settings.initial_changeset_comments_per_hour) do |count|
 280           post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 281           assert_response :success
 282         end
 283       end
 284
 285       assert_no_difference "ChangesetComment.count" do
 286         post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header
 287         assert_response :too_many_requests
 288       end
 289     end
 290
 291     ##
 292     # create comment rate limit for experienced users
 293     def test_create_by_experienced_user_with_rate_limit
 294       changeset = create(:changeset, :closed)
 295       user = create(:user)
 296       create_list(:changeset_comment, Settings.comments_to_max_changeset_comments, :author_id => user.id, :created_at => Time.now.utc - 1.day)
 297
 298       auth_header = bearer_authorization_header user
 299
 300       assert_difference "ChangesetComment.count", Settings.max_changeset_comments_per_hour do
 301         1.upto(Settings.max_changeset_comments_per_hour) do |count|
 302           post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 303           assert_response :success
 304         end
 305       end
 306
 307       assert_no_difference "ChangesetComment.count" do
 308         post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header
 309         assert_response :too_many_requests
 310       end
 311     end
 312
 313     ##
 314     # create comment rate limit for reported users
 315     def test_create_by_reported_user_with_rate_limit
 316       changeset = create(:changeset, :closed)
 317       user = create(:user)
 318       create(:issue_with_reports, :reportable => user, :reported_user => user)
 319
 320       auth_header = bearer_authorization_header user
 321
 322       assert_difference "ChangesetComment.count", Settings.initial_changeset_comments_per_hour / 2 do
 323         1.upto(Settings.initial_changeset_comments_per_hour / 2) do |count|
 324           post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 325           assert_response :success
 326         end
 327       end
 328
 329       assert_no_difference "ChangesetComment.count" do
 330         post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header
 331         assert_response :too_many_requests
 332       end
 333     end
 334
 335     ##
 336     # create comment rate limit for moderator users
 337     def test_create_by_moderator_user_with_rate_limit
 338       changeset = create(:changeset, :closed)
 339       user = create(:moderator_user)
 340
 341       auth_header = bearer_authorization_header user
 342
 343       assert_difference "ChangesetComment.count", Settings.moderator_changeset_comments_per_hour do
 344         1.upto(Settings.moderator_changeset_comments_per_hour) do |count|
 345           post api_changeset_changeset_comments_path(changeset, :text => "Comment #{count}"), :headers => auth_header
 346           assert_response :success
 347         end
 348       end
 349
 350       assert_no_difference "ChangesetComment.count" do
 351         post api_changeset_changeset_comments_path(changeset, :text => "One comment too many"), :headers => auth_header
 352         assert_response :too_many_requests
 353       end
 354     end
 355
 356     def test_hide_by_unauthorized
 357       comment = create(:changeset_comment)
 358
 359       post changeset_comment_hide_path(comment)
 360
 361       assert_response :unauthorized
 362       assert comment.reload.visible
 363     end
 364
 365     def test_hide_by_normal_user
 366       comment = create(:changeset_comment)
 367       auth_header = bearer_authorization_header
 368
 369       post changeset_comment_hide_path(comment), :headers => auth_header
 370
 371       assert_response :forbidden
 372       assert comment.reload.visible
 373     end
 374
 375     def test_hide_missing_comment
 376       auth_header = bearer_authorization_header create(:moderator_user)
 377
 378       post changeset_comment_hide_path(999111), :headers => auth_header
 379
 380       assert_response :not_found
 381     end
 382
 383     def test_hide_without_required_scope
 384       comment = create(:changeset_comment)
 385       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs]
 386
 387       post changeset_comment_hide_path(comment), :headers => auth_header
 388
 389       assert_response :forbidden
 390       assert comment.reload.visible
 391     end
 392
 393     def test_hide_with_write_changeset_comments_scope
 394       comment = create(:changeset_comment)
 395       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 396
 397       post changeset_comment_hide_path(comment), :headers => auth_header
 398
 399       assert_response :success
 400       assert_equal "application/xml", response.media_type
 401       assert_dom "osm", 1 do
 402         assert_dom "> changeset", 1 do
 403           assert_dom "> @id", comment.changeset_id.to_s
 404           assert_dom "> @comments_count", "0"
 405         end
 406       end
 407
 408       assert_not comment.reload.visible
 409     end
 410
 411     def test_hide_with_write_changeset_comments_scope_json
 412       comment = create(:changeset_comment)
 413       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 414
 415       post changeset_comment_hide_path(comment, :format => "json"), :headers => auth_header
 416
 417       assert_response :success
 418       assert_equal "application/json", response.media_type
 419       js = ActiveSupport::JSON.decode(@response.body)
 420       assert_not_nil js["changeset"]
 421       assert_equal comment.changeset_id, js["changeset"]["id"]
 422       assert_equal 0, js["changeset"]["comments_count"]
 423
 424       assert_not comment.reload.visible
 425     end
 426
 427     def test_hide_with_write_api_scope
 428       comment = create(:changeset_comment)
 429       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 430
 431       post changeset_comment_hide_path(comment), :headers => auth_header
 432
 433       assert_response :success
 434       assert_equal "application/xml", response.media_type
 435       assert_dom "osm", 1 do
 436         assert_dom "> changeset", 1 do
 437           assert_dom "> @id", comment.changeset_id.to_s
 438           assert_dom "> @comments_count", "0"
 439         end
 440       end
 441
 442       assert_not comment.reload.visible
 443     end
 444
 445     def test_hide_with_write_api_scope_json
 446       comment = create(:changeset_comment)
 447       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 448
 449       post changeset_comment_hide_path(comment, :format => "json"), :headers => auth_header
 450
 451       assert_response :success
 452       assert_equal "application/json", response.media_type
 453       js = ActiveSupport::JSON.decode(@response.body)
 454       assert_not_nil js["changeset"]
 455       assert_equal comment.changeset_id, js["changeset"]["id"]
 456       assert_equal 0, js["changeset"]["comments_count"]
 457
 458       assert_not comment.reload.visible
 459     end
 460
 461     def test_unhide_by_unauthorized
 462       comment = create(:changeset_comment, :visible => false)
 463
 464       post changeset_comment_unhide_path(comment)
 465
 466       assert_response :unauthorized
 467       assert_not comment.reload.visible
 468     end
 469
 470     def test_unhide_by_normal_user
 471       comment = create(:changeset_comment, :visible => false)
 472       auth_header = bearer_authorization_header
 473
 474       post changeset_comment_unhide_path(comment), :headers => auth_header
 475
 476       assert_response :forbidden
 477       assert_not comment.reload.visible
 478     end
 479
 480     def test_unhide_missing_comment
 481       auth_header = bearer_authorization_header create(:moderator_user)
 482
 483       post changeset_comment_unhide_path(999111), :headers => auth_header
 484
 485       assert_response :not_found
 486     end
 487
 488     def test_unhide_without_required_scope
 489       comment = create(:changeset_comment, :visible => false)
 490       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs]
 491
 492       post changeset_comment_unhide_path(comment), :headers => auth_header
 493
 494       assert_response :forbidden
 495       assert_not comment.reload.visible
 496     end
 497
 498     def test_unhide_with_write_changeset_comments_scope
 499       comment = create(:changeset_comment, :visible => false)
 500       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 501
 502       post changeset_comment_unhide_path(comment), :headers => auth_header
 503
 504       assert_response :success
 505       assert_equal "application/xml", response.media_type
 506       assert_dom "osm", 1 do
 507         assert_dom "> changeset", 1 do
 508           assert_dom "> @id", comment.changeset_id.to_s
 509           assert_dom "> @comments_count", "1"
 510         end
 511       end
 512
 513       assert comment.reload.visible
 514     end
 515
 516     def test_unhide_with_write_changeset_comments_scope_json
 517       comment = create(:changeset_comment, :visible => false)
 518       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_changeset_comments]
 519
 520       post changeset_comment_unhide_path(comment, :format => "json"), :headers => auth_header
 521
 522       assert_response :success
 523       assert_equal "application/json", response.media_type
 524       js = ActiveSupport::JSON.decode(@response.body)
 525       assert_not_nil js["changeset"]
 526       assert_equal comment.changeset_id, js["changeset"]["id"]
 527       assert_equal 1, js["changeset"]["comments_count"]
 528
 529       assert comment.reload.visible
 530     end
 531
 532     def test_unhide_with_write_api_scope
 533       comment = create(:changeset_comment, :visible => false)
 534       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 535
 536       post changeset_comment_unhide_path(comment), :headers => auth_header
 537
 538       assert_response :success
 539       assert_equal "application/xml", response.media_type
 540       assert_dom "osm", 1 do
 541         assert_dom "> changeset", 1 do
 542           assert_dom "> @id", comment.changeset_id.to_s
 543           assert_dom "> @comments_count", "1"
 544         end
 545       end
 546
 547       assert comment.reload.visible
 548     end
 549
 550     def test_unhide_with_write_api_scope_json
 551       comment = create(:changeset_comment, :visible => false)
 552       auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_api]
 553
 554       post changeset_comment_unhide_path(comment, :format => "json"), :headers => auth_header
 555
 556       assert_response :success
 557       js = ActiveSupport::JSON.decode(@response.body)
 558       assert_equal "application/json", response.media_type
 559       assert_not_nil js["changeset"]
 560       assert_equal comment.changeset_id, js["changeset"]["id"]
 561       assert_equal 1, js["changeset"]["comments_count"]
 562
 563       assert comment.reload.visible
 564     end
 565
 566     private
 567
 568     ##
 569     # check that certain comments exist in the output in the specified order
 570     def assert_comments_in_order(comments)
 571       assert_dom "osm > comment", comments.size do |dom_comments|
 572         comments.zip(dom_comments).each do |comment, dom_comment|
 573           assert_dom dom_comment, "> @id", comment.id.to_s
 574           assert_dom dom_comment, "> @uid", comment.author.id.to_s
 575           assert_dom dom_comment, "> @user", comment.author.display_name
 576           assert_dom dom_comment, "> text", comment.body
 577         end
 578       end
 579     end
 580   end
 581 end