Add the has_pk(:schema, :table) variant

Resolves #287.

Also removed outdated manual custom schema installation instructions
from the README.

Changes

@@ -23,6 +23,9 @@ Revision history for pgTAP
     * `domain_type_isnt()`
     * `has_operator()`
     * `hasnt_operator()`
+* Added the `has_pk( :schema, :table )` variant, which requires that `:table` be
+  cast to `name` to avoid confusion with the `has_pk( :schema, :description )`
+  variant. Thanks to Adrian Klaver for the report (#287)!
 
 1.3.0 2023-08-14T22:14:20Z
 --------------------------

Makefile

@@ -205,6 +205,7 @@ uninstall-all:
 	rm -f $(EXTENSION_DIR)/pgtap*
 
 # TODO: switch this whole thing to a perl or shell script that understands the file naming convention and how to compare that to $VERSION.
+# VERSION = 9.1.0 # Uncomment to test all patches.
 sql/pgtap.sql: sql/pgtap.sql.in
 	cp $< $@
 ifeq ($(shell echo $(VERSION) | grep -qE "^(9[.][0123456]|8[.][1234])" && echo yes || echo no),yes)

README.md

@@ -81,12 +81,6 @@ installed, you can upgrade it to a properly packaged extension with:
 
     CREATE EXTENSION pgtap FROM unpackaged;
 
-If you want to install pgTAP and all of its supporting objects into a
-specific schema, use the `PGOPTIONS` environment variable to specify the
-schema, like so:
-
-    PGOPTIONS=--search_path=tap psql -d mydb -f pgTAP.sql
-
 If you want to install pgTAP and all of its supporting objects into a specific
 schema, use the `SCHEMA` clause to specify the schema, like so:
 

compat/install-9.1.patch

@@ -11,7 +11,7 @@
      RETURN ok( FALSE, descr ) || E'\n' || diag(
             '    died: ' || _error_diag(SQLSTATE, SQLERRM, detail, hint, context, schname, tabname, colname, chkname, typname)
      );
-@@ -6661,10 +6657,6 @@
+@@ -6667,10 +6663,6 @@
                  -- Something went wrong. Record that fact.
                  errstate := SQLSTATE;
                  errmsg := SQLERRM;
@@ -22,15 +22,15 @@
              END;
 
              -- Always raise an exception to rollback any changes.
-@@ -7132,7 +7124,6 @@
+@@ -7138,7 +7130,6 @@
      RETURN ok( true, $3 );
  EXCEPTION
      WHEN datatype_mismatch THEN
 -        GET STACKED DIAGNOSTICS err_msg = MESSAGE_TEXT;
          RETURN ok( false, $3 ) || E'\n' || diag(
              E'    Number of columns or their types differ between the queries' ||
              CASE WHEN have_rec::TEXT = want_rec::text THEN '' ELSE E':\n' ||
-@@ -7286,7 +7277,6 @@
+@@ -7292,7 +7283,6 @@
      RETURN ok( false, $3 );
  EXCEPTION
      WHEN datatype_mismatch THEN

compat/install-9.2.patch

@@ -14,7 +14,7 @@
      RETURN ok( FALSE, descr ) || E'\n' || diag(
             '    died: ' || _error_diag(SQLSTATE, SQLERRM, detail, hint, context, schname, tabname, colname, chkname, typname)
      );
-@@ -6669,12 +6664,7 @@
+@@ -6675,12 +6670,7 @@
                  GET STACKED DIAGNOSTICS
                      detail  = PG_EXCEPTION_DETAIL,
                      hint    = PG_EXCEPTION_HINT,

compat/install-9.4.patch

@@ -18,7 +18,7 @@
      -- There should have been no exception.
      GET STACKED DIAGNOSTICS
          detail  = PG_EXCEPTION_DETAIL,
-@@ -10213,233 +10213,6 @@
+@@ -10219,233 +10219,6 @@
      ), $2);
  $$ LANGUAGE SQL immutable;
 

compat/install-9.6.patch

@@ -1,6 +1,6 @@
 --- sql/pgtap.sql
 +++ sql/pgtap.sql
