require "test_helper"
-require "minitest/mock"
module Api
- class TracesControllerTest < ActionController::TestCase
+ class TracesControllerTest < ActionDispatch::IntegrationTest
+ # Use temporary directories with unique names for each test
+ # This allows the tests to be run in parallel.
def setup
- @gpx_trace_dir = Object.send("remove_const", "GPX_TRACE_DIR")
- Object.const_set("GPX_TRACE_DIR", Rails.root.join("test", "gpx", "traces"))
-
- @gpx_image_dir = Object.send("remove_const", "GPX_IMAGE_DIR")
- Object.const_set("GPX_IMAGE_DIR", Rails.root.join("test", "gpx", "images"))
+ @gpx_trace_dir_orig = Settings.gpx_trace_dir
+ @gpx_image_dir_orig = Settings.gpx_image_dir
+ Settings.gpx_trace_dir = Dir.mktmpdir("trace", Rails.root.join("test/gpx"))
+ Settings.gpx_image_dir = Dir.mktmpdir("image", Rails.root.join("test/gpx"))
end
def teardown
- File.unlink(*Dir.glob(File.join(GPX_TRACE_DIR, "*.gpx")))
- File.unlink(*Dir.glob(File.join(GPX_IMAGE_DIR, "*.gif")))
-
- Object.send("remove_const", "GPX_TRACE_DIR")
- Object.const_set("GPX_TRACE_DIR", @gpx_trace_dir)
-
- Object.send("remove_const", "GPX_IMAGE_DIR")
- Object.const_set("GPX_IMAGE_DIR", @gpx_image_dir)
+ FileUtils.remove_dir(Settings.gpx_trace_dir)
+ FileUtils.remove_dir(Settings.gpx_image_dir)
+ Settings.gpx_trace_dir = @gpx_trace_dir_orig
+ Settings.gpx_image_dir = @gpx_image_dir_orig
end
##
def test_routes
assert_routing(
{ :path => "/api/0.6/gpx/create", :method => :post },
- { :controller => "api/traces", :action => "api_create" }
+ { :controller => "api/traces", :action => "create" }
)
assert_routing(
{ :path => "/api/0.6/gpx/1", :method => :get },
- { :controller => "api/traces", :action => "api_read", :id => "1" }
+ { :controller => "api/traces", :action => "show", :id => "1" }
)
assert_routing(
{ :path => "/api/0.6/gpx/1", :method => :put },
- { :controller => "api/traces", :action => "api_update", :id => "1" }
+ { :controller => "api/traces", :action => "update", :id => "1" }
)
assert_routing(
{ :path => "/api/0.6/gpx/1", :method => :delete },
- { :controller => "api/traces", :action => "api_delete", :id => "1" }
+ { :controller => "api/traces", :action => "destroy", :id => "1" }
)
assert_recognizes(
- { :controller => "api/traces", :action => "api_read", :id => "1" },
+ { :controller => "api/traces", :action => "show", :id => "1" },
{ :path => "/api/0.6/gpx/1/details", :method => :get }
)
assert_routing(
{ :path => "/api/0.6/gpx/1/data", :method => :get },
- { :controller => "api/traces", :action => "api_data", :id => "1" }
+ { :controller => "api/traces", :action => "data", :id => "1" }
)
assert_routing(
{ :path => "/api/0.6/gpx/1/data.xml", :method => :get },
- { :controller => "api/traces", :action => "api_data", :id => "1", :format => "xml" }
+ { :controller => "api/traces", :action => "data", :id => "1", :format => "xml" }
)
end
# Check getting a specific trace through the api
- def test_api_read
+ def test_show
public_trace_file = create(:trace, :visibility => "public")
# First with no auth
- get :api_read, :params => { :id => public_trace_file.id }
+ get api_trace_path(public_trace_file)
assert_response :unauthorized
# Now with some other user, which should work since the trace is public
- basic_authorization create(:user).display_name, "test"
- get :api_read, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ get api_trace_path(public_trace_file), :headers => auth_header
assert_response :success
# And finally we should be able to do it with the owner of the trace
- basic_authorization public_trace_file.user.display_name, "test"
- get :api_read, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
+ get api_trace_path(public_trace_file), :headers => auth_header
assert_response :success
end
# Check an anoymous trace can't be specifically fetched by another user
- def test_api_read_anon
+ def test_show_anon
anon_trace_file = create(:trace, :visibility => "private")
# First with no auth
- get :api_read, :params => { :id => anon_trace_file.id }
+ get api_trace_path(anon_trace_file)
assert_response :unauthorized
# Now try with another user, which shouldn't work since the trace is anon
- basic_authorization create(:user).display_name, "test"
- get :api_read, :params => { :id => anon_trace_file.id }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ get api_trace_path(anon_trace_file), :headers => auth_header
assert_response :forbidden
# And finally we should be able to get the trace details with the trace owner
- basic_authorization anon_trace_file.user.display_name, "test"
- get :api_read, :params => { :id => anon_trace_file.id }
+ auth_header = basic_authorization_header anon_trace_file.user.display_name, "test"
+ get api_trace_path(anon_trace_file), :headers => auth_header
assert_response :success
end
# Check the api details for a trace that doesn't exist
- def test_api_read_not_found
+ def test_show_not_found
deleted_trace_file = create(:trace, :deleted)
# Try first with no auth, as it should require it
- get :api_read, :params => { :id => 0 }
+ get api_trace_path(:id => 0)
assert_response :unauthorized
# Login, and try again
- basic_authorization deleted_trace_file.user.display_name, "test"
- get :api_read, :params => { :id => 0 }
+ auth_header = basic_authorization_header deleted_trace_file.user.display_name, "test"
+ get api_trace_path(:id => 0), :headers => auth_header
assert_response :not_found
# Now try a trace which did exist but has been deleted
- basic_authorization deleted_trace_file.user.display_name, "test"
- get :api_read, :params => { :id => deleted_trace_file.id }
+ auth_header = basic_authorization_header deleted_trace_file.user.display_name, "test"
+ get api_trace_path(deleted_trace_file), :headers => auth_header
assert_response :not_found
end
# Test downloading a trace through the api
- def test_api_data
+ def test_data
public_trace_file = create(:trace, :visibility => "public", :fixture => "a")
# First with no auth
- get :api_data, :params => { :id => public_trace_file.id }
+ get api_trace_data_path(public_trace_file)
assert_response :unauthorized
# Now with some other user, which should work since the trace is public
- basic_authorization create(:user).display_name, "test"
- get :api_data, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ get api_trace_data_path(public_trace_file), :headers => auth_header
check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9"
# And finally we should be able to do it with the owner of the trace
- basic_authorization public_trace_file.user.display_name, "test"
- get :api_data, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
+ get api_trace_data_path(public_trace_file), :headers => auth_header
check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9"
end
# Test downloading a compressed trace through the api
- def test_api_data_compressed
+ def test_data_compressed
identifiable_trace_file = create(:trace, :visibility => "identifiable", :fixture => "d")
# Authenticate as the owner of the trace we will be using
- basic_authorization identifiable_trace_file.user.display_name, "test"
+ auth_header = basic_authorization_header identifiable_trace_file.user.display_name, "test"
# First get the data as is
- get :api_data, :params => { :id => identifiable_trace_file.id }
+ get api_trace_data_path(identifiable_trace_file), :headers => auth_header
check_trace_data identifiable_trace_file, "c6422a3d8750faae49ed70e7e8a51b93", "application/x-gzip", "gpx.gz"
# Now ask explicitly for XML format
- get :api_data, :params => { :id => identifiable_trace_file.id, :format => "xml" }
+ get api_trace_data_path(identifiable_trace_file, :format => "xml"), :headers => auth_header
check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d", "application/xml", "xml"
# Now ask explicitly for GPX format
- get :api_data, :params => { :id => identifiable_trace_file.id, :format => "gpx" }
+ get api_trace_data_path(identifiable_trace_file, :format => "gpx"), :headers => auth_header
check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d"
end
# Check an anonymous trace can't be downloaded by another user through the api
- def test_api_data_anon
+ def test_data_anon
anon_trace_file = create(:trace, :visibility => "private", :fixture => "b")
# First with no auth
- get :api_data, :params => { :id => anon_trace_file.id }
+ get api_trace_data_path(anon_trace_file)
assert_response :unauthorized
# Now with some other user, which shouldn't work since the trace is anon
- basic_authorization create(:user).display_name, "test"
- get :api_data, :params => { :id => anon_trace_file.id }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ get api_trace_data_path(anon_trace_file), :headers => auth_header
assert_response :forbidden
# And finally we should be able to do it with the owner of the trace
- basic_authorization anon_trace_file.user.display_name, "test"
- get :api_data, :params => { :id => anon_trace_file.id }
- check_trace_data anon_trace_file, "66179ca44f1e93d8df62e2b88cbea732"
+ auth_header = basic_authorization_header anon_trace_file.user.display_name, "test"
+ get api_trace_data_path(anon_trace_file), :headers => auth_header
+ check_trace_data anon_trace_file, "db4cb5ed2d7d2b627b3b504296c4f701"
end
# Test downloading a trace that doesn't exist through the api
- def test_api_data_not_found
+ def test_data_not_found
deleted_trace_file = create(:trace, :deleted)
# Try first with no auth, as it should require it
- get :api_data, :params => { :id => 0 }
+ get api_trace_data_path(:id => 0)
assert_response :unauthorized
# Login, and try again
- basic_authorization create(:user).display_name, "test"
- get :api_data, :params => { :id => 0 }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ get api_trace_data_path(:id => 0), :headers => auth_header
assert_response :not_found
# Now try a trace which did exist but has been deleted
- basic_authorization deleted_trace_file.user.display_name, "test"
- get :api_data, :params => { :id => deleted_trace_file.id }
+ auth_header = basic_authorization_header deleted_trace_file.user.display_name, "test"
+ get api_trace_data_path(deleted_trace_file), :headers => auth_header
assert_response :not_found
end
# Test creating a trace through the api
- def test_api_create
+ def test_create
# Get file to use
- fixture = Rails.root.join("test", "gpx", "fixtures", "a.gpx")
+ fixture = Rails.root.join("test/gpx/fixtures/a.gpx")
file = Rack::Test::UploadedFile.new(fixture, "application/gpx+xml")
user = create(:user)
# First with no auth
- post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }
+ post gpx_create_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }
assert_response :unauthorized
# Rewind the file
# Now authenticated
create(:user_preference, :user => user, :k => "gps.trace.visibility", :v => "identifiable")
assert_not_equal "trackable", user.preferences.where(:k => "gps.trace.visibility").first.v
- basic_authorization user.display_name, "test"
- post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }
+ auth_header = basic_authorization_header user.display_name, "test"
+ post gpx_create_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" }, :headers => auth_header
assert_response :success
trace = Trace.find(response.body.to_i)
assert_equal "a.gpx", trace.name
assert_equal "New Trace", trace.description
assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
assert_equal "trackable", trace.visibility
- assert_equal false, trace.inserted
+ assert_not trace.inserted
assert_equal File.new(fixture).read, File.new(trace.trace_name).read
trace.destroy
assert_equal "trackable", user.preferences.where(:k => "gps.trace.visibility").first.v
# Now authenticated, with the legacy public flag
assert_not_equal "public", user.preferences.where(:k => "gps.trace.visibility").first.v
- basic_authorization user.display_name, "test"
- post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 1 }
+ auth_header = basic_authorization_header user.display_name, "test"
+ post gpx_create_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 1 }, :headers => auth_header
assert_response :success
trace = Trace.find(response.body.to_i)
assert_equal "a.gpx", trace.name
assert_equal "New Trace", trace.description
assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
assert_equal "public", trace.visibility
- assert_equal false, trace.inserted
+ assert_not trace.inserted
assert_equal File.new(fixture).read, File.new(trace.trace_name).read
trace.destroy
assert_equal "public", user.preferences.where(:k => "gps.trace.visibility").first.v
# Now authenticated, with the legacy private flag
second_user = create(:user)
assert_nil second_user.preferences.where(:k => "gps.trace.visibility").first
- basic_authorization second_user.display_name, "test"
- post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 0 }
+ auth_header = basic_authorization_header second_user.display_name, "test"
+ post gpx_create_path, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 0 }, :headers => auth_header
assert_response :success
trace = Trace.find(response.body.to_i)
assert_equal "a.gpx", trace.name
assert_equal "New Trace", trace.description
assert_equal %w[new trace], trace.tags.order(:tag).collect(&:tag)
assert_equal "private", trace.visibility
- assert_equal false, trace.inserted
+ assert_not trace.inserted
assert_equal File.new(fixture).read, File.new(trace.trace_name).read
trace.destroy
assert_equal "private", second_user.preferences.where(:k => "gps.trace.visibility").first.v
end
# Check updating a trace through the api
- def test_api_update
+ def test_update
public_trace_file = create(:trace, :visibility => "public", :fixture => "a")
deleted_trace_file = create(:trace, :deleted)
anon_trace_file = create(:trace, :visibility => "private")
# First with no auth
- put :api_update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s
+ put api_trace_path(public_trace_file), :params => create_trace_xml(public_trace_file)
assert_response :unauthorized
# Now with some other user, which should fail
- basic_authorization create(:user).display_name, "test"
- put :api_update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ put api_trace_path(public_trace_file), :params => create_trace_xml(public_trace_file), :headers => auth_header
assert_response :forbidden
# Now with a trace which doesn't exist
- basic_authorization create(:user).display_name, "test"
- put :api_update, :params => { :id => 0 }, :body => public_trace_file.to_xml.to_s
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ put api_trace_path(:id => 0), :params => create_trace_xml(public_trace_file), :headers => auth_header
assert_response :not_found
# Now with a trace which did exist but has been deleted
- basic_authorization deleted_trace_file.user.display_name, "test"
- put :api_update, :params => { :id => deleted_trace_file.id }, :body => deleted_trace_file.to_xml.to_s
+ auth_header = basic_authorization_header deleted_trace_file.user.display_name, "test"
+ put api_trace_path(deleted_trace_file), :params => create_trace_xml(deleted_trace_file), :headers => auth_header
assert_response :not_found
# Now try an update with the wrong ID
- basic_authorization public_trace_file.user.display_name, "test"
- put :api_update, :params => { :id => public_trace_file.id }, :body => anon_trace_file.to_xml.to_s
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
+ put api_trace_path(public_trace_file), :params => create_trace_xml(anon_trace_file), :headers => auth_header
assert_response :bad_request,
"should not be able to update a trace with a different ID from the XML"
# And finally try an update that should work
- basic_authorization public_trace_file.user.display_name, "test"
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
t = public_trace_file
t.description = "Changed description"
t.visibility = "private"
- put :api_update, :params => { :id => t.id }, :body => t.to_xml.to_s
+ put api_trace_path(t), :params => create_trace_xml(t), :headers => auth_header
assert_response :success
nt = Trace.find(t.id)
assert_equal nt.description, t.description
end
# Test that updating a trace doesn't duplicate the tags
- def test_api_update_tags
+ def test_update_tags
tracetag = create(:tracetag)
trace = tracetag.trace
- basic_authorization trace.user.display_name, "test"
+ auth_header = basic_authorization_header trace.user.display_name, "test"
- put :api_update, :params => { :id => trace.id }, :body => trace.to_xml.to_s
+ put api_trace_path(trace), :params => create_trace_xml(trace), :headers => auth_header
assert_response :success
updated = Trace.find(trace.id)
# Ensure there's only one tag in the database after updating
- assert_equal Tracetag.count, 1
+ assert_equal(1, Tracetag.count)
# The new tag object might have a different id, so check the string representation
assert_equal trace.tagstring, updated.tagstring
end
# Check deleting a trace through the api
- def test_api_delete
+ def test_destroy
public_trace_file = create(:trace, :visibility => "public")
# First with no auth
- delete :api_delete, :params => { :id => public_trace_file.id }
+ delete api_trace_path(public_trace_file)
assert_response :unauthorized
# Now with some other user, which should fail
- basic_authorization create(:user).display_name, "test"
- delete :api_delete, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ delete api_trace_path(public_trace_file), :headers => auth_header
assert_response :forbidden
# Now with a trace which doesn't exist
- basic_authorization create(:user).display_name, "test"
- delete :api_delete, :params => { :id => 0 }
+ auth_header = basic_authorization_header create(:user).display_name, "test"
+ delete api_trace_path(:id => 0), :headers => auth_header
assert_response :not_found
# And finally we should be able to do it with the owner of the trace
- basic_authorization public_trace_file.user.display_name, "test"
- delete :api_delete, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
+ delete api_trace_path(public_trace_file), :headers => auth_header
assert_response :success
# Try it a second time, which should fail
- basic_authorization public_trace_file.user.display_name, "test"
- delete :api_delete, :params => { :id => public_trace_file.id }
+ auth_header = basic_authorization_header public_trace_file.user.display_name, "test"
+ delete api_trace_path(public_trace_file), :headers => auth_header
assert_response :not_found
end
def check_trace_data(trace, digest, content_type = "application/gpx+xml", extension = "gpx")
assert_response :success
assert_equal digest, Digest::MD5.hexdigest(response.body)
- assert_equal content_type, response.content_type
- assert_equal "attachment; filename=\"#{trace.id}.#{extension}\"", @response.header["Content-Disposition"]
+ assert_equal content_type, response.media_type
+ assert_equal "attachment; filename=\"#{trace.id}.#{extension}\"; filename*=UTF-8''#{trace.id}.#{extension}", @response.header["Content-Disposition"]
+ end
+
+ ##
+ # build XML for traces
+ # this builds a minimum viable XML for the tests in this suite
+ def create_trace_xml(trace)
+ root = XML::Document.new
+ root.root = XML::Node.new "osm"
+ trc = XML::Node.new "gpx_file"
+ trc["id"] = trace.id.to_s
+ trc["visibility"] = trace.visibility
+ trc["visible"] = trace.visible.to_s
+ desc = XML::Node.new "description"
+ desc << trace.description
+ trc << desc
+ trace.tags.each do |tag|
+ t = XML::Node.new "tag"
+ t << tag.tag
+ trc << t
+ end
+ root.root << trc
+ root.to_s
end
end
end
projects / rails.git / blobdiff