passenger-jmazzi 2.2.9

data/test/ruby/rails/framework_spawner_spec.rb

@@ -0,0 +1,133 @@
+require 'support/config'
+require 'support/test_helper'
+require 'phusion_passenger/railz/framework_spawner'
+
+require 'ruby/rails/minimal_spawner_spec'
+require 'ruby/spawn_server_spec'
+require 'ruby/rails/spawner_privilege_lowering_spec'
+require 'ruby/rails/spawner_error_handling_spec'
+include PhusionPassenger
+include PhusionPassenger::Railz
+
+# TODO: test whether FrameworkSpawner restarts ApplicationSpawner if it crashed
+
+describe FrameworkSpawner do
+	include TestHelper
+	
+	before :each do
+		@stub = setup_rails_stub('foobar')
+		if use_vendor_rails?
+			@stub.use_vendor_rails('minimal')
+			@spawner = FrameworkSpawner.new(:vendor => "#{@stub.app_root}/vendor/rails")
+		else
+			version = Application.detect_framework_version(@stub.app_root)
+			@spawner = FrameworkSpawner.new(:version => version)
+		end
+		@spawner.start
+		@server = @spawner
+	end
+	
+	after :each do
+		@spawner.stop
+		@stub.destroy
+	end
+	
+	describe "situations in which Rails is loaded via the gem" do
+		def use_vendor_rails?
+			false
+		end
+		
+		it_should_behave_like "a spawn server"
+	end
+	
+	describe "situations in which Rails is loaded via vendor folder" do
+		def use_vendor_rails?
+			true
+		end
+		
+		it_should_behave_like "a spawn server"
+	end
+	
+	def spawn_arbitrary_application
+		@spawner.spawn_application(@stub.app_root,
+			"lowest_user" => CONFIG['lowest_user'])
+	end
+end
+
+describe FrameworkSpawner do
+	include TestHelper
+	
+	describe "situations in which Rails is loaded via the gem" do
+		def use_vendor_rails?
+			false
+		end
+		
+		it_should_behave_like "a minimal spawner"
+		it_should_behave_like "handling errors in application initialization"
+		it_should_behave_like "handling errors in framework initialization"
+	end
+	
+	describe "situations in which Rails is loaded via vendor folder" do
+		def use_vendor_rails?
+			true
+		end
+		
+		it_should_behave_like "a minimal spawner"
+		it_should_behave_like "handling errors in framework initialization"
+	end
+	
+	def spawn_stub_application(stub, extra_options = {})
+		if use_vendor_rails?
+			stub.use_vendor_rails('minimal')
+		end
+		version = Application.detect_framework_version(stub.app_root)
+		if version == :vendor
+			options = { :vendor => "#{stub.app_root}/vendor/rails" }
+		else
+			options = { :version => version }
+		end
+		options["lowest_user"] = CONFIG['lowest_user']
+		options = options.merge(extra_options)
+		spawner = FrameworkSpawner.new(options)
+		spawner.start
+		begin
+			return spawner.spawn_application(stub.app_root, options)
+		ensure
+			spawner.stop
+		end
+	end
+	
+	def load_nonexistant_framework(options = {})
+		spawner = FrameworkSpawner.new(options.merge(:version => "1.9.827"))
+		begin
+			spawner.start
+		ensure
+			spawner.stop rescue nil
+		end
+	end
+end
+
+Process.euid == ApplicationSpawner::ROOT_UID &&
+describe("FrameworkSpawner privilege lowering support") do
+	include TestHelper
+	
+	it_should_behave_like "a spawner that supports lowering of privileges"
+	
+	def spawn_stub_application(options = {})
+		options = {
+			"lower_privilege" => true,
+			"lowest_user" => CONFIG['lowest_user']
+		}.merge(options)
+		@stub.use_vendor_rails('minimal')
+		@spawner = FrameworkSpawner.new(:vendor =>
+			"#{@stub.app_root}/vendor/rails")
+		@spawner.start
+		begin
+			app = @spawner.spawn_application(@stub.app_root, options)
+			yield app
+		ensure
+			app.close if app
+			@spawner.stop
+		end
+	end
+end

data/test/ruby/rails/minimal_spawner_spec.rb

