passenger 2.2.15 → 3.0.0.pre1

data/test/ruby/utils/file_system_watcher_spec.rb

@@ -0,0 +1,221 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'phusion_passenger/utils/file_system_watcher'
+
+module PhusionPassenger
+
+describe Utils::FileSystemWatcher do
+	before :each do
+		@tmpdir = "tmp.fs_watcher"
+		@tmpdir2 = "tmp.fs_watcher2"
+		@tmpdir3 = "tmp.fs_watcher3"
+		@term_pipe = IO.pipe
+		[@tmpdir, @tmpdir2, @tmpdir3].each do |dir|
+			remove_dir_tree(dir)
+			Dir.mkdir(dir)
+		end
+	end
+	
+	after :each do
+		if @thread
+			@term_pipe[1].write("x")
+			@thread.join
+		end
+		@watcher.close if @watcher
+		@term_pipe[0].close
+		@term_pipe[1].close
+		[@tmpdir, @tmpdir2, @tmpdir3].each do |dir|
+			remove_dir_tree(dir)
+		end
+	end
+	
+	def create(*args)
+		@watcher = Utils::FileSystemWatcher.new(*args)
+		@watcher.poll_interval = 0.1 if @watcher.respond_to?(:poll_interval=)
+		return @watcher
+	end
+	
+	describe "#wait_for_change blocks until" do
+		def test_block(filenames)
+			create(filenames, @term_pipe[0])
+			result = nil
+			thread = Thread.new do
+				result = @watcher.wait_for_change
+			end
+			yield if block_given?
+			eventually do
+				!thread.alive?
+			end
+			return result
+		ensure
+			if thread
+				@term_pipe[1].write("x")
+				thread.join
+			end
+			@watcher.close
+		end
+		
+		specify "a subdirectory has been created in one of the watched directories" do
+			result = test_block([@tmpdir, @tmpdir2]) do
+				Dir.mkdir("#{@tmpdir}/foo")
+			end
+			result.should be_true
+		end
+		
+		specify "a subdirectory has been removed in one of the watched directories" do
+			Dir.mkdir("#{@tmpdir2}/foo")
+			result = test_block([@tmpdir, @tmpdir2]) do
+				Dir.rmdir("#{@tmpdir2}/foo")
+			end
+			result.should be_true
+		end
+		
+		specify "a subdirectory has been renamed in one of the watched directories" do
+			Dir.mkdir("#{@tmpdir}/foo")
+			result = test_block([@tmpdir, @tmpdir2]) do
+				File.rename("#{@tmpdir}/foo", "#{@tmpdir3}/bar")
+			end
+			result.should be_true
+		end
+		
+		specify "a file has been created in one of the watched directories" do
+			result = test_block([@tmpdir, @tmpdir2]) do
+				File.touch("#{@tmpdir}/foo")
+			end
+			result.should be_true
+		end
+		
+		specify "a file has been removed in one of the watched directories" do
+			File.touch("#{@tmpdir2}/foo")
+			result = test_block([@tmpdir, @tmpdir2]) do
+				File.unlink("#{@tmpdir2}/foo")
+			end
+			result.should be_true
+		end
+		
+		specify "a file has been renamed in one of the watched directories" do
+			File.touch("#{@tmpdir}/foo")
+			result = test_block([@tmpdir, @tmpdir2]) do
+				File.rename("#{@tmpdir}/foo", "#{@tmpdir3}/bar")
+			end
+			result.should be_true
+		end
+		
+		specify "a watched file has been written to" do
+			File.touch("#{@tmpdir}/foo")
+			result = test_block(["#{@tmpdir}/foo"]) do
+				File.write("#{@tmpdir}/foo", "bar")
+			end
+		end
+		
+		specify "a watched file has been truncated" do
+			File.write("#{@tmpdir}/foo", "contents")
+			result = test_block(["#{@tmpdir}/foo"]) do
+				File.open("#{@tmpdir}/foo", "w").close
+			end
+		end
+		
+		specify "a watched file has been removed" do
+			File.touch("#{@tmpdir}/foo")
+			result = test_block(["#{@tmpdir}/foo"]) do
+				File.unlink("#{@tmpdir}/foo")
+			end
+		end
+		
+		specify "a watched file has been renamed" do
+			File.touch("#{@tmpdir}/foo")
+			result = test_block(["#{@tmpdir}/foo"]) do
+				File.rename("#{@tmpdir}/foo", "#{@tmpdir}/bar")
+			end
+		end
+		
+		specify "the termination pipe became readable" do
+			result = test_block([@tmpdir]) do
+				@term_pipe[1].write("x")
+			end
+			result.should be_nil
+		end
+		
+		specify "one of the watched files or directories could not be statted while constructing the object" do
+			test_block([@tmpdir, "#{@tmpdir}/foo"]).should be_false
+			
+			when_not_running_as_root do
+				Dir.mkdir("#{@tmpdir}/foo")
+				File.touch("#{@tmpdir}/foo/file")
+				Dir.mkdir("#{@tmpdir}/foo/dir")
+				File.chmod(0000, "#{@tmpdir}/foo")
+				
+				test_block([@tmpdir, "#{@tmpdir}/foo/file"]).should be_false
+				test_block([@tmpdir, "#{@tmpdir}/foo/dir"]).should be_false
+			end
+		end
+		
+		if Utils::FileSystemWatcher.opens_files?
+		when_not_running_as_root do
+			specify "one of the watched files or directories could not be opened while constructing the object" do
+				File.touch("#{@tmpdir}/file")
+				File.chmod(0000, "#{@tmpdir}/file")
+				test_block([@tmpdir, "#{@tmpdir}/file"]).should be_false
+				
+				Dir.mkdir("#{@tmpdir}/dir")
+				File.chmod(0000, "#{@tmpdir}/dir")
+				test_block([@tmpdir, "#{@tmpdir}/dir"]).should be_false
+			end
+		end
+		end # if
+	end
+	
+	describe "#wait_for_change does not return if" do
+		def test_block(filenames)
+			create(filenames, @term_pipe[0])
+			@thread = Thread.new do
+				@watcher.wait_for_change
+			end
+			yield
+			should_never_happen(0.4) do
+				!@thread.alive?
+			end
+		end
+		
+		specify "nothing happened in one of its watched files or directories" do
+			test_block([@tmpdir, @tmpdir2]) do
+				File.touch("#{@tmpdir3}/file")
+				Dir.mkdir("#{@tmpdir3}/dir")
+			end
+		end
+		
+		specify "something happened in a subdirectory that isn't on the watch list" do
+			# In other words it does not watch subdirectories recursively.
+			Dir.mkdir("#{@tmpdir}/subdir")
+			test_block([@tmpdir, @tmpdir2]) do
+				File.touch("#{@tmpdir}/subdir/file")
+			end
+		end
+		
+		specify "a file in a watched directory is merely modified" do
+			File.touch("#{@tmpdir}/hello", 10)
+			test_block([@tmpdir, @tmpdir2]) do
+				File.touch("#{@tmpdir}/hello", 4567)
+				File.write("#{@tmpdir}/hello", "foobar")
+			end
+		end
+	end
+	
+	specify "#wait_for_change notices events that have occurred after object construction but before #wait_for_change has been called" do
+		create([@tmpdir, @tmpdir2], @term_pipe[0])
+		@thread = Thread.new do
+			@watcher.wait_for_change
+		end
+		File.touch("#{@tmpdir}/foo", Time.now - 10)
+		eventually do
+			!@thread.alive?
+		end
+	end
+	
+	it "can be closed multiple times" do
+		create([@tmpdir])
+		@watcher.close
+		@watcher.close
+	end
+end
+
+end # module PhusionPassenger

