Skip to content

Commit 178d9cd

Browse files
jfrochejfroche
committed
feat: support multiple versions of the http extension
Build multiple versions of the http extension on different PostgreSQL versions. Add test for the extensions and their upgrade on PostgreSQL 15 and 17.
1 parent 7d78f14 commit 178d9cd

File tree

4 files changed

+273
-21
lines changed

4 files changed

+273
-21
lines changed

‎flake.nix

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,6 +1384,8 @@
13841384
devShell = devShells.default;
13851385
} // pkgs.lib.optionalAttrs (system == "aarch64-linux") {
13861386
inherit (basePackages) postgresql_15_debug postgresql_15_src postgresql_orioledb-17_debug postgresql_orioledb-17_src postgresql_17_debug postgresql_17_src;
1387+
} // pkgs.lib.optionalAttrs (system == "x86_64-linux") {
1388+
http = import ./nix/ext/tests/http.nix { inherit self; inherit pkgs; };
13871389
};
13881390

13891391
# Apps is a list of names of things that can be executed with 'nix run';

‎nix/ext/pgsql-http.nix

Lines changed: 103 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,112 @@
1-
{ lib, stdenv, fetchFromGitHub, curl, postgresql }:
1+
{
2+
pkgs,
3+
lib,
4+
stdenv,
5+
fetchFromGitHub,
6+
postgresql,
7+
curl,
8+
}:
9+
let
10+
pname = "http";
211

