Skip to content

Commit 269cf82

Browse files
steve-chavezsteve-chavez
committed
chore: enable code coverage
Requires changing the development workflow. Installation and packaging works as usual. It brings an `nxpg.nix` script, which some patches for older pg versions. This can be externalized later on as a flake.
1 parent d312525 commit 269cf82

15 files changed

+3213
-97
lines changed

‎.github/workflows/main.yml

+34-3
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ jobs:
1616
with:
1717
nix_path: nixpkgs=channel:nixos-unstable
1818

19-
- name: Run pytest tests
20-
run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
19+
- name: Run tests
20+
run: |
21+
nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build"
22+
nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-test"
2123
2224
#- name: Check C files are formatted
2325
#run: nix-shell --run "net-check-format"
@@ -35,4 +37,33 @@ jobs:
3537
with:
3638
nix_path: nixpkgs=channel:nixos-unstable
3739
- name: Run tests
38-
run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
40+
run: |
41+
nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build"
42+
nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-test"
43+
44+
coverage:
45+
46+
runs-on: ubuntu-latest
47+
48+
strategy:
49+
matrix:
50+
pg-version: ['16']
51+
52+
steps:
53+
- uses: actions/checkout@v4
54+
with:
55+
submodules: true
56+
- uses: cachix/install-nix-action@v18
57+
with:
58+
nix_path: nixpkgs=channel:nixos-unstable
59+
60+
- name: Run coverage
61+
run: |
62+
nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build-cov"
63+
nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-coverage"
64+
65+
- name: Send coverage to Coveralls
66+
uses: coverallsapp/[email protected]
67+
with:
68+
github-token: ${{ secrets.GITHUB_TOKEN }}
69+
files: ./coverage.info

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,16 @@ __pycache__/
77
.deployment.nixops*
88
valgrindlog
99
nix/nginx/logs/nginx.pid
10+
pg_net--*.sql
1011
.history
1112
*.o
1213
*.bc
1314
*.control
1415
*.so
16+
*.gcno
17+
*.gcda
18+
coverage.info
19+
coverage_html
1520
nginx.pid
1621
tags
1722
net_worker.pid

‎Makefile

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
PG_CFLAGS = -std=c11 -Werror -Wno-declaration-after-statement
2+
ifeq ($(COVERAGE), 1)
3+
PG_CFLAGS += --coverage
4+
endif
25
EXTENSION = pg_net
36
EXTVERSION = 0.14.0
47

