Skip to content

Commit e1bd499

Browse files
tglsfdctglsfdc
committed
Add test for session_preload_libraries and parameter permissions checks.
We weren't exercising the session_preload_libraries option in any meaningful way. auto_explain is a good testbed for doing so, since it's one of the primary use-cases for session_preload_libraries. Hence, adjust its TAP test to load the library via session_preload_libraries not shared_preload_libraries. While at it, feed test-specific settings to the backend via PGOPTIONS rather than tediously rewriting postgresql.conf. Also, since auto_explain has some PGC_SUSET parameters, we can use it to provide a test case for the permissions-checking bug just fixed by commit b35617d. Back-patch to v15 so that we have coverage for the permissions issue in that branch too. To do that, I back-patched the refactoring recently done by commit 550bc0a. Dagfinn Ilmari Mannsåker and Tom Lane Discussion: https://postgr.es/m/CABwTF4VEpwTHhRQ+q5MiC5ucngN-whN-PdcKeufX7eLSoAfbZA@mail.gmail.com
1 parent 31ed3cf commit e1bd499

File tree

1 file changed

+108
-17
lines changed

1 file changed

+108
-17
lines changed

‎contrib/auto_explain/t/001_auto_explain.pl

Lines changed: 108 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,50 +8,141 @@
88
use PostgreSQL::Test::Utils;
99
use Test::More;
1010

11+
# Runs the specified query and returns the emitted server log.
12+
# params is an optional hash mapping GUC names to values;
13+
# any such settings are transmitted to the backend via PGOPTIONS.
14+
sub query_log
15+
{
16+
my ($node, $sql, $params) = @_;
17+
$params ||= {};
18+
19+
local $ENV{PGOPTIONS} = join " ",
20+
map { "-c $_=$params->{$_}" } keys %$params;
21+
22+
my $log = $node->logfile();
23+
my $offset = -s $log;
24+
25+
$node->safe_psql("postgres", $sql);
26+
27+
return slurp_file($log, $offset);
28+
}
29+
1130
my $node = PostgreSQL::Test::Cluster->new('main');
1231
$node->init;
1332
$node->append_conf('postgresql.conf',
14-
"shared_preload_libraries = 'auto_explain'");
33+
"session_preload_libraries = 'auto_explain'");
1534
$node->append_conf('postgresql.conf', "auto_explain.log_min_duration = 0");
1635
$node->append_conf('postgresql.conf', "auto_explain.log_analyze = on");
1736
$node->start;
1837

19-
# run a couple of queries
20-
$node->safe_psql("postgres", "SELECT * FROM pg_class;");
21-
$node->safe_psql("postgres",
22-
"SELECT * FROM pg_proc WHERE proname = 'int4pl';");
38+
# Simple query.
39+
my $log_contents = query_log($node, "SELECT * FROM pg_class;");
2340

24-
# emit some json too
25-
$node->append_conf('postgresql.conf', "auto_explain.log_format = json");
26-
$node->reload;
27-
$node->safe_psql("postgres", "SELECT * FROM pg_proc;");
28-
$node->safe_psql("postgres",
29-
"SELECT * FROM pg_class WHERE relname = 'pg_class';");
30-
31-
$node->stop('fast');
32-
33-
my $log = $node->logfile();
41+
like(
42+
$log_contents,
43+
qr/Query Text: SELECT \* FROM pg_class;/,
44+
"query text logged, text mode");
3445

35-
my $log_contents = slurp_file($log);
46+
unlike(
47+
$log_contents,
48+
qr/Query Parameters:/,
49+
"no query parameters logged when none, text mode");
3650

3751
like(
3852
$log_contents,
3953
qr/Seq Scan on pg_class/,
4054
"sequential scan logged, text mode");
4155

56+
# Prepared query.
57+
$log_contents = query_log($node,
58+
q{PREPARE get_proc(name) AS SELECT * FROM pg_proc WHERE proname = $1; EXECUTE get_proc('int4pl');}
59+
);
60+
61+
like(
62+
$log_contents,
63+
qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
64+
"prepared query text logged, text mode");
65+
4266
like(
4367
$log_contents,
4468
qr/Index Scan using pg_proc_proname_args_nsp_index on pg_proc/,
4569
"index scan logged, text mode");
4670

71+
72+
# JSON format.
73+
$log_contents = query_log(
74+
$node,
75+
"SELECT * FROM pg_class;",
76+
{ "auto_explain.log_format" => "json" });
77+
78+
like(
79+
$log_contents,
80+
qr/"Query Text": "SELECT \* FROM pg_class;"/,
81+
"query text logged, json mode");
82+
83+
unlike(
84+
$log_contents,
85+
qr/"Query Parameters":/,
86+
"query parameters not logged when none, json mode");
87+
4788
like(
4889
$log_contents,
49-
qr/"Node Type": "Seq Scan"[^}]*"Relation Name": "pg_proc"/s,
90+
qr/"Node Type": "Seq Scan"[^}]*"Relation Name": "pg_class"/s,
5091
"sequential scan logged, json mode");
5192

93+
# Prepared query in JSON format.
94+
$log_contents = query_log(
95+
$node,
96+
q{PREPARE get_class(name) AS SELECT * FROM pg_class WHERE relname = $1; EXECUTE get_class('pg_class');},
97+
{ "auto_explain.log_format" => "json" });
98+
99+
like(
100+
$log_contents,
101+
qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
102+
"prepared query text logged, json mode");
103+
52104
like(
53105
$log_contents,
54106
qr/"Node Type": "Index Scan"[^}]*"Index Name": "pg_class_relname_nsp_index"/s,
55107
"index scan logged, json mode");
56108

109+
# Check that PGC_SUSET parameters can be set by non-superuser if granted,
110+
# otherwise not
111+
112+
$node->safe_psql(
113+
"postgres", q{
114+
CREATE USER regress_user1;
115+
GRANT SET ON PARAMETER auto_explain.log_format TO regress_user1;
116+
});
117+
118+
$ENV{PGUSER} = "regress_user1";
119+
120+
$log_contents = query_log(
121+
$node,
122+
"SELECT * FROM pg_database;",
123+
{ "auto_explain.log_format" => "json" });
124+
125+
like(
126+
$log_contents,
127+
qr/"Query Text": "SELECT \* FROM pg_database;"/,
128+
"query text logged, json mode selected by non-superuser");
129+
130+
$log_contents = query_log(
131+
$node,
132+
"SELECT * FROM pg_database;",
133+
{ "auto_explain.log_level" => "log" });
134+
135+
like(
136+
$log_contents,
137+
qr/WARNING: permission denied to set parameter "auto_explain\.log_level"/,
138+
"permission failure logged");
139+
140+
$ENV{PGUSER} = undef;
141+
142+
$node->safe_psql(
143+
"postgres", q{
144+
REVOKE SET ON PARAMETER auto_explain.log_format FROM regress_user1;
145+
DROP USER regress_user1;
146+
});
147+
57148
done_testing();

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy