chore: build/test normally with just Makefile

.github/workflows/ci.yaml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:
@@ -15,5 +15,7 @@ jobs:
       - uses: cachix/install-nix-action@v18
         with:
           nix_path: nixpkgs=channel:nixos-unstable
-      - name: Run tests pg_${{ matrix.postgres-version }}
+      - name: Run tests
         run: nix-shell --run "with-pg-${{ matrix.pg-version }} make installcheck"
+      - if: ${{ failure() }}
+        run: cat regression.diffs

.gitignore

@@ -7,3 +7,4 @@ results/
 *.control
 *.so
 sql/postgrest_openapi.sql
+test/fixtures_ran

Makefile

@@ -3,10 +3,6 @@ EXTVERSION = 0.0.1
 
 DATA = $(wildcard sql/*--*.sql)
 
-TESTS = $(wildcard test/sql/*.sql)
-REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
-REGRESS_OPTS = --use-existing --inputdir=test
-
 all: sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
 
 sql/$(EXTENSION).sql:
@@ -18,6 +14,22 @@ sql/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
 $(EXTENSION).control:
 	sed "s/@EXTVERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
 
+.PHONY: fixtures
+fixtures:
+	createdb contrib_regression
+	psql -v ON_ERROR_STOP=1 -f test/fixtures.sql -d contrib_regression
+
+.PHONY: clean_fixtures
+clean_fixtures:
+	dropdb --if-exists contrib_regression
+
+# extra dep for PostgreSQL targets in pgxs.mk
+clean: clean_fixtures
+
+TESTS = $(wildcard test/sql/*.sql)
+REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
+REGRESS_OPTS = --use-existing --inputdir=test
+
 EXTRA_CLEAN = sql/$(EXTENSION).sql sql/$(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
 
 PG_CONFIG = pg_config

README.md

@@ -7,30 +7,45 @@ SQL functions to build the OpenAPI output of a PostgREST instance.
 - The first step in the roadmap is to migrate the OpenAPI spec from the PostgREST core repository (version 2.0 to 3.1):
   - [x] Info object
   - [x] Server object (replaces host, basePath and schemes from OAS 2.0)
-  - [] Components object
+  - [ ] Components object
     - [x] Schemas (definitions in OAS 2.0)
     - [ ] Security scheme (security definitions in OAS 2.0)
     - [ ] Parameters
     - [ ] Responses (produces in OAS 2.0 - simple implementation)
     - [ ] Request bodies (consumes in OAS 2.0 - simple implementation)
-  - [] Paths object
+  - [ ] Paths object
 - The next step is to fix the issues tagged with `OpenAPI` in the core repo.
 
 ## Installation
 
+```bash
+make && sudo make install
+```
+
 ## Development
 
-- Execute the script to build the PostgreSQL extension file:
+For testing on your local database:
+
+```bash
+# this will load fixtures in a contrib_regression db on your local postgres
+make fixtures
+
+# run the tests, they can be run repeatedly
+make installcheck
+
+# to clean the fixtures you can use
+make clean
+```
 
-  ```
-  sh scripts/build.sh
-  ```
+For an isolated and reproducible enviroment you can use [Nix](https://nixos.org/download.html).
 
-- Run tests using [Nix](https://nixos.org/download.html):
+```bash
+# to run tests
+nix-shell --run "with-pg-15 make installcheck"
 
-  ```
-  nix-shell --run "with-pg-15 make installcheck"
-  ```
+# to interact with the local database with fixtures loaded
+nix-shell --run "with-pg-15 psql contrib_regression"
+```
 
 ## References
 

nix/pgScript.nix

@@ -20,9 +20,7 @@ let
 
     pg_ctl start -o "$default_options" -o "${options}"
 
-    createdb contrib_regression
-
-    psql -v ON_ERROR_STOP=1 -f test/fixtures/main.sql -d contrib_regression
+    make fixtures
 
     "$@"
   '';

test/fixtures/main.sql → test/fixtures.sql

@@ -1,6 +1,6 @@
 create extension postgrest_openapi;
 
-drop schema if exists types, test cascade;
+drop schema if exists types, test, private cascade;
 
 -- Custom types
 create schema types;