chore: enable code coverage

.github/workflows/main.yml

@@ -16,8 +16,10 @@ jobs:
         with:
           nix_path: nixpkgs=channel:nixos-unstable
 
-      - name: Run pytest tests
-        run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
+      - name: Run tests
+        run: |
+            nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build"
+            nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-test"
 
       #- name: Check C files are formatted
         #run: nix-shell --run "net-check-format"
@@ -35,4 +37,33 @@ jobs:
       with:
         nix_path: nixpkgs=channel:nixos-unstable
     - name: Run tests
-      run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
+      run: |
+          nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build"
+          nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-test"
+
+  coverage:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        pg-version: ['16']
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: cachix/install-nix-action@v18
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+      - name: Run coverage
+        run: |
+          nix-shell --run "nxpg-${{ matrix.pg-version }} nxpg-build-cov"
+          nix-shell --run "net-with-nginx nxpg-${{ matrix.pg-version }} nxpg-tmp nxpg-coverage"
+
+      - name: Send coverage to Coveralls
+        uses: coverallsapp/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          files: ./coverage.info

.gitignore

@@ -7,11 +7,16 @@ __pycache__/
 .deployment.nixops*
 valgrindlog
 nix/nginx/logs/nginx.pid
+pg_net--*.sql
 .history
 *.o
 *.bc
 *.control
 *.so
+*.gcno
+*.gcda
+coverage.info
+coverage_html
 nginx.pid
 tags
 net_worker.pid

Makefile

@@ -1,9 +1,14 @@
 PG_CFLAGS = -std=c11 -Werror -Wno-declaration-after-statement
