Development Guide

Project Structure

pgmorbac/
├── src/                    # Modular SQL source files
├── tests/                  # Test files
├── tools/                  # Build and test scripts
├── docs/                   # Documentation
├── pgmorbac.control       # Version source of truth
├── pgmorbac.sql          # Generated (git-ignored)
└── Makefile               # Build automation

Version Management

Version is defined in pgmorbac.control under default_version.

Edit source files in src/ and commit them. Never edit or commit pgmorbac.sql (generated by build script).

Development Workflow

Edit Source Files

vim src/authorization.sql

Build and Test

make check

This builds from src/, creates a temporary database, runs all tests, and cleans up.

Commit Changes

git add src/authorization.sql tests/01_authorization.sql
git commit -m "Add feature X"

The build script concatenates src/ files in dependency order (header first, footer last).

Manual Testing

make build
createdb mytest
psql -d mytest -f pgmorbac.sql
psql -d mytest
dropdb mytest

Release Process

Update version in pgmorbac.control
Update CHANGELOG.md
Run make build and make check
Commit and tag:

git commit -m "Release vX.Y.Z"
git tag vX.Y.Z
git push origin main --tags

Makefile Targets

make build      # Build from src/ files
make check       # Build and run tests
make install    # Install to PostgreSQL
make help       # Show all targets

Code Style

SQL keywords in UPPERCASE. Identifiers in lowercase_snake_case. Always qualify with morbac. schema.

Functions use verb_noun pattern. Tables use plural nouns.

Adding Features

Edit files in src/
Add tests in tests/
Update docs/DOCUMENTATION.md
Run make check
Commit source files

Debugging

SELECT * FROM morbac.auth_cache ORDER BY computed_at DESC LIMIT 10;
SELECT morbac.invalidate_cache();
EXPLAIN ANALYZE SELECT morbac.is_allowed(...);
SELECT morbac.refresh_hierarchy_cache();

Resources

See DOCUMENTATION.md, PERFORMANCE.md, and ADMIN_GUIDE.md.

2.2 KiB Raw Permalink Blame History