Skip to content

Commit 3e49a5f

Browse files
jfrochejfroche
committed
feat: multiple versions for the pgaudit extension
Build multiple versions of the pgaudit extension on different PostgreSQL versions. Add test for the extensions and their upgrade on PostgreSQL 15 and 17.
1 parent daf0108 commit 3e49a5f

File tree

3 files changed

+300
-41
lines changed

3 files changed

+300
-41
lines changed

‎nix/ext/pgaudit.nix‎

Lines changed: 115 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,135 @@
11
{
22
lib,
33
stdenv,
4+
buildEnv,
45
fetchFromGitHub,
56
libkrb5,
67
openssl,
78
postgresql,
89
}:
910
#adapted from https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/sql/postgresql/ext/pgaudit.nix
1011
let
11-
source =
12-
{
13-
"17" = {
14-
version = "17.0";
15-
hash = "sha256-3ksq09wiudQPuBQI3dhEQi8IkXKLVIsPFgBnwLiicro=";
16-
};
17-
"16" = {
18-
version = "16.0";
19-
hash = "sha256-8+tGOl1U5y9Zgu+9O5UDDE4bec4B0JC/BQ6GLhHzQzc=";
20-
};
21-
"15" = {
22-
version = "1.7.0";
23-
hash = "sha256-8pShPr4HJaJQPjW1iPJIpj3CutTx8Tgr+rOqoXtgCcw=";
24-
};
25-
}
26-
.${lib.versions.major postgresql.version}
27-
or (throw "Source for pgaudit is not available for ${postgresql.version}");
28-
in
29-
stdenv.mkDerivation {
3012
pname = "pgaudit";
31-
inherit (source) version;
13+
# Load version configuration from external file
14+
allVersions = (builtins.fromJSON (builtins.readFile ./versions.json)).${pname};
3215

33-
src = fetchFromGitHub {
34-
owner = "pgaudit";
35-
repo = "pgaudit";
36-
rev = source.version;
37-
hash = source.hash;
38-
};
16+
# Filter versions compatible with current PostgreSQL version
17+
supportedVersions = lib.filterAttrs (
18+
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
19+
) allVersions;
20+
21+
# Derived version information
22+
versions = lib.naturalSort (lib.attrNames supportedVersions);
23+
latestVersion = lib.last versions;
24+
numberOfVersions = builtins.length versions;
25+
packages = builtins.attrValues (
26+
lib.mapAttrs (name: value: build name value.hash) supportedVersions
27+
);
28+
29+
# Build function for individual pgaudit versions
30+
build =
31+
version: hash:
32+
stdenv.mkDerivation {
33+
inherit pname version;
34+
35+
src = fetchFromGitHub {
36+
owner = "pgaudit";
37+
repo = "pgaudit";
38+
rev = version;
39+
inherit hash;
40+
};
41+
42+
buildInputs = [
43+
libkrb5
44+
openssl
45+
postgresql
46+
];
47+
48+
makeFlags = [ "USE_PGXS=1" ];
3949

40-
buildInputs = [
41-
libkrb5
42-
openssl
43-
postgresql
50+
postBuild =
51+
lib.optionalString (version == "1.7.0") ''
52+
mv ${pname}--1.7.sql ${pname}--1.7.0.sql
53+
cp ${pname}--1.7.0.sql ${pname}--1.6.1--1.7.0.sql
54+
''
55+
+ lib.optionalString (version == "1.7.1") ''
56+
mv ${pname}--1.7--1.7.1.sql ${pname}--1.7.0--1.7.1.sql
57+
'';
58+
59+
installPhase = ''
60+
runHook preInstall
61+
62+
mkdir -p $out/{lib,share/postgresql/extension}
63+
64+
# Install shared library with version suffix
65+
mv ${pname}${postgresql.dlSuffix} $out/lib/${pname}-${version}${postgresql.dlSuffix}
66+
67+
# Install SQL files
68+
sed -i '1s/^/DROP EVENT TRIGGER IF EXISTS pgaudit_ddl_command_end; \n/' *.sql
69+
sed -i '1s/^/DROP EVENT TRIGGER IF EXISTS pgaudit_sql_drop; \n/' *.sql
70+
sed -i 's/CREATE FUNCTION/CREATE OR REPLACE FUNCTION/' *.sql
71+
cp *.sql $out/share/postgresql/extension
72+
73+
# Create version-specific control file
74+
sed -e "/^default_version =/d" \
75+
-e "s|^module_pathname = .*|module_pathname = '\$libdir/${pname}'|" \
76+
${pname}.control > $out/share/postgresql/extension/${pname}--${version}.control
77+
78+
# For the latest version, create default control file and symlink
79+
if [[ "${version}" == "${latestVersion}" ]]; then
80+
{
81+
echo "default_version = '${latestVersion}'"
82+
cat $out/share/postgresql/extension/${pname}--${latestVersion}.control
83+
} > $out/share/postgresql/extension/${pname}.control
84+
ln -sfn ${pname}-${latestVersion}${postgresql.dlSuffix} $out/lib/${pname}${postgresql.dlSuffix}
85+
fi
86+
87+
runHook postInstall
88+
'';
89+
90+
meta = with lib; {
91+
description = "Open Source PostgreSQL Audit Logging";
92+
homepage = "https://github.com/pgaudit/pgaudit";
93+
changelog = "https://github.com/pgaudit/pgaudit/releases/tag/${source.version}";
94+
license = licenses.postgresql;
95+
inherit (postgresql.meta) platforms;
96+
};
97+
};
98+
in
99+
buildEnv {
100+
name = pname;
101+
paths = packages;
102+
pathsToLink = [
103+
"/lib"
104+
"/share/postgresql/extension"
44105
];
106+
postBuild = ''
107+
# checks
108+
(set -x
109+
test "$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)" = "${
110+
toString (numberOfVersions + 1)
111+
}"
112+
)
45113
46-
makeFlags = [ "USE_PGXS=1" ];
114+
# Verify all expected library files are present
115+
expectedFiles=${toString (numberOfVersions + 1)}
116+
actualFiles=$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)
47117
48-
installPhase = ''
49-
install -D -t $out/lib pgaudit${postgresql.dlSuffix}
50-
install -D -t $out/share/postgresql/extension *.sql
51-
install -D -t $out/share/postgresql/extension *.control
118+
if [[ "$actualFiles" != "$expectedFiles" ]]; then
119+
echo "Error: Expected $expectedFiles library files, found $actualFiles"
120+
echo "Files found:"
121+
ls -la $out/lib/${pname}*${postgresql.dlSuffix} || true
122+
exit 1
123+
fi
52124
'';
53125

54-
meta = with lib; {
55-
description = "Open Source PostgreSQL Audit Logging";
56-
homepage = "https://github.com/pgaudit/pgaudit";
57-
changelog = "https://github.com/pgaudit/pgaudit/releases/tag/${source.version}";
58-
platforms = postgresql.meta.platforms;
59-
license = licenses.postgresql;
126+
passthru = {
127+
inherit versions numberOfVersions;
128+
pname = "${pname}-all";
129+
version =
130+
"multi-" + lib.concatStringsSep "-" (map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
131+
defaultSettings = {
132+
"shared_preload_libraries" = pname;
133+
};
60134
};
61135
}

‎nix/ext/tests/pgaudit.nix‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
{ self, pkgs }:
2+
let
3+
pname = "pgaudit";
4+
inherit (pkgs) lib;
5+
installedExtension =
6+
postgresMajorVersion: self.packages.${pkgs.system}."psql_${postgresMajorVersion}/exts/${pname}-all";
7+
versions = postgresqlMajorVersion: (installedExtension postgresqlMajorVersion).versions;
8+
postgresqlWithExtension =
9+
postgresql:
10+
let
11+
majorVersion = lib.versions.major postgresql.version;
12+
pkg = pkgs.buildEnv {
13+
name = "postgresql-${majorVersion}-${pname}";
14+
paths = [
15+
postgresql
16+
postgresql.lib
17+
(installedExtension majorVersion)
18+
];
19+
passthru = {
20+
inherit (postgresql) version psqlSchema;
21+
lib = pkg;
22+
withPackages = _: pkg;
23+
};
24+
nativeBuildInputs = [ pkgs.makeWrapper ];
25+
pathsToLink = [
26+
"/"
27+
"/bin"
28+
"/lib"
29+
];
30+
postBuild = ''
31+
wrapProgram $out/bin/postgres --set NIX_PGLIBDIR $out/lib
32+
wrapProgram $out/bin/pg_ctl --set NIX_PGLIBDIR $out/lib
33+
wrapProgram $out/bin/pg_upgrade --set NIX_PGLIBDIR $out/lib
34+
'';
35+
};
36+
in
37+
pkg;
38+
psql_15 = postgresqlWithExtension self.packages.${pkgs.system}.postgresql_15;
39+
psql_17 = postgresqlWithExtension self.packages.${pkgs.system}.postgresql_17;
40+
in
41+
self.inputs.nixpkgs.lib.nixos.runTest {
42+
name = pname;
43+
hostPkgs = pkgs;
44+
nodes.server =
45+
{ config, ... }:
46+
{
47+
virtualisation = {
48+
forwardPorts = [
49+
{
50+
from = "host";
51+
host.port = 13022;
52+
guest.port = 22;
53+
}
54+
];
55+
};
56+
57+
services.postgresql = {
58+
enable = true;
59+
package = psql_15;
60+
settings = {
61+
"shared_preload_libraries" = pname;
62+
};
63+
};
64+
65+
specialisation.postgresql17.configuration = {
66+
services.postgresql = {
67+
package = lib.mkForce psql_17;
68+
settings = {
69+
"shared_preload_libraries" = pname;
70+
};
71+
};
72+
73+
systemd.services.postgresql-migrate = {
74+
serviceConfig = {
75+
Type = "oneshot";
76+
RemainAfterExit = true;
77+
User = "postgres";
78+
Group = "postgres";
79+
StateDirectory = "postgresql";
80+
WorkingDirectory = "${builtins.dirOf config.services.postgresql.dataDir}";
81+
};
82+
script =
83+
let
84+
oldPostgresql = psql_15;
85+
newPostgresql = psql_17;
86+
oldDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${oldPostgresql.psqlSchema}";
87+
newDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${newPostgresql.psqlSchema}";
88+
in
89+
''
90+
if [[ ! -d ${newDataDir} ]]; then
91+
install -d -m 0700 -o postgres -g postgres "${newDataDir}"
92+
${newPostgresql}/bin/initdb -D "${newDataDir}"
93+
${newPostgresql}/bin/pg_upgrade --old-datadir "${oldDataDir}" --new-datadir "${newDataDir}" \
94+
--old-bindir "${oldPostgresql}/bin" --new-bindir "${newPostgresql}/bin" \
95+
--old-options="-c shared_preload_libraries='pgaudit'" \
96+
--new-options="-c shared_preload_libraries='pgaudit'"
97+
else
98+
echo "${newDataDir} already exists"
99+
fi
100+
'';
101+
};
102+
103+
systemd.services.postgresql = {
104+
after = [ "postgresql-migrate.service" ];
105+
requires = [ "postgresql-migrate.service" ];
106+
};
107+
};
108+
};
109+
testScript =
110+
{ nodes, ... }:
111+
let
112+
pg17-configuration = "${nodes.server.system.build.toplevel}/specialisation/postgresql17";
113+
in
114+
''
115+
versions = {
116+
"15": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "15"))}],
117+
"17": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "17"))}],
118+
}
119+
extension_name = "${pname}"
120+
support_upgrade = True
121+
pg17_configuration = "${pg17-configuration}"
122+
ext_has_background_worker = ${
123+
if (installedExtension "15") ? hasBackgroundWorker then "True" else "False"
124+
}
125+
126+
${builtins.readFile ./lib.py}
127+
128+
start_all()
129+
130+
server.wait_for_unit("multi-user.target")
131+
server.wait_for_unit("postgresql.service")
132+
133+
test = PostgresExtensionTest(server, extension_name, versions, support_upgrade)
134+
135+
with subtest("Check upgrade path with postgresql 15"):
136+
test.check_upgrade_path("15")
137+
138+
last_version = None
139+
with subtest("Check the install of the last version of the extension"):
140+
last_version = test.check_install_last_version("15")
141+
142+
with subtest("switch to postgresql 17"):
143+
server.succeed(
144+
f"{pg17_configuration}/bin/switch-to-configuration test >&2"
145+
)
146+
147+
with subtest("Check last version of the extension after upgrade"):
148+
test.assert_version_matches(last_version)
149+
150+
with subtest("Check upgrade path with postgresql 17"):
151+
test.check_upgrade_path("17")
152+
'';
153+
}

