From 761c74cb95776ef59ee1f58b40a1a5de745d804b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bj=C3=B6rkevik?= <david@bjorkevik.se>
Date: Fri, 20 Sep 2024 09:31:58 +0200
Subject: [PATCH] Added utility shell script to launch PostgreSQL in Docker for
 use with test suite

---
 README.md                                     | 25 +++++++++++++
 .../init-scripts/pg8000-init.sh               | 36 +++++++++++++++++++
 .../init-scripts/pg8000-init.sql              |  3 ++
 postgres_test_server/run-test-server.sh       | 16 +++++++++
 4 files changed, 80 insertions(+)
 create mode 100644 postgres_test_server/init-scripts/pg8000-init.sh
 create mode 100644 postgres_test_server/init-scripts/pg8000-init.sql
 create mode 100755 postgres_test_server/run-test-server.sh

diff --git a/README.md b/README.md
index 9270b31..5af4ada 100644
--- a/README.md
+++ b/README.md
@@ -2061,6 +2061,21 @@ the easiest to express:
 
 - Install [tox](http://testrun.org/tox/latest/): `pip install tox`
 
+The pg8000 test suite requires a PostgreSQL server running on the local host.
+
+### Running PostgreSQL server using Docker
+If you have Docker installed you may use it to fire up a local PostgreSQL server
+to run the tests against, using the provided shell script:
+```shell
+./postgres_test_server/run-test-server.sh
+```
+The server will run in the foreground, logging all statements sent to it to the
+terminal, until you stop it with Ctrl-C.
+
+### Manual configuration of PostgreSQL server
+If you'd like to configure your PostgreSQL server manually instead of going
+with Docker, these are the required steps:
+
 - Enable the PostgreSQL hstore extension by running the SQL command:
   `create extension hstore;`
 
@@ -2077,8 +2092,18 @@ host    all                  all        127.0.0.1/32            trust
 - Set password encryption to `scram-sha-256` in `postgresql.conf`:
   `password_encryption = 'scram-sha-256'`
 
+- Enable SSL in `postgresql.conf`:
+  `ssl = on`
+
+- Create a self-signed server certificate for the PostgreSQL server.
+
+- Make sure there is a PostgreSQL user and a database with the same name as
+  you logged in user.
+
 - Set the password for the postgres user: `ALTER USER postgresql WITH PASSWORD 'pw';`
 
+### Running the tests
+
 - Run `tox` from the `pg8000` directory: `tox`
 
 This will run the tests against the Python version of the virtual environment, on the
diff --git a/postgres_test_server/init-scripts/pg8000-init.sh b/postgres_test_server/init-scripts/pg8000-init.sh
new file mode 100644
index 0000000..5844045
--- /dev/null
+++ b/postgres_test_server/init-scripts/pg8000-init.sh
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+cat > /var/lib/postgresql/data/pg_hba.conf  <<EOF
+host    pg8000_md5           all        0.0.0.0/0            md5
+host    pg8000_gss           all        0.0.0.0/0            gss
+host    pg8000_password      all        0.0.0.0/0            password
+host    pg8000_scram_sha_256 all        0.0.0.0/0            scram-sha-256
+host    all                  all        0.0.0.0/0            trust
+EOF
+
+
+# Generate server key and certificate
+openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout /var/lib/postgresql/data/server.key -out /var/lib/postgresql/data/server.crt -subj "/CN=localhost"
+
+# Secure the server.key file
+chmod 600 /var/lib/postgresql/data/server.key
+
+# Ensure the right owner and permissions for PostgreSQL to use the certificates
+chown postgres:postgres /var/lib/postgresql/data/server.crt /var/lib/postgresql/data/server.key
+
+# Enable SSL, set proper password encryption and enable logging of all statements
+cat >> /var/lib/postgresql/data/postgresql.conf <<EOF
+password_encryption = 'scram-sha-256'
+
+ssl = on
+ssl_cert_file = '/var/lib/postgresql/data/server.crt'
+ssl_key_file = '/var/lib/postgresql/data/server.key'
+
+log_statement = all
+EOF
+
+# Create a user and database with the same name as the "outside" user,
+#in order for code in readme.md tests to work
+
+createuser "${OUTSIDE_USER}"
+createdb "${OUTSIDE_USER}"
diff --git a/postgres_test_server/init-scripts/pg8000-init.sql b/postgres_test_server/init-scripts/pg8000-init.sql
new file mode 100644
index 0000000..332b2ad
--- /dev/null
+++ b/postgres_test_server/init-scripts/pg8000-init.sql
@@ -0,0 +1,3 @@
+CREATE EXTENSION hstore;
+
+CREATE DATABASE pg8000_gss;
diff --git a/postgres_test_server/run-test-server.sh b/postgres_test_server/run-test-server.sh
new file mode 100755
index 0000000..ec9750a
--- /dev/null
+++ b/postgres_test_server/run-test-server.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# This script will fire up a local postgresql test server using docker
+
+base_path=$(dirname "$0")
+
+docker run \
+       --interactive \
+       --tty \
+       --rm \
+       --publish 127.0.0.1:5432:5432 \
+       --env POSTGRES_PASSWORD=pw \
+       --env OUTSIDE_USER="$USER" \
+       --mount type=bind,source="$base_path/init-scripts",target=/docker-entrypoint-initdb.d \
+       --name pg8000-test-server \
+       postgres:latest "$@"