-@@ -10195,136 +10195,6 @@
+@@ -10201,136 +10201,6 @@
      );
  $$ LANGUAGE sql;
 

doc/pgtap.mmd

@@ -4636,6 +4636,7 @@ the diagnostics will tell you that, too. But you use `has_column()` and
 ### `has_pk()` ###
 
     SELECT has_pk( :schema, :table, :description );
+    SELECT has_pk( :schema, :table );
     SELECT has_pk( :table, :description );
     SELECT has_pk( :table );
 
@@ -4657,6 +4658,11 @@ test description is omitted, it will be set to "Table `:table` should have a
 primary key". Note that this test will fail if the table in question does not
 exist.
 
+If you find that the function call confuses the table name for a
+description, cast the table to the `NAME` type:
+
+    SELECT has_pk( 'myschema', 'mytable'::name );
+
 ### `hasnt_pk()` ###
 
     SELECT hasnt_pk( :schema, :table, :description );

sql/pgtap.sql.in

@@ -1827,6 +1827,12 @@ RETURNS TEXT AS $$
     SELECT ok( _hasc( $1, $2, 'p' ), $3 );
 $$ LANGUAGE sql;
 
+-- has_pk( schema, table )
+CREATE OR REPLACE FUNCTION has_pk ( NAME, NAME )
+RETURNS TEXT AS $$
+    SELECT has_pk( $1, $2, 'Table ' || quote_ident($1) || '.' || quote_ident($2) || ' should have a primary key' );
+$$ LANGUAGE sql;
+
 -- has_pk( table, description )
 CREATE OR REPLACE FUNCTION has_pk ( NAME, TEXT )
 RETURNS TEXT AS $$

test/expected/pktap.out

@@ -1,92 +1,98 @@
 \unset ECHO
-1..90
+1..96
 ok 1 - has_pk( schema, table, description ) should pass
 ok 2 - has_pk( schema, table, description ) should have the proper description
 ok 3 - has_pk( schema, table, description ) should have the proper diagnostics
