Skip to content

Commit 8be32c6

Browse files
jfrochejfroche
committed
feat: multiple versions for the index_advisor extension
Build multiple versions of the index_advisor extension on different PostgreSQL versions. Add test for the extensions and their upgrade on PostgreSQL 15 and 17.
1 parent 4b77682 commit 8be32c6

File tree

4 files changed

+236
-20
lines changed

4 files changed

+236
-20
lines changed

‎flake.nix

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

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

‎nix/ext/index_advisor.nix

Lines changed: 75 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,84 @@
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 = "index_advisor";
5-
version = "0.2.0";
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 = "olirice";
11-
repo = pname;
12-
rev = "v${version}";
13-
hash = "sha256-G0eQk2bY5CNPMeokN/nb05g03CuiplRf902YXFVQFbs=";
14-
};
25+
src = fetchFromGitHub {
26+
owner = "olirice";
27+
repo = pname;
28+
rev = "v${version}";
29+
inherit hash;
30+
};
31+
32+
installPhase = ''
33+
mkdir -p $out/{lib,share/postgresql/extension}
34+
35+
create_sql_files() {
36+
echo "Creating SQL files for previous versions..."
37+
if [[ "${version}" == "${latestVersion}" ]]; then
38+
cp *.sql $out/share/postgresql/extension
39+
fi
40+
}
41+
42+
create_control_files() {
43+
sed -e "/^default_version =/d" \
44+
-e "s|^module_pathname = .*|module_pathname = '\$libdir/${pname}'|" \
45+
${pname}.control > $out/share/postgresql/extension/${pname}--${version}.control
46+
47+
if [[ "${version}" == "${latestVersion}" ]]; then
48+
{
49+
echo "default_version = '${latestVersion}'"
50+
cat $out/share/postgresql/extension/${pname}--${latestVersion}.control
51+
} > $out/share/postgresql/extension/${pname}.control
52+
fi
53+
}
1554
16-
installPhase = ''
17-
mkdir -p $out/{lib,share/postgresql/extension}
55+
create_sql_files
56+
create_control_files
57+
'';
1858

19-
cp *.sql $out/share/postgresql/extension
20-
cp *.control $out/share/postgresql/extension
21-
'';
59+
meta = with lib; {
60+
description = "Recommend indexes to improve query performance in PostgreSQL";
61+
homepage = "https://github.com/olirice/index_advisor";
62+
license = licenses.postgresql;
63+
inherit (postgresql.meta) platforms;
64+
};
65+
};
66+
packages = builtins.attrValues (
67+
lib.mapAttrs (name: value: build name value.hash) supportedVersions
68+
);
69+
in
70+
pkgs.buildEnv {
71+
name = pname;
72+
paths = packages;
73+
pathsToLink = [
74+
"/lib"
75+
"/share/postgresql/extension"
76+
];
2277

23-
meta = with lib; {
24-
description = "Recommend indexes to improve query performance in PostgreSQL";
25-
homepage = "https://github.com/olirice/index_advisor";
26-
platforms = postgresql.meta.platforms;
27-
license = licenses.postgresql;
78+
passthru = {
79+
inherit versions numberOfVersions;
80+
pname = "${pname}-all";
81+
version =
82+
"multi-" + lib.concatStringsSep "-" (map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
2883
};
2984
}

‎nix/ext/tests/index_advisor.nix

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

‎nix/ext/versions.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"index_advisor": {
3+
"0.2.0": {
4+
"postgresql": [
5+
"15",
6+
"17"
7+
],
8+
"hash": "sha256-G0eQk2bY5CNPMeokN/nb05g03CuiplRf902YXFVQFbs="
9+
}
10+
}
11+
}

0 commit comments

Comments
 (0)