Merge pull request #20 from cipherstash/chore/add-postgres-tests

Chore: add Postgres integration tests

Author: CDThomas

.github/workflows/test.yml

@@ -52,6 +52,16 @@ jobs:
   tests:
     name: Tests
     runs-on: ubuntu-latest
+    env:
+      CS_WORKSPACE_ID: ${{ secrets.CS_WORKSPACE_ID }}
+      CS_CLIENT_ACCESS_KEY: ${{ secrets.CS_CLIENT_ACCESS_KEY }}
+      CS_CLIENT_ID: ${{ secrets.CS_CLIENT_ID }}
+      CS_CLIENT_KEY: ${{ secrets.CS_CLIENT_KEY }}
+      PGPORT: 5432
+      PGDATABASE: cipherstash
+      PGUSER: cipherstash
+      PGPASSWORD: password
+      PGHOST: localhost
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
@@ -69,11 +79,12 @@ jobs:
       - name: Install integration test dependencies
         run: npm ci
         working-directory: ./integration-tests
+      - name: Set up integration test DB
+        run: |
+          docker compose up --detach --wait
+          npm run eql:download
+          npm run eql:install
+        working-directory: ./integration-tests
       - name: Test (integration)
-        env:
-          CS_WORKSPACE_ID: ${{ secrets.CS_WORKSPACE_ID }}
-          CS_CLIENT_ACCESS_KEY: ${{ secrets.CS_CLIENT_ACCESS_KEY }}
-          CS_CLIENT_ID: ${{ secrets.CS_CLIENT_ID }}
-          CS_CLIENT_KEY: ${{ secrets.CS_CLIENT_KEY }}
         run: npm test
         working-directory: ./integration-tests

.gitignore

@@ -8,3 +8,4 @@ cargo.log
 cross.log
 mise.local.toml
 cipherstash.secret.toml
+cipherstash-*.sql

README.md

@@ -124,20 +124,31 @@ protect-ffi/
 Integration tests live in the `./integration-tests` directory.
 These tests use the local build of Rust and JavaScript artifacts to test `@cipherstash/protect-ffi` as API consumers would.
 
-These tests rely on CipherStash to be configured (via `.toml` config or environment variables).
+These tests rely on:
 
-Example environment variables to set:
+- CipherStash to be configured (via `.toml` config or environment variables), and 
+- Environment variables for Postgres to be set
+
+Example environment variables:
 ```
 CS_CLIENT_ID=
 CS_CLIENT_KEY=
 CS_CLIENT_ACCESS_KEY=
 CS_WORKSPACE_ID=
+PGPORT=5432
+PGDATABASE=cipherstash
+PGUSER=cipherstash
+PGPASSWORD=password
+PGHOST=localhost
 ```
 
 To run integration tests:
 ```
 npm run debug
 cd integration-tests
+docker compose up --detach --wait
+npm run eql:download
+npm run eql:install
 npm run test
 ```
 

integration-tests/docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  postgres:
+    image: postgres:latest
+    container_name: protect-ffi-postgres
+    environment:
+      - POSTGRES_DB=${PGDATABASE:-cipherstash}
+      - POSTGRES_USER=${PGUSER:-cipherstash}
+      - POSTGRES_PASSWORD=${PGPASSWORD:-password}
+    ports:
+      - 5432:5432
+    restart: always
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready" ]
+      interval: 1s
+      timeout: 5s
+      retries: 10