WIP

lamppu · lamppu · commit 6d2d291f0944 · 2025-04-09T18:26:35.000+03:00
diff --git a/.env.example b/.env.example
@@ -13,13 +13,6 @@ DATABASE_URL=
 # API URL
 NEXT_PUBLIC_API_URL=http://localhost:5000/api/
 
-##########################################################################
-# Compulsory when running Playwright tests:
-##########################################################################
-# E2E test user credentials
-E2E_USER_USERNAME=
-E2E_USER_PASSWORD=
-
 ##########################################################################
 # Compulsory in production (aka when NODE_ENV=production):
 ##########################################################################
diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
@@ -17,17 +17,7 @@ jobs:
         environment: test-environment
         env:
             DATABASE_URL: ${{ vars.DATABASE_URL }}
-            E2E_USER_USERNAME: ${{ secrets.E2E_USER_USERNAME }}
-            E2E_USER_PASSWORD: ${{ secrets.E2E_USER_PASSWORD }}
-            KEYCLOAK_URL: ${{ vars.KEYCLOAK_URL }}
-            KEYCLOAK_REALM: ${{ secrets.KEYCLOAK_REALM }}
-            KEYCLOAK_CLIENT_ID_UI: ${{ secrets.KEYCLOAK_CLIENT_ID_UI }}
-            KEYCLOAK_CLIENT_SECRET_UI: ${{ secrets.KEYCLOAK_CLIENT_SECRET_UI }}
-            KEYCLOAK_CLIENT_ID_API: ${{ secrets.KEYCLOAK_CLIENT_ID_API }}
-            KEYCLOAK_CLIENT_SECRET_API: ${{ secrets.KEYCLOAK_CLIENT_SECRET_API }}
-            NEXTAUTH_URL: http://localhost:3000
             NEXTAUTH_SECRET: ${{ secrets.NEXTAUTH_SECRET }}
-            NEXT_PUBLIC_API_URL: http://localhost:3001/api/
         steps:
             - uses: actions/checkout@v4
             - uses: actions/setup-node@v4
@@ -36,19 +26,14 @@ jobs:
                   cache: "npm"
             - name: Install dependencies
               run: npm ci
-            - name: Install Playwright Browsers
-              working-directory: apps/clearance_ui
-              run: npx playwright install --with-deps
             - name: Run prisma generate
               run: npm run db:generate
-            - name: Build project
-              run: npm run build
             - name: Start the testing environment
-              run: docker compose up -d
+              run: docker compose up api clearance-ui scanner-worker -d
             - name: Seed the database and populate the spaces bucket
               run: npm run db:migrate:reset
             - name: Run Playwright tests
-              run: npm run test:e2e
+              run: docker compose up playwright-tests
             - name: Print Docker Compose logs
               run: docker compose logs
               if: failure()
diff --git a/.gitignore b/.gitignore
@@ -158,3 +158,6 @@ yarn.lock
 # Terraform
 terraform/.terraform/*
 terraform/terraform.tfstate*
+
+# Playwright artifacts
+playwright-artifacts/*
diff --git a/Playwright.Dockerfile b/Playwright.Dockerfile
@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2025 Double Open Oy
+#
+# SPDX-License-Identifier: MIT
+
+FROM node:22.14.0
+
+WORKDIR /workspace
+
+RUN npm i -g turbo
+
+COPY package.json ./package.json
+COPY apps/api/package.json ./apps/api/package.json
+COPY apps/clearance_ui/package.json ./apps/clearance_ui/package.json
+COPY packages/database/package.json ./packages/database/package.json
+COPY packages/s3-helpers/package.json ./packages/s3-helpers/package.json
+COPY packages/spdx-validation/package.json ./packages/spdx-validation/package.json
+COPY packages/validation-helpers/package.json ./packages/validation-helpers/package.json
+COPY package-lock.json ./package-lock.json
+
+RUN npm ci
+
+COPY . .
+
+RUN npm run db:generate
+
+RUN npm run build:api
+
+ARG NEXT_PUBLIC_API_URL
+ENV NEXT_PUBLIC_API_URL=$NEXT_PUBLIC_API_URL
+
+RUN npm run build:cui
+
+# Install browsers for UI tests
+WORKDIR /workspace/apps/clearance_ui
+RUN npm run install-browsers
diff --git a/README.md b/README.md
@@ -42,8 +42,6 @@ To run this project you will need Node.js, npm and Docker installed.
 
     ```shell
     DATABASE_URL=postgres://postgres:postgres@localhost:5432/postgres
-    E2E_USER_USERNAME=
-    E2E_USER_PASSWORD=
     ```
 
     See [.env.example](https://github.com/doubleopen-project/dos/blob/main/.env.example) file for other non-compulsory configurable variables.
diff --git a/apps/api/playwright.config.ts b/apps/api/playwright.config.ts
@@ -19,15 +19,15 @@ export default defineConfig({
 
     testDir: "./tests/e2e",
     /* Run tests in files in parallel */