@@ -0,0 +1,93 @@
+shared_examples_for "a minimal spawner" do
+	it "can spawn our stub application" do
+		use_rails_stub('foobar') do |stub|
+			app = spawn_stub_application(stub)
+			app.pid.should_not == 0
+			app.app_root.should_not be_nil
+			app.close
+		end
+	end
+	
+	it "can spawn an arbitary number of applications" do
+		use_rails_stub('foobar') do |stub|
+			last_pid = 0
+			4.times do
+				app = spawn_stub_application(stub)
+				app.pid.should_not == last_pid
+				app.app_root.should_not be_nil
+				last_pid = app.pid
+				app.close
+			end
+		end
+	end
+	
+	it "respects ENV['RAILS_ENV']= in environment.rb" do
+		use_rails_stub('foobar') do |stub|
+			File.prepend(stub.environment_rb, "ENV['RAILS_ENV'] = 'development'\n")
+			File.append(stub.environment_rb, %q{
+				File.open('environment.txt', 'w') do |f|
+					f.write(RAILS_ENV)
+				end
+			})
+			spawn_stub_application(stub).close
+			environment = File.read("#{stub.app_root}/environment.txt")
+			environment.should == "development"
+		end
+	end
+	
+	it "does not conflict with models in the application that are named 'Passenger'" do
+		use_rails_stub('foobar') do |stub|
+			if !File.directory?("#{stub.app_root}/app/models")
+				Dir.mkdir("#{stub.app_root}/app/models")
+			end
+			File.open("#{stub.app_root}/app/models/passenger.rb", 'w') do |f|
+				f.write(%q{
+					class Passenger
+						def name
+							return "Gourry Gabriev"
+						end
+					end
+				})
+			end
+			File.append(stub.environment_rb, %q{
+				# We explicitly call 'require' here because we might be
+				# using a stub Rails framework (that doesn't support automatic
+				# loading of model source files).
+				require 'app/models/passenger'
+				File.open('passenger.txt', 'w') do |f|
+					f.write(Passenger.new.name)
+				end
+			})
+			spawn_stub_application(stub).close
+			passenger_name = File.read("#{stub.app_root}/passenger.txt")
+			passenger_name.should == 'Gourry Gabriev'
+		end
+	end
+	
+	it "loads application_controller.rb instead of application.rb, if the former exists" do
+		use_rails_stub('foobar') do |stub|
+			File.rename("#{stub.app_root}/app/controllers/application.rb",
+				"#{stub.app_root}/app/controllers/application_controller.rb")
+			lambda { spawn_stub_application(stub).close }.should_not raise_error
+		end
+	end
+	
+	it "sets the environment variables passed in the environment_variables option" do
+		use_rails_stub('foobar') do |stub|
+			File.append(stub.environment_rb, %q{
+				File.open("env.txt", "w") do |f|
+					ENV.each_pair do |key, value|
+						f.puts("#{key} = #{value}")
+					end
+				end
+			})
+			env_vars_string = "PATH\0/usr/bin:/opt/sw/bin\0FOO\0foo bar!\0"
+			options = { "environment_variables" => [env_vars_string].pack("m") }
+			spawn_stub_application(stub, options).close
+			
+			contents = File.read("#{stub.app_root}/env.txt")
+			contents.should =~ %r(PATH = /usr/bin:/opt/sw/bin\n)
+			contents.should =~ %r(FOO = foo bar\!\n)
+		end
+	end
+end

data/test/ruby/rails/spawner_error_handling_spec.rb

