Added support for standard PostgreSQL-type regression testing by just…

… copying the test script and setting some variables for it and providing an expected/ directory. The test now lives in the sql/ directory.

Makefile

@@ -1,8 +1,9 @@
 DATA_built = pgtap.sql drop_pgtap.sql
 DOCS = README.pgtap
 SCRIPTS = pg_prove
-TAPTEST = test.sql
-EXTRA_CLEAN = $(TAPTEST) sql
+TAPTEST = sql/taptest.sql
+REGRESS = pgtap
+EXTRA_CLEAN = sql/$(REGRESS).sql
 
 top_builddir = ../..
 in_contrib = $(wildcard $(top_builddir)/src/Makefile.global);
@@ -18,7 +19,7 @@ else
 	include $(PGXS)
 endif
 
-all: $(DATA_built) $(TAPTEST) $(SCRIPTS)
+all: $(DATA_built) $(TAPTEST) $(SCRIPTS) cptest
 
 # Override how .sql targets are processed to add the schema info, if
 # necessary. Otherwise just copy the files.
@@ -29,5 +30,8 @@ else
 	cp $< $@
 endif
 
+cptest:
+	sed -e 's/^-- !! //g' $(TAPTEST) > sql/$(REGRESS).sql
+
 test:
 	./pg_prove $(TAPTEST)

README.pgtap

@@ -13,6 +13,33 @@ For the impatient, to install pgTAP into a PostgreSQL database, just do this:
     make
     make test
     make install
+    make installcheck
+
+If you encounter an error such as:
+
+  "Makefile", line 8: Need an operator
+
+You need to use GNU make, which may well be installed on your system as
+'gmake':
+
+    gmake
+    gmake test
+    gmake install
+    gmake installcheck
+
+If you encounter an error such as:
+
+  make: pg_config: Command not found
+
+Be sure that you have pg_config installed and in your path. If you used a
+package management system such as RPM to install PostgreSQL, be sure that the
+-devel package is also installed. If necessary, add the path to pg_config to
+your $PATH environment variable:
+
+  env PATH=$PATH:/path/to/pgsql/bin make && make test && make install
+
+And finally, if all that fails, copy the entire distribution directory to the
+'contrib' subdirectory of the PostgreSQL source code and try it there.
 
 If you want to schema-qualify pgTAP (that is, install all of its functions
 into their own schema), set the $TAPSCHEMA environment variable to the name

expected/pgtap.out

@@ -0,0 +1,81 @@
+-- These are here for the usual PostgreSQL regression tests to use.
+\set ECHO
+1..78
+ok 1 - My pass() passed, w00t!
+ok 2 - Testing fail()
+ok 3 - We should get the proper output from fail()
+ok 4 - The output of finish() should reflect the test failure
+ok 5 - We should have one failure
+ok 6 - We should now have no failures
+ok 7 - diag() should work properly
+ok 8 - multiline diag() should work properly
+ok 9 - multiline diag() should work properly with existing comments
+ok 10 - no_plan() should have stored a plan of 0
+ok 11 - Set the plan to 4000
+ok 12 - The output of finish() should reflect a high test plan
+ok 13 - Set the plan to 4
+ok 14 - The output of finish() should reflect a low test plan
+ok 15 - Reset the plan
+ok 16 - plan() should have stored the test count
+ok 17 - ok() success
+ok 18 - ok(true) should work
+ok 19 - ok() success 2
+ok 20 - ok(true, '') should work
+ok 21 - ok() success 3
+ok 22 - ok(true, 'foo') should work
+ok 23 - ok() failure
+ok 24 - ok(false) should work
+ok 25 - ok() failure 2
+ok 26 - ok(false, '') should work
+ok 27 - ok() failure 3
+ok 28 - ok(false, 'foo') should work
+ok 29 - is() success
+ok 30 - isa(1, 1) should work
+ok 31 - is() success 2
+ok 32 - is('x', 'x') should work
+ok 33 - is() success 3
+ok 34 - is(1.1, 1.10) should work
+ok 35 - is() success 4
+ok 36 - is(1.1, 1.10) should work
+ok 37 - is() success 5
+ok 38 - is(true, true) should work
+ok 39 - is() success 6
+ok 40 - is(false, false) should work
+ok 41 - is() success 7
+ok 42 - is(1, 1, 'foo') should work
+ok 43 - is() failure
+ok 44 - is(1, 2) should work
+ok 45 - isnt() success
+ok 46 - isnt(1, 2) should work
+ok 47 - isnt() failure
+ok 48 - is(1, 2) should work
+ok 49 - is() should work with psql variables
+ok 50 - matches() should work
+ok 51 - matches() should work with a regex
+ok 52 - imatches() should work with a regex
+ok 53 - matches() failure
+ok 54 - Check matches diagnostics
+ok 55 - doesnt_match() should work
+ok 56 - doesnt_match() should work with a regex
+ok 57 - doesnt_imatch() should work with a regex
+ok 58 - doesnt_match() failure
+ok 59 - doesnt_match() should work
+ok 60 - alike() should work
+ok 61 - alike() should work with a regex
+ok 62 - ialike() should work with a regex
+ok 63 - alike() failure
+ok 64 - Check alike diagnostics
+ok 65 - unalike() should work
+ok 66 - unalike() should work with a regex
+ok 67 - iunalike() should work with a regex
+ok 68 - unalike() failure
+ok 69 - Check unalike diagnostics
+ok 70 - throws_ok(1/0) should work
+ok 71 - throws_ok failure diagnostics
+ok 72 - We should get the proper diagnostics from throws_ok()
+ok 73 - throws_ok(1/0, NULL) should work
+ok 74 - throws_ok failure diagnostics
+ok 75 - We should get the proper diagnostics from throws_ok() with a NULL error code
+ok 76 - lives_ok() should work
+ok 77 - lives_ok failure diagnostics
+ok 78 - We should get the proper diagnostics for a lives_ok() failure

