Add test of various escape functions

anarazel · anarazel · commit 01784793fca3 · 2025-02-10T10:03:39.000-05:00
As highlighted by the prior commit, writing correct escape functions is less trivial than one might hope. This test module tries to verify that different escaping functions behave reasonably. It e.g. tests: - Invalidly encoded input to an escape function leads to invalidly encoded output - Trailing incomplete multi-byte characters are handled sensibly - Escaped strings are parsed as single statement by psql's parser (which derives from the backend parser) There are further tests that would be good to add. But even in the current state it was rather useful for writing the fix in the prior commit. Reviewed-by: Noah Misch <noah@leadboat.com> Backpatch-through: 13 Security: CVE-2025-1094
diff --git a/src/test/modules/Makefile b/src/test/modules/Makefile
@@ -18,6 +18,7 @@ SUBDIRS = \
 		  test_copy_callbacks \
 		  test_custom_rmgrs \
 		  test_ddl_deparse \
+		  test_escape \
 		  test_extensions \
 		  test_ginpostinglist \
 		  test_integerset \
diff --git a/src/test/modules/meson.build b/src/test/modules/meson.build
@@ -15,6 +15,7 @@ subdir('test_bloomfilter')
 subdir('test_copy_callbacks')
 subdir('test_custom_rmgrs')
 subdir('test_ddl_deparse')
+subdir('test_escape')
 subdir('test_extensions')
 subdir('test_ginpostinglist')
 subdir('test_integerset')
diff --git a/src/test/modules/test_escape/.gitignore b/src/test/modules/test_escape/.gitignore
@@ -0,0 +1,2 @@
+/tmp_check/
+/test_escape
diff --git a/src/test/modules/test_escape/Makefile b/src/test/modules/test_escape/Makefile
@@ -0,0 +1,27 @@
+# src/test/modules/test_escape/Makefile
+
+PGFILEDESC = "test escape program"
+PGAPPICON = win32
+
+PROGRAM = test_escape
+OBJS = $(WIN32RES) test_escape.o
+
+PG_CPPFLAGS = -I$(libpq_srcdir)
+PG_LIBS_INTERNAL += -L$(top_builddir)/src/fe_utils -lpgfeutils $(libpq_pgport)
+
+NO_INSTALL = 1
+TAP_TESTS = 1
+
+ifdef USE_PGXS
+PG_CONFIG = pg_config
+PGXS := $(shell $(PG_CONFIG) --pgxs)
+include $(PGXS)
+else
+subdir = src/test/modules/test_escape
+top_builddir = ../../../..
+include $(top_builddir)/src/Makefile.global
+include $(top_srcdir)/contrib/contrib-global.mk
+endif
+
+test_escape$(X): | submake-libpgfeutils
+check: test_escape$(X)
diff --git a/src/test/modules/test_escape/meson.build b/src/test/modules/test_escape/meson.build
@@ -0,0 +1,31 @@
+test_escape_sources = files(
+  'test_escape.c',
+)
+
+if host_system == 'windows'
+  test_escape_sources += rc_bin_gen.process(win32ver_rc, extra_args: [
+    '--NAME', 'test_escape',
+    '--FILEDESC', 'test escape program',])
+endif
+
+test_escape = executable('test_escape',
+  test_escape_sources,
+  dependencies: [frontend_code, libpq],
+  kwargs: default_bin_args + {
+    'install': false,
+  }
+)
+testprep_targets += test_escape
+
+
+tests += {
+  'name': 'test_escape',
+  'sd': meson.current_source_dir(),
+  'bd': meson.current_build_dir(),
+  'tap': {
+    'tests': [
+      't/001_test_escape.pl',
+    ],
+    'deps': [test_escape],
+  },
+}
diff --git a/src/test/modules/test_escape/t/001_test_escape.pl b/src/test/modules/test_escape/t/001_test_escape.pl
@@ -0,0 +1,53 @@
+# Copyright (c) 2023-2025, PostgreSQL Global Development Group
+use strict;
+use warnings FATAL => 'all';
+use Config;
+use PostgreSQL::Test::Utils;
+use PostgreSQL::Test::Cluster;
+use Test::More;
+
+my $node = PostgreSQL::Test::Cluster->new('node');
+
+$node->init();
+$node->start();
+
+$node->safe_psql('postgres',
+	q(CREATE DATABASE db_sql_ascii ENCODING "sql_ascii" TEMPLATE template0;));
+
+my $cmd =
+  [ 'test_escape', '--conninfo', $node->connstr . " dbname=db_sql_ascii" ];
+
+# There currently is no good other way to transport test results from a C
+# program that requires just the node being set-up...
+my ($stderr, $stdout);
+my $result = IPC::Run::run $cmd, '>', \$stdout, '2>', \$stderr;
+
+is($result, 1, "test_escape returns 0");
+is($stderr, '', "test_escape stderr is empty");
+
+foreach my $line (split('\n', $stdout))
+{
+	if ($line =~ m/^ok \d+ ?(.*)/)
+	{
+		ok(1, $1);
+	}
+
+	elsif ($line =~ m/^not ok \d+ ?(.*)/)
+	{
+		ok(0, $1);
+	}
+
+	elsif ($line =~ m/^# ?(.*)/)
+	{
+		note $1;
+	}
+	elsif ($line =~ m/^\d+..\d+$/)
+	{
+	}
+	else
+	{
+		BAIL_OUT("no unmapped lines, got $line");
+	}
+}
+
+done_testing();
diff --git a/src/test/modules/test_escape/test_escape.c b/src/test/modules/test_escape/test_escape.c
diff --git a/src/tools/msvc/Mkvcbuild.pm b/src/tools/msvc/Mkvcbuild.pm
diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list