-ok 4 - has_pk( hideschema, hidetable, description ) should pass
-ok 5 - has_pk( hideschema, hidetable, description ) should have the proper description
-ok 6 - has_pk( hideschema, hidetable, description ) should have the proper diagnostics
-ok 7 - has_pk( table, description ) should pass
-ok 8 - has_pk( table, description ) should have the proper description
-ok 9 - has_pk( table, description ) should have the proper diagnostics
-ok 10 - has_pk( hidetable, description ) fail should fail
-ok 11 - has_pk( hidetable, description ) fail should have the proper description
-ok 12 - has_pk( hidetable, description ) fail should have the proper diagnostics
-ok 13 - has_pk( table ) should pass
-ok 14 - has_pk( table ) should have the proper description
-ok 15 - has_pk( table ) should have the proper diagnostics
-ok 16 - has_pk( schema, table, description ) fail should fail
-ok 17 - has_pk( schema, table, description ) fail should have the proper description
-ok 18 - has_pk( schema, table, description ) fail should have the proper diagnostics
-ok 19 - has_pk( table, description ) fail should fail
-ok 20 - has_pk( table, description ) fail should have the proper description
-ok 21 - has_pk( table, description ) fail should have the proper diagnostics
-ok 22 - hasnt_pk( schema, table, description ) should fail
-ok 23 - hasnt_pk( schema, table, description ) should have the proper description
-ok 24 - hasnt_pk( schema, table, description ) should have the proper diagnostics
-ok 25 - hasnt_pk( table, description ) should fail
-ok 26 - hasnt_pk( table, description ) should have the proper description
-ok 27 - hasnt_pk( table, description ) should have the proper diagnostics
-ok 28 - hasnt_pk( table ) should fail
-ok 29 - hasnt_pk( table ) should have the proper description
-ok 30 - hasnt_pk( table ) should have the proper diagnostics
-ok 31 - hasnt_pk( schema, table, description ) pass should pass
-ok 32 - hasnt_pk( schema, table, description ) pass should have the proper description
-ok 33 - hasnt_pk( schema, table, description ) pass should have the proper diagnostics
-ok 34 - hasnt_pk( table, description ) pass should pass
-ok 35 - hasnt_pk( table, description ) pass should have the proper description
-ok 36 - hasnt_pk( table, description ) pass should have the proper diagnostics
-ok 37 - col_is_pk( schema, table, column, description ) should pass
-ok 38 - col_is_pk( schema, table, column, description ) should have the proper description
-ok 39 - col_is_pk( schema, table, column, description ) should have the proper diagnostics
-ok 40 - col_is_pk( schema, table, column ) should pass
-ok 41 - col_is_pk( schema, table, column ) should have the proper description
-ok 42 - col_is_pk( schema, table, column ) should have the proper diagnostics
-ok 43 - col_is_pk( table, column, description ) should pass
-ok 44 - col_is_pk( table, column, description ) should have the proper description
-ok 45 - col_is_pk( table, column, description ) should have the proper diagnostics
-ok 46 - col_is_pk( table, column ) should pass
-ok 47 - col_is_pk( table, column ) should have the proper description
-ok 48 - col_is_pk( table, column ) should have the proper diagnostics
-ok 49 - col_is_pk( schema, table, column, description ) fail should fail
-ok 50 - col_is_pk( schema, table, column, description ) fail should have the proper description
-ok 51 - col_is_pk( schema, table, column, description ) fail should have the proper diagnostics
-ok 52 - col_is_pk( table, column, description ) fail should fail
-ok 53 - col_is_pk( table, column, description ) fail should have the proper description
-ok 54 - col_is_pk( table, column, description ) fail should have the proper diagnostics
-ok 55 - col_is_pk( schema, table, column[], description ) should pass
-ok 56 - col_is_pk( schema, table, column[], description ) should have the proper description
-ok 57 - col_is_pk( schema, table, column[], description ) should have the proper diagnostics
-ok 58 - col_is_pk( schema, table, column[] ) should pass
-ok 59 - col_is_pk( schema, table, column[] ) should have the proper description
-ok 60 - col_is_pk( schema, table, column[] ) should have the proper diagnostics
-ok 61 - col_is_pk( table, column[], description ) should pass
-ok 62 - col_is_pk( table, column[], description ) should have the proper description
-ok 63 - col_is_pk( table, column[], description ) should have the proper diagnostics
-ok 64 - col_is_pk( table, column[] ) should pass
-ok 65 - col_is_pk( table, column[] ) should have the proper description
-ok 66 - col_is_pk( table, column[] ) should have the proper diagnostics
-ok 67 - col_isnt_pk( schema, table, column, description ) should fail
-ok 68 - col_isnt_pk( schema, table, column, description ) should have the proper description
-ok 69 - col_isnt_pk( schema, table, column, description ) should have the proper diagnostics
-ok 70 - col_isnt_pk( table, column, description ) should fail
-ok 71 - col_isnt_pk( table, column, description ) should have the proper description
-ok 72 - col_isnt_pk( table, column, description ) should have the proper diagnostics
-ok 73 - col_isnt_pk( table, column ) should fail
-ok 74 - col_isnt_pk( table, column ) should have the proper description
-ok 75 - col_isnt_pk( table, column ) should have the proper diagnostics
-ok 76 - col_isnt_pk( schema, table, column, description ) pass should pass
-ok 77 - col_isnt_pk( schema, table, column, description ) pass should have the proper description
-ok 78 - col_isnt_pk( schema, table, column, description ) pass should have the proper diagnostics
-ok 79 - col_isnt_pk( table, column, description ) pass should pass
-ok 80 - col_isnt_pk( table, column, description ) pass should have the proper description
-ok 81 - col_isnt_pk( table, column, description ) pass should have the proper diagnostics
-ok 82 - col_isnt_pk( schema, table, column[], description ) should pass
-ok 83 - col_isnt_pk( schema, table, column[], description ) should have the proper description
-ok 84 - col_isnt_pk( schema, table, column[], description ) should have the proper diagnostics
-ok 85 - col_isnt_pk( table, column[], description ) should pass
-ok 86 - col_isnt_pk( table, column[], description ) should have the proper description
-ok 87 - col_isnt_pk( table, column[], description ) should have the proper diagnostics
-ok 88 - col_isnt_pk( table, column[] ) should pass
-ok 89 - col_isnt_pk( table, column[] ) should have the proper description
-ok 90 - col_isnt_pk( table, column[] ) should have the proper diagnostics
+ok 4 - has_pk( schema, table ) should pass
+ok 5 - has_pk( schema, table ) should have the proper description
+ok 6 - has_pk( schema, table ) should have the proper diagnostics
+ok 7 - has_pk( hideschema, hidetable, description ) should pass
+ok 8 - has_pk( hideschema, hidetable, description ) should have the proper description
+ok 9 - has_pk( hideschema, hidetable, description ) should have the proper diagnostics
+ok 10 - has_pk( hideschema, hidetable ) should pass
+ok 11 - has_pk( hideschema, hidetable ) should have the proper description
+ok 12 - has_pk( hideschema, hidetable ) should have the proper diagnostics
+ok 13 - has_pk( table, description ) should pass
+ok 14 - has_pk( table, description ) should have the proper description
+ok 15 - has_pk( table, description ) should have the proper diagnostics
+ok 16 - has_pk( hidetable, description ) fail should fail
+ok 17 - has_pk( hidetable, description ) fail should have the proper description
+ok 18 - has_pk( hidetable, description ) fail should have the proper diagnostics
+ok 19 - has_pk( table ) should pass
+ok 20 - has_pk( table ) should have the proper description
+ok 21 - has_pk( table ) should have the proper diagnostics
+ok 22 - has_pk( schema, table, description ) fail should fail
+ok 23 - has_pk( schema, table, description ) fail should have the proper description
+ok 24 - has_pk( schema, table, description ) fail should have the proper diagnostics
+ok 25 - has_pk( table, description ) fail should fail
+ok 26 - has_pk( table, description ) fail should have the proper description
+ok 27 - has_pk( table, description ) fail should have the proper diagnostics
+ok 28 - hasnt_pk( schema, table, description ) should fail
+ok 29 - hasnt_pk( schema, table, description ) should have the proper description
+ok 30 - hasnt_pk( schema, table, description ) should have the proper diagnostics
+ok 31 - hasnt_pk( table, description ) should fail
+ok 32 - hasnt_pk( table, description ) should have the proper description
+ok 33 - hasnt_pk( table, description ) should have the proper diagnostics
+ok 34 - hasnt_pk( table ) should fail
+ok 35 - hasnt_pk( table ) should have the proper description
+ok 36 - hasnt_pk( table ) should have the proper diagnostics
+ok 37 - hasnt_pk( schema, table, description ) pass should pass
+ok 38 - hasnt_pk( schema, table, description ) pass should have the proper description
+ok 39 - hasnt_pk( schema, table, description ) pass should have the proper diagnostics
+ok 40 - hasnt_pk( table, description ) pass should pass
+ok 41 - hasnt_pk( table, description ) pass should have the proper description
+ok 42 - hasnt_pk( table, description ) pass should have the proper diagnostics
+ok 43 - col_is_pk( schema, table, column, description ) should pass
+ok 44 - col_is_pk( schema, table, column, description ) should have the proper description
+ok 45 - col_is_pk( schema, table, column, description ) should have the proper diagnostics
+ok 46 - col_is_pk( schema, table, column ) should pass
+ok 47 - col_is_pk( schema, table, column ) should have the proper description
+ok 48 - col_is_pk( schema, table, column ) should have the proper diagnostics
+ok 49 - col_is_pk( table, column, description ) should pass
+ok 50 - col_is_pk( table, column, description ) should have the proper description
+ok 51 - col_is_pk( table, column, description ) should have the proper diagnostics
+ok 52 - col_is_pk( table, column ) should pass
+ok 53 - col_is_pk( table, column ) should have the proper description
+ok 54 - col_is_pk( table, column ) should have the proper diagnostics
+ok 55 - col_is_pk( schema, table, column, description ) fail should fail
+ok 56 - col_is_pk( schema, table, column, description ) fail should have the proper description
+ok 57 - col_is_pk( schema, table, column, description ) fail should have the proper diagnostics
+ok 58 - col_is_pk( table, column, description ) fail should fail
+ok 59 - col_is_pk( table, column, description ) fail should have the proper description
+ok 60 - col_is_pk( table, column, description ) fail should have the proper diagnostics
+ok 61 - col_is_pk( schema, table, column[], description ) should pass
+ok 62 - col_is_pk( schema, table, column[], description ) should have the proper description
+ok 63 - col_is_pk( schema, table, column[], description ) should have the proper diagnostics
+ok 64 - col_is_pk( schema, table, column[] ) should pass
+ok 65 - col_is_pk( schema, table, column[] ) should have the proper description
+ok 66 - col_is_pk( schema, table, column[] ) should have the proper diagnostics
+ok 67 - col_is_pk( table, column[], description ) should pass
+ok 68 - col_is_pk( table, column[], description ) should have the proper description
+ok 69 - col_is_pk( table, column[], description ) should have the proper diagnostics
+ok 70 - col_is_pk( table, column[] ) should pass
+ok 71 - col_is_pk( table, column[] ) should have the proper description
+ok 72 - col_is_pk( table, column[] ) should have the proper diagnostics
+ok 73 - col_isnt_pk( schema, table, column, description ) should fail
+ok 74 - col_isnt_pk( schema, table, column, description ) should have the proper description
+ok 75 - col_isnt_pk( schema, table, column, description ) should have the proper diagnostics
+ok 76 - col_isnt_pk( table, column, description ) should fail
+ok 77 - col_isnt_pk( table, column, description ) should have the proper description
+ok 78 - col_isnt_pk( table, column, description ) should have the proper diagnostics
+ok 79 - col_isnt_pk( table, column ) should fail
+ok 80 - col_isnt_pk( table, column ) should have the proper description
+ok 81 - col_isnt_pk( table, column ) should have the proper diagnostics
+ok 82 - col_isnt_pk( schema, table, column, description ) pass should pass
+ok 83 - col_isnt_pk( schema, table, column, description ) pass should have the proper description
+ok 84 - col_isnt_pk( schema, table, column, description ) pass should have the proper diagnostics
+ok 85 - col_isnt_pk( table, column, description ) pass should pass
+ok 86 - col_isnt_pk( table, column, description ) pass should have the proper description
+ok 87 - col_isnt_pk( table, column, description ) pass should have the proper diagnostics
+ok 88 - col_isnt_pk( schema, table, column[], description ) should pass
+ok 89 - col_isnt_pk( schema, table, column[], description ) should have the proper description
+ok 90 - col_isnt_pk( schema, table, column[], description ) should have the proper diagnostics
+ok 91 - col_isnt_pk( table, column[], description ) should pass
+ok 92 - col_isnt_pk( table, column[], description ) should have the proper description
+ok 93 - col_isnt_pk( table, column[], description ) should have the proper diagnostics
+ok 94 - col_isnt_pk( table, column[] ) should pass
+ok 95 - col_isnt_pk( table, column[] ) should have the proper description
+ok 96 - col_isnt_pk( table, column[] ) should have the proper diagnostics

test/sql/pktap.sql

@@ -1,7 +1,8 @@
 \unset ECHO
 \i test/setup.sql
+-- \i sql/pgtap.sql
 
-SELECT plan(90);
+SELECT plan(96);
 --SELECT * FROM no_plan();
 
 -- This will be rolled back. :-)
@@ -37,6 +38,14 @@ SELECT * FROM check_test(
     ''
 );
 
+SELECT * FROM check_test(
+    has_pk( 'public', 'sometab'::name ),
+    true,
+    'has_pk( schema, table )',
+    'Table public.sometab should have a primary key',
+    ''
+);
+
 SELECT * FROM check_test(
     has_pk( 'hide', 'hidesometab', 'hide.sometab should have a pk' ),
     true,
@@ -45,6 +54,14 @@ SELECT * FROM check_test(
     ''
 );
 
+SELECT * FROM check_test(
+    has_pk( 'hide', 'hidesometab'::name ),
+    true,
+    'has_pk( hideschema, hidetable )',
+    'Table hide.hidesometab should have a primary key',
+    ''
+);
+
 SELECT * FROM check_test(
     has_pk( 'sometab', 'sometab should have a pk' ),
     true,