‎nix/ext/versions.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,38 @@
278278
"hash": "sha256-Cpi2iASi1QJoED0Qs1dANqg/BNZTsz5S+pw8iYyW03Y="
279279
}
280280
},
281+
"pgaudit": {
282+
"1.6.1": {
283+
"postgresql": [
284+
"15"
285+
],
286+
"hash": "sha256-vxUDVq7nWkq7Qugy7HJLOXk4B61MSBIYQkzcbU6wSG8="
287+
},
288+
"1.7.0": {
289+
"postgresql": [
290+
"15"
291+
],
292+
"hash": "sha256-8pShPr4HJaJQPjW1iPJIpj3CutTx8Tgr+rOqoXtgCcw="
293+
},
294+
"1.7.1": {
295+
"postgresql": [
296+
"15"
297+
],
298+
"hash": "sha256-emwoTowT7WKFX0RQDqJXjIblrzqaUIUkzqSqBCHVKQ8="
299+
},
300+
"17.0": {
301+
"postgresql": [
302+
"17"
303+
],
304+
"hash": "sha256-3ksq09wiudQPuBQI3dhEQi8IkXKLVIsPFgBnwLiicro="
305+
},
306+
"17.1": {
307+
"postgresql": [
308+
"17"
309+
],
310+
"hash": "sha256-9St/ESPiFq2NiPKqbwHLwkIyATKUkOGxFcUrWgT+Iqo="
311+
}
312+
},
281313
"pgrouting": {
282314
"3.4.1": {
283315
"postgresql": [

0 commit comments

Comments
 (0)