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