Merge pull request #6612 from NHSDigital/enable-postgis

Enable PostGIS

Author: thomasleese

…ithub/workflows/create_dockerized_db.yml …kflows/build-and-push-database-image.yml.github/workflows/create_dockerized_db.yml renamed to .github/workflows/build-and-push-database-image.yml .github/workflows/create_dockerized_db.yml renamed to .github/workflows/build-and-push-database-image.yml

@@ -1,11 +1,10 @@
-name: Create Dockerized Database
-run-name: Creating dockerized image from ${{ github.ref_name }}
+name: Build and push database image
+run-name: Build and push database image for ${{ github.ref_name }}
 
 on:
   workflow_dispatch:
   push:
-    branches:
-      - next
+    branches: [next]
   workflow_call:
     inputs:
       github_ref:
@@ -17,8 +16,8 @@ permissions:
   contents: read
 
 jobs:
-  setup-development-database:
-    name: Setup Development Database
+  build-and-push-database-image:
+    name: Build and push database image
     runs-on: ubuntu-latest
     env:
       RAILS_ENV: development
@@ -32,34 +31,36 @@ jobs:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           ref: ${{ inputs.github_ref || github.ref_name == 'next' && 'next' || github.ref_name }}
-          repository: nhsuk/manage-vaccinations-in-schools
+          repository: nhsdigital/manage-vaccinations-in-schools
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
         with:
           node-version-file: .tool-versions
           cache: yarn
-      - name: Build custom postgres image
-        run: |
-          echo -e "FROM postgres:16.11\n\nENV PGDATA=\"/var/lib/postgresql/mydata\"" > db.Dockerfile
-          docker build -t custom-postgres:latest -f db.Dockerfile .
-      - name: Start db container
+      - name: Create Dockerfile
+        run: >-
+          echo -e \
+            "FROM postgis/postgis:17-master\nENV PGDATA=\"/var/lib/postgresql/mydata\"" \
+            > database.Dockerfile
+      - name: Build image
+        run: docker build -t database:latest -f database.Dockerfile .
+      - name: Start container
         run: |
           docker run -d \
             --name database \
             -e "POSTGRES_HOST_AUTH_METHOD=trust" \
             -p 5432:5432 \
-            custom-postgres:latest
-      - name: Wait for db to be ready
+            database:latest
+      - name: Wait for database to be ready
         run: |
           docker exec database bash -c '
             until pg_isready -U postgres; do
               echo "Waiting for postgres..."
               sleep 2
-            done
-                '
+            done'
       - uses: ruby/setup-ruby@60ecfba8750476ff216b59eee3b88218bb5111cc # v1.303.0
         with:
           bundler-cache: true
-      - name: Populate database for testing
+      - name: Set up database for testing
         run: |
           bin/rails db:setup
           bin/rails feature_flags:enable_for_development
@@ -73,17 +74,17 @@ jobs:
         id: login-ecr
         uses: aws-actions/amazon-ecr-login@376925c9d111252e87ae59691e5a442dd100ef6a # v2.1.3
       # yamllint disable rule:line-length
-      - name: get github ref short
-        id: github-ref
+      - name: Get image tag
+        id: get-image-tag
         run: |
           git_ref=$(git rev-parse ${{ inputs.github_ref || github.ref_name == 'next' && 'origin/next' || github.ref_name }})
-          echo "ref=$git_ref" >> "$GITHUB_OUTPUT"
-      - name: Commit postgres container with database
+          echo "value=$git_ref" >> "$GITHUB_OUTPUT"
+      - name: Commit image
         run: >-
           docker commit database "${{ steps.login-ecr.outputs.registry
-          }}/mavis/development/postgres_db:${{ steps.github-ref.outputs.ref }}"
+          }}/mavis/development/postgres_db:${{ steps.get-image-tag.outputs.value }}"
       - name: Push image
         run: >-
           docker push "${{ steps.login-ecr.outputs.registry }}/mavis/development/postgres_db:${{
-          steps.github-ref.outputs.ref }}"
+          steps.get-image-tag.outputs.value }}"
       # yamllint enable rule:line-length

.github/workflows/end-to-end-tests-aws.yml

@@ -1,4 +1,4 @@
-name: AWS deployment E2E tests
+name: AWS
 
 on:
   workflow_call:
@@ -122,7 +122,7 @@ jobs:
     permissions:
       id-token: write
       contents: read
-    uses: ./.github/workflows/create_dockerized_db.yml
+    uses: ./.github/workflows/build-and-push-database-image.yml
     with:
       github_ref: ${{ needs.check-database-image-presence.outputs.db_git_ref_sha }}
   launch-dockerized-devimage:

