Merge pull request #134 from github-copilot-resources/playwright-alpine

Playwright tests + switching to alpine images

Author: karpikpl

.dockerignore

@@ -13,3 +13,14 @@ dist/
 .github/
 Dockerfile
 *.md
+azure-deploy/
+infra/
+
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+/test-results/
+/test-results-docker/
+test-results-docker-ent/
+test-results-docker-org/

.env

@@ -19,4 +19,7 @@ VUE_APP_GITHUB_TOKEN=
 
 # GitHub Api Url
 # for proxy api - set to /api/github defaults to https://api.github.com
-VUE_APP_GITHUB_API=
+VUE_APP_GITHUB_API=
+
+# Random string used in API to secure session, use when VUE_APP_GITHUB_API=/api/github
+#SESSION_SECRET=randomstring

.github/workflows/dependabot.yml renamed to .github/dependabot.yml

@@ -0,0 +1,96 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 10
+    permissions:
+      checks: write
+      pull-requests: read
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Run Playwright tests
+      run: CI=true npm test
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30
+
+  test-api-org:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build and export to Docker
+      uses: docker/build-push-action@v6
+      with:
+        file: api.Dockerfile
+        load: true
+        tags: api:test
+        build-args: mode=playwright
+    - name: Run Playwright tests
+      run: |
+          docker run --rm --name playwright \
+          -v $(pwd)/test-results-docker-org:/test-results \
+          -e CI=true \
+          -e VUE_APP_SCOPE=organization \
+          -e VUE_APP_GITHUB_ORG=octodemo \
+          -e VUE_APP_GITHUB_API=/api/github \
+          -e APP_MOCKED_DATA=true \
+          -e VUE_APP_GITHUB_TOKEN=dummy \
+          -e SESSION_SECRET=dummy \
+          api:test "@org"
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report-docker-org
+        path: test-results-docker-org/
+        retention-days: 30
+
+  test-api-ent:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build and export to Docker
+      uses: docker/build-push-action@v6
+      with:
+        file: api.Dockerfile
+        load: true
+        tags: api:test
+        build-args: mode=playwright
+    - name: Run Playwright tests
+      run: |
+          docker run --rm --name playwright \
+          -v $(pwd)/test-results-docker-ent:/test-results \
+          -e CI=true \
+          -e VUE_APP_SCOPE=enterprise \
+          -e VUE_APP_GITHUB_ENT=octodemo \
+          -e VUE_APP_GITHUB_API=/api/github \
+          -e APP_MOCKED_DATA=true \
+          -e VUE_APP_GITHUB_TOKEN=dummy \
+          -e SESSION_SECRET=dummy \
+          api:test "@ent"
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report-docker-ent
+        path: test-results-docker-ent/
+        retention-days: 30

.github/workflows/playwright.yml

@@ -25,3 +25,12 @@ pnpm-debug.log*
 
 api/public
 test.http
+
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+/test-results/
+/test-results-docker/
+test-results-docker-ent/
+test-results-docker-org/

.gitignore

@@ -1,5 +1,5 @@
 # Stage 1: Build the Vue.js application
-FROM node:22 AS build-stage
+FROM node:23-alpine AS build-stage
 WORKDIR /app
 COPY package*.json ./
 RUN npm install

Dockerfile

@@ -1,34 +1,41 @@
 # Stage 1: Build the Vue.js application
-FROM node:23 AS build-stage
+# mode can be 'prod' - default or 'playwright'
+# for 'playwright' mode, the final image will be base-playwright
+# for 'prod' mode, the final image will be base-prod
+# build with 'docker build -f api.Dockerfile -t api --build-arg mode=playwright .'
+# build with 'docker build -f api.Dockerfile -t api .' for production
+ARG mode=prod
+
+FROM node:23-alpine AS build-stage
 
 USER node
 WORKDIR /app
 
 COPY --chown=1000:1000 package*.json ./
-RUN npm install
+RUN npm ci
 COPY --chown=1000:1000 . .
 RUN npm run build
 
 # Stage 2: Prepare the Node.js API
-FROM node:23 AS api-stage
+FROM node:23-alpine AS base-prod
 
 WORKDIR /api
 
 # Copy package.json and other necessary files for the API
 COPY --chown=1000:1000 api/package*.json ./
-RUN npm install && \
+RUN npm ci && \
     chown -R 1000:1000 /api && \
