pg 0.8.0 → 0.9.0.pre156

data/rake/testing.rb

@@ -0,0 +1,187 @@
+# 
+# Rake tasklib for testing tasks
+
+# 
+# Authors:
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+unless defined?( COVERAGE_MINIMUM )
+	if ENV['COVVERAGE_MINIMUM']
+		COVERAGE_MINIMUM = Float( ENV['COVERAGE_MINIMUM'] )
+	else
+		COVERAGE_MINIMUM = 85.0 
+	end
+end
+SPEC_FILES       = [] unless defined?( SPEC_FILES )
+TEST_FILES       = [] unless defined?( TEST_FILES )
+
+COMMON_SPEC_OPTS = ['-Du'] unless defined?( COMMON_SPEC_OPTS )
+
+COVERAGE_TARGETDIR = BASEDIR + 'coverage' unless defined?( COVERAGE_TARGETDIR )
+RCOV_EXCLUDES      = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib' unless
+	defined?( RCOV_EXCLUDES )
+
+
+desc "Run all defined tests"
+task :test do
+	unless SPEC_FILES.empty?
+		log "Running specs"
+		Rake::Task['spec:quiet'].invoke
+	end
+
+	unless TEST_FILES.empty?
+		log "Running unit tests"
+		Rake::Task[:unittests].invoke 
+	end
+end
+
+
+### RSpec specifications
+begin
+	gem 'rspec', '>= 1.1.3'
+
+	require 'spec'
+	require 'spec/rake/spectask'
+
+	### Task: spec
+	desc "Run specs"
+	task :spec => 'spec:doc'
+
+	namespace :spec do
+		desc "Run rspec every time there's a change to one of the files"
+		task :autotest do
+			require 'autotest/rspec'
+
+			autotester = Autotest::Rspec.new
+			autotester.run
+		end
+
+		desc "Generate regular color 'doc' spec output"
+		Spec::Rake::SpecTask.new( :doc ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 's', '-c']
+		end
+
+		desc "Generate spec output with profiling"
+		Spec::Rake::SpecTask.new( :profile ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'o']
+		end
+
+		desc "Generate quiet non-colored plain-text output"
+		Spec::Rake::SpecTask.new( :quiet ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'p']
+		end
+
+		desc "Generate HTML output"
+		Spec::Rake::SpecTask.new( :html ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'h']
+		end
+
+	end
+rescue LoadError => err
+	task :no_rspec do
+		$stderr.puts "Specification tasks not defined: %s" % [ err.message ]
+	end
+
+	task :spec => :no_rspec
+	namespace :spec do
+		task :autotest => :no_rspec
+		task :doc => :no_rspec
+		task :profile => :no_rspec
+		task :quiet => :no_rspec
+		task :html => :no_rspec
+	end
+end
+
+
+### Test::Unit tests
+begin
+	require 'rake/testtask'
+
+	Rake::TestTask.new( :unittests ) do |task|
+		task.libs += [LIBDIR]
+		task.test_files = TEST_FILES
+		task.verbose = true
+	end
+
+rescue LoadError => err
+	task :no_test do
+		$stderr.puts "Test tasks not defined: %s" % [ err.message ]
+	end
+
+	task :unittests => :no_rspec
+end
+
+
+### RCov (via RSpec) tasks
+begin
+	gem 'rcov'
+	gem 'rspec', '>= 1.1.3'
+
+	require 'spec'
+	require 'rcov'
+
+	### Task: coverage (via RCov)
+	desc "Build test coverage reports"
+	unless SPEC_FILES.empty?
+		Spec::Rake::SpecTask.new( :coverage ) do |task|
+			task.spec_files = SPEC_FILES
+			task.libs += [LIBDIR]
+			task.spec_opts = ['-f', 'p', '-b']
+			task.rcov_opts = RCOV_OPTS
+			task.rcov = true
+		end
+	end
+
+
+	### Task: rcov
+	task :rcov => :coverage
+
+	### Other coverage tasks
+	namespace :coverage do
+		desc "Generate a detailed text coverage report"
+		Spec::Rake::SpecTask.new( :text ) do |task|
+			task.spec_files = SPEC_FILES
+			task.rcov_opts = RCOV_OPTS + ['--text-report']
+			task.rcov = true
+		end
+
+		desc "Show differences in coverage from last run"
+		Spec::Rake::SpecTask.new( :diff ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = ['-f', 'p', '-b']
+			task.rcov_opts = RCOV_OPTS - ['--save'] + ['--text-coverage-diff']
+			task.rcov = true
+		end
+
+		desc "Run RCov in 'spec-only' mode to check coverage from specs"
+		Spec::Rake::SpecTask.new( :speconly ) do |task|
+			task.spec_files = SPEC_FILES
+			task.rcov_opts = ['--exclude', RCOV_EXCLUDES, '--text-report', '--save']
+			task.rcov = true
+		end
+	end
+
+	CLOBBER.include( COVERAGE_TARGETDIR )
+
+rescue LoadError => err
+	task :no_rcov do
+		$stderr.puts "Coverage tasks not defined: RSpec+RCov tasklib not available: %s" %
+		[ err.message ]
+	end
+
+	task :coverage => :no_rcov
+	task :clobber_coverage
+	task :rcov => :no_rcov
+	namespace :coverage do
+		task :text => :no_rcov
+		task :diff => :no_rcov
+	end
+	task :verify => :no_rcov
+end
+
+

data/rake/verifytask.rb

@@ -0,0 +1,64 @@
+#####################################################################
+###	S U B V E R S I O N   T A S K S   A N D   H E L P E R S
+#####################################################################
+
+require 'rake/tasklib'
+
+#
+# Work around the inexplicable behaviour of the original RDoc::VerifyTask, which 
+# errors if your coverage isn't *exactly* the threshold.
+# 
+
+# A task that can verify that the RCov coverage doesn't
+# drop below a certain threshold. It should be run after
+# running Spec::Rake::SpecTask.
+class VerifyTask < Rake::TaskLib
+	
+	COVERAGE_PERCENTAGE_PATTERN = 
+		%r{<tt class='coverage_code'>(\d+\.\d+)%</tt>}
+	
+	# Name of the task. Defaults to :verify_rcov
+	attr_accessor :name
+
+	# Path to the index.html file generated by RCov, which
+	# is the file containing the total coverage.
+	# Defaults to 'coverage/index.html'
+	attr_accessor :index_html
+
+	# Whether or not to output details. Defaults to true.
+	attr_accessor :verbose
+
+	# The threshold value (in percent) for coverage. If the 
+	# actual coverage is not equal to this value, the task will raise an 
+	# exception. 
+	attr_accessor :threshold
+
+	def initialize( name=:verify )
+		@name = name
+		@index_html = 'coverage/index.html'
+		@verbose = true
+		yield self if block_given?
+		raise "Threshold must be set" if @threshold.nil?
+		define
+	end
+
+	def define
+		desc "Verify that rcov coverage is at least #{threshold}%"
+
+		task @name do
+			total_coverage = nil
+			if match = File.read( index_html ).match( COVERAGE_PERCENTAGE_PATTERN )
+				total_coverage = Float( match[1] )
+			else
+				raise "Couldn't find the coverage percentage in #{index_html}"
+			end
+
+			puts "Coverage: #{total_coverage}% (threshold: #{threshold}%)" if verbose
+			if total_coverage < threshold
+				raise "Coverage must be at least #{threshold}% but was #{total_coverage}%"
+			end
+		end
+	end
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/lib/helpers.rb

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+module PgTestingHelpers
+
+	# Set some ANSI escape code constants (Shamelessly stolen from Perl's
+	# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
+	ANSI_ATTRIBUTES = {
+		'clear'      => 0,
+		'reset'      => 0,
+		'bold'       => 1,
+		'dark'       => 2,
+		'underline'  => 4,
+		'underscore' => 4,
+		'blink'      => 5,
+		'reverse'    => 7,
+		'concealed'  => 8,
+
+		'black'      => 30,   'on_black'   => 40,
+		'red'        => 31,   'on_red'     => 41,
+		'green'      => 32,   'on_green'   => 42,
+		'yellow'     => 33,   'on_yellow'  => 43,
+		'blue'       => 34,   'on_blue'    => 44,
+		'magenta'    => 35,   'on_magenta' => 45,
+		'cyan'       => 36,   'on_cyan'    => 46,
+		'white'      => 37,   'on_white'   => 47
+	}
+
+
+	###############
+	module_function
+	###############
+
+	### Create a string that contains the ANSI codes specified and return it
+	def ansi_code( *attributes )
+		attributes.flatten!
+		attributes.collect! {|at| at.to_s }
+		# $stderr.puts "Returning ansicode for TERM = %p: %p" %
+		# 	[ ENV['TERM'], attributes ]
+		return '' unless /(?:vt10[03]|xterm(?:-color)?|linux|screen)/i =~ ENV['TERM']
+		attributes = ANSI_ATTRIBUTES.values_at( *attributes ).compact.join(';')
+
+		# $stderr.puts "  attr is: %p" % [attributes]
+		if attributes.empty? 
+			return ''
+		else
+			return "\e[%sm" % attributes
+		end
+	end
+
+
+	### Colorize the given +string+ with the specified +attributes+ and return it, handling 
+	### line-endings, color reset, etc.
+	def colorize( *args )
+		string = ''
+
+		if block_given?
+			string = yield
+		else
+			string = args.shift
+		end
+
+		ending = string[/(\s)$/] || ''
+		string = string.rstrip
+
+		return ansi_code( args.flatten ) + string + ansi_code( 'reset' ) + ending
+	end
+
+
+	### Output a message with highlighting.
+	def message( *msg )
+		$stderr.puts( colorize(:bold) { msg.flatten.join(' ') } )
+	end
+
+
+	### Output a logging message if $VERBOSE is true
+	def trace( *msg )
+		return unless $VERBOSE
+		output = colorize( msg.flatten.join(' '), 'yellow' )
+		$stderr.puts( output )
+	end
+
+
+	### Return the specified args as a string, quoting any that have a space.
+	def quotelist( *args )
+		return args.flatten.collect {|part| part.to_s =~ /\s/ ? part.to_s.inspect : part.to_s }
+	end
+
+
+	### Run the specified command +cmd+ with system(), failing if the execution
+	### fails.
+	def run( *cmd )
+		cmd.flatten!
+
+		if cmd.length > 1
+			trace( quotelist(*cmd) )
+		else
+			trace( cmd )
+		end
+
+		system( *cmd )
+		raise "Command failed: [%s]" % [cmd.join(' ')] unless $?.success?
+	end
+
+
+	### Run the specified command +cmd+ after redirecting stdout and stderr to the specified 
+	### +logpath+, failing if the execution fails.
+	def log_and_run( logpath, *cmd )
+		cmd.flatten!
+
+		if cmd.length > 1
+			trace( quotelist(*cmd) )
+		else
+			trace( cmd )
+		end
+
+		logfh = File.open( logpath, File::WRONLY|File::CREAT|File::APPEND )
+		if pid = fork
+			logfh.close
+			Process.wait
+		else
+			$stdout.reopen( logfh )
+			$stderr.reopen( $stdout )
+			exec( *cmd )
+			$stderr.puts "After the exec()?!??!"
+			exit!
+		end
+
+		raise "Command failed: [%s]" % [cmd.join(' ')] unless $?.success?
+	end
+
+
+	### Check the current directory for directories that look like they're
+	### testing directories from previous tests, and tell any postgres instances
+	### running in them to shut down.
+	def stop_existing_postmasters
+		# tmp_test_0.22329534700318
+		pat = Pathname.getwd + 'tmp_test_*'
+		Pathname.glob( pat.to_s ).each do |testdir|
+			datadir = testdir + 'data'
+			pidfile = datadir + 'postmaster.pid'
+			if pidfile.exist? && pid = pidfile.read.chomp.to_i
+				begin
+					Process.kill( 0, pid )
+				rescue Errno::ESRCH
+					trace "No postmaster running for %s" % [ datadir ]
+					# Process isn't alive, so don't try to stop it
+				else
+					trace "Stopping lingering database at PID %d"
+					run 'pg_ctl', '-D', datadir.to_s, '-m', 'fast', 'stop'
+				end
+			end
+		end
+	end
+
+
+	### Set up a PostgreSQL database instance for testing.
+	def setup_testing_db( description )
+		require 'pg'
+		stop_existing_postmasters()
+
+		puts "Setting up test database for #{description} tests"
+		@test_directory = Pathname.getwd + "tmp_test_specs"
+		@test_pgdata = @test_directory + 'data'
+		@test_pgdata.mkpath
+
+		@port = 54321
+		ENV['PGPORT'] = @port.to_s
+		ENV['PGHOST'] = 'localhost'
+		@conninfo = "host=localhost port=#{@port} dbname=test"
+
+		@logfile = @test_directory + 'setup.log'
+		trace "Command output logged to #{@logfile}"
+
+		begin
+			unless (@test_pgdata+"postgresql.conf").exist?
+				FileUtils.rm_rf( @test_pgdata, :verbose => $DEBUG )
+				trace "Running initdb"
+				log_and_run @logfile, 'initdb', '--no-locale', '-D', @test_pgdata.to_s
+			end
+
+			trace "Starting postgres"
+			log_and_run @logfile, 'pg_ctl', '-w', '-o', "-k #{@test_directory.to_s.inspect}",
+				'-D', @test_pgdata.to_s, 'start'
+
+			if `psql -l` =~ /^\s*test\s/
+				trace "Dropping the test DB"
+				log_and_run @logfile, 'dropdb', 'test'
+			end
+			trace "Creating the test DB"
+			log_and_run @logfile, 'createdb', 'test'
+		rescue => err
+			$stderr.puts "%p during test setup: %s" % [ err.class, err.message ]
+			$stderr.puts "See #{@logfile} for details."
+			$stderr.puts *err.backtrace if $DEBUG
+			fail
+		end
+
+		conn = PGconn.connect( @conninfo )
+		conn.set_notice_processor do |message|
+			$stderr.puts( message ) if $DEBUG
+		end
+
+		return conn
+	end
+
+
+	def teardown_testing_db( conn )
+		puts "Tearing down test database"
+		conn.finish if conn
+		log_and_run @logfile, 'pg_ctl', '-D', @test_pgdata.to_s, 'stop'
+	end
+end
+
+