Merge pull request #8 from funidata/trunk

Test database migrations in CI

.github/workflows/run-tests.yaml

@@ -34,3 +34,22 @@ jobs:
         run: npm ci
       - name: Run prettier
         run: npm run format:check
+
+  migrations:
+    name: Check database migrations
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+      - name: Build Docker image
+        run: npm run build
+      - name: Start Postgres
+        run: docker compose up -d db
+      - name: Run migrations
+        run: docker compose run app npm run migration:run
+      - name: Stop Postgres
+        run: npm stop

.prettierignore

@@ -0,0 +1 @@
+app/dist

README.md

@@ -7,3 +7,4 @@ revolves around easily sharing information about when and where from you are wor
 
 - [Requirements](./docs/requirements.md)
 - [Configuration](./docs/configuration.md)
+- [Testing](./docs/testing.md)

compose.yaml

@@ -7,7 +7,8 @@ services:
       context: app
       dockerfile: Dockerfile.dev
     env_file:
-      - .env
+      - path: .env
+        required: false
     environment:
       NODE_ENV: development
       DATABASE_NAME: kaiku_dev

docs/testing.md

@@ -0,0 +1,32 @@
+# Testing
+
+Currently, Kaiku's test suite includes only linting, formatting, and database migration checks. The
+plan is to utilize integration tests as the primary tool once the project matures slightly more.
+
+Passing all tests is required for code to be merged into `main`.
+
+## Local Development
+
+Run all local tests with `npm test`. (Does not include migration tests.)
+
+### Linting
+
+Linting is configured only for the `app/` folder and uses ESLint.
+
+```bash
+npm run lint
+```
+
+### Formatting
+
+Prettier is used to format all code in the repository. The formatting test passes if formatting
+results in an empty diff. Prettier is configured in repository root.
+
+```bash
+npm run format:check
+```
+
+## CI/CD
+
+GitHub Actions is used for CI/CD. In addition to linting and formatting, also database migrations
+are run on CI. This test simply requires the migration run to result in the zero exit code.

package.json

@@ -8,7 +8,9 @@
     "build": "docker compose build",
     "logs": "docker compose logs -f app",
     "postinstall": "cd app && npm ci",
-    "format:check": "prettier --check ."
+    "format:check": "prettier --check .",
+    "lint": "cd app && npm run lint",
+    "test": "npm run format:check && npm run lint"
   },
   "author": "Joonas Häkkinen <[email protected]>",
   "license": "GPL-3.0",