Feat/implement testcontainers

.github/workflows/release.yml

@@ -10,14 +10,14 @@ jobs:
   tests-npm:
     uses: digicatapult/shared-workflows/.github/workflows/tests-npm.yml@main
     with:
+      docker_compose_file: ''
       npm_build_command: 'npm run tsoa:build'
-      pre_test_command: 'npm run db:migrate'
-      docker_compose_file: docker-compose.yml
   e2e-tests-npm:
     uses: digicatapult/shared-workflows/.github/workflows/tests-e2e-npm.yml@main
     with:
-      docker_compose_file: docker-compose.e2e.yml
-      test_command: 'docker compose -f docker-compose.e2e.yml up --exit-code-from e2e-tests --abort-on-container-exit --quiet-pull'
+      docker_compose_file: ''
+      pre_test_command: 'npm ci && npx playwright install-deps && npx playwright install'
+      test_command: 'npm run test:playwright || exit 1'
     permissions:
       contents: write
     secrets: inherit
@@ -38,4 +38,4 @@ jobs:
     uses: digicatapult/shared-workflows/.github/workflows/release-github.yml@main
     permissions:
       contents: write
-    secrets: inherit
+    secrets: inherit

.github/workflows/test.yml

@@ -10,14 +10,14 @@ jobs:
   tests-npm:
     uses: digicatapult/shared-workflows/.github/workflows/tests-npm.yml@main
     with:
+      docker_compose_file: ''
       npm_build_command: 'npm run tsoa:build'
-      pre_test_command: 'npm run db:migrate'
-      docker_compose_file: docker-compose.yml
   e2e-tests-npm:
     uses: digicatapult/shared-workflows/.github/workflows/tests-e2e-npm.yml@main
     with:
-      docker_compose_file: docker-compose.e2e.yml
-      test_command: 'docker compose -f docker-compose.e2e.yml up --exit-code-from e2e-tests --abort-on-container-exit --quiet-pull'
+      docker_compose_file: ''
+      pre_test_command: 'npm ci && npx playwright install-deps && npx playwright install'
+      test_command: 'npm run test:playwright || exit 1'
     permissions:
       contents: write
     secrets: inherit

Dockerfile

@@ -14,7 +14,7 @@ COPY . .
 RUN npm run build
 
 # Test stage
-FROM node:current-bookworm-slim AS test
+FROM node:lts-bookworm-slim AS test
 
 WORKDIR /veritable-ui
 

README.md

@@ -168,7 +168,7 @@ npm run test:unit
 
 Integration tests are placed at the root level of a repository and can be found at the root level `test/` folder along with mock services and helpers and a test environment variables that will be in `test/test.env`.
 
-Integration tests can be run locally by executing the below command
+Integration tests can be run locally by executing the below command (it is recommended to add debugging so you can follow the logs in the console, refer to [testcontainers section](#testcontainers))
 
 ```sh
 npm run test:integration
@@ -196,6 +196,7 @@ Then run:
 npm run test:e2e
 ```
 
+(it is recommended to add debugging so you can follow the logs in the console, refer to [testcontainers section](#testcontainers))
 A browser window will pop up where you can run tests and follow their progress. Alternatively you can run:
 
 ```sh
@@ -212,6 +213,36 @@ docker compose -f docker-compose.e2e.yml up
 
 Then you'll find the test results in directory `playwright-report` at root level.
 
+### Testcontainers
+
+so see logs from a container e.g. if it is dying on startup add:
+
+```
+.withLogConsumer((stream) => {
+    stream.on('data', (line) => console.log(line))
+    stream.on('err', (line) => console.error(line))
+    stream.on('end', () => console.log('Stream closed'))
+})
+```
+
+and run with
+
+```
+DEBUG=testcontainers* npm run test:integration
+```
+
+or
+
+```
+DEBUG=testcontainers* npm run test:e2e
+```
+
+Normally the containers are removed after a run, however you can keep them for further inspection by adding this:
+
+```
+await container.stop({ remove: false })
+```
+
 ## Database
 
 This service is dependant on postgreSQL which will sync up across all nodes and will update cloudagent when needed. We use `knex` wrapper for wrapping [create, read, write, update] database quries. We also have different models for inserting and returning data which gives us a control of sensitive data or data we do not want to get along the record. We also use **zod** for enchanted validation. It's currently used in `src/models/db/types.ts` file.