Skip to content

Commit bc7811c

Browse files
jfrochejfroche
committed
feat: support multiple versions of the pg-safeupdate extension
Build multiple versions of the pg-safeupdate extension on different PostgreSQL versions. Add test for the extension and their upgrade on PostgreSQL 15 and 17.
1 parent 377291a commit bc7811c

File tree

3 files changed

+218
-19
lines changed

3 files changed

+218
-19
lines changed

‎nix/ext/pg-safeupdate.nix‎

Lines changed: 76 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,90 @@
11
{
2+
pkgs,
23
lib,
34
stdenv,
45
fetchFromGitHub,
56
postgresql,
7+
makeWrapper,
8+
switch-ext-version,
69
}:
710

8-
stdenv.mkDerivation rec {
9-
pname = "pg-safeupdate";
10-
version = "1.4";
11+
let
12+
pname = "safeupdate";
13+
build =
14+
version: hash:
15+
stdenv.mkDerivation rec {
16+
inherit pname version;
1117

12-
buildInputs = [ postgresql ];
18+
buildInputs = [ postgresql ];
1319

14-
src = fetchFromGitHub {
15-
owner = "eradman";
16-
repo = pname;
17-
rev = version;
18-
hash = "sha256-1cyvVEC9MQGMr7Tg6EUbsVBrMc8ahdFS3+CmDkmAq4Y=";
19-
};
20+
src = fetchFromGitHub {
21+
owner = "eradman";
22+
repo = pname;
23+
rev = version;
24+
inherit hash;
25+
};
26+
27+
installPhase = ''
28+
runHook preInstall
29+
30+
mkdir -p $out/share/postgresql/extension
31+
32+
# Install versioned library
33+
install -Dm755 ${pname}${postgresql.dlSuffix} $out/lib/${pname}-${version}${postgresql.dlSuffix}
34+
35+
runHook postInstall
36+
'';
37+
38+
meta = with lib; {
39+
description = "A simple extension to PostgreSQL that requires criteria for UPDATE and DELETE";
40+
homepage = "https://github.com/eradman/pg-safeupdate";
41+
changelog = "https://github.com/eradman/pg-safeupdate/raw/${src.rev}/NEWS";
42+
platforms = postgresql.meta.platforms;
43+
license = licenses.postgresql;
44+
broken = versionOlder postgresql.version "14";
45+
};
46+
};
47+
allVersions = (builtins.fromJSON (builtins.readFile ./versions.json)).safeupdate;
48+
supportedVersions = lib.filterAttrs (
49+
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
50+
) allVersions;
51+
versions = lib.naturalSort (lib.attrNames supportedVersions);
52+
latestVersion = lib.last versions;
53+
numberOfVersions = builtins.length versions;
54+
packages = builtins.attrValues (
55+
lib.mapAttrs (name: value: build name value.hash) supportedVersions
56+
);
57+
in
58+
pkgs.buildEnv {
59+
name = pname;
60+
paths = packages;
61+
nativeBuildInputs = [ makeWrapper ];
62+
pathsToLink = [
63+
"/lib"
64+
"/share/postgresql/extension"
65+
];
66+
postBuild = ''
67+
ln -sfn ${pname}-${latestVersion}${postgresql.dlSuffix} $out/lib/${pname}${postgresql.dlSuffix}
68+
69+
# checks
70+
(set -x
71+
test "$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)" = "${
72+
toString (numberOfVersions + 1)
73+
}"
74+
)
2075
21-
installPhase = ''
22-
install -D safeupdate${postgresql.dlSuffix} -t $out/lib
76+
makeWrapper ${lib.getExe switch-ext-version} $out/bin/switch_pg_net_version \
77+
--prefix EXT_WRAPPER : "$out" --prefix EXT_NAME : "${pname}"
2378
'';
2479

25-
meta = with lib; {
26-
description = "A simple extension to PostgreSQL that requires criteria for UPDATE and DELETE";
27-
homepage = "https://github.com/eradman/pg-safeupdate";
28-
changelog = "https://github.com/eradman/pg-safeupdate/raw/${src.rev}/NEWS";
29-
platforms = postgresql.meta.platforms;
30-
license = licenses.postgresql;
31-
broken = versionOlder postgresql.version "14";
80+
passthru = {
81+
inherit versions numberOfVersions;
82+
pname = "${pname}-all";
83+
defaultSettings = {
84+
shared_preload_libraries = [ "safeupdate" ];
85+
};
86+
pgRegressTestName = "pg-safeupdate";
87+
version =
88+
"multi-" + lib.concatStringsSep "-" (map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
3289
};
3390
}

‎nix/ext/tests/pg_safeupdate.nix‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
{ self, pkgs }:
2+
let
3+
pname = "safeupdate";
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+
services.postgresql = {
48+
enable = true;
49+
package = (postgresqlWithExtension psql_15);
50+
settings = (installedExtension "15").defaultSettings or { };
51+
};
52+
53+
specialisation.postgresql17.configuration = {
54+
services.postgresql = {
55+
package = lib.mkForce psql_17;
56+
settings = (installedExtension "15").defaultSettings or { };
57+
};
58+
59+
systemd.services.postgresql-migrate = {
60+
serviceConfig = {
61+
Type = "oneshot";
62+
RemainAfterExit = true;
63+
User = "postgres";
64+
Group = "postgres";
65+
StateDirectory = "postgresql";
66+
WorkingDirectory = "${builtins.dirOf config.services.postgresql.dataDir}";
67+
};
68+
script =
69+
let
70+
oldPostgresql = psql_15;
71+
newPostgresql = psql_17;
72+
oldDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${oldPostgresql.psqlSchema}";
73+
newDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${newPostgresql.psqlSchema}";
74+
in
75+
''
76+
if [[ ! -d ${newDataDir} ]]; then
77+
install -d -m 0700 -o postgres -g postgres "${newDataDir}"
78+
${newPostgresql}/bin/initdb -D "${newDataDir}"
79+
${newPostgresql}/bin/pg_upgrade --old-datadir "${oldDataDir}" --new-datadir "${newDataDir}" \
80+
--old-bindir "${oldPostgresql}/bin" --new-bindir "${newPostgresql}/bin"
81+
else
82+
echo "${newDataDir} already exists"
83+
fi
84+
'';
85+
};
86+
87+
systemd.services.postgresql = {
88+
after = [ "postgresql-migrate.service" ];
89+
requires = [ "postgresql-migrate.service" ];
90+
};
91+
};
92+
};
93+
testScript =
94+
{ nodes, ... }:
95+
let
96+
pg17-configuration = "${nodes.server.system.build.toplevel}/specialisation/postgresql17";
97+
in
98+
''
99+
from pathlib import Path
100+
versions = {
101+
"15": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "15"))}],
102+
"17": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "17"))}],
103+
}
104+
extension_name = "${pname}"
105+
support_upgrade = False
106+
pg17_configuration = "${pg17-configuration}"
107+
ext_has_background_worker = ${
108+
if (installedExtension "15") ? hasBackgroundWorker then "True" else "False"
109+
}
110+
sql_test_directory = Path("${../../tests}")
111+
pg_regress_test_name = "${(installedExtension "15").pgRegressTestName or pname}"
112+
113+
${builtins.readFile ./lib.py}
114+
115+
start_all()
116+
117+
server.wait_for_unit("multi-user.target")
118+
server.wait_for_unit("postgresql.service")
119+
120+
test = PostgresExtensionTest(server, extension_name, versions, sql_test_directory, support_upgrade)
121+
122+
with subtest("Check pg_regress with postgresql 15 after extension upgrade"):
123+
test.check_pg_regress(Path("${psql_15}/lib/pgxs/src/test/regress/pg_regress"), "15", pg_regress_test_name)
124+
125+
with subtest("switch to postgresql 17"):
126+
server.succeed(
127+
f"{pg17_configuration}/bin/switch-to-configuration test >&2"
128+
)
129+
130+
with subtest("Check pg_regress with postgresql 17 after extension upgrade"):
131+
test.check_pg_regress(Path("${psql_17}/lib/pgxs/src/test/regress/pg_regress"), "17", pg_regress_test_name)
132+
'';
133+
}

‎nix/ext/versions.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -622,5 +622,14 @@
622622
],
623623
"hash": "sha256-wfjiLkx+S3zVrAynisX1GdazueVJ3EOwQEPcgUQt7eA="
624624
}
625+
},
626+
"safeupdate": {
627+
"1.4": {
628+
"postgresql": [
629+
"15",
630+
"17"
631+
],
632+
"hash": "sha256-1cyvVEC9MQGMr7Tg6EUbsVBrMc8ahdFS3+CmDkmAq4Y="
633+
}
625634
}
626635
}

0 commit comments

Comments
 (0)