@@ -0,0 +1,107 @@
+require 'stringio'
+
+shared_examples_for "handling errors in application initialization" do
+	before :each do
+		@stub = setup_rails_stub('foobar')
+		@stub.use_vendor_rails('minimal')
+	end
+	
+	after :each do
+		teardown_rails_stub
+	end
+
+	it "raises an AppInitError if the spawned app raises a standard exception during startup" do
+		File.prepend(@stub.environment_rb, "raise 'This is a dummy exception.'\n")
+		begin
+			spawn_stub_application(@stub, "print_exceptions" => false).close
+			violated "Spawning the application should have raised an AppInitError."
+		rescue AppInitError => e
+			e.child_exception.message.should == "This is a dummy exception."
+		end
+	end
+	
+	it "raises an AppInitError if the spawned app raises a custom-defined exception during startup" do
+		File.prepend(@stub.environment_rb, %{
+			class MyError < StandardError
+			end
+			
+			raise MyError, "This is a custom exception."
+		})
+		begin
+			spawn_stub_application(@stub, "print_exceptions" => false).close
+			violated "Spawning the application should have raised an AppInitError."
+		rescue AppInitError => e
+			e.child_exception.message.should == "This is a custom exception. (MyError)"
+		end
+	end
+	
+	it "raises an AppInitError if the spawned app calls exit() during startup" do
+		File.prepend(@stub.environment_rb, "exit\n")
+		begin
+			spawn_stub_application(@stub, "print_exceptions" => false).close
+			violated "Spawning the application should have raised an AppInitError."
+		rescue AppInitError => e
+			e.child_exception.class.should == SystemExit
+		end
+	end
+	
+	it "prints the exception to STDERR if the spawned app raised an error" do
+		old_stderr = STDERR
+		file = File.new('output.tmp', 'w+')
+		begin
+			Object.send(:remove_const, "STDERR") rescue nil
+			Object.const_set("STDERR", file)
+			
+			File.prepend(@stub.environment_rb, "raise 'This is a dummy exception.'\n")
+			block = lambda do
+				spawn_stub_application(@stub).close
+			end
+			block.should raise_error(AppInitError)
+			
+			file.rewind
+			data = file.read
+			data.should =~ /spawn_stub_application/
+			data.should =~ /spawner_error_handling_spec\.rb/
+		ensure
+			Object.send(:remove_const, "STDERR") rescue nil
+			Object.const_set("STDERR", old_stderr)
+			file.close rescue nil
+			File.unlink('output.tmp') rescue nil
+		end
+	end
+end
+
+shared_examples_for "handling errors in framework initialization" do
+	include Utils
+	
+	it "raises FrameworkInitError if the framework could not be loaded" do
+		block = lambda do
+			load_nonexistant_framework(:print_framework_loading_exceptions => false).close
+		end
+		block.should raise_error(FrameworkInitError)
+	end
+	
+	it "prints the exception to STDERR if the framework could not be loaded" do
+		old_stderr = STDERR
+		file = File.new('output.tmp', 'w+')
+		begin
+			Object.send(:remove_const, "STDERR") rescue nil
+			Object.const_set("STDERR", file)
+			
+			block = lambda do
+				load_nonexistant_framework.close
+			end
+			block.should raise_error(FrameworkInitError)
+			
+			file.rewind
+			data = file.read
+			data.should =~ /load_nonexistant_framework/
+			data.should =~ /spawner_error_handling_spec\.rb/
+		ensure
+			Object.send(:remove_const, "STDERR") rescue nil
+			Object.const_set("STDERR", old_stderr)
+			file.close rescue nil
+			File.unlink('output.tmp') rescue nil
+		end
+	end
+end

data/test/ruby/rails/spawner_privilege_lowering_spec.rb

