test/controllers/api/changesets_controller_test.rb

   1 require "test_helper"
   2
   3 module Api
   4   class ChangesetsControllerTest < ActionDispatch::IntegrationTest
   5     ##
   6     # test all routes which lead to this controller
   7     def test_routes
   8       assert_routing(
   9         { :path => "/api/0.6/changesets", :method => :get },
  10         { :controller => "api/changesets", :action => "index" }
  11       )
  12       assert_routing(
  13         { :path => "/api/0.6/changesets.json", :method => :get },
  14         { :controller => "api/changesets", :action => "index", :format => "json" }
  15       )
  16       assert_routing(
  17         { :path => "/api/0.6/changesets", :method => :post },
  18         { :controller => "api/changesets", :action => "create" }
  19       )
  20       assert_routing(
  21         { :path => "/api/0.6/changeset/1", :method => :get },
  22         { :controller => "api/changesets", :action => "show", :id => "1" }
  23       )
  24       assert_routing(
  25         { :path => "/api/0.6/changeset/1.json", :method => :get },
  26         { :controller => "api/changesets", :action => "show", :id => "1", :format => "json" }
  27       )
  28       assert_routing(
  29         { :path => "/api/0.6/changeset/1", :method => :put },
  30         { :controller => "api/changesets", :action => "update", :id => "1" }
  31       )
  32
  33       assert_recognizes(
  34         { :controller => "api/changesets", :action => "create" },
  35         { :path => "/api/0.6/changeset/create", :method => :put }
  36       )
  37     end
  38
  39     ##
  40     # test the query functionality of changesets
  41     def test_index
  42       private_user = create(:user, :data_public => false)
  43       private_user_changeset = create(:changeset, :user => private_user)
  44       private_user_closed_changeset = create(:changeset, :closed, :user => private_user)
  45       user = create(:user)
  46       changeset = create(:changeset, :user => user)
  47       closed_changeset = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
  48       changeset2 = create(:changeset, :bbox => [5, 5, 15, 15])
  49       changeset3 = create(:changeset, :bbox => [4.5, 4.5, 5, 5])
  50
  51       get api_changesets_path(:bbox => "-10,-10, 10, 10")
  52       assert_response :success, "can't get changesets in bbox"
  53       assert_changesets_in_order [changeset3, changeset2]
  54
  55       get api_changesets_path(:bbox => "4.5,4.5,4.6,4.6")
  56       assert_response :success, "can't get changesets in bbox"
  57       assert_changesets_in_order [changeset3]
  58
  59       # not found when looking for changesets of non-existing users
  60       get api_changesets_path(:user => User.maximum(:id) + 1)
  61       assert_response :not_found
  62       assert_equal "text/plain", @response.media_type
  63       get api_changesets_path(:display_name => " ")
  64       assert_response :not_found
  65       assert_equal "text/plain", @response.media_type
  66
  67       # can't get changesets of user 1 without authenticating
  68       get api_changesets_path(:user => private_user.id)
  69       assert_response :not_found, "shouldn't be able to get changesets by non-public user (ID)"
  70       get api_changesets_path(:display_name => private_user.display_name)
  71       assert_response :not_found, "shouldn't be able to get changesets by non-public user (name)"
  72
  73       # but this should work
  74       auth_header = bearer_authorization_header private_user
  75       get api_changesets_path(:user => private_user.id), :headers => auth_header
  76       assert_response :success, "can't get changesets by user ID"
  77       assert_changesets_in_order [private_user_changeset, private_user_closed_changeset]
  78
  79       get api_changesets_path(:display_name => private_user.display_name), :headers => auth_header
  80       assert_response :success, "can't get changesets by user name"
  81       assert_changesets_in_order [private_user_changeset, private_user_closed_changeset]
  82
  83       # test json endpoint
  84       get api_changesets_path(:display_name => private_user.display_name), :headers => auth_header, :params => { :format => "json" }
  85       assert_response :success, "can't get changesets by user name"
  86
  87       js = ActiveSupport::JSON.decode(@response.body)
  88       assert_not_nil js
  89
  90       assert_equal Settings.api_version, js["version"]
  91       assert_equal Settings.generator, js["generator"]
  92       assert_equal 2, js["changesets"].count
  93
  94       # check that the correct error is given when we provide both UID and name
  95       get api_changesets_path(:user => private_user.id,
  96                               :display_name => private_user.display_name), :headers => auth_header
  97       assert_response :bad_request, "should be a bad request to have both ID and name specified"
  98
  99       get api_changesets_path(:user => private_user.id, :open => true), :headers => auth_header
 100       assert_response :success, "can't get changesets by user and open"
 101       assert_changesets_in_order [private_user_changeset]
 102
 103       get api_changesets_path(:time => "2007-12-31"), :headers => auth_header
 104       assert_response :success, "can't get changesets by time-since"
 105       assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset, private_user_closed_changeset, closed_changeset]
 106
 107       get api_changesets_path(:time => "2008-01-01T12:34Z"), :headers => auth_header
 108       assert_response :success, "can't get changesets by time-since with hour"
 109       assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset, private_user_closed_changeset, closed_changeset]
 110
 111       get api_changesets_path(:time => "2007-12-31T23:59Z,2008-01-02T00:01Z"), :headers => auth_header
 112       assert_response :success, "can't get changesets by time-range"
 113       assert_changesets_in_order [closed_changeset]
 114
 115       get api_changesets_path(:open => "true"), :headers => auth_header
 116       assert_response :success, "can't get changesets by open-ness"
 117       assert_changesets_in_order [changeset3, changeset2, changeset, private_user_changeset]
 118
 119       get api_changesets_path(:closed => "true"), :headers => auth_header
 120       assert_response :success, "can't get changesets by closed-ness"
 121       assert_changesets_in_order [private_user_closed_changeset, closed_changeset]
 122
 123       get api_changesets_path(:closed => "true", :user => private_user.id), :headers => auth_header
 124       assert_response :success, "can't get changesets by closed-ness and user"
 125       assert_changesets_in_order [private_user_closed_changeset]
 126
 127       get api_changesets_path(:closed => "true", :user => user.id), :headers => auth_header
 128       assert_response :success, "can't get changesets by closed-ness and user"
 129       assert_changesets_in_order [closed_changeset]
 130
 131       get api_changesets_path(:changesets => "#{private_user_changeset.id},#{changeset.id},#{closed_changeset.id}"), :headers => auth_header
 132       assert_response :success, "can't get changesets by id (as comma-separated string)"
 133       assert_changesets_in_order [changeset, private_user_changeset, closed_changeset]
 134
 135       get api_changesets_path(:changesets => ""), :headers => auth_header
 136       assert_response :bad_request, "should be a bad request since changesets is empty"
 137     end
 138
 139     ##
 140     # test the query functionality of changesets with the limit parameter
 141     def test_index_limit
 142       user = create(:user)
 143       changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
 144       changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 2, 1, 0, 0, 0), :closed_at => Time.utc(2008, 2, 2, 0, 0, 0))
 145       changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 3, 1, 0, 0, 0), :closed_at => Time.utc(2008, 3, 2, 0, 0, 0))
 146       changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 4, 1, 0, 0, 0), :closed_at => Time.utc(2008, 4, 2, 0, 0, 0))
 147       changeset5 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 5, 1, 0, 0, 0), :closed_at => Time.utc(2008, 5, 2, 0, 0, 0))
 148
 149       get api_changesets_path
 150       assert_response :success
 151       assert_changesets_in_order [changeset5, changeset4, changeset3, changeset2, changeset1]
 152
 153       get api_changesets_path(:limit => "3")
 154       assert_response :success
 155       assert_changesets_in_order [changeset5, changeset4, changeset3]
 156
 157       get api_changesets_path(:limit => "0")
 158       assert_response :bad_request
 159
 160       get api_changesets_path(:limit => Settings.max_changeset_query_limit)
 161       assert_response :success
 162       assert_changesets_in_order [changeset5, changeset4, changeset3, changeset2, changeset1]
 163
 164       get api_changesets_path(:limit => Settings.max_changeset_query_limit + 1)
 165       assert_response :bad_request
 166     end
 167
 168     ##
 169     # test the query functionality of sequential changesets with order and time parameters
 170     def test_index_order
 171       user = create(:user)
 172       changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
 173       changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 2, 1, 0, 0, 0), :closed_at => Time.utc(2008, 2, 2, 0, 0, 0))
 174       changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 3, 1, 0, 0, 0), :closed_at => Time.utc(2008, 3, 2, 0, 0, 0))
 175       changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 4, 1, 0, 0, 0), :closed_at => Time.utc(2008, 4, 2, 0, 0, 0))
 176       changeset5 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 5, 1, 0, 0, 0), :closed_at => Time.utc(2008, 5, 2, 0, 0, 0))
 177       changeset6 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 6, 1, 0, 0, 0), :closed_at => Time.utc(2008, 6, 2, 0, 0, 0))
 178
 179       get api_changesets_path
 180       assert_response :success
 181       assert_changesets_in_order [changeset6, changeset5, changeset4, changeset3, changeset2, changeset1]
 182
 183       get api_changesets_path(:order => "oldest")
 184       assert_response :success
 185       assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4, changeset5, changeset6]
 186
 187       [
 188         # lower time bound at the opening time of a changeset
 189         ["2008-02-01T00:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3, changeset2]],
 190         # lower time bound in the middle of a changeset
 191         ["2008-02-01T12:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3]],
 192         # lower time bound at the closing time of a changeset
 193         ["2008-02-02T00:00:00Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3, changeset2], [changeset5, changeset4, changeset3]],
 194         # lower time bound after the closing time of a changeset
 195         ["2008-02-02T00:00:01Z", "2008-05-15T00:00:00Z", [changeset5, changeset4, changeset3], [changeset5, changeset4, changeset3]],
 196         # upper time bound in the middle of a changeset
 197         ["2007-09-09T12:00:00Z", "2008-04-01T12:00:00Z", [changeset4, changeset3, changeset2, changeset1], [changeset4, changeset3, changeset2, changeset1]],
 198         # empty range
 199         ["2009-02-02T00:00:01Z", "2018-05-15T00:00:00Z", [], []]
 200       ].each do |from, to, interval_changesets, point_changesets|
 201         get api_changesets_path(:time => "#{from},#{to}")
 202         assert_response :success
 203         assert_changesets_in_order interval_changesets
 204
 205         get api_changesets_path(:from => from, :to => to)
 206         assert_response :success
 207         assert_changesets_in_order point_changesets
 208
 209         get api_changesets_path(:from => from, :to => to, :order => "oldest")
 210         assert_response :success
 211         assert_changesets_in_order point_changesets.reverse
 212       end
 213     end
 214
 215     ##
 216     # test the query functionality of overlapping changesets with order and time parameters
 217     def test_index_order_overlapping
 218       user = create(:user)
 219       changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 17, 0, 0), :closed_at => Time.utc(2015, 6, 4, 17, 0, 0))
 220       changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 16, 0, 0), :closed_at => Time.utc(2015, 6, 4, 18, 0, 0))
 221       changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 4, 14, 0, 0), :closed_at => Time.utc(2015, 6, 4, 20, 0, 0))
 222       changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 3, 23, 0, 0), :closed_at => Time.utc(2015, 6, 4, 23, 0, 0))
 223       create(:changeset, :closed, :user => user, :created_at => Time.utc(2015, 6, 2, 23, 0, 0), :closed_at => Time.utc(2015, 6, 3, 23, 0, 0))
 224
 225       get api_changesets_path(:time => "2015-06-04T00:00:00Z")
 226       assert_response :success
 227       assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4]
 228
 229       get api_changesets_path(:from => "2015-06-04T00:00:00Z")
 230       assert_response :success
 231       assert_changesets_in_order [changeset1, changeset2, changeset3]
 232
 233       get api_changesets_path(:from => "2015-06-04T00:00:00Z", :order => "oldest")
 234       assert_response :success
 235       assert_changesets_in_order [changeset3, changeset2, changeset1]
 236
 237       get api_changesets_path(:time => "2015-06-04T16:00:00Z,2015-06-04T17:30:00Z")
 238       assert_response :success
 239       assert_changesets_in_order [changeset1, changeset2, changeset3, changeset4]
 240
 241       get api_changesets_path(:from => "2015-06-04T16:00:00Z", :to => "2015-06-04T17:30:00Z")
 242       assert_response :success
 243       assert_changesets_in_order [changeset1, changeset2]
 244
 245       get api_changesets_path(:from => "2015-06-04T16:00:00Z", :to => "2015-06-04T17:30:00Z", :order => "oldest")
 246       assert_response :success
 247       assert_changesets_in_order [changeset2, changeset1]
 248     end
 249
 250     ##
 251     # check that errors are returned if garbage is inserted
 252     # into query strings
 253     def test_index_invalid
 254       ["abracadabra!",
 255        "1,2,3,F",
 256        ";drop table users;"].each do |bbox|
 257         get api_changesets_path(:bbox => bbox)
 258         assert_response :bad_request, "'#{bbox}' isn't a bbox"
 259       end
 260
 261       ["now()",
 262        "00-00-00",
 263        ";drop table users;",
 264        ",",
 265        "-,-"].each do |time|
 266         get api_changesets_path(:time => time)
 267         assert_response :bad_request, "'#{time}' isn't a valid time range"
 268       end
 269
 270       ["me",
 271        "foobar",
 272        "-1",
 273        "0"].each do |uid|
 274         get api_changesets_path(:user => uid)
 275         assert_response :bad_request, "'#{uid}' isn't a valid user ID"
 276       end
 277
 278       get api_changesets_path(:order => "oldest", :time => "2008-01-01T00:00Z,2018-01-01T00:00Z")
 279       assert_response :bad_request, "cannot use order=oldest with time"
 280     end
 281
 282     # -----------------------
 283     # Test simple changeset creation
 284     # -----------------------
 285
 286     def test_create
 287       user = create(:user)
 288       auth_header = bearer_authorization_header user
 289       # Create the first user's changeset
 290       xml = "<osm><changeset>" \
 291             "<tag k='created_by' v='osm test suite checking changesets'/>" \
 292             "</changeset></osm>"
 293
 294       assert_difference "Changeset.count", 1 do
 295         post api_changesets_path, :params => xml, :headers => auth_header
 296         assert_response :success, "Creation of changeset did not return success status"
 297       end
 298       newid = @response.body.to_i
 299
 300       # check end time, should be an hour ahead of creation time
 301       changeset = Changeset.find(newid)
 302       duration = changeset.closed_at - changeset.created_at
 303       # the difference can either be a rational, or a floating point number
 304       # of seconds, depending on the code path taken :-(
 305       if duration.instance_of?(Rational)
 306         assert_equal Rational(1, 24), duration, "initial idle timeout should be an hour (#{changeset.created_at} -> #{changeset.closed_at})"
 307       else
 308         # must be number of seconds...
 309         assert_equal 3600, duration.round, "initial idle timeout should be an hour (#{changeset.created_at} -> #{changeset.closed_at})"
 310       end
 311
 312       assert_equal [user], changeset.subscribers
 313     end
 314
 315     def test_create_invalid
 316       auth_header = bearer_authorization_header create(:user, :data_public => false)
 317       xml = "<osm><changeset></osm>"
 318       post api_changesets_path, :params => xml, :headers => auth_header
 319       assert_require_public_data
 320
 321       ## Try the public user
 322       auth_header = bearer_authorization_header
 323       xml = "<osm><changeset></osm>"
 324       post api_changesets_path, :params => xml, :headers => auth_header
 325       assert_response :bad_request, "creating a invalid changeset should fail"
 326     end
 327
 328     def test_create_invalid_no_content
 329       ## First check with no auth
 330       post api_changesets_path
 331       assert_response :unauthorized, "shouldn't be able to create a changeset with no auth"
 332
 333       ## Now try to with a non-public user
 334       auth_header = bearer_authorization_header create(:user, :data_public => false)
 335       post api_changesets_path, :headers => auth_header
 336       assert_require_public_data
 337
 338       ## Try an inactive user
 339       auth_header = bearer_authorization_header create(:user, :pending)
 340       post api_changesets_path, :headers => auth_header
 341       assert_inactive_user
 342
 343       ## Now try to use a normal user
 344       auth_header = bearer_authorization_header
 345       post api_changesets_path, :headers => auth_header
 346       assert_response :bad_request, "creating a changeset with no content should fail"
 347     end
 348
 349     def test_create_wrong_method
 350       auth_header = bearer_authorization_header
 351
 352       put api_changesets_path, :headers => auth_header
 353       assert_response :not_found
 354       assert_template "rescues/routing_error"
 355     end
 356
 357     def test_create_legacy_path
 358       auth_header = bearer_authorization_header
 359       xml = "<osm><changeset></changeset></osm>"
 360
 361       assert_difference "Changeset.count", 1 do
 362         put "/api/0.6/changeset/create", :params => xml, :headers => auth_header
 363       end
 364
 365       assert_response :success, "Creation of changeset did not return success status"
 366       assert_equal Changeset.last.id, @response.body.to_i
 367     end
 368
 369     ##
 370     # check that the changeset can be shown and returns the correct
 371     # document structure.
 372     def test_show
 373       changeset = create(:changeset)
 374
 375       get api_changeset_path(changeset)
 376       assert_response :success, "cannot get first changeset"
 377
 378       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 379       assert_single_changeset changeset do
 380         assert_dom "> discussion", 0
 381       end
 382
 383       get api_changeset_path(changeset, :include_discussion => true)
 384       assert_response :success, "cannot get first changeset with comments"
 385
 386       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 387       assert_single_changeset changeset do
 388         assert_dom "> discussion", 1
 389         assert_dom "> discussion > comment", 0
 390       end
 391     end
 392
 393     def test_show_comments
 394       # all comments visible
 395       changeset = create(:changeset, :closed)
 396       comment1, comment2, comment3 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
 397
 398       get api_changeset_path(changeset, :include_discussion => true)
 399       assert_response :success, "cannot get closed changeset with comments"
 400
 401       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1 do
 402         assert_single_changeset changeset do
 403           assert_dom "> discussion", 1 do
 404             assert_dom "> comment", 3 do |dom_comments|
 405               assert_dom dom_comments[0], "> @id", comment1.id.to_s
 406               assert_dom dom_comments[0], "> @visible", "true"
 407               assert_dom dom_comments[1], "> @id", comment2.id.to_s
 408               assert_dom dom_comments[1], "> @visible", "true"
 409               assert_dom dom_comments[2], "> @id", comment3.id.to_s
 410               assert_dom dom_comments[2], "> @visible", "true"
 411             end
 412           end
 413         end
 414       end
 415
 416       # one hidden comment not included because not asked for
 417       comment2.update(:visible => false)
 418       changeset.reload
 419
 420       get api_changeset_path(changeset, :include_discussion => true)
 421       assert_response :success, "cannot get closed changeset with comments"
 422
 423       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 424       assert_single_changeset changeset do
 425         assert_dom "> discussion", 1 do
 426           assert_dom "> comment", 2 do |dom_comments|
 427             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 428             assert_dom dom_comments[0], "> @visible", "true"
 429             assert_dom dom_comments[1], "> @id", comment3.id.to_s
 430             assert_dom dom_comments[1], "> @visible", "true"
 431           end
 432         end
 433       end
 434
 435       # one hidden comment not included because no permissions
 436       get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true)
 437       assert_response :success, "cannot get closed changeset with comments"
 438
 439       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 440       assert_single_changeset changeset do
 441         assert_dom "> discussion", 1 do
 442           assert_dom "> comment", 2 do |dom_comments|
 443             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 444             assert_dom dom_comments[0], "> @visible", "true"
 445             # maybe will show an empty comment element with visible=false in the future
 446             assert_dom dom_comments[1], "> @id", comment3.id.to_s
 447             assert_dom dom_comments[1], "> @visible", "true"
 448           end
 449         end
 450       end
 451
 452       # one hidden comment shown to moderators
 453       moderator_user = create(:moderator_user)
 454       auth_header = bearer_authorization_header moderator_user
 455       get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
 456       assert_response :success, "cannot get closed changeset with comments"
 457
 458       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 459       assert_single_changeset changeset do
 460         assert_dom "> discussion", 1 do
 461           assert_dom "> comment", 3 do |dom_comments|
 462             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 463             assert_dom dom_comments[0], "> @visible", "true"
 464             assert_dom dom_comments[1], "> @id", comment2.id.to_s
 465             assert_dom dom_comments[1], "> @visible", "false"
 466             assert_dom dom_comments[2], "> @id", comment3.id.to_s
 467             assert_dom dom_comments[2], "> @visible", "true"
 468           end
 469         end
 470       end
 471     end
 472
 473     def test_show_tags
 474       changeset = create(:changeset, :closed)
 475       create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
 476       create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
 477
 478       get api_changeset_path(changeset)
 479
 480       assert_response :success
 481       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 482       assert_single_changeset changeset do
 483         assert_dom "> tag", 2
 484         assert_dom "> tag[k='created_by'][v='JOSM/1.5 (18364)']", 1
 485         assert_dom "> tag[k='comment'][v='changeset comment']", 1
 486       end
 487     end
 488
 489     def test_show_json
 490       changeset = create(:changeset)
 491
 492       get api_changeset_path(changeset, :format => "json")
 493       assert_response :success, "cannot get first changeset"
 494
 495       js = ActiveSupport::JSON.decode(@response.body)
 496       assert_not_nil js
 497
 498       assert_equal Settings.api_version, js["version"]
 499       assert_equal Settings.generator, js["generator"]
 500       assert_single_changeset_json changeset, js
 501       assert_nil js["changeset"]["tags"]
 502       assert_nil js["changeset"]["comments"]
 503       assert_equal changeset.user.id, js["changeset"]["uid"]
 504       assert_equal changeset.user.display_name, js["changeset"]["user"]
 505
 506       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 507       assert_response :success, "cannot get first changeset with comments"
 508
 509       js = ActiveSupport::JSON.decode(@response.body)
 510       assert_not_nil js
 511       assert_equal Settings.api_version, js["version"]
 512       assert_equal Settings.generator, js["generator"]
 513       assert_single_changeset_json changeset, js
 514       assert_nil js["changeset"]["tags"]
 515       assert_nil js["changeset"]["min_lat"]
 516       assert_nil js["changeset"]["min_lon"]
 517       assert_nil js["changeset"]["max_lat"]
 518       assert_nil js["changeset"]["max_lon"]
 519       assert_equal 0, js["changeset"]["comments"].count
 520     end
 521
 522     def test_show_comments_json
 523       # all comments visible
 524       changeset = create(:changeset, :closed)
 525       comment0, comment1, comment2 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
 526
 527       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 528       assert_response :success, "cannot get closed changeset with comments"
 529
 530       js = ActiveSupport::JSON.decode(@response.body)
 531       assert_not_nil js
 532       assert_equal Settings.api_version, js["version"]
 533       assert_equal Settings.generator, js["generator"]
 534       assert_single_changeset_json changeset, js
 535       assert_equal 3, js["changeset"]["comments"].count
 536       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 537       assert js["changeset"]["comments"][0]["visible"]
 538       assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
 539       assert js["changeset"]["comments"][1]["visible"]
 540       assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
 541       assert js["changeset"]["comments"][2]["visible"]
 542
 543       # one hidden comment not included because not asked for
 544       comment1.update(:visible => false)
 545       changeset.reload
 546
 547       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 548       assert_response :success, "cannot get closed changeset with comments"
 549
 550       js = ActiveSupport::JSON.decode(@response.body)
 551       assert_not_nil js
 552       assert_equal Settings.api_version, js["version"]
 553       assert_equal Settings.generator, js["generator"]
 554       assert_single_changeset_json changeset, js
 555       assert_equal 2, js["changeset"]["comments"].count
 556       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 557       assert js["changeset"]["comments"][0]["visible"]
 558       assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
 559       assert js["changeset"]["comments"][1]["visible"]
 560
 561       # one hidden comment not included because no permissions
 562       get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true)
 563       assert_response :success, "cannot get closed changeset with comments"
 564
 565       js = ActiveSupport::JSON.decode(@response.body)
 566       assert_not_nil js
 567       assert_equal Settings.api_version, js["version"]
 568       assert_equal Settings.generator, js["generator"]
 569       assert_single_changeset_json changeset, js
 570       assert_equal 2, js["changeset"]["comments"].count
 571       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 572       assert js["changeset"]["comments"][0]["visible"]
 573       # maybe will show an empty comment element with visible=false in the future
 574       assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
 575       assert js["changeset"]["comments"][1]["visible"]
 576
 577       # one hidden comment shown to moderators
 578       moderator_user = create(:moderator_user)
 579       auth_header = bearer_authorization_header moderator_user
 580       get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
 581       assert_response :success, "cannot get closed changeset with comments"
 582
 583       js = ActiveSupport::JSON.decode(@response.body)
 584       assert_not_nil js
 585       assert_equal Settings.api_version, js["version"]
 586       assert_equal Settings.generator, js["generator"]
 587       assert_single_changeset_json changeset, js
 588       assert_equal 3, js["changeset"]["comments"].count
 589       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 590       assert js["changeset"]["comments"][0]["visible"]
 591       assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
 592       assert_not js["changeset"]["comments"][1]["visible"]
 593       assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
 594       assert js["changeset"]["comments"][2]["visible"]
 595     end
 596
 597     def test_show_tags_json
 598       changeset = create(:changeset, :closed)
 599       create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
 600       create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
 601
 602       get api_changeset_path(changeset, :format => "json")
 603
 604       assert_response :success
 605       js = ActiveSupport::JSON.decode(@response.body)
 606       assert_not_nil js
 607       assert_equal Settings.api_version, js["version"]
 608       assert_equal Settings.generator, js["generator"]
 609       assert_single_changeset_json changeset, js
 610       assert_equal 2, js["changeset"]["tags"].count
 611       assert_equal "JOSM/1.5 (18364)", js["changeset"]["tags"]["created_by"]
 612       assert_equal "changeset comment", js["changeset"]["tags"]["comment"]
 613     end
 614
 615     def test_show_bbox_json
 616       changeset = create(:changeset, :bbox => [5, -5, 12, 15])
 617
 618       get api_changeset_path(changeset, :format => "json")
 619       assert_response :success, "cannot get first changeset"
 620
 621       js = ActiveSupport::JSON.decode(@response.body)
 622       assert_not_nil js
 623       assert_equal(-5, js["changeset"]["min_lat"])
 624       assert_equal 5, js["changeset"]["min_lon"]
 625       assert_equal 15, js["changeset"]["max_lat"]
 626       assert_equal 12, js["changeset"]["max_lon"]
 627     end
 628
 629     ##
 630     # check that a changeset that doesn't exist returns an appropriate message
 631     def test_show_not_found
 632       [0, -32, 233455644, "afg", "213"].each do |id|
 633         get api_changeset_path(id)
 634         assert_response :not_found, "should get a not found"
 635       rescue ActionController::UrlGenerationError => e
 636         assert_match(/No route matches/, e.to_s)
 637       end
 638     end
 639
 640     def test_repeated_changeset_create
 641       3.times do
 642         auth_header = bearer_authorization_header
 643
 644         # create a temporary changeset
 645         xml = "<osm><changeset>" \
 646               "<tag k='created_by' v='osm test suite checking changesets'/>" \
 647               "</changeset></osm>"
 648         assert_difference "Changeset.count", 1 do
 649           post api_changesets_path, :params => xml, :headers => auth_header
 650         end
 651         assert_response :success
 652       end
 653     end
 654
 655     ##
 656     # check updating tags on a changeset
 657     def test_changeset_update
 658       private_user = create(:user, :data_public => false)
 659       private_changeset = create(:changeset, :user => private_user)
 660       user = create(:user)
 661       changeset = create(:changeset, :user => user)
 662
 663       ## First try with a non-public user
 664       new_changeset = create_changeset_xml(:user => private_user)
 665       new_tag = XML::Node.new "tag"
 666       new_tag["k"] = "tagtesting"
 667       new_tag["v"] = "valuetesting"
 668       new_changeset.find("//osm/changeset").first << new_tag
 669
 670       # try without any authorization
 671       put api_changeset_path(private_changeset), :params => new_changeset.to_s
 672       assert_response :unauthorized
 673
 674       # try with the wrong authorization
 675       auth_header = bearer_authorization_header
 676       put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
 677       assert_response :conflict
 678
 679       # now this should get an unauthorized
 680       auth_header = bearer_authorization_header private_user
 681       put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
 682       assert_require_public_data "user with their data non-public, shouldn't be able to edit their changeset"
 683
 684       ## Now try with the public user
 685       new_changeset = create_changeset_xml(:id => 1)
 686       new_tag = XML::Node.new "tag"
 687       new_tag["k"] = "tagtesting"
 688       new_tag["v"] = "valuetesting"
 689       new_changeset.find("//osm/changeset").first << new_tag
 690
 691       # try without any authorization
 692       put api_changeset_path(changeset), :params => new_changeset.to_s
 693       assert_response :unauthorized
 694
 695       # try with the wrong authorization
 696       auth_header = bearer_authorization_header
 697       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 698       assert_response :conflict
 699
 700       # now this should work...
 701       auth_header = bearer_authorization_header user
 702       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 703       assert_response :success
 704
 705       assert_select "osm>changeset[id='#{changeset.id}']", 1
 706       assert_select "osm>changeset>tag", 1
 707       assert_select "osm>changeset>tag[k='tagtesting'][v='valuetesting']", 1
 708     end
 709
 710     ##
 711     # check that a user different from the one who opened the changeset
 712     # can't modify it.
 713     def test_changeset_update_invalid
 714       auth_header = bearer_authorization_header
 715
 716       changeset = create(:changeset)
 717       new_changeset = create_changeset_xml(:user => changeset.user, :id => changeset.id)
 718       new_tag = XML::Node.new "tag"
 719       new_tag["k"] = "testing"
 720       new_tag["v"] = "testing"
 721       new_changeset.find("//osm/changeset").first << new_tag
 722
 723       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 724       assert_response :conflict
 725     end
 726
 727     ##
 728     # check that a changeset can contain a certain max number of changes.
 729     ## FIXME should be changed to an integration test due to the with_controller
 730     def test_changeset_limits
 731       user = create(:user)
 732       auth_header = bearer_authorization_header user
 733
 734       # create an old changeset to ensure we have the maximum rate limit
 735       create(:changeset, :user => user, :created_at => Time.now.utc - 28.days)
 736
 737       # open a new changeset
 738       xml = "<osm><changeset/></osm>"
 739       post api_changesets_path, :params => xml, :headers => auth_header
 740       assert_response :success, "can't create a new changeset"
 741       changeset_id = @response.body.to_i
 742
 743       # start the counter just short of where the changeset should finish.
 744       offset = 10
 745       # alter the database to set the counter on the changeset directly,
 746       # otherwise it takes about 6 minutes to fill all of them.
 747       changeset = Changeset.find(changeset_id)
 748       changeset.num_changes = Changeset::MAX_ELEMENTS - offset
 749       changeset.save!
 750
 751       with_controller(NodesController.new) do
 752         # create a new node
 753         xml = "<osm><node changeset='#{changeset_id}' lat='0.0' lon='0.0'/></osm>"
 754         post api_nodes_path, :params => xml, :headers => auth_header
 755         assert_response :success, "can't create a new node"
 756         node_id = @response.body.to_i
 757
 758         get api_node_path(node_id)
 759         assert_response :success, "can't read back new node"
 760         node_doc = XML::Parser.string(@response.body).parse
 761         node_xml = node_doc.find("//osm/node").first
 762
 763         # loop until we fill the changeset with nodes
 764         offset.times do |i|
 765           node_xml["lat"] = rand.to_s
 766           node_xml["lon"] = rand.to_s
 767           node_xml["version"] = (i + 1).to_s
 768
 769           put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
 770           assert_response :success, "attempt #{i} should have succeeded"
 771         end
 772
 773         # trying again should fail
 774         node_xml["lat"] = rand.to_s
 775         node_xml["lon"] = rand.to_s
 776         node_xml["version"] = offset.to_s
 777
 778         put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
 779         assert_response :conflict, "final attempt should have failed"
 780       end
 781
 782       changeset = Changeset.find(changeset_id)
 783       assert_equal Changeset::MAX_ELEMENTS + 1, changeset.num_changes
 784
 785       # check that the changeset is now closed as well
 786       assert_not(changeset.open?,
 787                  "changeset should have been auto-closed by exceeding " \
 788                  "element limit.")
 789     end
 790
 791     private
 792
 793     ##
 794     # check that the output consists of one specific changeset
 795     def assert_single_changeset(changeset, &)
 796       assert_dom "> changeset", 1 do
 797         assert_dom "> @id", changeset.id.to_s
 798         assert_dom "> @created_at", changeset.created_at.xmlschema
 799         if changeset.open?
 800           assert_dom "> @open", "true"
 801           assert_dom "> @closed_at", 0
 802         else
 803           assert_dom "> @open", "false"
 804           assert_dom "> @closed_at", changeset.closed_at.xmlschema
 805         end
 806         assert_dom "> @comments_count", changeset.comments.length.to_s
 807         assert_dom "> @changes_count", changeset.num_changes.to_s
 808         yield if block_given?
 809       end
 810     end
 811
 812     def assert_single_changeset_json(changeset, js)
 813       assert_equal changeset.id, js["changeset"]["id"]
 814       assert_equal changeset.created_at.xmlschema, js["changeset"]["created_at"]
 815       if changeset.open?
 816         assert js["changeset"]["open"]
 817         assert_nil js["changeset"]["closed_at"]
 818       else
 819         assert_not js["changeset"]["open"]
 820         assert_equal changeset.closed_at.xmlschema, js["changeset"]["closed_at"]
 821       end
 822       assert_equal changeset.comments.length, js["changeset"]["comments_count"]
 823       assert_equal changeset.num_changes, js["changeset"]["changes_count"]
 824     end
 825
 826     ##
 827     # check that certain changesets exist in the output in the specified order
 828     def assert_changesets_in_order(changesets)
 829       assert_select "osm>changeset", changesets.size
 830       changesets.each_with_index do |changeset, index|
 831         assert_select "osm>changeset:nth-child(#{index + 1})[id='#{changeset.id}']", 1
 832       end
 833     end
 834
 835     ##
 836     # build XML for changesets
 837     def create_changeset_xml(user: nil, id: nil)
 838       root = XML::Document.new
 839       root.root = XML::Node.new "osm"
 840       changeset = XML::Node.new "changeset"
 841       if user
 842         changeset["user"] = user.display_name
 843         changeset["uid"] = user.id.to_s
 844       end
 845       changeset["id"] = id.to_s if id
 846       root.root << changeset
 847       root
 848     end
 849   end
 850 end