-    fullyParallel: true,
+    //fullyParallel: true,
     /* Fail the build on CI if you accidentally left test.only in the source code. */
     forbidOnly: !!process.env.CI,
     /* Retry on CI only */
     retries: process.env.CI ? 2 : 0,
     /* Opt out of parallel tests on CI. */
     workers: process.env.CI ? 1 : undefined,
     /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-    reporter: "html",
+    reporter: [["html", { open: "never" }]],
     /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
     use: {
         /* Base URL to use in actions like `await page.goto('/')`. */
diff --git a/apps/api/tests/e2e/api.spec.ts b/apps/api/tests/e2e/api.spec.ts
@@ -11,34 +11,31 @@ import {
 import test, { expect } from "@playwright/test";
 import { Zodios, ZodiosInstance } from "@zodios/core";
 import AdmZip from "adm-zip";
-import { getPresignedPutUrl, S3Client } from "s3-helpers";
+import { authConfig } from "common-helpers";
+//import { getPresignedPutUrl, S3Client } from "s3-helpers";
 import { dosAPI, userAPI } from "validation-helpers";
 
 /**
  * Construct Zodios callers for the API endpoints to easily call them in the tests.
  */
 
-const server = process.env.KEYCLOAK_URL;
-const realm = process.env.KEYCLOAK_REALM;
-const clientId = process.env.KEYCLOAK_CLIENT_ID_API;
-const clientSecret = process.env.KEYCLOAK_CLIENT_SECRET_API;
-const username = process.env.E2E_USER_USERNAME;
-const password = process.env.E2E_USER_PASSWORD;
-
-if (!server || !realm || !clientId || !clientSecret || !username || !password) {
-    throw new Error(
-        "KEYCLOAK_URL, KEYCLOAK_REALM, KEYCLOAK_CLIENT_ID_API, KEYCLOAK_CLIENT_SECRET_API, E2E_USER_USERNAME and E2E_USER_PASSWORD environment variables must be set",
-    );
-}
+const server = authConfig.url;
+const realm = authConfig.realm;
+const clientId = authConfig.clientIdUI;
+const clientSecret = authConfig.clientSecretUI;
+const username = "test-user";
+const password = "test-user";
+const apiUrl = process.env.E2E_API_BASE_URL || "http://localhost:5000";
 
+/*
 const s3Client = S3Client(
     process.env.NODE_ENV !== "production",
     // This needs to be localhost instead of SPACES_ENDPOINT due to the containers needing to access
     // Minio with SPACES_ENDPOINT, but the tests needing to access Minio with localhost.
     "http://localhost:9000",
     process.env.SPACES_KEY,
     process.env.SPACES_SECRET,
-);
+);*/
 
 test.describe("API lets authenticated users to", () => {
     let keycloakToken: string;
@@ -72,7 +69,7 @@ test.describe("API lets authenticated users to", () => {
         const body = await result.json();
         keycloakToken = (body as { access_token: string }).access_token;
 
-        userZodios = new Zodios("http://localhost:3001/api/user/", userAPI, {
+        userZodios = new Zodios(`${apiUrl}/api/user/`, userAPI, {
             axiosConfig: {
                 headers: {
                     Authorization: `Bearer ${keycloakToken}`,
@@ -88,7 +85,7 @@ test.describe("API lets authenticated users to", () => {
 
         dosToken = userToken.token;
 
-        dosZodios = new Zodios("http://localhost:3001/api/", dosAPI, {
+        dosZodios = new Zodios(`${apiUrl}/api/`, dosAPI, {
             axiosConfig: {
                 headers: {
                     Authorization: `Bearer ${dosToken}`,
@@ -133,11 +130,18 @@ test.describe("API lets authenticated users to", () => {
          * running on host. This means that we need to create the presigned URL with an external S3
          * client that can access the Minio on localhost.
          */
+        /*
         const presignedUrl = await getPresignedPutUrl(
             s3Client,
             "doubleopen",
             zipKey,
-        );
+        );*/
+
+        const presignedUrl = (
+            await dosZodios.post("/upload-url", {
+                key: zipKey,
+            })
+        ).presignedUrl;
 
         expect(presignedUrl).toBeDefined();
 
diff --git a/apps/clearance_ui/package.json b/apps/clearance_ui/package.json
@@ -11,7 +11,8 @@
         "test:watch": "jest --watchAll --verbose",
         "test:e2e": "playwright test",
         "test:e2e:report": "playwright show-report",
-        "test:e2e:ui": "playwright test --ui"
+        "test:e2e:ui": "playwright test --ui",
+        "install-browsers": "playwright install --with-deps"
     },
     "dependencies": {
         "@hookform/resolvers": "5.0.1",
diff --git a/apps/clearance_ui/playwright.config.ts b/apps/clearance_ui/playwright.config.ts
@@ -29,13 +29,16 @@ export default defineConfig({
     /* Opt out of parallel tests on CI. */
     workers: process.env.CI ? 1 : undefined,
     /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-    reporter: "html",
+    reporter: [["html", { open: "never" }]],
     /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
     use: {
         /* Base URL to use in actions like `await page.goto('/')`. */
+        /*
         baseURL: process.env.CI
             ? "http://localhost:3002"
-            : "http://localhost:3000",
+            : "http://localhost:3000",*/
+
+        baseURL: process.env.E2E_UI_BASE_URL || "http://localhost:3000",
 
         /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
         trace: "on-first-retry",
diff --git a/apps/clearance_ui/tests/e2e/global.setup.ts b/apps/clearance_ui/tests/e2e/global.setup.ts
@@ -6,11 +6,6 @@ import { expect, test as setup } from "@playwright/test";
 import { STORAGE_STATE } from "../../playwright.config";
 
 setup("logs in", async ({ page }) => {
-    if (!process.env.E2E_USER_USERNAME || !process.env.E2E_USER_PASSWORD) {
-        throw new Error(
-            "E2E_USER_USERNAME and E2E_USER_PASSWORD environment variables must be set",
-        );
-    }
     // Clear old session cookie from the browser
     await page.goto("/api/auth/signout");
 
@@ -24,8 +19,8 @@ setup("logs in", async ({ page }) => {
     await page.click("button:has-text('Sign in with Keycloak')");
 
     // Fill the login form
-    await page.fill("#username", process.env.E2E_USER_USERNAME);
-    await page.fill("#password", process.env.E2E_USER_PASSWORD);
+    await page.fill("#username", "test-user");
+    await page.fill("#password", "test-user");
 
     // Submit login form
     await page.click('button[type="submit"]');
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -112,11 +112,8 @@ services:
             - 3001:3001
         environment:
             - DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
-            - KEYCLOAK_URL=$KEYCLOAK_URL
-            - KEYCLOAK_REALM=$KEYCLOAK_REALM
-            - KEYCLOAK_CLIENT_ID_API=$KEYCLOAK_CLIENT_ID_API
-            - KEYCLOAK_CLIENT_SECRET_API=$KEYCLOAK_CLIENT_SECRET_API
-            - ALLOWED_ORIGINS=http://localhost:3002,http://localhost:3000
+            - KEYCLOAK_URL=http://keycloak:8080
+            - ALLOWED_ORIGINS=http://clearance-ui:3000
             - SPACES_ENDPOINT=http://minio:9000
             - REDIS_URL=redis://redis:6379
             - PORT=3001
@@ -138,6 +135,15 @@ services:
             minio:
                 condition: service_healthy
                 required: true
+            createbuckets:
+                condition: service_completed_successfully
+                required: true
+            keycloak:
+                condition: service_healthy
+                required: true
+            terraform:
+                condition: service_completed_successfully
+                required: true
 
     scanner-worker:
         build:
@@ -154,17 +160,37 @@ services:
         build:
             dockerfile: UI.Dockerfile
             args:
-                - NEXT_PUBLIC_API_URL=http://localhost:3001/api/
+                - NEXT_PUBLIC_API_URL=http://api:3001/api/
         environment:
-            - NEXTAUTH_URL=http://localhost:3002
-            - NEXTAUTH_SECRET=$NEXTAUTH_SECRET
-            - KEYCLOAK_URL=$KEYCLOAK_URL
-            - KEYCLOAK_CLIENT_ID_UI=$KEYCLOAK_CLIENT_ID_UI
-            - KEYCLOAK_CLIENT_ID_API=$KEYCLOAK_CLIENT_ID_API
-            - KEYCLOAK_CLIENT_SECRET_UI=$KEYCLOAK_CLIENT_SECRET_UI
-            - KEYCLOAK_REALM=dos-dev
-        ports:
-            - 3002:3000
+            - NEXTAUTH_URL=http://clearance-ui:3000
+            - NEXTAUTH_SECRET=secret
+            - KEYCLOAK_URL=http://keycloak:8080
+
+    playwright-tests:
+        build:
+            context: .
+            dockerfile: Playwright.Dockerfile
+            args:
+                - NEXT_PUBLIC_API_URL=http://api:3001/api/
+        environment:
+            - KEYCLOAK_URL=http://keycloak:8080
+            - E2E_API_BASE_URL=http://api:3001
+            - E2E_UI_BASE_URL=http://clearance-ui:3000
+        depends_on:
+            api:
+                condition: service_healthy
+            clearance-ui:
+                condition: service_started
+        volumes:
+            - ./playwright-artifacts/clearance_ui:/workspace/apps/clearance_ui/playwright-report
+        working_dir: /workspace
+        command: >
+            bash -c "
+                echo 'Waiting for services...';
+                until curl -s http://api:3001/api/health; do echo 'Waiting for API...'; sleep 2; done;
+                echo 'API is up!';
+                npm run test:e2e;
+            "
 
 volumes:
     db-data:
diff --git a/terraform/keycloak.tf b/terraform/keycloak.tf
@@ -169,8 +169,8 @@ resource "keycloak_openid_client" "dos_ui_openid_client" {
     }
 
     root_url = "http://localhost:3000"
-    valid_redirect_uris = ["/*", "http://localhost:3002/*"]
-    valid_post_logout_redirect_uris = ["/*", "http://localhost:3002/*"]
+    valid_redirect_uris = ["/*", "http://clearance-ui:3000/*"]
+    valid_post_logout_redirect_uris = ["/*", "http://clearance-ui:3000/*"]
     web_origins = ["+"] # + means all origins of Valid Redirect URIs
 }
 
diff --git a/turbo.json b/turbo.json
@@ -11,8 +11,8 @@
         "DB_RETRY_INTERVAL",
         "DEBUG",
         "DL_CONCURRENCY",
-        "E2E_USER_USERNAME",
-        "E2E_USER_PASSWORD",
+        "E2E_API_BASE_URL",
+        "E2E_UI_BASE_URL",
         "KEYCLOAK_CLIENT_ID_API",
         "KEYCLOAK_CLIENT_ID_UI",
         "KEYCLOAK_CLIENT_SECRET_API",