58
DATA = $(wildcard sql/*--*.sql)
69

10+
EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
11+
712
TESTS = $(wildcard test/sql/*.sql)
813
REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
914
REGRESS_OPTS = --use-existing --inputdir=test
@@ -12,21 +17,19 @@ MODULE_big = $(EXTENSION)
1217
SRC = $(wildcard src/*.c)
1318
OBJS = $(patsubst src/%.c, src/%.o, $(SRC))
1419

15-
all: sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
16-
17-
sql/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
18-
cp $< $@
19-
20-
$(EXTENSION).control:
21-
sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
22-
23-
EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
24-
2520
PG_CONFIG = pg_config
2621
SHLIB_LINK = -lcurl
2722

2823
# Find <curl/curl.h> from system headers
2924
PG_CPPFLAGS := $(CPPFLAGS) -DEXTVERSION=\"$(EXTVERSION)\"
3025

26+
all: $(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
27+
28+
$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
29+
cp $< $@
30+
31+
$(EXTENSION).control:
32+
sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
33+
3134
PGXS := $(shell $(PG_CONFIG) --pgxs)
3235
include $(PGXS)

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Requires libcurl >= 7.83. Compatible with PostgreSQL > = 12.
55

66
![PostgreSQL version](https://img.shields.io/badge/postgresql-12+-blue.svg)
77
[![License](https://img.shields.io/pypi/l/markdown-subtemplate.svg)](https://github.com/supabase/pg_net/blob/master/LICENSE)
8+
[![Coverage Status](https://coveralls.io/repos/github/supabase/pg_net/badge.svg)](https://coveralls.io/github/supabase/pg_net)
89
[![Tests](https://github.com/supabase/pg_net/actions/workflows/main.yml/badge.svg)](https://github.com/supabase/pg_net/actions)
910

1011
**Documentation**: [https://supabase.github.io/pg_net](https://supabase.github.io/pg_net)

‎docs/contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ For testing locally, execute:
1414
$ nix-shell
1515

1616
# test on pg 12
17-
$ net-with-pg-12 python -m pytest -vv"
17+
$ nxpg-12 nxpg-build && net-with-nginx nxpg-12 nxpg-tmp nxpg-test
1818

1919
# test on pg 13
20-
$ net-with-pg-13 python -m pytest -vv"
20+
$ nxpg-13 nxpg-build && net-with-nginx nxpg-13 nxpg-tmp nxpg-test
2121
```
2222

2323
### Debugging
2424

2525
You can turn on logging level to see curl traces with
2626

2727
```
28-
$ LOG_MIN_MESSAGES=debug2 net-with-pg-12 psql
28+
$ export LOG_MIN_MESSAGES=debug2
2929
```
3030

3131
```sql

‎nix/nxpg.nix

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
{ stdenv, lib, makeWrapper, fetchurl, writeShellScriptBin, findutils, entr, callPackage, lcov
2+
, pidFileName, gnused, python3
3+
, postgresql_16, postgresql_15, postgresql_14, postgresql_13, postgresql_12
4+
} :
5+
let
6+
prefix = "nxpg";
7+
ourPg = callPackage ./postgresql {
8+
inherit lib;
9+
inherit stdenv;
10+
inherit fetchurl;
11+
inherit makeWrapper;
12+
inherit callPackage;
13+
};
14+
supportedPgs = [
15+
ourPg.postgresql_17
16+
postgresql_16
17+
postgresql_15
18+
postgresql_14
19+
postgresql_13
20+
postgresql_12
21+
];
22+
build =
23+
writeShellScriptBin "${prefix}-build" ''
24+
set -euo pipefail
25+
26+
make clean
27+
make
28+
'';
29+
buildCov =
30+
writeShellScriptBin "${prefix}-build-cov" ''
31+
set -euo pipefail
32+
33+
make clean
34+
make COVERAGE=1
35+
'';
36+
test =
37+
writeShellScriptBin "${prefix}-test" ''
38+
set -euo pipefail
39+
40+
${python3}/bin/python -m pytest -vv "$@"
41+
'';
42+
cov =
43+
writeShellScriptBin "${prefix}-coverage" ''
44+
set -euo pipefail
45+
46+
info_file="coverage.info"
47+
out_dir="coverage_html"
48+
49+
${python3}/bin/python -m pytest -vv "$@"
50+
51+
${lcov}/bin/lcov --capture --directory . --output-file "$info_file"
52+
53+
# remove postgres headers on the nix store, otherwise they show on the output
54+
${lcov}/bin/lcov --remove "$info_file" '/nix/*' --output-file "$info_file" || true
55+
56+
${lcov}/bin/lcov --list coverage.info
57+
${lcov}/bin/genhtml "$info_file" --output-directory "$out_dir"
58+
59+
echo "${prefix}-coverage: To see the results, visit file://$(pwd)/$out_dir/index.html on your browser"
60+
'';
61+
watch =
62+
writeShellScriptBin "${prefix}-watch" ''
63+
set -euo pipefail
64+
65+
${findutils}/bin/find . -type f \( -name '*.c' -o -name '*.h' \) | ${entr}/bin/entr -dr "$@"
66+
'';
67+
68+
tmpDb =
69+
writeShellScriptBin "${prefix}-tmp" ''
70+
set -euo pipefail
71+
72+
export tmpdir="$(mktemp -d)"
73+
74+
export PGDATA="$tmpdir"
75+
export PGHOST="$tmpdir"
76+
export PGUSER=postgres
77+
export PGDATABASE=postgres
78+
79+
trap 'pg_ctl stop -m i && rm -rf "$tmpdir" && rm ${pidFileName}' sigint sigterm exit
80+
81+
PGTZ=UTC initdb --no-locale --encoding=UTF8 --nosync -U "$PGUSER"
82+
83+
# pg versions older than 16 don't support adding "-c" to initdb to add these options
84+
# so we just modify the resulting postgresql.conf to avoid an error
85+
echo "dynamic_library_path='\$libdir:$(pwd)'" >> $PGDATA/postgresql.conf
86+
echo "extension_control_path='\$system:$(pwd)'" >> $PGDATA/postgresql.conf
87+
88+
options="-F -c listen_addresses=\"\" -c log_min_messages=\"''${LOG_MIN_MESSAGES:-INFO}\" -k $PGDATA"
89+
90+
ext_options="-c shared_preload_libraries=\"pg_net\""
91+
92+
pg_ctl start -o "$options" -o "$ext_options"
93+
94+
psql -v ON_ERROR_STOP=1 -c "create database pre_existing" -d postgres
95+
96+
psql -v ON_ERROR_STOP=1 -c "create role pre_existing nosuperuser login" -d postgres
97+
98+
psql -v ON_ERROR_STOP=1 -c "create extension pg_net" -d postgres
99+
100+
psql -t -c "\o ${pidFileName}" -c "select pid from pg_stat_activity where backend_type ilike '%pg_net%'"
101+
102+
${gnused}/bin/sed '/^''$/d;s/[[:blank:]]//g' -i ${pidFileName}
103+
104+
psql -f ${./bench.sql}
105+
106+
"$@"
107+
'';
108+
allPgPaths = map (pg:
109+
let
110+
ver = builtins.head (builtins.splitVersion pg.version);
111+
patchedPg = pg.overrideAttrs(oldAttrs: {
112+
patches = oldAttrs.patches ++ [
113+
./postgresql/patches/${ver}-add-extension_control_path-for.patch
114+
];
115+
});
116+
script = ''
117+
set -euo pipefail
118+
119+
export PATH=${patchedPg}/bin:"$PATH"
120+
121+
"$@"
122+
'';
123+
in
124+
writeShellScriptBin "${prefix}-${ver}" script
125+
) supportedPgs;
126+
in
127+
[
128+
build
129+
buildCov
130+
test
131+
cov
132+
watch
133+
tmpDb
134+
allPgPaths
135+
]

‎nix/pgScript.nix

-42
This file was deleted.

‎nix/pg_net.nix

-20
This file was deleted.

0 commit comments

Comments
 (0)