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