Skip to content

Commit 40de6d0

Browse files
committed
feat(hypopg): build multiple versions of the hypopg extension
Build multiple versions of the hypopg extension on different PostgreSQL versions. Add test for the extensions and their upgrade on PostgreSQL 15 and 17.
1 parent 2b07c9c commit 40de6d0

File tree

4 files changed

+260
-20
lines changed

4 files changed

+260
-20
lines changed

flake.nix

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1382,6 +1382,8 @@
13821382
inherit (basePackages) wal-g-2 wal-g-3 dbmate-tool pg_regress;
13831383
} // pkgs.lib.optionalAttrs (system == "aarch64-linux") {
13841384
inherit (basePackages) postgresql_15_debug postgresql_15_src postgresql_orioledb-17_debug postgresql_orioledb-17_src postgresql_17_debug postgresql_17_src;
1385+
} // pkgs.lib.optionalAttrs (system == "x86_64-linux") {
1386+
hypopg = import ./nix/tests/hypopg.nix { inherit self; inherit pkgs; };
13851387
};
13861388

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

nix/ext/hypopg.nix

Lines changed: 85 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,95 @@
1-
{ lib, stdenv, fetchFromGitHub, postgresql }:
1+
{
2+
pkgs,
3+
lib,
4+
stdenv,
5+
fetchFromGitHub,
6+
postgresql,
7+
}:
28

3-
stdenv.mkDerivation rec {
9+
let
410
pname = "hypopg";
5-
version = "1.4.1";
11+
allVersions = (builtins.fromJSON (builtins.readFile ./versions.json)).${pname};
12+
supportedVersions = lib.filterAttrs (
13+
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
14+
) allVersions;
15+
versions = lib.naturalSort (lib.attrNames supportedVersions);
16+
latestVersion = lib.last versions;
17+
numberOfVersions = builtins.length versions;
18+
build =
19+
version: hash:
20+
stdenv.mkDerivation rec {
21+
inherit pname version;
622

7-
buildInputs = [ postgresql ];
23+
buildInputs = [ postgresql ];
824

9-
src = fetchFromGitHub {
10-
owner = "HypoPG";
11-
repo = pname;
12-
rev = "refs/tags/${version}";
13-
hash = "sha256-88uKPSnITRZ2VkelI56jZ9GWazG/Rn39QlyHKJKSKMM=";
14-
};
25+
src = fetchFromGitHub {
26+
owner = "HypoPG";
27+
repo = pname;
28+
rev = "refs/tags/${version}";
29+
inherit hash;
30+
};
31+
32+
installPhase = ''
33+
mkdir -p $out/{lib,share/postgresql/extension}
34+
35+
mv ${pname}${postgresql.dlSuffix} $out/lib/${pname}-${version}${postgresql.dlSuffix}
36+
37+
create_sql_files() {
38+
echo "Creating SQL files for previous versions..."
39+
if [[ "${version}" == "${latestVersion}" ]]; then
40+
cp *.sql $out/share/postgresql/extension
41+
fi
42+
}
43+
44+
create_control_files() {
45+
sed -e "/^default_version =/d" \
46+
-e "s|^module_pathname = .*|module_pathname = '\$libdir/${pname}'|" \
47+
${pname}.control > $out/share/postgresql/extension/${pname}--${version}.control
48+
49+
if [[ "${version}" == "${latestVersion}" ]]; then
50+
{
51+
echo "default_version = '${latestVersion}'"
52+
cat $out/share/postgresql/extension/${pname}--${latestVersion}.control
53+
} > $out/share/postgresql/extension/${pname}.control
54+
ln -sfn ${pname}-${latestVersion}${postgresql.dlSuffix} $out/lib/${pname}${postgresql.dlSuffix}
55+
fi
56+
}
1557
16-
installPhase = ''
17-
mkdir -p $out/{lib,share/postgresql/extension}
58+
create_sql_files
59+
create_control_files
60+
'';
1861

19-
cp *${postgresql.dlSuffix} $out/lib
20-
cp *.sql $out/share/postgresql/extension
21-
cp *.control $out/share/postgresql/extension
62+
meta = with lib; {
63+
description = "Hypothetical Indexes for PostgreSQL";
64+
homepage = "https://github.com/HypoPG/${pname}";
65+
license = licenses.postgresql;
66+
inherit (postgresql.meta) platforms;
67+
};
68+
};
69+
packages = builtins.attrValues (
70+
lib.mapAttrs (name: value: build name value.hash) supportedVersions
71+
);
72+
in
73+
pkgs.buildEnv {
74+
name = pname;
75+
paths = packages;
76+
pathsToLink = [
77+
"/lib"
78+
"/share/postgresql/extension"
79+
];
80+
postBuild = ''
81+
# checks
82+
(set -x
83+
test "$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)" = "${
84+
toString (numberOfVersions + 1)
85+
}"
86+
)
2287
'';
2388

24-
meta = with lib; {
25-
description = "Hypothetical Indexes for PostgreSQL";
26-
homepage = "https://github.com/HypoPG/${pname}";
27-
platforms = postgresql.meta.platforms;
28-
license = licenses.postgresql;
89+
passthru = {
90+
inherit versions numberOfVersions;
91+
pname = "${pname}-all";
92+
version =
93+
"multi-" + lib.concatStringsSep "-" (map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
2994
};
3095
}

nix/ext/versions.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"hypopg": {
3+
"1.3.1": {
4+
"postgresql": [
5+
"15"
6+
],
7+
"hash": "sha256-AIBXy+LxyHUo+1hd8gQTwaBdFiTEzKaCVc4cx5tZgME="
8+
},
9+
"1.4.1": {
10+
"postgresql": [
11+
"15",
12+
"17"
13+
],
14+
"hash": "sha256-88uKPSnITRZ2VkelI56jZ9GWazG/Rn39QlyHKJKSKMM="
15+
}
16+
}
17+
}

nix/tests/hypopg.nix

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
{ self, pkgs }:
2+
let
3+
pname = "hypopg";
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}';""")
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};'")
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+
with subtest("Check ${pname} latest extension version"):
150+
installed_extensions=run_sql(r"""SELECT extname, extversion FROM pg_extension;""")
151+
latestVersion = versions["17"][-1]
152+
assert f"${pname},{latestVersion}" in installed_extensions
153+
154+
check_upgrade_path("17")
155+
'';
156+
}

0 commit comments

Comments
 (0)