.github/workflows/end-to-end-tests-local.yml

@@ -1,13 +1,13 @@
-name: Local E2E tests
+name: Local
 
 on: [workflow_call]
 
 jobs:
   end-to-end-tests:
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres:17.2
+      postgresql:
+        image: postgis/postgis:17-master
         env:
           POSTGRES_PASSWORD: postgres
         options: >-

.github/workflows/end-to-end-tests-on-pull-request.yml

@@ -1,4 +1,4 @@
-name: E2E tests on PR
+name: End-to-end tests
 
 on: [pull_request]
 
@@ -11,7 +11,7 @@ permissions: {}
 jobs:
   aws-e2e-flow:
     if: github.event.pull_request.head.repo.full_name == github.repository
-    name: AWS deployment E2E tests
+    name: AWS
     permissions:
       id-token: write
       contents: write
@@ -22,7 +22,7 @@ jobs:
 
   local-e2e-flow:
     if: github.event.pull_request.head.repo.full_name != github.repository
-    name: Local E2E tests
+    name: Local
     uses: ./.github/workflows/end-to-end-tests-local.yml
 
   ensure-run-success:

.github/workflows/test.yml

@@ -11,8 +11,8 @@ jobs:
     name: RSpec
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres:17.2
+      postgresql:
+        image: postgis/postgis:17-master
         env:
           POSTGRES_PASSWORD: postgres
         options: >-
@@ -50,8 +50,8 @@ jobs:
     name: Seeds
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres:17.2
+      postgresql:
+        image: postgis/postgis:17-master
         env:
           POSTGRES_PASSWORD: postgres
         options: >-
@@ -60,7 +60,8 @@ jobs:
           - 5432:5432
     env:
       RAILS_ENV: development
-      DATABASE_URL: postgres://postgres:postgres@localhost:5432/manage_vaccinations_development
+      DATABASE_URL: >-
+        postgis://postgres:postgres@localhost:5432/manage_vaccinations_development
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
@@ -70,7 +71,7 @@ jobs:
       - uses: ruby/setup-ruby@60ecfba8750476ff216b59eee3b88218bb5111cc # v1.303.0
         with:
           bundler-cache: true
-      - name: Check seeds run
+      - name: Run seeds
         run: bin/rails db:prepare
 
   jest:
@@ -82,5 +83,7 @@ jobs:
         with:
           node-version-file: .tool-versions
           cache: yarn
-      - run: yarn install --immutable --immutable-cache --check-cache
-      - run: yarn test
+      - name: Install dependencies
+        run: yarn install --immutable --immutable-cache --check-cache
+      - name: Run tests
+        run: yarn test

.tool-versions

@@ -3,9 +3,9 @@ awscli     2.27.46
 hk         1.37.0
 nodejs     22.15.0
 pkl        0.31.0
-postgres   17.2
 python     3.14.4
-redis      8.2.1
 ruby       4.0.3
 shellcheck 0.11.0
 yamllint   1.38.0
+yarn       4.9.4
+uv         0.11.7

Gemfile

@@ -22,6 +22,7 @@ gem "stackprof"
 
 # 3rd party gems
 gem "activerecord-import"
+gem "activerecord-postgis-adapter"
 gem "activerecord-session_store"
 gem "active_record_union"
 gem "amazing_print"

Gemfile.lock

@@ -90,6 +90,9 @@ GEM
       timeout (>= 0.4.0)
     activerecord-import (2.2.0)
       activerecord (>= 4.2)
+    activerecord-postgis-adapter (11.1.1)
+      activerecord (~> 8.1.0)
+      rgeo-activerecord (~> 8.1.0)
     activerecord-session_store (2.2.0)
       actionpack (>= 7.0)
       activerecord (>= 7.0)
@@ -664,6 +667,10 @@ GEM
     reverse_markdown (3.0.2)
       nokogiri
     rexml (3.4.4)
+    rgeo (3.1.0)
+    rgeo-activerecord (8.1.0)
+      activerecord (>= 8.1, < 8.2)
+      rgeo (>= 3.0)
     rladr (1.2.0)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -910,6 +917,7 @@ PLATFORMS
 DEPENDENCIES
   active_record_union
   activerecord-import
+  activerecord-postgis-adapter
   activerecord-session_store
   amazing_print
   annotaterb

README.md

@@ -16,8 +16,8 @@ This is a service used within the NHS for managing and recording school-aged vac
 
 We have two RDoc versions:
 