+ifeq ($(COVERAGE), 1)
+PG_CFLAGS += --coverage
+endif
 EXTENSION = pg_net
 EXTVERSION = 0.14.0
 
 DATA = $(wildcard sql/*--*.sql)
 
+EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
+
 TESTS = $(wildcard test/sql/*.sql)
 REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
 REGRESS_OPTS = --use-existing --inputdir=test
@@ -12,21 +17,19 @@ MODULE_big = $(EXTENSION)
 SRC = $(wildcard src/*.c)
 OBJS = $(patsubst src/%.c, src/%.o, $(SRC))
 
-all: sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
-
-sql/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
-	cp $< $@
-
-$(EXTENSION).control:
-	sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
-
-EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
-
 PG_CONFIG = pg_config
 SHLIB_LINK = -lcurl
 
 # Find <curl/curl.h> from system headers
 PG_CPPFLAGS := $(CPPFLAGS) -DEXTVERSION=\"$(EXTVERSION)\"
 
+all: $(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
+
+$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
+	cp $< $@
+
+$(EXTENSION).control:
+	sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
+
 PGXS := $(shell $(PG_CONFIG) --pgxs)
 include $(PGXS)

README.md

@@ -5,6 +5,7 @@ Requires libcurl >= 7.83. Compatible with PostgreSQL > = 12.
 
 ![PostgreSQL version](https://img.shields.io/badge/postgresql-12+-blue.svg)
 [![License](https://img.shields.io/pypi/l/markdown-subtemplate.svg)](https://github.com/supabase/pg_net/blob/master/LICENSE)
+[![Coverage Status](https://coveralls.io/repos/github/supabase/pg_net/badge.svg)](https://coveralls.io/github/supabase/pg_net)
 [![Tests](https://github.com/supabase/pg_net/actions/workflows/main.yml/badge.svg)](https://github.com/supabase/pg_net/actions)
 
 **Documentation**: [https://supabase.github.io/pg_net](https://supabase.github.io/pg_net)

docs/contributing.md

@@ -14,18 +14,18 @@ For testing locally, execute:
 $ nix-shell
 
 # test on pg 12
-$ net-with-pg-12 python -m pytest -vv"
+$ nxpg-12 nxpg-build && net-with-nginx nxpg-12 nxpg-tmp nxpg-test
 
 # test on pg 13
-$ net-with-pg-13 python -m pytest -vv"
+$ nxpg-13 nxpg-build && net-with-nginx nxpg-13 nxpg-tmp nxpg-test
 ```
 
 ### Debugging
 
 You can turn on logging level to see curl traces with
 
 ```
-$ LOG_MIN_MESSAGES=debug2 net-with-pg-12 psql
+$ export LOG_MIN_MESSAGES=debug2
 ```
 
 ```sql

nix/nxpg.nix

@@ -0,0 +1,135 @@
+{ stdenv, lib, makeWrapper, fetchurl, writeShellScriptBin, findutils, entr, callPackage, lcov
+, pidFileName, gnused, python3
+, postgresql_16, postgresql_15, postgresql_14, postgresql_13, postgresql_12
+} :
+let
+  prefix = "nxpg";
+  ourPg = callPackage ./postgresql {
+    inherit lib;
+    inherit stdenv;
+    inherit fetchurl;
+    inherit makeWrapper;
+    inherit callPackage;
+  };
+  supportedPgs = [
+    ourPg.postgresql_17
+    postgresql_16
+    postgresql_15
+    postgresql_14
+    postgresql_13
+    postgresql_12
+  ];
+  build =
+    writeShellScriptBin "${prefix}-build" ''
+      set -euo pipefail
+
+      make clean
+      make
+    '';
+  buildCov =
+    writeShellScriptBin "${prefix}-build-cov" ''
+      set -euo pipefail
+
+      make clean
+      make COVERAGE=1
+    '';
+  test =
+    writeShellScriptBin "${prefix}-test" ''
+      set -euo pipefail
+
+      ${python3}/bin/python -m pytest -vv "$@"
+    '';
+  cov =
+    writeShellScriptBin "${prefix}-coverage" ''
+      set -euo pipefail
+
+      info_file="coverage.info"
+      out_dir="coverage_html"
+
+      ${python3}/bin/python -m pytest -vv "$@"
+
+      ${lcov}/bin/lcov --capture --directory . --output-file "$info_file"
+
+      # remove postgres headers on the nix store, otherwise they show on the output
+      ${lcov}/bin/lcov --remove "$info_file" '/nix/*' --output-file "$info_file" || true
+
+      ${lcov}/bin/lcov --list coverage.info
+      ${lcov}/bin/genhtml "$info_file" --output-directory "$out_dir"
+
+      echo "${prefix}-coverage: To see the results, visit file://$(pwd)/$out_dir/index.html on your browser"
+    '';
+  watch =
+    writeShellScriptBin "${prefix}-watch" ''
+      set -euo pipefail
+
+      ${findutils}/bin/find . -type f \( -name '*.c' -o -name '*.h' \) | ${entr}/bin/entr -dr "$@"
+    '';
+
+  tmpDb =
+    writeShellScriptBin "${prefix}-tmp" ''
+      set -euo pipefail
+
+      export tmpdir="$(mktemp -d)"
+
+      export PGDATA="$tmpdir"
+      export PGHOST="$tmpdir"
+      export PGUSER=postgres
+      export PGDATABASE=postgres
+
+      trap 'pg_ctl stop -m i && rm -rf "$tmpdir" && rm ${pidFileName}' sigint sigterm exit
+
+      PGTZ=UTC initdb --no-locale --encoding=UTF8 --nosync -U "$PGUSER"
+
+      # pg versions older than 16 don't support adding "-c" to initdb to add these options
+      # so we just modify the resulting postgresql.conf to avoid an error
+      echo "dynamic_library_path='\$libdir:$(pwd)'" >> $PGDATA/postgresql.conf
+      echo "extension_control_path='\$system:$(pwd)'" >> $PGDATA/postgresql.conf
+
+      options="-F -c listen_addresses=\"\" -c log_min_messages=\"''${LOG_MIN_MESSAGES:-INFO}\" -k $PGDATA"
+
+      ext_options="-c shared_preload_libraries=\"pg_net\""
+
+      pg_ctl start -o "$options" -o "$ext_options"
+
+      psql -v ON_ERROR_STOP=1 -c "create database pre_existing" -d postgres
+
+      psql -v ON_ERROR_STOP=1 -c "create role pre_existing nosuperuser login" -d postgres
+
+      psql -v ON_ERROR_STOP=1 -c "create extension pg_net" -d postgres
+
+      psql -t -c "\o ${pidFileName}" -c "select pid from pg_stat_activity where backend_type ilike '%pg_net%'"
+
+      ${gnused}/bin/sed '/^''$/d;s/[[:blank:]]//g' -i ${pidFileName}
+
+      psql -f ${./bench.sql}
+
+      "$@"
+    '';
+    allPgPaths = map (pg:
+      let
+        ver = builtins.head (builtins.splitVersion pg.version);
+        patchedPg = pg.overrideAttrs(oldAttrs: {
+          patches = oldAttrs.patches ++ [
+            ./postgresql/patches/${ver}-add-extension_control_path-for.patch
+          ];
+        });
+        script = ''
+          set -euo pipefail
+
+          export PATH=${patchedPg}/bin:"$PATH"
+
+          "$@"
+        '';
+      in
+      writeShellScriptBin "${prefix}-${ver}" script
+    ) supportedPgs;
+in
+[
+  build
+  buildCov
+  test
+  cov
+  watch
+  tmpDb
+  allPgPaths
+]