@@ -0,0 +1,97 @@
+require 'support/config'
+require 'etc'
+require 'yaml'
+
+shared_examples_for "a spawner that supports lowering of privileges" do
+	before :each do
+		@stub = setup_rails_stub('foobar')
+		@environment_rb = @stub.environment_rb
+		@original_uid = File.stat(@environment_rb).uid
+		File.append(@environment_rb, %q{
+			require 'yaml'
+			info = {
+				:username => `whoami`.strip,
+				:user_id  => `id -u`.strip.to_i,
+				:group_id => `id -g`.strip.to_i,
+				:groups   => `groups "#{`whoami`.strip}"`.strip,
+				:home     => ENV['HOME']
+			}
+			File.open("#{RAILS_ROOT}/dump.yml", 'w') do |f|
+				YAML::dump(info, f)
+			end
+		})
+	end
+	
+	after :each do
+		@stub.destroy
+	end
+	
+	it "lowers its privileges to the owner of environment.rb" do
+		File.chown(uid_for('normal_user_1'), nil, @environment_rb)
+		spawn_stub_application do |app|
+			read_dumped_info[:username].should == CONFIG['normal_user_1']
+		end
+	end
+	
+	it "switches the group to environment.rb's owner's primary group, after lowering privileges" do
+		File.chown(uid_for('normal_user_1'), nil, @environment_rb)
+		spawn_stub_application do |app|
+			expected_gid = Etc.getpwnam(CONFIG['normal_user_1']).gid
+			read_dumped_info[:group_id].should == expected_gid
+		end
+	end
+	
+	it "switches supplementary groups to environment.rb's owner's default supplementary groups" do
+		File.chown(uid_for('normal_user_1'), nil, @environment_rb)
+		spawn_stub_application do |app|
+			default_groups = `groups "#{CONFIG['normal_user_1']}"`.strip
+			read_dumped_info[:groups].should == default_groups
+		end
+	end
+	
+	it "lowers its privileges to 'lowest_user' if environment.rb is owned by root" do
+		File.chown(ApplicationSpawner::ROOT_UID, nil, @environment_rb)
+		spawn_stub_application do |app|
+			read_dumped_info[:username].should == CONFIG['lowest_user']
+		end
+	end
+	
+	it "lowers its privileges to 'lowest_user' if environment.rb is owned by a nonexistant user" do
+		File.chown(CONFIG['nonexistant_uid'], nil, @environment_rb)
+		spawn_stub_application do |app|
+			read_dumped_info[:username].should == CONFIG['lowest_user']
+		end
+	end
+	
+	it "doesn't switch user if environment.rb is owned by a nonexistant user, and 'lowest_user' doesn't exist either" do
+		File.chown(CONFIG['nonexistant_uid'], nil, @environment_rb)
+		spawn_stub_application("lowest_user" => CONFIG['nonexistant_user']) do |app|
+			read_dumped_info[:username].should == my_username
+		end
+	end
+	
+	it "doesn't switch user if 'lower_privilege' is set to false" do
+		File.chown(uid_for('normal_user_2'), nil, @environment_rb)
+		spawn_stub_application("lower_privilege" => false) do |app|
+			read_dumped_info[:username].should == my_username
+		end
+	end
+	
+	it "sets $HOME to the user's home directory, after privilege lowering" do
+		spawn_stub_application("lowest_user" => CONFIG['normal_user_1']) do |app|
+			read_dumped_info[:home].should == Etc.getpwnam(CONFIG['normal_user_1']).dir
+		end
+	end
+	
+	def read_dumped_info
+		return YAML.load_file("#{@stub.app_root}/dump.yml")
+	end
+	
+	def my_username
+		return `whoami`.strip
+	end
+	
+	def uid_for(name)
+		return Etc.getpwnam(CONFIG[name]).uid
+	end
+end

data/test/ruby/spawn_manager_spec.rb

