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       assert_predicate changeset, :num_type_changes_in_sync?
 314     end
 315
 316     def test_create_invalid
 317       auth_header = bearer_authorization_header create(:user, :data_public => false)
 318       xml = "<osm><changeset></osm>"
 319       post api_changesets_path, :params => xml, :headers => auth_header
 320       assert_require_public_data
 321
 322       ## Try the public user
 323       auth_header = bearer_authorization_header
 324       xml = "<osm><changeset></osm>"
 325       post api_changesets_path, :params => xml, :headers => auth_header
 326       assert_response :bad_request, "creating a invalid changeset should fail"
 327     end
 328
 329     def test_create_invalid_no_content
 330       ## First check with no auth
 331       post api_changesets_path
 332       assert_response :unauthorized, "shouldn't be able to create a changeset with no auth"
 333
 334       ## Now try to with a non-public user
 335       auth_header = bearer_authorization_header create(:user, :data_public => false)
 336       post api_changesets_path, :headers => auth_header
 337       assert_require_public_data
 338
 339       ## Try an inactive user
 340       auth_header = bearer_authorization_header create(:user, :pending)
 341       post api_changesets_path, :headers => auth_header
 342       assert_inactive_user
 343
 344       ## Now try to use a normal user
 345       auth_header = bearer_authorization_header
 346       post api_changesets_path, :headers => auth_header
 347       assert_response :bad_request, "creating a changeset with no content should fail"
 348     end
 349
 350     def test_create_wrong_method
 351       auth_header = bearer_authorization_header
 352
 353       put api_changesets_path, :headers => auth_header
 354       assert_response :not_found
 355       assert_template "rescues/routing_error"
 356     end
 357
 358     def test_create_legacy_path
 359       auth_header = bearer_authorization_header
 360       xml = "<osm><changeset></changeset></osm>"
 361
 362       assert_difference "Changeset.count", 1 do
 363         put "/api/0.6/changeset/create", :params => xml, :headers => auth_header
 364       end
 365
 366       assert_response :success, "Creation of changeset did not return success status"
 367       assert_equal Changeset.last.id, @response.body.to_i
 368     end
 369
 370     ##
 371     # check that the changeset can be shown and returns the correct
 372     # document structure.
 373     def test_show
 374       changeset = create(:changeset)
 375
 376       get api_changeset_path(changeset)
 377       assert_response :success, "cannot get first changeset"
 378
 379       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 380       assert_single_changeset changeset do
 381         assert_dom "> discussion", 0
 382       end
 383
 384       get api_changeset_path(changeset, :include_discussion => true)
 385       assert_response :success, "cannot get first changeset with comments"
 386
 387       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 388       assert_single_changeset changeset do
 389         assert_dom "> discussion", 1
 390         assert_dom "> discussion > comment", 0
 391       end
 392     end
 393
 394     def test_show_comments
 395       # all comments visible
 396       changeset = create(:changeset, :closed)
 397       comment1, comment2, comment3 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
 398
 399       get api_changeset_path(changeset, :include_discussion => true)
 400       assert_response :success, "cannot get closed changeset with comments"
 401
 402       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1 do
 403         assert_single_changeset changeset do
 404           assert_dom "> discussion", 1 do
 405             assert_dom "> comment", 3 do |dom_comments|
 406               assert_dom dom_comments[0], "> @id", comment1.id.to_s
 407               assert_dom dom_comments[0], "> @visible", "true"
 408               assert_dom dom_comments[1], "> @id", comment2.id.to_s
 409               assert_dom dom_comments[1], "> @visible", "true"
 410               assert_dom dom_comments[2], "> @id", comment3.id.to_s
 411               assert_dom dom_comments[2], "> @visible", "true"
 412             end
 413           end
 414         end
 415       end
 416
 417       # one hidden comment not included because not asked for
 418       comment2.update(:visible => false)
 419       changeset.reload
 420
 421       get api_changeset_path(changeset, :include_discussion => true)
 422       assert_response :success, "cannot get closed changeset with comments"
 423
 424       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 425       assert_single_changeset changeset do
 426         assert_dom "> discussion", 1 do
 427           assert_dom "> comment", 2 do |dom_comments|
 428             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 429             assert_dom dom_comments[0], "> @visible", "true"
 430             assert_dom dom_comments[1], "> @id", comment3.id.to_s
 431             assert_dom dom_comments[1], "> @visible", "true"
 432           end
 433         end
 434       end
 435
 436       # one hidden comment not included because no permissions
 437       get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true)
 438       assert_response :success, "cannot get closed changeset with comments"
 439
 440       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 441       assert_single_changeset changeset do
 442         assert_dom "> discussion", 1 do
 443           assert_dom "> comment", 2 do |dom_comments|
 444             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 445             assert_dom dom_comments[0], "> @visible", "true"
 446             # maybe will show an empty comment element with visible=false in the future
 447             assert_dom dom_comments[1], "> @id", comment3.id.to_s
 448             assert_dom dom_comments[1], "> @visible", "true"
 449           end
 450         end
 451       end
 452
 453       # one hidden comment shown to moderators
 454       moderator_user = create(:moderator_user)
 455       auth_header = bearer_authorization_header moderator_user
 456       get api_changeset_path(changeset, :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
 457       assert_response :success, "cannot get closed changeset with comments"
 458
 459       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 460       assert_single_changeset changeset do
 461         assert_dom "> discussion", 1 do
 462           assert_dom "> comment", 3 do |dom_comments|
 463             assert_dom dom_comments[0], "> @id", comment1.id.to_s
 464             assert_dom dom_comments[0], "> @visible", "true"
 465             assert_dom dom_comments[1], "> @id", comment2.id.to_s
 466             assert_dom dom_comments[1], "> @visible", "false"
 467             assert_dom dom_comments[2], "> @id", comment3.id.to_s
 468             assert_dom dom_comments[2], "> @visible", "true"
 469           end
 470         end
 471       end
 472     end
 473
 474     def test_show_tags
 475       changeset = create(:changeset, :closed)
 476       create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
 477       create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
 478
 479       get api_changeset_path(changeset)
 480
 481       assert_response :success
 482       assert_dom "osm[version='#{Settings.api_version}'][generator='#{Settings.generator}']", 1
 483       assert_single_changeset changeset do
 484         assert_dom "> tag", 2
 485         assert_dom "> tag[k='created_by'][v='JOSM/1.5 (18364)']", 1
 486         assert_dom "> tag[k='comment'][v='changeset comment']", 1
 487       end
 488     end
 489
 490     def test_show_json
 491       changeset = create(:changeset)
 492
 493       get api_changeset_path(changeset, :format => "json")
 494       assert_response :success, "cannot get first changeset"
 495
 496       js = ActiveSupport::JSON.decode(@response.body)
 497       assert_not_nil js
 498
 499       assert_equal Settings.api_version, js["version"]
 500       assert_equal Settings.generator, js["generator"]
 501       assert_single_changeset_json changeset, js
 502       assert_nil js["changeset"]["tags"]
 503       assert_nil js["changeset"]["comments"]
 504       assert_equal changeset.user.id, js["changeset"]["uid"]
 505       assert_equal changeset.user.display_name, js["changeset"]["user"]
 506
 507       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 508       assert_response :success, "cannot get first changeset with comments"
 509
 510       js = ActiveSupport::JSON.decode(@response.body)
 511       assert_not_nil js
 512       assert_equal Settings.api_version, js["version"]
 513       assert_equal Settings.generator, js["generator"]
 514       assert_single_changeset_json changeset, js
 515       assert_nil js["changeset"]["tags"]
 516       assert_nil js["changeset"]["min_lat"]
 517       assert_nil js["changeset"]["min_lon"]
 518       assert_nil js["changeset"]["max_lat"]
 519       assert_nil js["changeset"]["max_lon"]
 520       assert_equal 0, js["changeset"]["comments"].count
 521     end
 522
 523     def test_show_comments_json
 524       # all comments visible
 525       changeset = create(:changeset, :closed)
 526       comment0, comment1, comment2 = create_list(:changeset_comment, 3, :changeset_id => changeset.id)
 527
 528       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 529       assert_response :success, "cannot get closed changeset with comments"
 530
 531       js = ActiveSupport::JSON.decode(@response.body)
 532       assert_not_nil js
 533       assert_equal Settings.api_version, js["version"]
 534       assert_equal Settings.generator, js["generator"]
 535       assert_single_changeset_json changeset, js
 536       assert_equal 3, js["changeset"]["comments"].count
 537       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 538       assert js["changeset"]["comments"][0]["visible"]
 539       assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
 540       assert js["changeset"]["comments"][1]["visible"]
 541       assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
 542       assert js["changeset"]["comments"][2]["visible"]
 543
 544       # one hidden comment not included because not asked for
 545       comment1.update(:visible => false)
 546       changeset.reload
 547
 548       get api_changeset_path(changeset, :format => "json", :include_discussion => true)
 549       assert_response :success, "cannot get closed changeset with comments"
 550
 551       js = ActiveSupport::JSON.decode(@response.body)
 552       assert_not_nil js
 553       assert_equal Settings.api_version, js["version"]
 554       assert_equal Settings.generator, js["generator"]
 555       assert_single_changeset_json changeset, js
 556       assert_equal 2, js["changeset"]["comments"].count
 557       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 558       assert js["changeset"]["comments"][0]["visible"]
 559       assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
 560       assert js["changeset"]["comments"][1]["visible"]
 561
 562       # one hidden comment not included because no permissions
 563       get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true)
 564       assert_response :success, "cannot get closed changeset with comments"
 565
 566       js = ActiveSupport::JSON.decode(@response.body)
 567       assert_not_nil js
 568       assert_equal Settings.api_version, js["version"]
 569       assert_equal Settings.generator, js["generator"]
 570       assert_single_changeset_json changeset, js
 571       assert_equal 2, js["changeset"]["comments"].count
 572       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 573       assert js["changeset"]["comments"][0]["visible"]
 574       # maybe will show an empty comment element with visible=false in the future
 575       assert_equal comment2.id, js["changeset"]["comments"][1]["id"]
 576       assert js["changeset"]["comments"][1]["visible"]
 577
 578       # one hidden comment shown to moderators
 579       moderator_user = create(:moderator_user)
 580       auth_header = bearer_authorization_header moderator_user
 581       get api_changeset_path(changeset, :format => "json", :include_discussion => true, :show_hidden_comments => true), :headers => auth_header
 582       assert_response :success, "cannot get closed changeset with comments"
 583
 584       js = ActiveSupport::JSON.decode(@response.body)
 585       assert_not_nil js
 586       assert_equal Settings.api_version, js["version"]
 587       assert_equal Settings.generator, js["generator"]
 588       assert_single_changeset_json changeset, js
 589       assert_equal 3, js["changeset"]["comments"].count
 590       assert_equal comment0.id, js["changeset"]["comments"][0]["id"]
 591       assert js["changeset"]["comments"][0]["visible"]
 592       assert_equal comment1.id, js["changeset"]["comments"][1]["id"]
 593       assert_not js["changeset"]["comments"][1]["visible"]
 594       assert_equal comment2.id, js["changeset"]["comments"][2]["id"]
 595       assert js["changeset"]["comments"][2]["visible"]
 596     end
 597
 598     def test_show_tags_json
 599       changeset = create(:changeset, :closed)
 600       create(:changeset_tag, :changeset => changeset, :k => "created_by", :v => "JOSM/1.5 (18364)")
 601       create(:changeset_tag, :changeset => changeset, :k => "comment", :v => "changeset comment")
 602
 603       get api_changeset_path(changeset, :format => "json")
 604
 605       assert_response :success
 606       js = ActiveSupport::JSON.decode(@response.body)
 607       assert_not_nil js
 608       assert_equal Settings.api_version, js["version"]
 609       assert_equal Settings.generator, js["generator"]
 610       assert_single_changeset_json changeset, js
 611       assert_equal 2, js["changeset"]["tags"].count
 612       assert_equal "JOSM/1.5 (18364)", js["changeset"]["tags"]["created_by"]
 613       assert_equal "changeset comment", js["changeset"]["tags"]["comment"]
 614     end
 615
 616     def test_show_bbox_json
 617       changeset = create(:changeset, :bbox => [5, -5, 12, 15])
 618
 619       get api_changeset_path(changeset, :format => "json")
 620       assert_response :success, "cannot get first changeset"
 621
 622       js = ActiveSupport::JSON.decode(@response.body)
 623       assert_not_nil js
 624       assert_equal(-5, js["changeset"]["min_lat"])
 625       assert_equal 5, js["changeset"]["min_lon"]
 626       assert_equal 15, js["changeset"]["max_lat"]
 627       assert_equal 12, js["changeset"]["max_lon"]
 628     end
 629
 630     ##
 631     # check that a changeset that doesn't exist returns an appropriate message
 632     def test_show_not_found
 633       [0, -32, 233455644, "afg", "213"].each do |id|
 634         get api_changeset_path(id)
 635         assert_response :not_found, "should get a not found"
 636       rescue ActionController::UrlGenerationError => e
 637         assert_match(/No route matches/, e.to_s)
 638       end
 639     end
 640
 641     def test_repeated_changeset_create
 642       3.times do
 643         auth_header = bearer_authorization_header
 644
 645         # create a temporary changeset
 646         xml = "<osm><changeset>" \
 647               "<tag k='created_by' v='osm test suite checking changesets'/>" \
 648               "</changeset></osm>"
 649         assert_difference "Changeset.count", 1 do
 650           post api_changesets_path, :params => xml, :headers => auth_header
 651         end
 652         assert_response :success
 653       end
 654     end
 655
 656     ##
 657     # check updating tags on a changeset
 658     def test_changeset_update
 659       private_user = create(:user, :data_public => false)
 660       private_changeset = create(:changeset, :user => private_user)
 661       user = create(:user)
 662       changeset = create(:changeset, :user => user)
 663
 664       ## First try with a non-public user
 665       new_changeset = create_changeset_xml(:user => private_user)
 666       new_tag = XML::Node.new "tag"
 667       new_tag["k"] = "tagtesting"
 668       new_tag["v"] = "valuetesting"
 669       new_changeset.find("//osm/changeset").first << new_tag
 670
 671       # try without any authorization
 672       put api_changeset_path(private_changeset), :params => new_changeset.to_s
 673       assert_response :unauthorized
 674
 675       # try with the wrong authorization
 676       auth_header = bearer_authorization_header
 677       put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
 678       assert_response :conflict
 679
 680       # now this should get an unauthorized
 681       auth_header = bearer_authorization_header private_user
 682       put api_changeset_path(private_changeset), :params => new_changeset.to_s, :headers => auth_header
 683       assert_require_public_data "user with their data non-public, shouldn't be able to edit their changeset"
 684
 685       ## Now try with the public user
 686       new_changeset = create_changeset_xml(:id => 1)
 687       new_tag = XML::Node.new "tag"
 688       new_tag["k"] = "tagtesting"
 689       new_tag["v"] = "valuetesting"
 690       new_changeset.find("//osm/changeset").first << new_tag
 691
 692       # try without any authorization
 693       put api_changeset_path(changeset), :params => new_changeset.to_s
 694       assert_response :unauthorized
 695
 696       # try with the wrong authorization
 697       auth_header = bearer_authorization_header
 698       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 699       assert_response :conflict
 700
 701       # now this should work...
 702       auth_header = bearer_authorization_header user
 703       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 704       assert_response :success
 705
 706       assert_select "osm>changeset[id='#{changeset.id}']", 1
 707       assert_select "osm>changeset>tag", 1
 708       assert_select "osm>changeset>tag[k='tagtesting'][v='valuetesting']", 1
 709     end
 710
 711     ##
 712     # check that a user different from the one who opened the changeset
 713     # can't modify it.
 714     def test_changeset_update_invalid
 715       auth_header = bearer_authorization_header
 716
 717       changeset = create(:changeset)
 718       new_changeset = create_changeset_xml(:user => changeset.user, :id => changeset.id)
 719       new_tag = XML::Node.new "tag"
 720       new_tag["k"] = "testing"
 721       new_tag["v"] = "testing"
 722       new_changeset.find("//osm/changeset").first << new_tag
 723
 724       put api_changeset_path(changeset), :params => new_changeset.to_s, :headers => auth_header
 725       assert_response :conflict
 726     end
 727
 728     ##
 729     # check that a changeset can contain a certain max number of changes.
 730     ## FIXME should be changed to an integration test due to the with_controller
 731     def test_changeset_limits
 732       user = create(:user)
 733       auth_header = bearer_authorization_header user
 734
 735       # create an old changeset to ensure we have the maximum rate limit
 736       create(:changeset, :user => user, :created_at => Time.now.utc - 28.days)
 737
 738       # open a new changeset
 739       xml = "<osm><changeset/></osm>"
 740       post api_changesets_path, :params => xml, :headers => auth_header
 741       assert_response :success, "can't create a new changeset"
 742       changeset_id = @response.body.to_i
 743
 744       # start the counter just short of where the changeset should finish.
 745       offset = 10
 746       # alter the database to set the counter on the changeset directly,
 747       # otherwise it takes about 6 minutes to fill all of them.
 748       changeset = Changeset.find(changeset_id)
 749       changeset.num_changes = Changeset::MAX_ELEMENTS - offset
 750       changeset.save!
 751
 752       with_controller(NodesController.new) do
 753         # create a new node
 754         xml = "<osm><node changeset='#{changeset_id}' lat='0.0' lon='0.0'/></osm>"
 755         post api_nodes_path, :params => xml, :headers => auth_header
 756         assert_response :success, "can't create a new node"
 757         node_id = @response.body.to_i
 758
 759         get api_node_path(node_id)
 760         assert_response :success, "can't read back new node"
 761         node_doc = XML::Parser.string(@response.body).parse
 762         node_xml = node_doc.find("//osm/node").first
 763
 764         # loop until we fill the changeset with nodes
 765         offset.times do |i|
 766           node_xml["lat"] = rand.to_s
 767           node_xml["lon"] = rand.to_s
 768           node_xml["version"] = (i + 1).to_s
 769
 770           put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
 771           assert_response :success, "attempt #{i} should have succeeded"
 772         end
 773
 774         # trying again should fail
 775         node_xml["lat"] = rand.to_s
 776         node_xml["lon"] = rand.to_s
 777         node_xml["version"] = offset.to_s
 778
 779         put api_node_path(node_id), :params => node_doc.to_s, :headers => auth_header
 780         assert_response :conflict, "final attempt should have failed"
 781       end
 782
 783       changeset = Changeset.find(changeset_id)
 784       assert_equal Changeset::MAX_ELEMENTS + 1, changeset.num_changes
 785
 786       # check that the changeset is now closed as well
 787       assert_not(changeset.open?,
 788                  "changeset should have been auto-closed by exceeding " \
 789                  "element limit.")
 790     end
 791
 792     private
 793
 794     ##
 795     # check that the output consists of one specific changeset
 796     def assert_single_changeset(changeset, &)
 797       assert_dom "> changeset", 1 do
 798         assert_dom "> @id", changeset.id.to_s
 799         assert_dom "> @created_at", changeset.created_at.xmlschema
 800         if changeset.open?
 801           assert_dom "> @open", "true"
 802           assert_dom "> @closed_at", 0
 803         else
 804           assert_dom "> @open", "false"
 805           assert_dom "> @closed_at", changeset.closed_at.xmlschema
 806         end
 807         assert_dom "> @comments_count", changeset.comments.length.to_s
 808         assert_dom "> @changes_count", changeset.num_changes.to_s
 809         yield if block_given?
 810       end
 811     end
 812
 813     def assert_single_changeset_json(changeset, js)
 814       assert_equal changeset.id, js["changeset"]["id"]
 815       assert_equal changeset.created_at.xmlschema, js["changeset"]["created_at"]
 816       if changeset.open?
 817         assert js["changeset"]["open"]
 818         assert_nil js["changeset"]["closed_at"]
 819       else
 820         assert_not js["changeset"]["open"]
 821         assert_equal changeset.closed_at.xmlschema, js["changeset"]["closed_at"]
 822       end
 823       assert_equal changeset.comments.length, js["changeset"]["comments_count"]
 824       assert_equal changeset.num_changes, js["changeset"]["changes_count"]
 825     end
 826
 827     ##
 828     # check that certain changesets exist in the output in the specified order
 829     def assert_changesets_in_order(changesets)
 830       assert_select "osm>changeset", changesets.size
 831       changesets.each_with_index do |changeset, index|
 832         assert_select "osm>changeset:nth-child(#{index + 1})[id='#{changeset.id}']", 1
 833       end
 834     end
 835
 836     ##
 837     # build XML for changesets
 838     def create_changeset_xml(user: nil, id: nil)
 839       root = XML::Document.new
 840       root.root = XML::Node.new "osm"
 841       changeset = XML::Node.new "changeset"
 842       if user
 843         changeset["user"] = user.display_name
 844         changeset["uid"] = user.id.to_s
 845       end
 846       changeset["id"] = id.to_s if id
 847       root.root << changeset
 848       root
 849     end
 850   end
 851 end