3-
stdenv.mkDerivation rec {
4-
pname = "pgsql-http";
5-
version = "1.6.1";
12+
# Load version configuration from external file
13+
allVersions = (builtins.fromJSON (builtins.readFile ./versions.json)).${pname};
614

7-
buildInputs = [ curl postgresql ];
15+
# Filter versions compatible with current PostgreSQL version
16+
supportedVersions = lib.filterAttrs (
17+
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
18+
) allVersions;
819

9-
src = fetchFromGitHub {
10-
owner = "pramsey";
11-
repo = pname;
12-
rev = "refs/tags/v${version}";
13-
hash = "sha256-C8eqi0q1dnshUAZjIsZFwa5FTYc7vmATF3vv2CReWPM=";
14-
};
20+
# Derived version information
21+
versions = lib.naturalSort (lib.attrNames supportedVersions);
22+
latestVersion = lib.last versions;
23+
numberOfVersions = builtins.length versions;
24+
packages = builtins.attrValues (
25+
lib.mapAttrs (name: value: build name value.hash) supportedVersions
26+
);
27+
28+
# Build function for individual versions
29+
build =
30+
version: hash:
31+
stdenv.mkDerivation rec {
32+
inherit pname version;
33+
34+
buildInputs = [
35+
curl
36+
postgresql
37+
];
38+
39+
src = fetchFromGitHub {
40+
owner = "pramsey";
41+
repo = "pgsql-http";
42+
rev = "refs/tags/v${version}";
43+
inherit hash;
44+
};
45+
46+
installPhase = ''
47+
runHook preInstall
48+
49+
mkdir -p $out/{lib,share/postgresql/extension}
50+
51+
# Install SQL files
52+
MAJOR_MINOR_VERSION=${lib.concatStringsSep "." (lib.take 2 (builtins.splitVersion version))}
53+
54+
# Install versioned library
55+
install -Dm755 ${pname}${postgresql.dlSuffix} $out/lib/${pname}--$MAJOR_MINOR_VERSION${postgresql.dlSuffix}
56+
57+
cp ${pname}--$MAJOR_MINOR_VERSION.sql $out/share/postgresql/extension/${pname}--$MAJOR_MINOR_VERSION.sql
58+
59+
# Create versioned control file with modified module path
60+
sed -e "/^default_version =/d" \
61+
-e "s|^module_pathname = .*|module_pathname = '\$libdir/${pname}'|" \
62+
${pname}.control > $out/share/postgresql/extension/${pname}--$MAJOR_MINOR_VERSION.control
63+
64+
# For the latest version, create default control file and symlink and copy SQL upgrade scripts
65+
if [[ "${version}" == "${latestVersion}" ]]; then
66+
{
67+
echo "default_version = '$MAJOR_MINOR_VERSION'"
68+
cat $out/share/postgresql/extension/${pname}--$MAJOR_MINOR_VERSION.control
69+
} > $out/share/postgresql/extension/${pname}.control
70+
ln -sfn ${pname}-${latestVersion}${postgresql.dlSuffix} $out/lib/${pname}${postgresql.dlSuffix}
71+
cp *.sql $out/share/postgresql/extension
72+
fi
73+
74+
runHook postInstall
75+
'';
76+
77+
meta = with lib; {
78+
description = "HTTP client for Postgres";
79+
homepage = "https://github.com/pramsey/${pname}";
80+
inherit (postgresql.meta) platforms;
81+
license = licenses.postgresql;
82+
};
83+
};
84+
in
85+
pkgs.buildEnv {
86+
name = pname;
87+
paths = packages;
1588

16-
installPhase = ''
17-
mkdir -p $out/{lib,share/postgresql/extension}
89+
pathsToLink = [
90+
"/lib"
91+
"/share/postgresql/extension"
92+
];
93+
postBuild = ''
94+
# Verify all expected library files are present
95+
expectedFiles=${toString (numberOfVersions + 1)}
96+
actualFiles=$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)
1897
19-
cp *${postgresql.dlSuffix} $out/lib
20-
cp *.sql $out/share/postgresql/extension
21-
cp *.control $out/share/postgresql/extension
98+
if [[ "$actualFiles" != "$expectedFiles" ]]; then
99+
echo "Error: Expected $expectedFiles library files, found $actualFiles"
100+
echo "Files found:"
101+
ls -la $out/lib/${pname}*${postgresql.dlSuffix} || true
102+
exit 1
103+
fi
22104
'';
23105

24-
meta = with lib; {
25-
description = "HTTP client for Postgres";
26-
homepage = "https://github.com/pramsey/${pname}";
27-
platforms = postgresql.meta.platforms;
28-
license = licenses.postgresql;
106+
passthru = {
107+
inherit versions numberOfVersions;
108+
pname = "${pname}-all";
109+
version =
110+
"multi-" + lib.concatStringsSep "-" (map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
29111
};
30112
}

‎nix/ext/tests/http.nix

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
{ self, pkgs }:
2+
let
3+
pname = "http";
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+
in
39+
self.inputs.nixpkgs.lib.nixos.runTest {
40+
name = pname;
41+
hostPkgs = pkgs;
42+
nodes.server =
43+
{ config, ... }:
44+
{
45+
virtualisation = {
46+
forwardPorts = [
47+
{
48+
from = "host";
49+
host.port = 13022;
50+
guest.port = 22;
51+
}
52+
];
53+
};
54+
55+
services.postgresql = {
56+
enable = true;
57+
package = postgresqlWithExtension self.packages.${pkgs.system}.postgresql_15;
58+
settings = {
59+
"shared_preload_libraries" = pname;
60+
};
61+
};
62+
63+
specialisation.postgresql17.configuration = {
64+
services.postgresql = {
65+
package = lib.mkForce (postgresqlWithExtension self.packages.${pkgs.system}.postgresql_17);
66+
};
67+
68+
systemd.services.postgresql-migrate = {
69+
serviceConfig = {
70+
Type = "oneshot";
71+
RemainAfterExit = true;
72+
User = "postgres";
73+
Group = "postgres";
74+
StateDirectory = "postgresql";
75+
WorkingDirectory = "${builtins.dirOf config.services.postgresql.dataDir}";
76+
};
77+
script =
78+
let
79+
oldPostgresql = postgresqlWithExtension self.packages.${pkgs.system}.postgresql_15;
80+
newPostgresql = postgresqlWithExtension self.packages.${pkgs.system}.postgresql_17;
81+
oldDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${oldPostgresql.psqlSchema}";
82+
newDataDir = "${builtins.dirOf config.services.postgresql.dataDir}/${newPostgresql.psqlSchema}";
83+
in
84+
''
85+
if [[ ! -d ${newDataDir} ]]; then
86+
install -d -m 0700 -o postgres -g postgres "${newDataDir}"
87+
${newPostgresql}/bin/initdb -D "${newDataDir}"
88+
echo "shared_preload_libraries = '${pname}'" >> "${newDataDir}/postgresql.conf"
89+
${newPostgresql}/bin/pg_upgrade --old-datadir "${oldDataDir}" --new-datadir "${newDataDir}" \
90+
--old-bindir "${oldPostgresql}/bin" --new-bindir "${newPostgresql}/bin"
91+
else
92+
echo "${newDataDir} already exists"
93+
fi
94+
'';
95+
};
96+
97+
systemd.services.postgresql = {
98+
after = [ "postgresql-migrate.service" ];
99+
requires = [ "postgresql-migrate.service" ];
100+
};
101+
};
102+
103+
};
104+
testScript =
105+
{ nodes, ... }:
106+
let
107+
pg17-configuration = "${nodes.server.system.build.toplevel}/specialisation/postgresql17";
108+
in
109+
''
110+
versions = {
111+
"15": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "15"))}],
112+
"17": [${lib.concatStringsSep ", " (map (s: ''"${s}"'') (versions "17"))}],
113+
}
114+
115+
def run_sql(query):
116+
return server.succeed(f"""sudo -u postgres psql -t -A -F\",\" -c \"{query}\" """).strip()
117+
118+
def check_upgrade_path(pg_version):
119+
with subtest("Check ${pname} upgrade path"):
120+
firstVersion = versions[pg_version][0]
121+
server.succeed("sudo -u postgres psql -c 'DROP EXTENSION IF EXISTS ${pname};'")
122+
run_sql(f"""CREATE EXTENSION ${pname} WITH VERSION '{firstVersion}' CASCADE;""")
123+
installed_version = run_sql(r"""SELECT extversion FROM pg_extension WHERE extname = '${pname}';""")
124+
assert installed_version == firstVersion, f"Expected ${pname} version {firstVersion}, but found {installed_version}"
125+
for version in versions[pg_version][1:]:
126+
run_sql(f"""ALTER EXTENSION ${pname} UPDATE TO '{version}';""")
127+
installed_version = run_sql(r"""SELECT extversion FROM pg_extension WHERE extname = '${pname}';""")
128+
assert installed_version == version, f"Expected ${pname} version {version}, but found {installed_version}"
129+
130+
start_all()
131+
132+
server.wait_for_unit("multi-user.target")
133+
server.wait_for_unit("postgresql.service")
134+
135+
check_upgrade_path("15")
136+
137+
with subtest("Check ${pname} latest extension version"):
138+
server.succeed("sudo -u postgres psql -c 'DROP EXTENSION ${pname};'")
139+
server.succeed("sudo -u postgres psql -c 'CREATE EXTENSION ${pname} CASCADE;'")
140+
installed_extensions=run_sql(r"""SELECT extname, extversion FROM pg_extension;""")
141+
latestVersion = versions["15"][-1]
142+
assert f"${pname},{latestVersion}" in installed_extensions
143+
144+
with subtest("switch to postgresql 17"):
145+
server.succeed(
146+
"${pg17-configuration}/bin/switch-to-configuration test >&2"
147+
)
148+
149+
check_upgrade_path("17")
150+
'';
151+
}

‎nix/ext/versions.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"http": {
3+
"1.5.0": {
4+
"postgresql": [
5+
"15"
6+
],
7+
"hash": "sha256-+N/CXm4arRgvhglanfvO0FNOBUWV5RL8mn/9FpNvcjY="
8+
},
9+
"1.6.1": {
10+
"postgresql": [
11+
"15",
12+
"17"
13+
],
14+
"hash": "sha256-C8eqi0q1dnshUAZjIsZFwa5FTYc7vmATF3vv2CReWPM="
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)