@@ -0,0 +1,205 @@
+require 'support/config'
+require 'support/test_helper'
+require 'phusion_passenger/application'
+require 'phusion_passenger/spawn_manager'
+
+require 'ruby/abstract_server_spec'
+require 'ruby/rails/minimal_spawner_spec'
+require 'ruby/rails/spawner_privilege_lowering_spec'
+require 'ruby/rails/spawner_error_handling_spec'
+include PhusionPassenger
+include PhusionPassenger::Utils
+
+# TODO: test whether SpawnManager restarts FrameworkSpawner if it crashed
+
+describe SpawnManager do
+	include TestHelper
+	
+	before :each do
+		@manager = SpawnManager.new
+		@stub = setup_rails_stub('foobar')
+		@stub.use_vendor_rails('minimal')
+		@server = @manager
+		@server.start
+	end
+	
+	after :each do
+		@manager.cleanup
+		@stub.destroy
+	end
+	
+	describe "smart spawning" do
+		before :each do
+			@spawn_method = "smart"
+		end
+		
+		it_should_behave_like "an AbstractServer"
+	end
+	
+	describe "conservative spawning" do
+		before :each do
+			@spawn_method = "conservative"
+		end
+		
+		it_should_behave_like "an AbstractServer"
+	end
+	
+	def spawn_arbitrary_application
+		@manager.spawn_application(@stub.app_root, true, CONFIG['lowest_user'],
+			"production", @spawn_method)
+	end
+end
+
+describe SpawnManager do
+	include TestHelper
+	
+	before :each do
+		@manager = SpawnManager.new
+		@stub = setup_rails_stub('foobar')
+		@stub.use_vendor_rails('minimal')
+	end
+	
+	after :each do
+		@manager.cleanup
+		@stub.destroy
+	end
+	
+	it "can spawn when the server's not running" do
+		app = @manager.spawn_application("app_root" => @stub.app_root,
+			"lowest_user" => CONFIG['lowest_user'])
+		app.close
+	end
+	
+	it "can spawn when the server's running synchronously" do
+		a, b = UNIXSocket.pair
+		pid = fork do
+			begin
+				a.close
+				sleep(1) # Give @manager the chance to start.
+				channel = MessageChannel.new(b)
+				channel.write("spawn_application",
+					"app_root", @stub.app_root,
+					"lowest_user", CONFIG['lowest_user'])
+				channel.read
+				pid, listen_socket = channel.read
+				channel.recv_io.close
+				channel.close
+			rescue Exception => e
+				print_exception("child", e)
+			ensure
+				exit!
+			end
+		end
+		b.close
+		@manager.start_synchronously(a)
+		a.close
+		Process.waitpid(pid) rescue nil
+	end
+	
+	it "doesn't crash upon spawning an application that doesn't specify its Rails version" do
+		File.write(@stub.environment_rb) do |content|
+			content.sub(/^RAILS_GEM_VERSION = .*$/, '')
+		end
+		@stub.dont_use_vendor_rails
+		@manager.spawn_application("app_root" => @stub.app_root,
+			"lowest_user" => CONFIG['lowest_user']).close
+	end
+	
+	it "properly reloads applications that do not specify a Rails version" do
+		File.write(@stub.environment_rb) do |content|
+			content.sub(/^RAILS_GEM_VERSION = .*$/, '')
+		end
+		@stub.dont_use_vendor_rails
+		@manager.reload(@stub.app_root)
+		spawners = @manager.instance_eval { @spawners }
+		spawners.synchronize do
+			spawners.should be_empty
+		end
+	end
+end
+
+describe SpawnManager do
+	include TestHelper
+
+	it "can spawn a Rack application" do
+		use_stub('rack') do |stub|
+			@manager = SpawnManager.new
+			begin
+				app = @manager.spawn_application(
+					"app_root" => stub.app_root,
+					"app_type" => "rack",
+					"lowest_user" => CONFIG['lowest_user'])
+				app.close
+			rescue => e
+				puts e
+				puts e.child_exception.backtrace
+			ensure
+				@manager.cleanup
+			end
+		end
+	end
+end
+
+describe SpawnManager do
+	include TestHelper
+	
+	before :each do
+		@spawn_method = "smart"
+	end
+	
+	describe "smart spawning" do
+		it_should_behave_like "a minimal spawner"
+	end
+	
+	describe "smart-lv2 spawning" do
+		before :each do
+			@spawn_method = "smart-lv2"
+		end
+		
+		it_should_behave_like "a minimal spawner"
+	end
+	
+	describe "conservative spawning" do
+		before :each do
+			@spawn_method = "conservative"
+		end
+		
+		it_should_behave_like "a minimal spawner"
+	end
+	
+	it_should_behave_like "handling errors in application initialization"
+	it_should_behave_like "handling errors in framework initialization"
+	
+	def spawn_stub_application(stub, extra_options = {})
+		spawner = SpawnManager.new
+		begin
+			options = {
+				"app_root" => stub.app_root,
+				"spawn_method" => @spawn_method,
+				"lowest_user" => CONFIG['lowest_user']
+			}.merge(extra_options)
+			return spawner.spawn_application(options)
+		ensure
+			spawner.cleanup
+		end
+	end
+	
+	def load_nonexistant_framework(extra_options = {})
+		# Prevent detect_framework_version from raising VersionNotFound
+		Application.instance_eval do
+			alias orig_detect_framework_version detect_framework_version
+			def detect_framework_version(app_root)
+				return "1.9.827"
+			end
+		end
+		begin
+			File.write(@stub.environment_rb, "RAILS_GEM_VERSION = '1.9.827'")
+			@stub.dont_use_vendor_rails
+			return spawn_stub_application(@stub, extra_options)
+		ensure
+			Application.instance_eval do
+				alias detect_framework_version orig_detect_framework_version
+			end
+		end
+	end
+end