data/test/ruby/utils/hosts_file_parser.rb

@@ -0,0 +1,258 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'phusion_passenger/utils/hosts_file_parser'
+require 'stringio'
+
+module PhusionPassenger
+
+describe Utils::HostsFileParser do
+	before :each do
+		@io = StringIO.new
+	end
+	
+	def create
+		@io.rewind
+		@parser = Utils::HostsFileParser.new(@io)
+	end
+	
+	describe "parsing" do
+		it "ignores comments" do
+			@io.puts("# 127.0.0.1 foo.com")
+			create
+			@parser.ip_count.should == 0
+			@parser.host_count.should == 0
+		end
+		
+		it "ignores comments that come after leading spaces" do
+			@io.puts("   # 127.0.0.1 foo.com")
+			create
+			@parser.ip_count.should == 0
+			@parser.host_count.should == 0
+		end
+		
+		it "ignores comments that come after leading tabs" do
+			@io.puts("\t# 127.0.0.1 foo.com")
+			create
+			@parser.ip_count.should == 0
+			@parser.host_count.should == 0
+		end
+		
+		it "ignores empty lines" do
+			@io.puts("127.0.0.1 foo.com")
+			@io.puts
+			@io.puts("127.0.0.1 bar.com")
+			@io.puts("127.0.0.2 baz.com")
+			create
+			@parser.ip_count.should == 2
+			@parser.host_count.should == 3
+		end
+		
+		it "ignores leading and trailing spaces" do
+			@io.puts("  127.0.0.1 foo.com")
+			@io.puts
+			@io.puts("  127.0.0.1 bar.com  ")
+			@io.puts("127.0.0.2 baz.com  ")
+			create
+			@parser.ip_count.should == 2
+			@parser.host_count.should == 3
+			@parser.resolve("foo.com").should == "127.0.0.1"
+			@parser.resolve("bar.com").should == "127.0.0.1"
+			@parser.resolve("baz.com").should == "127.0.0.2"
+		end
+		
+		it "ignores leading and trailing tabs" do
+			@io.puts("\t\t127.0.0.1 foo.com")
+			@io.puts
+			@io.puts("\t127.0.0.1 bar.com\t")
+			@io.puts("127.0.0.2 baz.com\t\t")
+			create
+			@parser.ip_count.should == 2
+			@parser.host_count.should == 3
+			@parser.resolve("foo.com").should == "127.0.0.1"
+			@parser.resolve("bar.com").should == "127.0.0.1"
+			@parser.resolve("baz.com").should == "127.0.0.2"
+		end
+		
+		it "correctly handles spaces as seperators" do
+			@io.puts("127.0.0.1 foo.com bar.com  baz.com")
+			create
+			@parser.ip_count.should == 1
+			@parser.host_count.should == 3
+			@parser.resolve("foo.com").should == "127.0.0.1"
+			@parser.resolve("bar.com").should == "127.0.0.1"
+			@parser.resolve("baz.com").should == "127.0.0.1"
+		end
+		
+		it "correctly handles tabs as seperators" do
+			@io.puts("127.0.0.1\tfoo.com\t\tbar.com baz.com")
+			create
+			@parser.ip_count.should == 1
+			@parser.host_count.should == 3
+			@parser.resolve("foo.com").should == "127.0.0.1"
+			@parser.resolve("bar.com").should == "127.0.0.1"
+			@parser.resolve("baz.com").should == "127.0.0.1"
+		end
+	end
+	
+	describe "#resolve" do
+		it "returns nil if the host name is not in the file" do
+			@io.puts("127.0.0.1 foo.com")
+			create
+			@parser.resolve("bar.com").should be_nil
+		end
+		
+		it "returns the IP address associated with the host name if it exists" do
+			@io.puts("255.255.255.255 foo.com")
+			create
+			@parser.resolve("foo.com").should == "255.255.255.255"
+		end
+		
+		it "is case-insensitive" do
+			@io.puts("255.255.255.255 fOO.com")
+			create
+			@parser.resolve("foo.COM").should == "255.255.255.255"
+		end
+		
+		it "correctly handles lines that contain multiple host names" do
+			@io.puts("255.255.255.255 foo.com bar.com")
+			create
+			@parser.resolve("foo.com").should == "255.255.255.255"
+			@parser.resolve("bar.com").should == "255.255.255.255"
+			@parser.resolve("baz.com").should be_nil
+		end
+		
+		it "always returns 127.0.0.1 for localhost" do
+			create
+			@parser.resolve("localhost").should == "127.0.0.1"
+			@parser.resolve("localHOST").should == "127.0.0.1"
+		end
+	end
+	
+	describe "#resolves_to_localhost?" do
+		before :each do
+			@io.puts "127.0.0.1 kotori"
+			@io.puts "192.168.0.1 kanako"
+			@io.puts "::1 ageha"
+			@io.puts "::2 sawako"
+			@io.puts "0.0.0.0 mizusawa"
+			create
+		end
+		
+		it "returns true if the host name resolves to 127.0.0.1" do
+			@parser.resolves_to_localhost?("kotori").should be_true
+		end
+		
+		it "returns true if the host name resolves to ::1" do
+			@parser.resolves_to_localhost?("ageha").should be_true
+		end
+		
+		it "returns true if the host name resolves to 0.0.0.0" do
+			@parser.resolves_to_localhost?("mizusawa").should be_true
+		end
+		
+		it "returns false if the host name resolves to something else" do
+			@parser.resolves_to_localhost?("sawako").should be_false
+			@parser.resolves_to_localhost?("kanako").should be_false
+		end
+		
+		it "returns false if the host name does not resolve" do
+			@parser.resolves_to_localhost?("foo.com").should be_false
+		end
+	end
+	
+	describe "#add_group_data" do
+		before :each do
+			@standard_entries =
+				"127.0.0.1 kotori hazuki\n" +
+				"  192.168.0.1 kanako\n\n" +
+				"\t::1 ageha sawako\n" +
+				"0.0.0.0 mizusawa naru\n"
+			@target = StringIO.new
+		end
+		
+		it "adds the group data if it doesn't exist" do
+			@io.puts @standard_entries
+			create
+			
+			@parser.add_group_data("some marker",
+				"# a comment\n" +
+				"127.0.0.1 foo\n")
+			@parser.write(@target)
+			@target.string.should ==
+				@standard_entries +
+				"###### BEGIN some marker ######\n" +
+				"# a comment\n" +
+				"127.0.0.1 foo\n" +
+				"###### END some marker ######\n"
+		end
+		
+		it "replaces the existing group data if it does exist" do
+			@io.puts "###### BEGIN some marker ######\n" +
+				"# another comment\n" +
+				"127.0.0.1 bar\n" +
+				"###### END some marker ######\n" +
+				"\n" +
+				@standard_entries +
+				"###### BEGIN some other marker ######\n" +
+				"# another comment\n" +
+				"127.0.0.1 bar\n" +
+				"###### END some other marker ######\n"
+			create
+			
+			@parser.add_group_data("some marker", "127.0.0.1 foo\n")
+			@parser.write(@target)
+			@target.string.should ==
+				"###### BEGIN some marker ######\n" +
+				"127.0.0.1 foo\n" +
+				"###### END some marker ######\n" +
+				"\n" +
+				@standard_entries +
+				"###### BEGIN some other marker ######\n" +
+				"# another comment\n" +
+				"127.0.0.1 bar\n" +
+				"###### END some other marker ######\n"
+		end
+		
+		it "correctly handles the lack of a terminating newline in the group data" do
+			@io.puts @standard_entries
+			create
+			
+			@parser.add_group_data("some marker",
+				"# a comment\n" +
+				"127.0.0.1 foo")
+			@parser.write(@target)
+			@target.string.should ==
+				@standard_entries +
+				"###### BEGIN some marker ######\n" +
+				"# a comment\n" +
+				"127.0.0.1 foo\n" +
+				"###### END some marker ######\n"
+		end
+		
+		it "ensures that the group data starts at a new line" do
+			@io.write "127.0.0.1 foo.com"
+			create
+			@parser.add_group_data("some marker", "127.0.0.1 bar.com")
+			@parser.write(@target)
+			@target.string.should ==
+				"127.0.0.1 foo.com\n" +
+				"###### BEGIN some marker ######\n" +
+				"127.0.0.1 bar.com\n" +
+				"###### END some marker ######\n"
+		end
+	end
+	
+	describe "#write" do
+		it "preserves all comments and leading and trailing whitespaces" do
+			@io.puts "127.0.0.1 foo.com  "
+			@io.puts "# a comment"
+			@io.puts "\t127.0.0.1  bar.com\t"
+			create
+			original_data = @io.string
+			target = StringIO.new
+			@parser.write(target)
+			target.string.should == original_data
+		end
+	end
+end
+
+end # module PhusionPassenger