sql/taptest.sql

@@ -0,0 +1,237 @@
+-- These are here for the usual PostgreSQL regression tests to use.
+-- !! \set ECHO
+-- !! \set ON_ERROR_ROLBACK 1
+-- !! \pset format unaligned
+-- !! \pset tuples_only
+-- !! \pset pager
+-- !! CREATE LANGUAGE plpgsql;
+--
+-- Tests for pgTAP.
+--
+--
+
+-- Keep things quiet.
+SET client_min_messages = warning;
+
+-- Load the TAP functions.
+BEGIN;
+\i pgtap.sql
+\set numb_tests 78
+
+-- ## SET search_path TO TAPSCHEMA,public;
+
+-- Set the test plan.
+SELECT plan(:numb_tests);
+
+-- Replace the internal record of the plan for a few tests.
+UPDATE  __tcache__ SET value = 3 WHERE label = 'plan';
+
+/****************************************************************************/
+-- Test pass().
+SELECT pass( 'My pass() passed, w00t!' );
+
+-- Test fail().
+\set fail_numb 2
+\echo ok :fail_numb - Testing fail()
+SELECT is(
+       fail('oops'),
+       E'not ok 2 - oops\n# Failed test 2: "oops"', 'We should get the proper output from fail()');
+
+-- Check the finish() output.
+SELECT is(
+    (SELECT * FROM finish() LIMIT 1),
+    '# Looks like you failed 1 test of 3',
+    'The output of finish() should reflect the test failure'
+);
+
+/****************************************************************************/
+-- Check num_failed
+SELECT is( num_failed(), 1, 'We should have one failure' );
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb = :fail_numb;
+SELECT is( num_failed(), 0, 'We should now have no failures' );
+
+/****************************************************************************/
+-- Check diag.
+SELECT is( diag('foo'), '# foo', 'diag() should work properly' );
+SELECT is( diag(E'foo\nbar'), E'# foo\n# bar', 'multiline diag() should work properly' );
+SELECT is( diag(E'foo\n# bar'), E'# foo\n# # bar', 'multiline diag() should work properly with existing comments' );
+
+/****************************************************************************/
+-- Check no_plan.
+DELETE FROM __tcache__ WHERE label = 'plan';
+SELECT * FROM no_plan();
+SELECT is( value, 0, 'no_plan() should have stored a plan of 0' )
+  FROM __tcache__
+ WHERE label = 'plan';
+
+-- Set the plan to a high number.
+DELETE FROM __tcache__ WHERE label = 'plan';
+SELECT is( plan(4000), '1..4000', 'Set the plan to 4000' );
+SELECT is(
+    (SELECT * FROM finish() LIMIT 1),
+    '# Looks like you planned 4000 test but only ran 11',
+    'The output of finish() should reflect a high test plan'
+);
+
+-- Set the plan to a low number.
+DELETE FROM __tcache__ WHERE label = 'plan';
+SELECT is( plan(4), '1..4', 'Set the plan to 4' );
+SELECT is(
+    (SELECT * FROM finish() LIMIT 1),
+    '# Looks like you planned 4 test but ran 9 extra',
+    'The output of finish() should reflect a low test plan'
+);
+
+-- Reset the original plan.
+DELETE FROM __tcache__ WHERE label = 'plan';
+SELECT is( plan(:numb_tests), '1..' || :numb_tests, 'Reset the plan' );
+SELECT is( value, :numb_tests, 'plan() should have stored the test count' )
+  FROM __tcache__
+ WHERE label = 'plan';
+
+/****************************************************************************/
+-- Test ok()
+\echo ok 17 - ok() success
+SELECT is( ok(true), 'ok 17', 'ok(true) should work' );
+\echo ok 19 - ok() success 2
+SELECT is( ok(true, ''), 'ok 19', 'ok(true, '''') should work' );
+\echo ok 21 - ok() success 3
+SELECT is( ok(true, 'foo'), 'ok 21 - foo', 'ok(true, ''foo'') should work' );
+
+\echo ok 23 - ok() failure
+SELECT is( ok(false), E'not ok 23\n# Failed test 23', 'ok(false) should work' );
+\echo ok 25 - ok() failure 2
+SELECT is( ok(false, ''), E'not ok 25\n# Failed test 25', 'ok(false, '''') should work' );
+\echo ok 27 - ok() failure 3
+SELECT is( ok(false, 'foo'), E'not ok 27 - foo\n# Failed test 27: "foo"', 'ok(false, ''foo'') should work' );
+
+-- Clean up the failed test results.
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 23, 25, 27);
+
+/****************************************************************************/
+-- Test is().
+\echo ok 29 - is() success
+SELECT is( is(1, 1), 'ok 29', 'isa(1, 1) should work' );
+\echo ok 31 - is() success 2
+SELECT is( is('x'::text, 'x'::text), 'ok 31', 'is(''x'', ''x'') should work' );
+\echo ok 33 - is() success 3
+SELECT is( is(1.1, 1.10), 'ok 33', 'is(1.1, 1.10) should work' );
+\echo ok 35 - is() success 4
+SELECT is( is(1.1, 1.10), 'ok 35', 'is(1.1, 1.10) should work' );
+\echo ok 37 - is() success 5
+SELECT is( is(true, true), 'ok 37', 'is(true, true) should work' );
+\echo ok 39 - is() success 6
+SELECT is( is(false, false), 'ok 39', 'is(false, false) should work' );
+--SELECT is( '12:45'::time, '12:45'::time, 'ok 41', 'is(time, time) should work' );
+\echo ok 41 - is() success 7
+SELECT is( is(1, 1, 'foo'), 'ok 41 - foo', 'is(1, 1, ''foo'') should work' );
+\echo ok 43 - is() failure
+SELECT is( is( 1, 2 ), E'not ok 43\n# Failed test 43\n#          got: 1\n#     expected: 2', 'is(1, 2) should work' );
+
+/****************************************************************************/
+-- Test isnt().
+\echo ok 45 - isnt() success
+SELECT is( isnt(1, 2), 'ok 45', 'isnt(1, 2) should work' );
+\echo ok 47 - isnt() failure
+SELECT is( isnt( 1, 1 ), E'not ok 47\n# Failed test 47\n#     1\n#       <>\n#     1', 'is(1, 2) should work' );
+
+-- Clean up the failed test results.
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 43, 47 );
+
+/****************************************************************************/
+-- Try using variables.
+\set foo '\'' waffle '\''
+\set bar '\'' waffle '\''
+SELECT is( :foo::text, :bar::text, 'is() should work with psql variables' );
+
+/****************************************************************************/
+-- Test matches().
+SELECT matches( 'foo'::text, 'o', 'matches() should work' );
+SELECT matches( 'foo'::text, '^fo', 'matches() should work with a regex' );
+SELECT imatches( 'FOO'::text, '^fo', 'imatches() should work with a regex' );
+
+-- Check matches() diagnostics.
+\echo ok 53 - matches() failure
+SELECT is( matches( 'foo'::text, '^a' ), E'not ok 53\n# Failed test 53\n#                   ''foo''\n#    doesn''t match: ''^a''', 'Check matches diagnostics' );
+
+-- Check doesnt_match.
+SELECT doesnt_match( 'foo'::text, 'a', 'doesnt_match() should work' );
+SELECT doesnt_match( 'foo'::text, '^o', 'doesnt_match() should work with a regex' );
+SELECT doesnt_imatch( 'foo'::text, '^o', 'doesnt_imatch() should work with a regex' );
+
+-- Check doesnt_match diagnostics.
+\echo ok 58 - doesnt_match() failure
+SELECT is(
+    doesnt_match( 'foo'::text, 'o' ),
+    E'not ok 58\n# Failed test 58\n#                   ''foo''\n#          matches: ''o''',
+    'doesnt_match() should work'
+);
+
+-- Clean up the failed test results.
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 53, 58 );
+
+/****************************************************************************/
+-- Test alike().
+SELECT alike( 'foo'::text, 'foo', 'alike() should work' );
+SELECT alike( 'foo'::text, 'fo%', 'alike() should work with a regex' );
+SELECT ialike( 'FOO'::text, 'fo%', 'ialike() should work with a regex' );
+
+-- Check alike() diagnostics.
+\echo ok 63 - alike() failure
+SELECT is( alike( 'foo'::text, 'a%'::text ), E'not ok 63\n# Failed test 63\n#                   ''foo''\n#    doesn''t match: ''a%''', 'Check alike diagnostics' );
+
+-- Test unalike().
+SELECT unalike( 'foo'::text, 'f', 'unalike() should work' );
+SELECT unalike( 'foo'::text, 'f%i', 'unalike() should work with a regex' );
+SELECT unialike( 'FOO'::text, 'f%i', 'iunalike() should work with a regex' );
+
+-- Check unalike() diagnostics.
+\echo ok 68 - unalike() failure
+SELECT is( unalike( 'foo'::text, 'f%'::text ), E'not ok 68\n# Failed test 68\n#                   ''foo''\n#          matches: ''f%''', 'Check unalike diagnostics' );
+
+-- Clean up the failed test results.
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 63, 68 );
+
+/****************************************************************************/
+-- test throws_ok().
+SELECT throws_ok( 'SELECT 1 / 0', '22012', 'throws_ok(1/0) should work' );
+
+-- Check its diagnostics for an invalid error code.
+\echo ok 71 - throws_ok failure diagnostics
+SELECT is(
+    throws_ok( 'SELECT 1 / 0', '97212' ),
+    E'not ok 71 - threw 97212\n# Failed test 71: "threw 97212"\n#       caught: 22012: division by zero\n#     expected: 97212',
+    'We should get the proper diagnostics from throws_ok()'
+);
+
+SELECT throws_ok( 'SELECT 1 / 0', NULL, 'throws_ok(1/0, NULL) should work' );
+
+-- Check its diagnostics no error.
+\echo ok 74 - throws_ok failure diagnostics
+SELECT is(
+    throws_ok( 'SELECT 1', NULL ),
+    E'not ok 74 - threw an exception\n# Failed test 74: "threw an exception"\n#       caught: no exception\n#     expected: an exception',
+    'We should get the proper diagnostics from throws_ok() with a NULL error code'
+);
+
+-- Clean up the failed test results.
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 71, 74 );
+
+/****************************************************************************/
+-- test lives_ok().
+SELECT lives_ok( 'SELECT 1', 'lives_ok() should work' );
+
+-- Check its diagnostics when there is an exception.
+\echo ok 77 - lives_ok failure diagnostics
+SELECT is(
+    lives_ok( 'SELECT 1 / 0' ),
+    E'not ok 77\n# Failed test 77\n#         died: 22012: division by zero',
+    'We should get the proper diagnostics for a lives_ok() failure'
+);
+
+UPDATE __tresults__ SET ok = true, aok = true WHERE numb IN( 77 );
+
+-- Finish the tests and clean up.
+SELECT * FROM finish();
+ROLLBACK;
+