-    apt-get update && \
-    apt-get install -y --no-install-recommends gettext-base && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*
+    apk update && \
+    apk add --no-cache gettext && \
+    rm -rf /var/cache/apk/*
 
 # Copy the rest of your API source code
 COPY --chown=1000:1000 api/ .
 
 # Copy the built Vue.js app from the previous stage
 COPY --chown=1000:1000 --from=build-stage /app/dist /api/public
 COPY --chown=1000:1000 --from=build-stage /app/dist/assets/app-config.js /api/app-config.template.js
+COPY --chown=1000:1000 --from=build-stage /app/mock-data /mock-data
 
 # Expose the port your API will run on
 EXPOSE 3000
@@ -37,4 +44,29 @@ EXPOSE 3000
 RUN chmod +x /api/docker-entrypoint.api/entrypoint.sh
 
 USER node
-ENTRYPOINT ["/api/docker-entrypoint.api/entrypoint.sh"]
+ENTRYPOINT ["/api/docker-entrypoint.api/entrypoint.sh"]
+
+#-----------------------------------
+FROM mcr.microsoft.com/playwright:v1.49.1 AS base-playwright
+
+WORKDIR /pw
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends gettext-base && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY --chown=1000:1000 --from=base-prod /api /api
+COPY --chown=1000:1000 --from=base-prod /mock-data /mock-data
+COPY --chown=1000:1000 tests ./tests
+COPY --chown=1000:1000 playwright.config.ts .
+COPY --chown=1000:1000 playwright.docker.config.ts .
+
+
+RUN npm install @playwright/[email protected] 
+# RUN npx playwright install --with-deps
+
+ENTRYPOINT [ "npx", "playwright", "test", "-c", "playwright.docker.config.ts", "--output", "/test-results", "--grep"]
+
+#-----------------------------------
+FROM base-${mode} AS final

api.Dockerfile

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 
 configTemplateFile=/api/app-config.template.js
 configTargetFile=/api/public/assets/app-config.js

api/docker-entrypoint.api/entrypoint.sh

@@ -5,6 +5,7 @@ import axios from 'axios';
 import { fileURLToPath } from 'url';
 import session from 'express-session';
 import { createProxyMiddleware } from 'http-proxy-middleware';
+import { readFileSync } from 'fs';
 import MemoryStoreFactory from 'memorystore';
 import RateLimit from 'express-rate-limit';
 
@@ -58,16 +59,47 @@ const authMiddleware = (req, res, next) => {
   next();
 };
 
+const simpleRequestLogger = (proxyServer, options) => {
+  proxyServer.on('proxyReq', (proxyReq, req, res) => {
+    console.log(`[HPM] [${req.method}] ${req.url}`); // outputs: [HPM] GET /users
+  });
+}
+
+const mockResponses = (proxyServer, options) => {
+  proxyServer.on('proxyReq', (proxyReq, req, res) => {
+    // Do not send to GitHub when mocked
+    switch (req.path) {
+      case "/orgs/octodemo/copilot/usage":
+        res.json(JSON.parse(readFileSync(path.join(__dirname, '../mock-data/organization_response_sample.json'), 'utf8')));
+        break;
+      case "/orgs/octodemo/copilot/billing/seats":
+        res.json(JSON.parse(readFileSync(path.join(__dirname, '../mock-data/organization_response_sample_seats.json'), 'utf8')));
+        break;
+      case "/enterprises/octodemo/copilot/usage":
+        res.json(JSON.parse(readFileSync(path.join(__dirname, '../mock-data/enterprise_response_sample.json'), 'utf8')));
+        break;
+      case "/enterprises/octodemo/copilot/billing/seats":
+        res.json(JSON.parse(readFileSync(path.join(__dirname, '../mock-data/enterprise_response_sample_seats.json'), 'utf8')));
+        break;
+      default:
+        res.status(418).send('🫖Request Not Mocked');
+    }
+  });
+}
+
+const plugins = [simpleRequestLogger];
+
+if (process.env.APP_MOCKED_DATA === 'true') {
+  plugins.push(mockResponses);
+}
+
 const githubProxy = createProxyMiddleware({
   target: 'https://api.github.com',
   changeOrigin: true,
   pathRewrite: {
     '^/api/github': '', // Rewrite URL path (remove /api/github)
   },
-  onProxyReq: (proxyReq, req) => {
-    console.log('Proxying request to GitHub API:', req.url);
-    // Optional: Modify the proxy request here (e.g., headers)
-  },
+  plugins
 });
 
 // Apply middlewares to the app