From b7d39e5695ef1cdcdc53f6b811b947c186f7a433 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Wed, 25 Oct 2023 10:43:05 +0900 Subject: [PATCH 2/2] Add test module for injection points --- src/test/modules/Makefile | 1 + src/test/modules/meson.build | 1 + .../modules/test_injection_points/.gitignore | 4 + .../modules/test_injection_points/Makefile | 22 +++++ .../expected/test_injection_points.out | 45 ++++++++++ .../expected/test_injection_points_1.out | 32 +++++++ .../modules/test_injection_points/meson.build | 33 +++++++ .../sql/test_injection_points.sql | 15 ++++ .../test_injection_points--1.0.sql | 36 ++++++++ .../test_injection_points.c | 88 +++++++++++++++++++ .../test_injection_points.control | 4 + doc/src/sgml/xfunc.sgml | 3 + 12 files changed, 284 insertions(+) create mode 100644 src/test/modules/test_injection_points/.gitignore create mode 100644 src/test/modules/test_injection_points/Makefile create mode 100644 src/test/modules/test_injection_points/expected/test_injection_points.out create mode 100644 src/test/modules/test_injection_points/expected/test_injection_points_1.out create mode 100644 src/test/modules/test_injection_points/meson.build create mode 100644 src/test/modules/test_injection_points/sql/test_injection_points.sql create mode 100644 src/test/modules/test_injection_points/test_injection_points--1.0.sql create mode 100644 src/test/modules/test_injection_points/test_injection_points.c create mode 100644 src/test/modules/test_injection_points/test_injection_points.control diff --git a/src/test/modules/Makefile b/src/test/modules/Makefile index e81873cb5ae..a0ca613b1cf 100644 --- a/src/test/modules/Makefile +++ b/src/test/modules/Makefile @@ -19,6 +19,7 @@ SUBDIRS = \ test_ddl_deparse \ test_extensions \ test_ginpostinglist \ + test_injection_points \ test_integerset \ test_lfind \ test_misc \ diff --git a/src/test/modules/meson.build b/src/test/modules/meson.build index fcd643f6f10..67e9eff878a 100644 --- a/src/test/modules/meson.build +++ b/src/test/modules/meson.build @@ -16,6 +16,7 @@ subdir('test_custom_rmgrs') subdir('test_ddl_deparse') subdir('test_extensions') subdir('test_ginpostinglist') +subdir('test_injection_points') subdir('test_integerset') subdir('test_lfind') subdir('test_misc') diff --git a/src/test/modules/test_injection_points/.gitignore b/src/test/modules/test_injection_points/.gitignore new file mode 100644 index 00000000000..5dcb3ff9723 --- /dev/null +++ b/src/test/modules/test_injection_points/.gitignore @@ -0,0 +1,4 @@ +# Generated subdirectories +/log/ +/results/ +/tmp_check/ diff --git a/src/test/modules/test_injection_points/Makefile b/src/test/modules/test_injection_points/Makefile new file mode 100644 index 00000000000..65bcdde782f --- /dev/null +++ b/src/test/modules/test_injection_points/Makefile @@ -0,0 +1,22 @@ +# src/test/modules/test_injection_points/Makefile + +MODULE_big = test_injection_points +OBJS = \ + $(WIN32RES) \ + test_injection_points.o +PGFILEDESC = "test_injection_points - test injection points" + +EXTENSION = test_injection_points +DATA = test_injection_points--1.0.sql +REGRESS = test_injection_points + +ifdef USE_PGXS +PG_CONFIG = pg_config +PGXS := $(shell $(PG_CONFIG) --pgxs) +include $(PGXS) +else +subdir = src/test/modules/test_injection_points +top_builddir = ../../../.. +include $(top_builddir)/src/Makefile.global +include $(top_srcdir)/contrib/contrib-global.mk +endif diff --git a/src/test/modules/test_injection_points/expected/test_injection_points.out b/src/test/modules/test_injection_points/expected/test_injection_points.out new file mode 100644 index 00000000000..c85639146cd --- /dev/null +++ b/src/test/modules/test_injection_points/expected/test_injection_points.out @@ -0,0 +1,45 @@ +CREATE EXTENSION test_injection_points; +SELECT test_injection_points_create('TestInjectionBooh', 'booh'); +ERROR: incorrect mode "booh" for injection point creation +SELECT test_injection_points_create('TestInjectionError', 'error'); + test_injection_points_create +------------------------------ + +(1 row) + +SELECT test_injection_points_create('TestInjectionLog', 'notice'); + test_injection_points_create +------------------------------ + +(1 row) + +SELECT test_injection_points_run('TestInjectionBooh'); -- nothing happens + test_injection_points_run +--------------------------- + +(1 row) + +SELECT test_injection_points_run('TestInjectionLog'); +NOTICE: notice triggered for injection point TestInjectionLog + test_injection_points_run +--------------------------- + +(1 row) + +SELECT test_injection_points_run('TestInjectionError'); +ERROR: error triggered for injection point TestInjectionError +SELECT test_injection_points_drop('TestInjectionError'); -- ok + test_injection_points_drop +---------------------------- + +(1 row) + +SELECT test_injection_points_drop('TestInjectionLog'); -- ok + test_injection_points_drop +---------------------------- + +(1 row) + +SELECT test_injection_points_drop('TestInjectionLog'); -- fails +ERROR: injection point "TestInjectionLog" not found +DROP EXTENSION test_injection_points; diff --git a/src/test/modules/test_injection_points/expected/test_injection_points_1.out b/src/test/modules/test_injection_points/expected/test_injection_points_1.out new file mode 100644 index 00000000000..68d14b2d5ca --- /dev/null +++ b/src/test/modules/test_injection_points/expected/test_injection_points_1.out @@ -0,0 +1,32 @@ +CREATE EXTENSION test_injection_points; +SELECT test_injection_points_create('TestInjectionBooh', 'booh'); +ERROR: incorrect mode "booh" for injection point creation +SELECT test_injection_points_create('TestInjectionError', 'error'); +ERROR: Injection points are not supported by this build +SELECT test_injection_points_create('TestInjectionLog', 'notice'); +ERROR: Injection points are not supported by this build +SELECT test_injection_points_run('TestInjectionBooh'); -- nothing happens + test_injection_points_run +--------------------------- + +(1 row) + +SELECT test_injection_points_run('TestInjectionLog'); + test_injection_points_run +--------------------------- + +(1 row) + +SELECT test_injection_points_run('TestInjectionError'); + test_injection_points_run +--------------------------- + +(1 row) + +SELECT test_injection_points_drop('TestInjectionError'); -- ok +ERROR: Injection points are not supported by this build +SELECT test_injection_points_drop('TestInjectionLog'); -- ok +ERROR: Injection points are not supported by this build +SELECT test_injection_points_drop('TestInjectionLog'); -- fails +ERROR: Injection points are not supported by this build +DROP EXTENSION test_injection_points; diff --git a/src/test/modules/test_injection_points/meson.build b/src/test/modules/test_injection_points/meson.build new file mode 100644 index 00000000000..49e29ac8a9a --- /dev/null +++ b/src/test/modules/test_injection_points/meson.build @@ -0,0 +1,33 @@ +# Copyright (c) 2022-2023, PostgreSQL Global Development Group + +test_injection_points_sources = files( + 'test_injection_points.c', +) + +if host_system == 'windows' + test_injection_points_sources += rc_lib_gen.process(win32ver_rc, extra_args: [ + '--NAME', 'test_injection_points', + '--FILEDESC', 'test_injection_points - test injection points',]) +endif + +test_injection_points = shared_module('test_injection_points', + test_injection_points_sources, + kwargs: pg_test_mod_args, +) +test_install_libs += test_injection_points + +test_install_data += files( + 'test_injection_points.control', + 'test_injection_points--1.0.sql', +) + +tests += { + 'name': 'test_injection_points', + 'sd': meson.current_source_dir(), + 'bd': meson.current_build_dir(), + 'regress': { + 'sql': [ + 'test_injection_points', + ], + }, +} diff --git a/src/test/modules/test_injection_points/sql/test_injection_points.sql b/src/test/modules/test_injection_points/sql/test_injection_points.sql new file mode 100644 index 00000000000..44135c7c374 --- /dev/null +++ b/src/test/modules/test_injection_points/sql/test_injection_points.sql @@ -0,0 +1,15 @@ +CREATE EXTENSION test_injection_points; + +SELECT test_injection_points_create('TestInjectionBooh', 'booh'); +SELECT test_injection_points_create('TestInjectionError', 'error'); +SELECT test_injection_points_create('TestInjectionLog', 'notice'); + +SELECT test_injection_points_run('TestInjectionBooh'); -- nothing happens +SELECT test_injection_points_run('TestInjectionLog'); +SELECT test_injection_points_run('TestInjectionError'); + +SELECT test_injection_points_drop('TestInjectionError'); -- ok +SELECT test_injection_points_drop('TestInjectionLog'); -- ok +SELECT test_injection_points_drop('TestInjectionLog'); -- fails + +DROP EXTENSION test_injection_points; diff --git a/src/test/modules/test_injection_points/test_injection_points--1.0.sql b/src/test/modules/test_injection_points/test_injection_points--1.0.sql new file mode 100644 index 00000000000..c4c42b5b699 --- /dev/null +++ b/src/test/modules/test_injection_points/test_injection_points--1.0.sql @@ -0,0 +1,36 @@ +/* src/test/modules/test_injection_points/test_injection_points--1.0.sql */ + +-- complain if script is sourced in psql, rather than via CREATE EXTENSION +\echo Use "CREATE EXTENSION test_injection_points" to load this file. \quit + +-- +-- test_injection_points_create() +-- +-- Creates an injection point using callbacks from one of the predefined +-- modes. +-- +CREATE FUNCTION test_injection_points_create(IN point_name TEXT, + IN mode text) +RETURNS void +AS 'MODULE_PATHNAME', 'test_injection_points_create' +LANGUAGE C STRICT PARALLEL UNSAFE; + +-- +-- test_injection_points_run() +-- +-- Executes an injection point. +-- +CREATE FUNCTION test_injection_points_run(IN point_name TEXT) +RETURNS void +AS 'MODULE_PATHNAME', 'test_injection_points_run' +LANGUAGE C STRICT PARALLEL UNSAFE; + +-- +-- test_injection_points_drop() +-- +-- Drops an injection point. +-- +CREATE FUNCTION test_injection_points_drop(IN point_name TEXT) +RETURNS void +AS 'MODULE_PATHNAME', 'test_injection_points_drop' +LANGUAGE C STRICT PARALLEL UNSAFE; diff --git a/src/test/modules/test_injection_points/test_injection_points.c b/src/test/modules/test_injection_points/test_injection_points.c new file mode 100644 index 00000000000..a842d837e82 --- /dev/null +++ b/src/test/modules/test_injection_points/test_injection_points.c @@ -0,0 +1,88 @@ +/*-------------------------------------------------------------------------- + * + * test_injection_points.c + * Code for testing injection points. + * + * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group + * Portions Copyright (c) 1994, Regents of the University of California + * + * IDENTIFICATION + * src/test/modules/test_injection_points/test_injection_points.c + * + * Injection points are able to trigger user-defined callbacks in pre-defined + * code paths. + * + * ------------------------------------------------------------------------- + */ + +#include "postgres.h" + +#include "fmgr.h" +#include "utils/builtins.h" +#include "utils/injection_point.h" + +PG_MODULE_MAGIC; + +/* Set of callbacks available at point creation */ +static void +test_injection_error(const char *name) +{ + elog(ERROR, "error triggered for injection point %s", name); +} + +static void +test_injection_notice(const char *name) +{ + elog(NOTICE, "notice triggered for injection point %s", name); +} + +/* + * SQL function for creating an injection point. + */ +PG_FUNCTION_INFO_V1(test_injection_points_create); +Datum +test_injection_points_create(PG_FUNCTION_ARGS) +{ + char *name = text_to_cstring(PG_GETARG_TEXT_PP(0)); + char *mode = text_to_cstring(PG_GETARG_TEXT_PP(1)); + InjectionPointCallback callback; + + if (strcmp(mode, "error") == 0) + callback = test_injection_error; + else if (strcmp(mode, "notice") == 0) + callback = test_injection_notice; + else + elog(ERROR, "incorrect mode \"%s\" for injection point creation", mode); + + InjectionPointCreate(name, callback); + + PG_RETURN_VOID(); +} + +/* + * SQL function for triggering an injection point. + */ +PG_FUNCTION_INFO_V1(test_injection_points_run); +Datum +test_injection_points_run(PG_FUNCTION_ARGS) +{ + char *name = text_to_cstring(PG_GETARG_TEXT_PP(0)); + + INJECTION_POINT_RUN(name); + + PG_RETURN_VOID(); +} + +/* + * SQL function for dropping an injection point. + */ +PG_FUNCTION_INFO_V1(test_injection_points_drop); +Datum +test_injection_points_drop(PG_FUNCTION_ARGS) +{ + char *name = text_to_cstring(PG_GETARG_TEXT_PP(0)); + + InjectionPointDrop(name); + + PG_RETURN_VOID(); +} diff --git a/src/test/modules/test_injection_points/test_injection_points.control b/src/test/modules/test_injection_points/test_injection_points.control new file mode 100644 index 00000000000..a13657cfc65 --- /dev/null +++ b/src/test/modules/test_injection_points/test_injection_points.control @@ -0,0 +1,4 @@ +comment = 'Test code for injection points' +default_version = '1.0' +module_pathname = '$libdir/test_injection_points' +relocatable = true diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index e8dd262152e..de1b4a627d3 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -3530,6 +3530,9 @@ extern void InjectionPointDrop(const char *name); from configure or from Meson. + An example can be found in + src/test/modules/test_injection_points in the + PostgreSQL source tree. -- 2.42.0