Add 'postgres-version' input parameter

ikalnytskyi · malor · rkiyanchuk · ikalnytskyi · commit 6bb2488b17fe · 2024-08-11T16:22:30.000+03:00
One of the foundational principles of this action was to use preinstalled PostgreSQL binaries. The rationale was simple: * Make sure the action is fast and no installation is required. * Make sure it's safe and doesn't reach out to external servers. * Make sure it's auditable and everyone can verify it contains no malicious code. It's quite common, however, for applications to follow upstream PostgreSQL releases and switch to them as soon as possible. This applications look to install the latest stable version instead. This patch adds a new `postgres-version` input parameter that controls what major version of PostgreSQL to install. Please note, the parameter receives only major part of the version, e.g. "14'. It's impossible to request any minor release. Co-Authored-By: Roman Podoliaka <roman.podoliaka@gmail.com> Co-Authored-By: Ruslan Kiyanchuk <ruslan.kiyanchuk@gmail.com> Resolves: #14
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -47,6 +47,7 @@ jobs:
           SERVICE_NAME: ${{ steps.postgres.outputs.service-name }}
           EXPECTED_CONNECTION_URI: postgresql://postgres:postgres@localhost:5432/postgres
           EXPECTED_SERVICE_NAME: postgres
+          EXPECTED_SERVER_VERSION: "16"
 
   parametrized:
     runs-on: ${{ matrix.os }}
@@ -56,6 +57,10 @@ jobs:
           - ubuntu-latest
           - macos-latest
           - windows-latest
+        postgres-version:
+          - "13"
+          - "14"
+          - "15"
     steps:
       - uses: actions/checkout@v4
 
@@ -66,6 +71,7 @@ jobs:
           password: GrandMaster
           database: jedi_order
           port: 34837
+          postgres-version: ${{ matrix.postgres-version }}
         id: postgres
 
       - name: Run setup-python
@@ -82,3 +88,4 @@ jobs:
           SERVICE_NAME: ${{ steps.postgres.outputs.service-name }}
           EXPECTED_CONNECTION_URI: postgresql://yoda:GrandMaster@localhost:34837/jedi_order
           EXPECTED_SERVICE_NAME: yoda
+          EXPECTED_SERVER_VERSION: ${{ matrix.postgres-version }}
diff --git a/README.md b/README.md
@@ -9,12 +9,13 @@ key features:
 
 * Runs on Linux, macOS and Windows action runners.
 * Adds PostgreSQL [client applications][1] to `PATH`.
-* Uses PostgreSQL binaries baked into [GitHub Actions Runner Images][2].
-* Easy [to prove][3] that it DOES NOT contain malicious code.
+* Supports PostgreSQL version parametrization.
+* Easy [to prove][2] that it DOES NOT contain malicious code.
+
+By default PostgreSQL 15 is used.
 
 [1]: https://www.postgresql.org/docs/current/reference-client.html
-[2]: https://github.com/actions/runner-images
-[3]: action.yml
+[2]: action.yml
 
 ## Usage
 
@@ -33,12 +34,13 @@ key features:
 
 #### Action Parameters
 
-| Key        | Value                                                                                                | Default     |
-|------------|------------------------------------------------------------------------------------------------------|-------------|
-| username   | The username of the user to setup.                                                                   | `postgres`  |
-| password   | The password of the user to setup.                                                                   | `postgres`  |
-| database   | The database name to setup and grant permissions to created user.                                    | `postgres`  |
-| port       | The server port to listen on.                                                                        | `5432`      |
+| Key              | Value                                                                                  | Default     |
+|------------------|----------------------------------------------------------------------------------------|-------------|
+| username         | The username of the user to setup.                                                     | `postgres`  |
+| password         | The password of the user to setup.                                                     | `postgres`  |
+| database         | The database name to setup and grant permissions to created user.                      | `postgres`  |
+| port             | The server port to listen on.                                                          | `5432`      |
+| postgres-version | The PostgreSQL major version to install. Supported versions: "13", "14", "15", "16".   | `16`        |
 
 #### Outputs
 
@@ -58,19 +60,20 @@ key features:
 
 ```yaml
 steps:
-  - uses: ikalnytskyi/action-setup-postgres@v6 
+  - uses: ikalnytskyi/action-setup-postgres@v6
 ```
 
 #### Advanced
 
 ```yaml
 steps:
-  - uses: ikalnytskyi/action-setup-postgres@v6 
+  - uses: ikalnytskyi/action-setup-postgres@v6
     with:
       username: ci
       password: sw0rdfish
       database: test
       port: 34837
+      postgres-version: "13"
     id: postgres
 
   - run: pytest -vv tests/
@@ -88,7 +91,7 @@ steps:
 
 ```yaml
 steps:
-  - uses: ikalnytskyi/action-setup-postgres@v6 
+  - uses: ikalnytskyi/action-setup-postgres@v6
 
   - run: |
       createuser myuser