-1. [next](https://nhsuk.github.io/manage-vaccinations-in-schools/rdoc/next) - useful for dev work (based off the `next` branch).
-2. [release](https://nhsuk.github.io/manage-vaccinations-in-schools/rdoc/release) - useful for ops to debug live issues (based off the `release` branch).
+- [next](https://nhsdigital.github.io/manage-vaccinations-in-schools/rdoc/next/) - useful for dev work (based off the `next` branch).
+- [release](https://nhsdigital.github.io/manage-vaccinations-in-schools/rdoc/release/) - useful for ops to debug live issues (based off the `release` branch).
 
 ## Development
 
@@ -29,7 +29,7 @@ This project depends on:
 - [Ruby on Rails](https://rubyonrails.org/)
 - [NodeJS](https://nodejs.org/)
 - [Yarn](https://yarnpkg.com/)
-- [PostgreSQL](https://www.postgresql.org/)
+- [PostgreSQL](https://www.postgresql.org/) with [PostGIS](https://postgis.net/)
 - [Redis](https://redis.io/) or [Valkey](https://valkey.io/)
 
 The instructions below assume you are using `mise` to manage the necessary
@@ -48,34 +48,55 @@ bin/bundle exec rladr new title
 
 ### Installing dependencies
 
-This project uses `mise`. Use the following to set up (replace `brew` and
-package names depending on your platform):
+This project uses [`mise`](https://mise.jdx.dev/) to manage tool versions.
+
+#### Prerequisites
+
+Before you can run `mise install` you might need to install some system
+libraries and databases.
+
+##### macOS with Homebrew
 
 ```shell
-# Dependencies for ruby
+# Dependencies for Ruby
 brew install libyaml
 
-# Dependencies for postgres
-brew install gcc readline zlib curl ossp-uuid icu4c pkg-config
+# PostgreSQL
+brew install postgresql postgis
 
-# Env vars for postgres
-export OPENSSL_PATH=$(brew --prefix openssl)
-export CMAKE_PREFIX_PATH=$(brew --prefix icu4c)
-export PATH="$OPENSSL_PATH/bin:$CMAKE_PREFIX_PATH/bin:$PATH"
-export LDFLAGS="-L$OPENSSL_PATH/lib $LDFLAGS"
-export CPPFLAGS="-I$OPENSSL_PATH/include $CPPFLAGS"
-export PKG_CONFIG_PATH="$CMAKE_PREFIX_PATH/lib/pkgconfig"
-export MACOSX_DEPLOYMENT_TARGET="$(sw_vers -productVersion)"
+# Redis
+brew install redis
 
-# Version manager
+# Mise
 brew install mise
+```
+
+##### Debian-based Linux
 
-# Yarn via brew as this skips installing `gpg`
-brew install yarn
+```shell
+# Dependencies for Ruby
+sudo apt install build-essential autoconf libssl-dev libyaml-dev zlib1g-dev libffi-dev libgmp-dev libicu-dev rustc
+
+# PostgreSQL
+sudo apt install -y postgresql-common
+sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
+sudo apt install postgresql-17 postgresql-contrib postgresql-17-postgis-3
+sudo -u postgres psql -c "CREATE USER $(whoami); ALTER USER $(whoami) WITH SUPERUSER;"
+
+# Redis
+sudo apt install redis-server
+
+# Mise
+curl https://mise.run | sh
 ```
 
-Then to install the required tools (or update, following a change to
-`.tool-versions`):
+See [installing Mise](https://mise.jdx.dev/installing-mise.html) for more
+details on how to install Mise.
+
+#### Using Mise
+
+At this point it should now be possible to use `mise` to install the required
+versions of the tools.
 
 ```shell
 mise install
@@ -86,28 +107,33 @@ mise install
 For the application to start successfully, PostgreSQL and Redis/Valkey must be
 running.
 
-#### PostgreSQL
+#### macOS with Homebrew
 
-If using `brew`, the simplest option is to run `brew services start postgresql`.
+```shell
+brew services start postgresql redis
+```
 
-Alternatively, you can run the server manually:
+#### Debian-based Linux
 
 ```shell
-pg_ctl start
-psql -U postgres -c "CREATE USER $(whoami); ALTER USER $(whoami) WITH SUPERUSER;"
+sudo systemctl start postgresql.service
+sudo systemctl start redis.service
 ```
 
-#### Redis/Valkey
+#### Manually
 
-If using `brew`, the simplest option is to run `brew services start redis`.
+```shell
+pg_ctl start
+psql -U postgres -c "CREATE USER $(whoami); ALTER USER $(whoami) WITH SUPERUSER;"
+```
 
-Alternatively, you can run the server manually:
+You may have to run this as root via `sudo`.
 
 ```shell
 redis-server
 ```
 
-### Running locally
+### Running the application
 
 When running for the first time, `bin/setup` will automatically install Ruby
 dependencies and set up the database.