Merge remote-tracking branch 'openstreetmap/pull/1004'
[rails.git] / test / controllers / api_controller_test.rb
1 require "test_helper"
2 require "api_controller"
3
4 class ApiControllerTest < ActionController::TestCase
5   api_fixtures
6
7   def setup
8     super
9     @badbigbbox = %w(-0.1,-0.1,1.1,1.1 10,10,11,11)
10     @badmalformedbbox = %w(-0.1 hello
11                            10N2W10.1N2.1W)
12     @badlatmixedbbox = %w(0,0.1,0.1,0 -0.1,80,0.1,70 0.24,54.34,0.25,54.33)
13     @badlonmixedbbox = %w(80,-0.1,70,0.1 54.34,0.24,54.33,0.25)
14     # @badlatlonoutboundsbbox = %w{ 191,-0.1,193,0.1  -190.1,89.9,-190,90 }
15     @goodbbox = %w(-0.1,-0.1,0.1,0.1 51.1,-0.1,51.2,0
16                    -0.1,%20-0.1,%200.1,%200.1 -0.1edcd,-0.1d,0.1,0.1 -0.1E,-0.1E,0.1S,0.1N S0.1,W0.1,N0.1,E0.1)
17     # That last item in the goodbbox really shouldn't be there, as the API should
18     # reall reject it, however this is to test to see if the api changes.
19   end
20
21   ##
22   # test all routes which lead to this controller
23   def test_routes
24     assert_routing(
25       { :path => "/api/capabilities", :method => :get },
26       { :controller => "api", :action => "capabilities" }
27     )
28     assert_recognizes(
29       { :controller => "api", :action => "capabilities" },
30       { :path => "/api/0.6/capabilities", :method => :get }
31     )
32     assert_routing(
33       { :path => "/api/0.6/permissions", :method => :get },
34       { :controller => "api", :action => "permissions" }
35     )
36     assert_routing(
37       { :path => "/api/0.6/map", :method => :get },
38       { :controller => "api", :action => "map" }
39     )
40     assert_routing(
41       { :path => "/api/0.6/trackpoints", :method => :get },
42       { :controller => "api", :action => "trackpoints" }
43     )
44     assert_routing(
45       { :path => "/api/0.6/changes", :method => :get },
46       { :controller => "api", :action => "changes" }
47     )
48   end
49
50   # -------------------------------------
51   # Test reading a bounding box.
52   # -------------------------------------
53
54   def test_map
55     node = current_nodes(:used_node_1)
56     # Need to split the min/max lat/lon out into their own variables here
57     # so that we can test they are returned later.
58     minlon = node.lon - 0.1
59     minlat = node.lat - 0.1
60     maxlon = node.lon + 0.1
61     maxlat = node.lat + 0.1
62     bbox = "#{minlon},#{minlat},#{maxlon},#{maxlat}"
63     get :map, :bbox => bbox
64     if $VERBOSE
65       print @request.to_yaml
66       print @response.body
67     end
68     assert_response :success, "Expected scucess with the map call"
69     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
70       assert_select "bounds[minlon='#{minlon}'][minlat='#{minlat}'][maxlon='#{maxlon}'][maxlat='#{maxlat}']", :count => 1
71       assert_select "node[id='#{node.id}'][lat='#{node.lat}'][lon='#{node.lon}'][version='#{node.version}'][changeset='#{node.changeset_id}'][visible='#{node.visible}'][timestamp='#{node.timestamp.xmlschema}']", :count => 1 do
72         # This should really be more generic
73         assert_select "tag[k='test'][v='yes']"
74       end
75       assert_select "way", :count => 2
76       assert_select "way[id='1']", :count => 1
77       assert_select "way[id='3']", :count => 1
78       assert_select "relation", :count => 1
79       assert_select "relation[id='1']", :count => 1
80     end
81   end
82
83   # This differs from the above test in that we are making the bbox exactly
84   # the same as the node we are looking at
85   def test_map_inclusive
86     node = current_nodes(:used_node_1)
87     bbox = "#{node.lon},#{node.lat},#{node.lon},#{node.lat}"
88     get :map, :bbox => bbox
89     assert_response :success, "The map call should have succeeded"
90     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
91       assert_select "bounds[minlon='#{node.lon}'][minlat='#{node.lat}'][maxlon='#{node.lon}'][maxlat='#{node.lat}']", :count => 1
92       assert_select "node[id='#{node.id}'][lat='#{node.lat}'][lon='#{node.lon}'][version='#{node.version}'][changeset='#{node.changeset_id}'][visible='#{node.visible}'][timestamp='#{node.timestamp.xmlschema}']", :count => 1 do
93         # This should really be more generic
94         assert_select "tag[k='test'][v='yes']"
95       end
96       assert_select "way", :count => 2
97       assert_select "way[id='1']", :count => 1
98       assert_select "way[id='3']", :count => 1
99       assert_select "relation", :count => 1
100       assert_select "relation[id='1']", :count => 1
101     end
102   end
103
104   def test_map_complete_way
105     node = current_nodes(:used_node_2)
106     bbox = "#{node.lon},#{node.lat},#{node.lon},#{node.lat}"
107     get :map, :bbox => bbox
108     assert_response :success, "The map call should have succeeded"
109     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
110       assert_select "bounds[minlon='#{node.lon}'][minlat='#{node.lat}'][maxlon='#{node.lon}'][maxlat='#{node.lat}']", :count => 1
111       assert_select "node", :count => 3
112       assert_select "node[id='4']", :count => 1
113       assert_select "node[id='11']", :count => 1
114       assert_select "node[id='15']", :count => 1
115       assert_select "way", :count => 2
116       assert_select "way[id='5']", :count => 1
117       assert_select "way[id='7']", :count => 1
118       assert_select "relation", :count => 1
119       assert_select "relation[id='8']", :count => 1
120     end
121   end
122
123   def test_map_empty
124     get :map, :bbox => "179.998,89.998,179.999.1,89.999"
125     assert_response :success, "The map call should have succeeded"
126     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
127       assert_select "bounds[minlon='179.998'][minlat='89.998'][maxlon='179.999'][maxlat='89.999']", :count => 1
128       assert_select "node", :count => 0
129       assert_select "way", :count => 0
130       assert_select "relation", :count => 0
131     end
132   end
133
134   def test_tracepoints
135     point = gpx_files(:public_trace_file)
136     minlon = point.longitude - 0.001
137     minlat = point.latitude - 0.001
138     maxlon = point.longitude + 0.001
139     maxlat = point.latitude + 0.001
140     bbox = "#{minlon},#{minlat},#{maxlon},#{maxlat}"
141     get :trackpoints, :bbox => bbox
142     assert_response :success
143     assert_select "gpx[version='1.0'][creator='OpenStreetMap.org']", :count => 1 do
144       assert_select "trk" do
145         assert_select "trkseg"
146       end
147     end
148   end
149
150   def test_tracepoints_trackable
151     point = gpx_files(:trackable_trace_file)
152     minlon = point.longitude - 0.002
153     minlat = point.latitude - 0.002
154     maxlon = point.longitude + 0.002
155     maxlat = point.latitude + 0.002
156     bbox = "#{minlon},#{minlat},#{maxlon},#{maxlat}"
157     get :trackpoints, :bbox => bbox
158     assert_response :success
159     assert_select "gpx[version='1.0'][creator='OpenStreetMap.org']", :count => 1 do
160       assert_select "trk", :count => 1 do
161         assert_select "trk > trkseg", :count => 2 do |trksegs|
162           trksegs.each do |trkseg|
163             assert_select trkseg, "trkpt", :count => 1 do |trkpt|
164               assert_select trkpt[0], "time", :count => 1
165             end
166           end
167         end
168       end
169     end
170   end
171
172   def test_tracepoints_identifiable
173     point = gpx_files(:identifiable_trace_file)
174     minlon = point.longitude - 0.002
175     minlat = point.latitude - 0.002
176     maxlon = point.longitude + 0.002
177     maxlat = point.latitude + 0.002
178     bbox = "#{minlon},#{minlat},#{maxlon},#{maxlat}"
179     get :trackpoints, :bbox => bbox
180     assert_response :success
181     assert_select "gpx[version='1.0'][creator='OpenStreetMap.org']", :count => 1 do
182       assert_select "trk", :count => 1 do
183         assert_select "trk>name", :count => 1
184         assert_select "trk>desc", :count => 1
185         assert_select "trk>url", :count => 1
186         assert_select "trkseg", :count => 1 do
187           assert_select "trkpt", :count => 1 do
188             assert_select "time", :count => 1
189           end
190         end
191       end
192     end
193   end
194
195   def test_map_without_bbox
196     %w(trackpoints map).each do |tq|
197       get tq
198       assert_response :bad_request
199       assert_equal "The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat", @response.body, "A bbox param was expected"
200     end
201   end
202
203   def test_traces_page_less_than_0
204     -10.upto(-1) do |i|
205       get :trackpoints, :page => i, :bbox => "-0.1,-0.1,0.1,0.1"
206       assert_response :bad_request
207       assert_equal "Page number must be greater than or equal to 0", @response.body, "The page number was #{i}"
208     end
209     0.upto(10) do |i|
210       get :trackpoints, :page => i, :bbox => "-0.1,-0.1,0.1,0.1"
211       assert_response :success, "The page number was #{i} and should have been accepted"
212     end
213   end
214
215   def test_bbox_too_big
216     @badbigbbox.each do |bbox|
217       %w(trackpoints map).each do |tq|
218         get tq, :bbox => bbox
219         assert_response :bad_request, "The bbox:#{bbox} was expected to be too big"
220         assert_equal "The maximum bbox size is #{MAX_REQUEST_AREA}, and your request was too large. Either request a smaller area, or use planet.osm", @response.body, "bbox: #{bbox}"
221       end
222     end
223   end
224
225   def test_bbox_malformed
226     @badmalformedbbox.each do |bbox|
227       %w(trackpoints map).each do |tq|
228         get tq, :bbox => bbox
229         assert_response :bad_request, "The bbox:#{bbox} was expected to be malformed"
230         assert_equal "The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat", @response.body, "bbox: #{bbox}"
231       end
232     end
233   end
234
235   def test_bbox_lon_mixedup
236     @badlonmixedbbox.each do |bbox|
237       %w(trackpoints map).each do |tq|
238         get tq, :bbox => bbox
239         assert_response :bad_request, "The bbox:#{bbox} was expected to have the longitude mixed up"
240         assert_equal "The minimum longitude must be less than the maximum longitude, but it wasn't", @response.body, "bbox: #{bbox}"
241       end
242     end
243   end
244
245   def test_bbox_lat_mixedup
246     @badlatmixedbbox.each do |bbox|
247       %w(trackpoints map).each do |tq|
248         get tq, :bbox => bbox
249         assert_response :bad_request, "The bbox:#{bbox} was expected to have the latitude mixed up"
250         assert_equal "The minimum latitude must be less than the maximum latitude, but it wasn't", @response.body, "bbox: #{bbox}"
251       end
252     end
253   end
254
255   # We can't actually get an out of bounds error, as the bbox is sanitised.
256   # def test_latlon_outofbounds
257   #  @badlatlonoutboundsbbox.each do |bbox|
258   #    [ "trackpoints", "map" ].each do |tq|
259   #      get tq, :bbox => bbox
260   #      #print @request.to_yaml
261   #      assert_response :bad_request, "The bbox #{bbox} was expected to be out of range"
262   #      assert_equal "The latitudes must be between -90 an 90, and longitudes between -180 and 180", @response.body, "bbox: #{bbox}"
263   #    end
264   #  end
265   # end
266
267   # MySQL and Postgres require that the C based functions are installed for
268   # this test to work. More information is available from:
269   # http://wiki.openstreetmap.org/wiki/Rails#Installing_the_quadtile_functions
270   # or by looking at the readme in db/README
271   def test_changes_simple
272     Timecop.freeze(Time.utc(2010, 4, 3, 10, 55, 0))
273     get :changes
274     assert_response :success
275     # print @response.body
276     # As we have loaded the fixtures, we can assume that there are no
277     # changes at the time we have frozen at
278     now = Time.now.getutc
279     hourago = now - 1.hour
280     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
281       assert_select "changes[starttime='#{hourago.xmlschema}'][endtime='#{now.xmlschema}']", :count => 1 do
282         assert_select "tile", :count => 0
283       end
284     end
285     Timecop.return
286
287     Timecop.freeze(Time.utc(2007, 1, 1, 0, 30, 0))
288     get :changes
289     assert_response :success
290     # print @response.body
291     # As we have loaded the fixtures, we can assume that there are some
292     # changes at the time we have frozen at
293     now = Time.now.getutc
294     hourago = now - 1.hour
295     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
296       assert_select "changes[starttime='#{hourago.xmlschema}'][endtime='#{now.xmlschema}']", :count => 1 do
297         assert_select "tile", :count => 10
298       end
299     end
300     Timecop.return
301   end
302
303   def test_changes_zoom_invalid
304     zoom_to_test = %w(p -1 0 17 one two)
305     zoom_to_test.each do |zoom|
306       get :changes, :zoom => zoom
307       assert_response :bad_request
308       assert_equal @response.body, "Requested zoom is invalid, or the supplied start is after the end time, or the start duration is more than 24 hours"
309     end
310   end
311
312   def test_changes_zoom_valid
313     1.upto(16) do |zoom|
314       get :changes, :zoom => zoom
315       assert_response :success
316       # NOTE: there was a test here for the timing, but it was too sensitive to be a good test
317       # and it was annoying.
318       assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
319         assert_select "changes", :count => 1
320       end
321     end
322   end
323
324   def test_changes_hours_invalid
325     invalid = %w(-21 335 -1 0 25 26 100 one two three ping pong :)
326     invalid.each do |hour|
327       get :changes, :hours => hour
328       assert_response :bad_request, "Problem with the hour: #{hour}"
329       assert_equal @response.body, "Requested zoom is invalid, or the supplied start is after the end time, or the start duration is more than 24 hours", "Problem with the hour: #{hour}."
330     end
331   end
332
333   def test_changes_hours_valid
334     1.upto(24) do |hour|
335       get :changes, :hours => hour
336       assert_response :success
337     end
338   end
339
340   def test_changes_start_end_invalid
341     get :changes, :start => "2010-04-03 10:55:00", :end => "2010-04-03 09:55:00"
342     assert_response :bad_request
343     assert_equal @response.body, "Requested zoom is invalid, or the supplied start is after the end time, or the start duration is more than 24 hours"
344   end
345
346   def test_changes_start_end_valid
347     get :changes, :start => "2010-04-03 09:55:00", :end => "2010-04-03 10:55:00"
348     assert_response :success
349   end
350
351   def test_capabilities
352     get :capabilities
353     assert_response :success
354     assert_select "osm[version='#{API_VERSION}'][generator='#{GENERATOR}']", :count => 1 do
355       assert_select "api", :count => 1 do
356         assert_select "version[minimum='#{API_VERSION}'][maximum='#{API_VERSION}']", :count => 1
357         assert_select "area[maximum='#{MAX_REQUEST_AREA}']", :count => 1
358         assert_select "tracepoints[per_page='#{TRACEPOINTS_PER_PAGE}']", :count => 1
359         assert_select "changesets[maximum_elements='#{Changeset::MAX_ELEMENTS}']", :count => 1
360         assert_select "status[database='online']", :count => 1
361         assert_select "status[api='online']", :count => 1
362         assert_select "status[gpx='online']", :count => 1
363       end
364     end
365   end
366
367   def test_permissions_anonymous
368     get :permissions
369     assert_response :success
370     assert_select "osm > permissions", :count => 1 do
371       assert_select "permission", :count => 0
372     end
373   end
374
375   def test_permissions_basic_auth
376     basic_authorization(users(:normal_user).email, "test")
377     get :permissions
378     assert_response :success
379     assert_select "osm > permissions", :count => 1 do
380       assert_select "permission", :count => ClientApplication.all_permissions.size
381       ClientApplication.all_permissions.each do |p|
382         assert_select "permission[name='#{p}']", :count => 1
383       end
384     end
385   end
386
387   def test_permissions_oauth
388     @request.env["oauth.token"] = AccessToken.new do |token|
389       # Just to test a few
390       token.allow_read_prefs = true
391       token.allow_write_api = true
392       token.allow_read_gpx = false
393     end
394     get :permissions
395     assert_response :success
396     assert_select "osm > permissions", :count => 1 do
397       assert_select "permission", :count => 2
398       assert_select "permission[name='allow_read_prefs']", :count => 1
399       assert_select "permission[name='allow_write_api']", :count => 1
400       assert_select "permission[name='allow_read_gpx']", :count => 0
401     end
402   end
403 end