@@ -110,7 +113,7 @@ steps:
 
 ```yaml
 steps:
-  - uses: ikalnytskyi/action-setup-postgres@v6 
+  - uses: ikalnytskyi/action-setup-postgres@v6
 ```
 
 ```python
diff --git a/action.yml b/action.yml
@@ -21,6 +21,10 @@ inputs:
     description: The server port to listen on.
     default: "5432"
     required: false
+  postgres-version:
+    description: The PostgreSQL major version to install. One of "13", "14", "15", and "16".
+    default: "16"
+    required: false
 outputs:
   connection-uri:
     description: The connection URI to connect to PostgreSQL.
@@ -31,10 +35,25 @@ outputs:
 runs:
   using: composite
   steps:
-    - name: Prerequisites
+    - name: Cache PostgreSQL installation packages
+      uses: actions/cache@v3
+      with:
+        key: ${{ runner.os }}-postgres-${{ inputs.postgres-version }}
+        path: |
+          /var/cache/apt/archives
+          C:\Users\<username>\AppData\Local\Temp\chocolatey
+
+    - name: Install PostgreSQL
       run: |
         if [ "$RUNNER_OS" == "Linux" ]; then
-          echo "$(pg_config --bindir)" >> $GITHUB_PATH
+          echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" \
+            | sudo tee /etc/apt/sources.list.d/pgdg.list
+          wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
+          sudo apt-get update
+          sudo apt-get -y install postgresql-${{ inputs.postgres-version }}
+
+          # Add PostgreSQL binaries to PATH, so they become globally available.
+          /usr/lib/postgresql/${{ inputs.postgres-version }}/bin/pg_config --bindir >> $GITHUB_PATH
         elif [ "$RUNNER_OS" == "Windows" ]; then
           echo "$PGBIN" >> $GITHUB_PATH
           echo "PQ_LIB_DIR=$PGROOT\lib" >> $GITHUB_ENV
@@ -45,6 +64,25 @@ runs:
           for name in "PGROOT" "PGDATA" "PGBIN" "PGUSER" "PGPASSWORD"; do
             echo "$name=" >> $GITHUB_ENV
           done
+
+          # FIXME: Aargh! For reasons unknown the '--servicename' option is
+          # ignored when installing a PostgreSQL version that is already
+          # preinstalled on GitHub runners. In order to bypass the issue I'm
+          # using default naming convention to overwrite the service name.
+          choco install postgresql${{ inputs.postgres-version }} \
+            --ia "--servicename postgresql-${{ runner.arch }}-${{ inputs.postgres-version }}"
+
+          # Stop PostgreSQL that has been auto started after installation. This
+          # action prepares new configuration and brings its own instance, and
+          # we need a network port to be free.
+          net stop postgresql-${{ runner.arch }}-${{ inputs.postgres-version }}
+
+          # Add PostgreSQL binaries to PATH, so they become globally available
+          # and set path to LIBPQ to link against. On Windows it comes together
+          # with PostgreSQL distribution.
+          export PGROOT="$PROGRAMFILES/PostgreSQL/${{ inputs.postgres-version }}"
+          "$PGROOT"/bin/pg_config.exe --bindir >> $GITHUB_PATH
+          echo "PQ_LIB_DIR=$("$PGROOT"/bin/pg_config.exe --libdir)" >> $GITHUB_ENV
         elif [ "$RUNNER_OS" == "macOS" ]; then
           case "$(sw_vers -productVersion)" in
             13.*|14.*)
@@ -56,6 +94,13 @@ runs:
               brew install --skip-post-install postgresql@14
               ;;
           esac
+
+          brew install postgresql@${{ inputs.postgres-version }}
+
+          # Link PostgreSQL binaries to /usr/local/bin so they become globally
+          # available. The overwrite option is required because they might be a
+          # preinstalled linked bottle.
+          brew link --overwrite postgresql@${{ inputs.postgres-version }}
         fi
       shell: bash
 
@@ -95,8 +140,7 @@ runs:
           --pwfile="$PWFILE" \
           --auth="scram-sha-256" \
           --encoding="$DEFAULT_ENCODING" \
-          --locale="$DEFAULT_LOCALE" \
-          --no-instructions
+          --locale="$DEFAULT_LOCALE"
 
         # Do not create unix sockets since they are created by default in the
         # directory we have no permissions to (owned by system postgres user).
diff --git a/test_action.py b/test_action.py
@@ -140,6 +140,13 @@ def test_environment_variables(is_windows: bool):
     assert pg_environ == pg_environ_exp
 
 
+def test_server_version(connection: psycopg.Connection):
+    """Test that PostgreSQL's version is expected."""
+
+    server_version = connection.execute("SHOW SERVER_VERSION").fetchone()[0]
+    assert server_version.split(".")[0] == os.getenv("EXPECTED_SERVER_VERSION")
+
+
 def test_user_permissions(connection: psycopg.Connection):
     """Test that a user has super/createdb permissions."""
 
