Improve output of results_eq and results_ne when number of columns or their types are different (#255)

wolfgangwalther · theory · web-flow · commit 986e3d47f0b8 · 2021-10-10T13:33:12.000-04:00
Co-authored-by: David E. Wheeler &lt;david@justatheory.com&gt;
diff --git a/Changes b/Changes
@@ -33,6 +33,8 @@ Revision history for pgTAP
   the pull request (#250).
 * Added `hasnt_operator()`, `hasnt_leftop()`, `hasnt_rightop()` (#38). Thanks to
   Wolfgang Walther for the pull request (#251).
+* Improve output of results_eq and results_ne when number of columns or their
+  types are different (#37).
 
 1.1.0 2019-11-25T19:05:38Z
 --------------------------
diff --git a/compat/install-9.1.patch b/compat/install-9.1.patch
@@ -22,3 +22,21 @@
              END;
  
              -- Always raise an exception to rollback any changes.
+--- sql/pgtap.sql
++++ sql/pgtap.sql
+@@ -6906,7 +6906,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' ||
+@@ -7060,7 +7059,6 @@
+     RETURN ok( false, $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' ||
diff --git a/sql/pgtap--1.1.0--1.2.0.sql b/sql/pgtap--1.1.0--1.2.0.sql
@@ -37,6 +37,91 @@ BEGIN
 END;
 $$ LANGUAGE plpgsql;
 
+-- results_eq( cursor, cursor, description )
+CREATE OR REPLACE FUNCTION results_eq( refcursor, refcursor, text )
+RETURNS TEXT AS $$
+DECLARE
+    have       ALIAS FOR $1;
+    want       ALIAS FOR $2;
+    have_rec   RECORD;
+    want_rec   RECORD;
+    have_found BOOLEAN;
+    want_found BOOLEAN;
+    rownum     INTEGER := 1;
+    err_msg    text := 'details not available in pg <= 9.1';
+BEGIN
+    FETCH have INTO have_rec;
+    have_found := FOUND;
+    FETCH want INTO want_rec;
+    want_found := FOUND;
+    WHILE have_found OR want_found LOOP
+        IF have_rec IS DISTINCT FROM want_rec OR have_found <> want_found THEN
+            RETURN ok( false, $3 ) || E'\n' || diag(
+                '    Results differ beginning at row ' || rownum || E':\n' ||
+                '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
+                '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
+            );
+        END IF;
+        rownum = rownum + 1;
+        FETCH have INTO have_rec;
+        have_found := FOUND;
+        FETCH want INTO want_rec;
+        want_found := FOUND;
+    END LOOP;
+
+    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' ||
+                '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
+                '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
+            END || E'\n        ERROR: ' || err_msg
+        );
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE OR REPLACE FUNCTION results_ne( refcursor, refcursor, text )
+RETURNS TEXT AS $$
+DECLARE
+    have       ALIAS FOR $1;
+    want       ALIAS FOR $2;
+    have_rec   RECORD;
+    want_rec   RECORD;
+    have_found BOOLEAN;
+    want_found BOOLEAN;
+    err_msg    text := 'details not available in pg <= 9.1';
+BEGIN
+    FETCH have INTO have_rec;
+    have_found := FOUND;
+    FETCH want INTO want_rec;
+    want_found := FOUND;
+    WHILE have_found OR want_found LOOP
+        IF have_rec IS DISTINCT FROM want_rec OR have_found <> want_found THEN
+            RETURN ok( true, $3 );
+        ELSE
+            FETCH have INTO have_rec;
+            have_found := FOUND;
+            FETCH want INTO want_rec;
+            want_found := FOUND;
+        END IF;
+    END LOOP;
+    RETURN ok( false, $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' ||
+                '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
+                '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
+            END || E'\n        ERROR: ' || err_msg
+        );
+END;
+$$ LANGUAGE plpgsql;
+=======
 -- hasnt_operator( left_type, schema, name, right_type, return_type, description )
 CREATE OR REPLACE FUNCTION hasnt_operator ( NAME, NAME, NAME, NAME, NAME, TEXT )
 RETURNS TEXT AS $$
@@ -176,50 +261,3 @@ RETURNS TEXT AS $$
          NOT _op_exists($1, $2, NULL ),
         'Right operator ' || $2 || '(' || $1 || ',NONE) should not exist'
     );
-=======
--- isnt_member_of( role, members[], description )
-CREATE OR REPLACE FUNCTION isnt_member_of( NAME, NAME[], TEXT )
-RETURNS TEXT AS $$
-DECLARE
-    extra text[];
-BEGIN
-    IF NOT _has_role($1) THEN
-        RETURN fail( $3 ) || E'\n' || diag (
-            '    Role ' || quote_ident($1) || ' does not exist'
-        );
-    END IF;
-
-    SELECT ARRAY(
-        SELECT quote_ident($2[i])
-          FROM generate_series(1, array_upper($2, 1)) s(i)
-          LEFT JOIN pg_catalog.pg_roles r ON rolname = $2[i]
-         WHERE r.oid = ANY ( _grolist($1) )
-         ORDER BY s.i
-    ) INTO extra;
-    IF extra[1] IS NULL THEN
-        RETURN ok( true, $3 );
-    END IF;
-    RETURN ok( false, $3 ) || E'\n' || diag(
-        '    Members, who should not be in ' || quote_ident($1) || E' role:\n        ' ||
-        array_to_string( extra, E'\n        ')
-    );
-END;
-$$ LANGUAGE plpgsql;
-
--- isnt_member_of( role, member, description )
-CREATE OR REPLACE FUNCTION isnt_member_of( NAME, NAME, TEXT )
-RETURNS TEXT AS $$
-    SELECT isnt_member_of( $1, ARRAY[$2], $3 );
-$$ LANGUAGE SQL;
-
--- isnt_member_of( role, members[] )
-CREATE OR REPLACE FUNCTION isnt_member_of( NAME, NAME[] )
-RETURNS TEXT AS $$
-    SELECT isnt_member_of( $1, $2, 'Should not have members of role ' || quote_ident($1) );
-$$ LANGUAGE SQL;
-
--- isnt_member_of( role, member )
-CREATE OR REPLACE FUNCTION isnt_member_of( NAME, NAME )
-RETURNS TEXT AS $$
-    SELECT isnt_member_of( $1, ARRAY[$2] );
-$$ LANGUAGE SQL;
diff --git a/sql/pgtap.sql.in b/sql/pgtap.sql.in
@@ -7070,6 +7070,7 @@ DECLARE
     have_found BOOLEAN;
     want_found BOOLEAN;
     rownum     INTEGER := 1;
+    err_msg    text := 'details not available in pg <= 9.1';
 BEGIN
     FETCH have INTO have_rec;
     have_found := FOUND;
@@ -7093,12 +7094,13 @@ BEGIN
     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' ||
                 '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
                 '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
-            END
+            END || E'\n        ERROR: ' || err_msg
         );
 END;
 $$ LANGUAGE plpgsql;
@@ -7227,6 +7229,7 @@ DECLARE
     want_rec   RECORD;
     have_found BOOLEAN;
     want_found BOOLEAN;
+    err_msg    text := 'details not available in pg <= 9.1';
 BEGIN
     FETCH have INTO have_rec;
     have_found := FOUND;
@@ -7245,10 +7248,13 @@ BEGIN
     RETURN ok( false, $3 );
 EXCEPTION
     WHEN datatype_mismatch THEN
+        GET STACKED DIAGNOSTICS err_msg = MESSAGE_TEXT;
         RETURN ok( false, $3 ) || E'\n' || diag(
-            E'    Columns differ between queries:\n' ||
-            '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
-            '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
+            E'    Number of columns or their types differ between the queries' ||
+            CASE WHEN have_rec::TEXT = want_rec::text THEN '' ELSE E':\n' ||
+                '        have: ' || CASE WHEN have_found THEN have_rec::text ELSE 'NULL' END || E'\n' ||
+                '        want: ' || CASE WHEN want_found THEN want_rec::text ELSE 'NULL' END
+            END || E'\n        ERROR: ' || err_msg
         );
 END;
 $$ LANGUAGE plpgsql;
diff --git a/test/sql/resultset.sql b/test/sql/resultset.sql
@@ -981,11 +981,20 @@ SELECT * FROM check_test(
     false,
     'results_eq(values, values) mismatch',
     '',
-    CASE WHEN pg_version_num() < 80400 THEN '    Results differ beginning at row 1:' ELSE '    Number of columns or their types differ between the queries:' END || '
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries:
         have: (1,foo)
-        want: (foo,1)'
+        want: (foo,1)
+        ERROR: cannot compare dissimilar column types integer and text at record column 1'
+    ELSE
+      '    Number of columns or their types differ between the queries:
+        have: (1,foo)
+        want: (foo,1)
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
+-- Handle failure due to more subtle column mismatch
 SELECT * FROM check_test(
     results_eq(
         'VALUES (1, ''foo''::varchar), (2, ''bar''::varchar)',
@@ -994,7 +1003,13 @@ SELECT * FROM check_test(
     false,
     'results_eq(values, values) subtle mismatch',
     '',
-    '    Number of columns or their types differ between the queries'
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries
+        ERROR: cannot compare dissimilar column types character varying and text at record column 2'
+    ELSE
+      '    Number of columns or their types differ between the queries
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 SELECT * FROM check_test(
@@ -1005,21 +1020,35 @@ SELECT * FROM check_test(
     false,
     'results_eq(values, values) integer type mismatch',
     '',
-    '    Number of columns or their types differ between the queries'
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries
+        ERROR: cannot compare dissimilar column types integer and bigint at record column 1'
+    ELSE
+      '    Number of columns or their types differ between the queries
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 -- Handle failure due to column count mismatch.
 SELECT * FROM check_test(
     results_eq(
         'SELECT pk from dubs ORDER BY pk LIMIT 2',
-        'SELECT name, pk from dubs ORDER BY pk LIMIT 2'
+        'SELECT pk, name from dubs ORDER BY pk LIMIT 2'
     ),
     false,
     'results_eq(values, values) fail column count',
     '',
-    CASE WHEN pg_version_num() < 80400 THEN '    Results differ beginning at row 1:' ELSE '    Number of columns or their types differ between the queries:' END || '
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries:
+        have: (1)
+        want: (1,foo)
+        ERROR: cannot compare record types with different numbers of columns'
+    ELSE
+      '    Number of columns or their types differ between the queries:
         have: (1)
-        want: (foo,1)'
+        want: (1,foo)
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 -- Compare with cursors.
@@ -2135,9 +2164,17 @@ SELECT * FROM check_test(
     false,
     'results_ne(values, values) mismatch',
     '',
-    '    Columns differ between queries:
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries:
         have: (1,foo)
-        want: (foo,1)'
+        want: (foo,1)
+        ERROR: cannot compare dissimilar column types integer and text at record column 1'
+    ELSE
+      '    Number of columns or their types differ between the queries:
+        have: (1,foo)
+        want: (foo,1)
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 -- Handle failure due to subtle column mismatch.
@@ -2149,20 +2186,32 @@ SELECT * FROM check_test(
     false,
     'results_ne(values, values) subtle mismatch',
     '',
-    '    Columns differ between queries:
-        have: (1,foo)
-        want: (1,foo)'
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries
+        ERROR: cannot compare dissimilar column types character varying and text at record column 2'
+    ELSE
+      '    Number of columns or their types differ between the queries
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 -- Handle failure due to column count mismatch.
 SELECT * FROM check_test(
-    results_ne( 'VALUES (1), (2)', 'VALUES (''foo'', 1), (''bar'', 2)' ),
+    results_ne( 'VALUES (1), (2)', 'VALUES (1, ''foo''), (2, ''bar'')' ),
     false,
     'results_ne(values, values) fail column count',
     '',
-    '    Columns differ between queries:
+    CASE WHEN pg_version_num() >= 90200 THEN
+      '    Number of columns or their types differ between the queries:
+        have: (1)
+        want: (1,foo)
+        ERROR: cannot compare record types with different numbers of columns'
+    ELSE
+      '    Number of columns or their types differ between the queries:
         have: (1)
-        want: (foo,1)'
+        want: (1,foo)
+        ERROR: details not available in pg <= 9.1'
+    END
 );
 
 -- Compare with cursors.
diff --git a/test/sql/valueset.sql b/test/sql/valueset.sql
diff --git a/test/test_MVU.sh b/test/test_MVU.sh
