Compare commits

...

2 Commits

Author SHA1 Message Date
midzelis 1d6131e490 chore(ci): deduplicate e2e server image cache with docker.yml
Change-Id: Idf104d87732b85b7402870195509752a6a6a6964
2026-03-24 18:17:37 +00:00
midzelis 10218fb900 feat: run e2e tests inside Docker compose network and in parallel
Change-Id: I04332d4f153b720316ab7b08c12f9a6e6a6a6964
2026-03-24 18:17:37 +00:00
18 changed files with 380 additions and 98 deletions
+190 -67
View File
@@ -404,6 +404,7 @@ jobs:
runs-on: ${{ matrix.runner }} runs-on: ${{ matrix.runner }}
permissions: permissions:
contents: read contents: read
actions: write
defaults: defaults:
run: run:
working-directory: ./e2e working-directory: ./e2e
@@ -416,58 +417,89 @@ jobs:
with: with:
app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }} app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }}
private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }} private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}
- name: Checkout code - name: Checkout code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: with:
persist-credentials: false persist-credentials: false
submodules: 'recursive' submodules: 'recursive'
token: ${{ steps.token.outputs.token }} token: ${{ steps.token.outputs.token }}
- name: Setup pnpm - name: Set up Docker Buildx
uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0 uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
- name: Setup Node - name: Compute server cache key
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0 run: |
with: BUILD_ARGS=$'DEVICE=cpu\n'
node-version-file: './e2e/.nvmrc' HASH=$(sha256sum <<< "${BUILD_ARGS}" | cut -d' ' -f1)
cache: 'pnpm' ARCH=$(echo "${{ runner.arch }}" | tr '[:upper:]' '[:lower:]')
cache-dependency-path: '**/pnpm-lock.yaml' [[ "$ARCH" == "x64" ]] && ARCH="amd64"
- name: Run setup typescript-sdk echo "SERVER_CACHE_KEY=linux-${ARCH}-${HASH}-main" >> $GITHUB_ENV
run: pnpm install --frozen-lockfile && pnpm build - name: Build Docker images from cache
working-directory: ./open-api/typescript-sdk run: docker compose -f docker-compose.yml -f docker-compose.ci.yml --profile test build
if: ${{ !cancelled() }}
- name: Run setup web
run: pnpm install --frozen-lockfile && pnpm exec svelte-kit sync
working-directory: ./web
if: ${{ !cancelled() }}
- name: Run setup cli
run: pnpm install --frozen-lockfile && pnpm build
working-directory: ./cli
if: ${{ !cancelled() }}
- name: Install dependencies
run: pnpm install --frozen-lockfile
if: ${{ !cancelled() }}
- name: Start Docker Compose - name: Start Docker Compose
run: docker compose up -d --build --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300 run: docker compose up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Run e2e tests (api & cli) - name: Run e2e tests (api & cli)
env: run: docker compose --profile test run --rm e2e-runner pnpm test
VITEST_DISABLE_DOCKER_SETUP: true
run: pnpm test
if: ${{ !cancelled() }}
- name: Run e2e tests (maintenance)
env:
VITEST_DISABLE_DOCKER_SETUP: true
run: pnpm test:maintenance
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Capture Docker logs - name: Capture Docker logs
if: always() if: always()
run: docker compose logs --no-color > docker-compose-logs.txt run: docker compose logs --no-color > docker-compose-logs.txt
- name: Archive Docker logs
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
if: always()
with:
name: e2e-server-docker-logs-${{ matrix.runner }}
path: e2e/docker-compose-logs.txt
e2e-tests-server-maintenance:
name: End-to-End Tests (Server Maintenance)
needs: pre-job
if: ${{ fromJSON(needs.pre-job.outputs.should_run).e2e == true || fromJSON(needs.pre-job.outputs.should_run).server == true || fromJSON(needs.pre-job.outputs.should_run).cli == true }}
runs-on: ${{ matrix.runner }}
permissions:
contents: read
actions: write
defaults:
run:
working-directory: ./e2e working-directory: ./e2e
strategy:
matrix:
runner: [ubuntu-latest, ubuntu-24.04-arm]
steps:
- id: token
uses: immich-app/devtools/actions/create-workflow-token@05e16407c0a5492138bb38139c9d9bf067b40886 # create-workflow-token-action-v1.0.1
with:
app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }}
private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}
- name: Checkout code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
submodules: 'recursive'
token: ${{ steps.token.outputs.token }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
- name: Compute server cache key
run: |
BUILD_ARGS=$'DEVICE=cpu\n'
HASH=$(sha256sum <<< "${BUILD_ARGS}" | cut -d' ' -f1)
ARCH=$(echo "${{ runner.arch }}" | tr '[:upper:]' '[:lower:]')
[[ "$ARCH" == "x64" ]] && ARCH="amd64"
echo "SERVER_CACHE_KEY=linux-${ARCH}-${HASH}-main" >> $GITHUB_ENV
- name: Build Docker images from cache
run: docker compose -f docker-compose.yml -f docker-compose.ci.yml --profile test build
- name: Start Docker Compose
run: docker compose up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
if: ${{ !cancelled() }}
- name: Run e2e tests (maintenance)
run: docker compose --profile test run --rm e2e-runner pnpm test:maintenance
if: ${{ !cancelled() }}
- name: Capture Docker logs
if: always()
run: docker compose logs --no-color > docker-compose-logs.txt
- name: Archive Docker logs - name: Archive Docker logs
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
if: always() if: always()
with: with:
name: e2e-server-docker-logs-${{ matrix.runner }} name: e2e-server-maintenance-docker-logs-${{ matrix.runner }}
path: e2e/docker-compose-logs.txt path: e2e/docker-compose-logs.txt
e2e-tests-web: e2e-tests-web:
name: End-to-End Tests (Web) name: End-to-End Tests (Web)
@@ -476,6 +508,7 @@ jobs:
runs-on: ${{ matrix.runner }} runs-on: ${{ matrix.runner }}
permissions: permissions:
contents: read contents: read
actions: write
defaults: defaults:
run: run:
working-directory: ./e2e working-directory: ./e2e
@@ -488,38 +521,28 @@ jobs:
with: with:
app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }} app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }}
private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }} private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}
- name: Checkout code - name: Checkout code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: with:
persist-credentials: false persist-credentials: false
submodules: 'recursive' submodules: 'recursive'
token: ${{ steps.token.outputs.token }} token: ${{ steps.token.outputs.token }}
- name: Setup pnpm - name: Set up Docker Buildx
uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0 uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
- name: Setup Node - name: Compute server cache key
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0 run: |
with: BUILD_ARGS=$'DEVICE=cpu\n'
node-version-file: './e2e/.nvmrc' HASH=$(sha256sum <<< "${BUILD_ARGS}" | cut -d' ' -f1)
cache: 'pnpm' ARCH=$(echo "${{ runner.arch }}" | tr '[:upper:]' '[:lower:]')
cache-dependency-path: '**/pnpm-lock.yaml' [[ "$ARCH" == "x64" ]] && ARCH="amd64"
- name: Run setup typescript-sdk echo "SERVER_CACHE_KEY=linux-${ARCH}-${HASH}-main" >> $GITHUB_ENV
run: pnpm install --frozen-lockfile && pnpm build - name: Build Docker images from cache
working-directory: ./open-api/typescript-sdk run: docker compose -f docker-compose.yml -f docker-compose.ci.yml --profile test build
if: ${{ !cancelled() }} - name: Start Docker Compose
- name: Install dependencies run: docker compose up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
run: pnpm install --frozen-lockfile
if: ${{ !cancelled() }}
- name: Install Playwright Browsers
run: pnpm exec playwright install chromium --only-shell
if: ${{ !cancelled() }}
- name: Docker build
run: docker compose up -d --build --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Run e2e tests (web) - name: Run e2e tests (web)
env: run: docker compose --profile test run --rm e2e-runner pnpm test:web
PLAYWRIGHT_DISABLE_WEBSERVER: true
run: pnpm test:web
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Archive e2e test (web) results - name: Archive e2e test (web) results
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
@@ -527,10 +550,57 @@ jobs:
with: with:
name: e2e-web-test-results-${{ matrix.runner }} name: e2e-web-test-results-${{ matrix.runner }}
path: e2e/playwright-report/ path: e2e/playwright-report/
- name: Capture Docker logs
if: always()
run: docker compose logs --no-color > docker-compose-logs.txt
- name: Archive Docker logs
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
if: always()
with:
name: e2e-web-docker-logs-${{ matrix.runner }}
path: e2e/docker-compose-logs.txt
e2e-tests-web-ui:
name: End-to-End Tests (Web UI)
needs: pre-job
if: ${{ fromJSON(needs.pre-job.outputs.should_run).e2e == true || fromJSON(needs.pre-job.outputs.should_run).web == true }}
runs-on: ${{ matrix.runner }}
permissions:
contents: read
actions: write
defaults:
run:
working-directory: ./e2e
strategy:
matrix:
runner: [ubuntu-latest, ubuntu-24.04-arm]
steps:
- id: token
uses: immich-app/devtools/actions/create-workflow-token@05e16407c0a5492138bb38139c9d9bf067b40886 # create-workflow-token-action-v1.0.1
with:
app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }}
private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}
- name: Checkout code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
submodules: 'recursive'
token: ${{ steps.token.outputs.token }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
- name: Compute server cache key
run: |
BUILD_ARGS=$'DEVICE=cpu\n'
HASH=$(sha256sum <<< "${BUILD_ARGS}" | cut -d' ' -f1)
ARCH=$(echo "${{ runner.arch }}" | tr '[:upper:]' '[:lower:]')
[[ "$ARCH" == "x64" ]] && ARCH="amd64"
echo "SERVER_CACHE_KEY=linux-${ARCH}-${HASH}-main" >> $GITHUB_ENV
- name: Build Docker images from cache
run: docker compose -f docker-compose.yml -f docker-compose.ci.yml --profile test build
- name: Start Docker Compose
run: docker compose up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
if: ${{ !cancelled() }}
- name: Run ui tests (web) - name: Run ui tests (web)
env: run: docker compose --profile test run --rm e2e-runner pnpm test:web:ui
PLAYWRIGHT_DISABLE_WEBSERVER: true
run: pnpm test:web:ui
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Archive ui test (web) results - name: Archive ui test (web) results
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
@@ -538,10 +608,57 @@ jobs:
with: with:
name: e2e-ui-test-results-${{ matrix.runner }} name: e2e-ui-test-results-${{ matrix.runner }}
path: e2e/playwright-report/ path: e2e/playwright-report/
- name: Capture Docker logs
if: always()
run: docker compose logs --no-color > docker-compose-logs.txt
- name: Archive Docker logs
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
if: always()
with:
name: e2e-web-ui-docker-logs-${{ matrix.runner }}
path: e2e/docker-compose-logs.txt
e2e-tests-web-maintenance:
name: End-to-End Tests (Web Maintenance)
needs: pre-job
if: ${{ fromJSON(needs.pre-job.outputs.should_run).e2e == true || fromJSON(needs.pre-job.outputs.should_run).web == true }}
runs-on: ${{ matrix.runner }}
permissions:
contents: read
actions: write
defaults:
run:
working-directory: ./e2e
strategy:
matrix:
runner: [ubuntu-latest, ubuntu-24.04-arm]
steps:
- id: token
uses: immich-app/devtools/actions/create-workflow-token@05e16407c0a5492138bb38139c9d9bf067b40886 # create-workflow-token-action-v1.0.1
with:
app-id: ${{ secrets.PUSH_O_MATIC_APP_ID }}
private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}
- name: Checkout code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
submodules: 'recursive'
token: ${{ steps.token.outputs.token }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
- name: Compute server cache key
run: |
BUILD_ARGS=$'DEVICE=cpu\n'
HASH=$(sha256sum <<< "${BUILD_ARGS}" | cut -d' ' -f1)
ARCH=$(echo "${{ runner.arch }}" | tr '[:upper:]' '[:lower:]')
[[ "$ARCH" == "x64" ]] && ARCH="amd64"
echo "SERVER_CACHE_KEY=linux-${ARCH}-${HASH}-main" >> $GITHUB_ENV
- name: Build Docker images from cache
run: docker compose -f docker-compose.yml -f docker-compose.ci.yml --profile test build
- name: Start Docker Compose
run: docker compose up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
if: ${{ !cancelled() }}
- name: Run maintenance tests - name: Run maintenance tests
env: run: docker compose --profile test run --rm e2e-runner pnpm test:web:maintenance
PLAYWRIGHT_DISABLE_WEBSERVER: true
run: pnpm test:web:maintenance
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
- name: Archive maintenance tests (web) results - name: Archive maintenance tests (web) results
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
@@ -552,16 +669,22 @@ jobs:
- name: Capture Docker logs - name: Capture Docker logs
if: always() if: always()
run: docker compose logs --no-color > docker-compose-logs.txt run: docker compose logs --no-color > docker-compose-logs.txt
working-directory: ./e2e
- name: Archive Docker logs - name: Archive Docker logs
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
if: always() if: always()
with: with:
name: e2e-web-docker-logs-${{ matrix.runner }} name: e2e-web-maintenance-docker-logs-${{ matrix.runner }}
path: e2e/docker-compose-logs.txt path: e2e/docker-compose-logs.txt
success-check-e2e: success-check-e2e:
name: End-to-End Tests Success name: End-to-End Tests Success
needs: [e2e-tests-server-cli, e2e-tests-web] needs:
[
e2e-tests-server-cli,
e2e-tests-server-maintenance,
e2e-tests-web,
e2e-tests-web-ui,
e2e-tests-web-maintenance,
]
permissions: {} permissions: {}
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: always() if: always()
+25 -5
View File
@@ -24,7 +24,7 @@ e2e-update:
@trap 'make e2e-down' EXIT; COMPOSE_BAKE=true docker compose -f ./e2e/docker-compose.yml up --build -V --remove-orphans @trap 'make e2e-down' EXIT; COMPOSE_BAKE=true docker compose -f ./e2e/docker-compose.yml up --build -V --remove-orphans
e2e-down: e2e-down:
docker compose -f ./e2e/docker-compose.yml down --remove-orphans docker compose -f ./e2e/docker-compose.yml --profile test down --remove-orphans
prod: prod:
@trap 'make prod-down' EXIT; COMPOSE_BAKE=true docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans @trap 'make prod-down' EXIT; COMPOSE_BAKE=true docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans
@@ -101,10 +101,30 @@ check-web:
pnpm --filter immich-web run check:svelte pnpm --filter immich-web run check:svelte
test-%: test-%:
pnpm --filter $(call map-package,$*) run test pnpm --filter $(call map-package,$*) run test
test-e2e: test-e2e: build-e2e test-e2e-server test-e2e-server-maintenance test-e2e-web test-e2e-web-ui test-e2e-web-maintenance
docker compose -f ./e2e/docker-compose.yml build
pnpm --filter immich-e2e run test test-e2e-server:
pnpm --filter immich-e2e run test:web docker compose -f ./e2e/docker-compose.yml up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
docker compose -f ./e2e/docker-compose.yml --profile test run --rm e2e-runner pnpm test
test-e2e-server-maintenance:
docker compose -f ./e2e/docker-compose.yml up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
docker compose -f ./e2e/docker-compose.yml --profile test run --rm e2e-runner pnpm test:maintenance
test-e2e-web:
docker compose -f ./e2e/docker-compose.yml up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
docker compose -f ./e2e/docker-compose.yml --profile test run --rm e2e-runner pnpm test:web
test-e2e-web-ui:
docker compose -f ./e2e/docker-compose.yml up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
docker compose -f ./e2e/docker-compose.yml --profile test run --rm e2e-runner pnpm test:web:ui
test-e2e-web-maintenance:
docker compose -f ./e2e/docker-compose.yml up -d --renew-anon-volumes --force-recreate --remove-orphans --wait --wait-timeout 300
docker compose -f ./e2e/docker-compose.yml --profile test run --rm e2e-runner pnpm test:web:maintenance
build-e2e:
docker compose -f ./e2e/docker-compose.yml --profile test build
test-medium: test-medium:
docker run \ docker run \
--rm \ --rm \
+1
View File
@@ -71,6 +71,7 @@ const setup = async () => {
const redirectUris = [ const redirectUris = [
'http://127.0.0.1:2285/auth/login', 'http://127.0.0.1:2285/auth/login',
'https://photos.immich.app/oauth/mobile-redirect', 'https://photos.immich.app/oauth/mobile-redirect',
...(process.env.EXTRA_REDIRECT_URIS?.split(',').filter(Boolean) ?? []),
]; ];
const port = 2286; const port = 2286;
const host = '0.0.0.0'; const host = '0.0.0.0';
+1
View File
@@ -1,6 +1,7 @@
{ {
"name": "@immich/e2e-auth-server", "name": "@immich/e2e-auth-server",
"version": "0.1.0", "version": "0.1.0",
"packageManager": "pnpm@10.30.3+sha512.c961d1e0a2d8e354ecaa5166b822516668b7f44cb5bd95122d590dd81922f606f5473b6d23ec4a5be05e7fcd18e8488d47d978bbe981872f1145d06e9a740017",
"type": "module", "type": "module",
"main": "auth-server.ts", "main": "auth-server.ts",
"scripts": { "scripts": {
+40
View File
@@ -0,0 +1,40 @@
FROM node:22-bookworm-slim
ENV PNPM_HOME="/pnpm"
ENV PATH="$PNPM_HOME:$PATH"
RUN corepack enable && corepack prepare pnpm@10.30.3 --activate
RUN apt-get update && apt-get install -y --no-install-recommends \
docker.io \
unzip \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /app
COPY package.json pnpm-workspace.yaml pnpm-lock.yaml .pnpmfile.cjs ./
COPY open-api/typescript-sdk/package.json open-api/typescript-sdk/
COPY cli/package.json cli/
COPY web/package.json web/
COPY e2e/package.json e2e/
COPY e2e-auth-server/package.json e2e-auth-server/
RUN pnpm install --frozen-lockfile
COPY open-api/typescript-sdk/ open-api/typescript-sdk/
RUN pnpm --filter @immich/sdk build
COPY cli/ cli/
RUN pnpm --filter @immich/cli build && ln -s /app/cli/bin/immich /app/cli/node_modules/.bin/immich
COPY web/svelte.config.js web/vite.config.ts web/tsconfig.json web/
COPY web/src/ web/src/
COPY web/static/ web/static/
RUN pnpm --filter immich-web exec svelte-kit sync
COPY e2e/ e2e/
COPY e2e-auth-server/ e2e-auth-server/
RUN pnpm --filter immich-e2e exec playwright install --with-deps chromium
WORKDIR /app/e2e
+23
View File
@@ -0,0 +1,23 @@
.vscode/
.github/
.git/
*.log
*.tmp
*.temp
**/node_modules/
**/.pnpm-store/
**/dist/
**/coverage/
**/build/
design/
docker/
docs/
fastlane/
machine-learning/
misc/
mobile/
server/
plugins/
i18n/
+16
View File
@@ -0,0 +1,16 @@
name: immich-e2e
services:
e2e-auth-server:
build:
cache_from:
- type=gha,scope=e2e-auth-${RUNNER_ARCH:-X64}
cache_to:
- type=gha,mode=max,scope=e2e-auth-${RUNNER_ARCH:-X64}
e2e-runner:
build:
cache_from:
- type=gha,scope=e2e-runner-${RUNNER_ARCH:-X64}
cache_to:
- type=gha,mode=max,scope=e2e-runner-${RUNNER_ARCH:-X64}
+29 -2
View File
@@ -5,6 +5,8 @@ services:
container_name: immich-e2e-auth-server container_name: immich-e2e-auth-server
build: build:
context: ../e2e-auth-server context: ../e2e-auth-server
environment:
EXTRA_REDIRECT_URIS: http://immich-server:2285/auth/login
ports: ports:
- 2286:2286 - 2286:2286
@@ -15,8 +17,7 @@ services:
context: ../ context: ../
dockerfile: server/Dockerfile dockerfile: server/Dockerfile
cache_from: cache_from:
- type=registry,ref=ghcr.io/immich-app/immich-server-build-cache:linux-amd64-cc099f297acd18c924b35ece3245215b53d106eb2518e3af6415931d055746cd-main - type=registry,ref=ghcr.io/immich-app/immich-server-build-cache:${SERVER_CACHE_KEY:-linux-amd64-cc099f297acd18c924b35ece3245215b53d106eb2518e3af6415931d055746cd-main}
- type=registry,ref=ghcr.io/immich-app/immich-server-build-cache:linux-arm64-cc099f297acd18c924b35ece3245215b53d106eb2518e3af6415931d055746cd-main
args: args:
- BUILD_ID=1234567890 - BUILD_ID=1234567890
- BUILD_IMAGE=e2e - BUILD_IMAGE=e2e
@@ -65,3 +66,29 @@ services:
timeout: 5s timeout: 5s
retries: 30 retries: 30
start_period: 10s start_period: 10s
e2e-runner:
container_name: immich-e2e-runner
build:
context: ../
dockerfile: e2e/Dockerfile.playwright
network_mode: 'service:immich-server'
shm_size: 1gb
environment:
PLAYWRIGHT_DB_HOST: database
PLAYWRIGHT_DB_PORT: '5432'
PLAYWRIGHT_DISABLE_WEBSERVER: 'true'
PLAYWRIGHT_AUTH_SERVER_URL: http://e2e-auth-server:2286
VITEST_DISABLE_DOCKER_SETUP: 'true'
CI: '${CI:-}'
volumes:
- ./test-assets:/app/e2e/test-assets
- ./playwright-report:/app/e2e/playwright-report
- /var/run/docker.sock:/var/run/docker.sock
depends_on:
immich-server:
condition: service_started
database:
condition: service_healthy
profiles:
- test
+2 -1
View File
@@ -7,6 +7,7 @@ dotenv.config({ quiet: true, path: resolve(import.meta.dirname, '.env') });
export const playwrightHost = process.env.PLAYWRIGHT_HOST ?? '127.0.0.1'; export const playwrightHost = process.env.PLAYWRIGHT_HOST ?? '127.0.0.1';
export const playwrightDbHost = process.env.PLAYWRIGHT_DB_HOST ?? '127.0.0.1'; export const playwrightDbHost = process.env.PLAYWRIGHT_DB_HOST ?? '127.0.0.1';
export const playwrightDbPort = process.env.PLAYWRIGHT_DB_PORT ?? '5435';
export const playwriteBaseUrl = process.env.PLAYWRIGHT_BASE_URL ?? `http://${playwrightHost}:2285`; export const playwriteBaseUrl = process.env.PLAYWRIGHT_BASE_URL ?? `http://${playwrightHost}:2285`;
export const playwriteSlowMo = Number.parseInt(process.env.PLAYWRIGHT_SLOW_MO ?? '0'); export const playwriteSlowMo = Number.parseInt(process.env.PLAYWRIGHT_SLOW_MO ?? '0');
export const playwrightDisableWebserver = process.env.PLAYWRIGHT_DISABLE_WEBSERVER; export const playwrightDisableWebserver = process.env.PLAYWRIGHT_DISABLE_WEBSERVER;
@@ -43,7 +44,7 @@ const config: PlaywrightTestConfig = {
use: { ...devices['Desktop Chrome'] }, use: { ...devices['Desktop Chrome'] },
testDir: './src/ui/specs', testDir: './src/ui/specs',
fullyParallel: true, fullyParallel: true,
workers: process.env.CI ? 3 : Math.max(1, Math.round(cpus().length * 0.75) - 1), workers: process.env.CI ? 3 : Math.min(10, Math.max(1, Math.round(cpus().length * 0.75) - 1)),
}, },
{ {
name: 'maintenance', name: 'maintenance',
+1 -1
View File
@@ -15,7 +15,7 @@ import { beforeAll, describe, expect, it } from 'vitest';
const authServer = { const authServer = {
internal: 'http://e2e-auth-server:2286', internal: 'http://e2e-auth-server:2286',
external: 'http://127.0.0.1:2286', external: process.env.PLAYWRIGHT_AUTH_SERVER_URL ?? 'http://127.0.0.1:2286',
}; };
const mobileOverrideRedirectUri = 'https://photos.immich.app/oauth/mobile-redirect'; const mobileOverrideRedirectUri = 'https://photos.immich.app/oauth/mobile-redirect';
@@ -106,7 +106,7 @@ describe('/shared-links', () => {
const resp = await request(shareUrl).get(`/${linkWithAssets.key}`); const resp = await request(shareUrl).get(`/${linkWithAssets.key}`);
expect(resp.status).toBe(200); expect(resp.status).toBe(200);
expect(resp.header['content-type']).toContain('text/html'); expect(resp.header['content-type']).toContain('text/html');
expect(resp.text).toContain(`<meta property="og:image" content="http://127.0.0.1:2285`); expect(resp.text).toContain(`<meta property="og:image" content="${baseUrl}`);
}); });
it('should fall back to my.immich.app og:image meta tag for shared asset if Host header is not present', async () => { it('should fall back to my.immich.app og:image meta tag for shared asset if Host header is not present', async () => {
+4 -4
View File
@@ -1,6 +1,6 @@
import { Permission } from '@immich/sdk'; import { Permission } from '@immich/sdk';
import { stat } from 'node:fs/promises'; import { stat } from 'node:fs/promises';
import { app, immichCli, utils } from 'src/utils'; import { app, baseUrl, immichCli, utils } from 'src/utils';
import { beforeEach, describe, expect, it } from 'vitest'; import { beforeEach, describe, expect, it } from 'vitest';
describe(`immich login`, () => { describe(`immich login`, () => {
@@ -33,7 +33,7 @@ describe(`immich login`, () => {
const key = await utils.createApiKey(admin.accessToken, [Permission.All]); const key = await utils.createApiKey(admin.accessToken, [Permission.All]);
const { stdout, stderr, exitCode } = await immichCli(['login', app, `${key.secret}`]); const { stdout, stderr, exitCode } = await immichCli(['login', app, `${key.secret}`]);
expect(stdout.split('\n')).toEqual([ expect(stdout.split('\n')).toEqual([
'Logging in to http://127.0.0.1:2285/api', `Logging in to ${baseUrl}/api`,
'Logged in as admin@immich.cloud', 'Logged in as admin@immich.cloud',
'Wrote auth info to /tmp/immich/auth.yml', 'Wrote auth info to /tmp/immich/auth.yml',
]); ]);
@@ -50,8 +50,8 @@ describe(`immich login`, () => {
const key = await utils.createApiKey(admin.accessToken, [Permission.All]); const key = await utils.createApiKey(admin.accessToken, [Permission.All]);
const { stdout, stderr, exitCode } = await immichCli(['login', app.replaceAll('/api', ''), `${key.secret}`]); const { stdout, stderr, exitCode } = await immichCli(['login', app.replaceAll('/api', ''), `${key.secret}`]);
expect(stdout.split('\n')).toEqual([ expect(stdout.split('\n')).toEqual([
'Logging in to http://127.0.0.1:2285', `Logging in to ${baseUrl}`,
'Discovered API at http://127.0.0.1:2285/api', `Discovered API at ${baseUrl}/api`,
'Logged in as admin@immich.cloud', 'Logged in as admin@immich.cloud',
'Wrote auth info to /tmp/immich/auth.yml', 'Wrote auth info to /tmp/immich/auth.yml',
]); ]);
@@ -1,4 +1,4 @@
import { immichCli, utils } from 'src/utils'; import { baseUrl, immichCli, utils } from 'src/utils';
import { beforeAll, describe, expect, it } from 'vitest'; import { beforeAll, describe, expect, it } from 'vitest';
describe(`immich server-info`, () => { describe(`immich server-info`, () => {
@@ -12,7 +12,7 @@ describe(`immich server-info`, () => {
const { stderr, stdout, exitCode } = await immichCli(['server-info']); const { stderr, stdout, exitCode } = await immichCli(['server-info']);
expect(stdout.split('\n')).toEqual([ expect(stdout.split('\n')).toEqual([
expect.stringContaining('Server Info (via admin@immich.cloud'), expect.stringContaining('Server Info (via admin@immich.cloud'),
' Url: http://127.0.0.1:2285/api', ` Url: ${baseUrl}/api`,
expect.stringContaining('Version:'), expect.stringContaining('Version:'),
' Formats:', ' Formats:',
expect.stringContaining('Images:'), expect.stringContaining('Images:'),
+20 -4
View File
@@ -1,5 +1,7 @@
import { LoginResponseDto } from '@immich/sdk'; import { LoginResponseDto } from '@immich/sdk';
import { expect, test } from '@playwright/test'; import { expect, test } from '@playwright/test';
import { lookup } from 'node:dns/promises';
import { playwrightHost } from 'playwright.config';
import { utils } from 'src/utils'; import { utils } from 'src/utils';
test.describe('Websocket', () => { test.describe('Websocket', () => {
@@ -12,14 +14,28 @@ test.describe('Websocket', () => {
}); });
test('connects using ipv4', async ({ page, context }) => { test('connects using ipv4', async ({ page, context }) => {
await utils.setAuthCookies(context, admin.accessToken); const { address: ipv4 } = await lookup(playwrightHost, 4);
await page.goto('http://127.0.0.1:2285/'); await utils.setAuthCookies(context, admin.accessToken, ipv4);
await page.goto(`http://${ipv4}:2285/`);
await expect(page.locator('#sidebar')).toContainText('Server Online'); await expect(page.locator('#sidebar')).toContainText('Server Online');
}); });
test('connects using ipv6', async ({ page, context }) => { test('connects using ipv6', async ({ page, context }) => {
await utils.setAuthCookies(context, admin.accessToken, '[::1]'); let ipv6: string;
await page.goto('http://[::1]:2285/'); if (playwrightHost === '127.0.0.1') {
ipv6 = '::1';
} else {
try {
const { address } = await lookup(playwrightHost, 6);
ipv6 = address;
} catch {
test.skip(true, 'No IPv6 address available');
return;
}
}
const ipv6Url = `http://[${ipv6}]:2285/`;
await utils.setAuthCookies(context, admin.accessToken, undefined, ipv6Url);
await page.goto(ipv6Url);
await expect(page.locator('#sidebar')).toContainText('Server Online'); await expect(page.locator('#sidebar')).toContainText('Server Online');
}); });
}); });
+11 -1
View File
@@ -1,4 +1,4 @@
import { BrowserContext } from '@playwright/test'; import { BrowserContext, expect, Page } from '@playwright/test';
import { playwrightHost } from 'playwright.config'; import { playwrightHost } from 'playwright.config';
export const setupBaseMockApiRoutes = async (context: BrowserContext, adminUserId: string) => { export const setupBaseMockApiRoutes = async (context: BrowserContext, adminUserId: string) => {
@@ -283,3 +283,13 @@ export const setupBaseMockApiRoutes = async (context: BrowserContext, adminUserI
}); });
}); });
}; };
export const waitForServiceWorker = async (page: Page) => {
await expect
.poll(() => page.context().serviceWorkers().length, {
message:
'Service worker not registered. Ensure the origin is a secure context (localhost or use --unsafely-treat-insecure-origin-as-secure flag).',
timeout: 10_000,
})
.toBeGreaterThan(0);
};
+2
View File
@@ -1,5 +1,6 @@
import type { AssetResponseDto } from '@immich/sdk'; import type { AssetResponseDto } from '@immich/sdk';
import { expect, Page } from '@playwright/test'; import { expect, Page } from '@playwright/test';
import { waitForServiceWorker } from 'src/ui/mock-network/base-network';
function getAssetIdFromUrl(url: URL): string | null { function getAssetIdFromUrl(url: URL): string | null {
const pathMatch = url.pathname.match(/\/memory\/photos\/([^/]+)/); const pathMatch = url.pathname.match(/\/memory\/photos\/([^/]+)/);
@@ -15,6 +16,7 @@ export const memoryViewerUtils = {
}, },
async waitForMemoryLoad(page: Page) { async waitForMemoryLoad(page: Page) {
await waitForServiceWorker(page);
await expect(this.locator(page)).toBeVisible(); await expect(this.locator(page)).toBeVisible();
await expect(page.locator('#memory-viewer img').first()).toBeVisible(); await expect(page.locator('#memory-viewer img').first()).toBeVisible();
}, },
+3
View File
@@ -1,6 +1,7 @@
import { BrowserContext, expect, Page } from '@playwright/test'; import { BrowserContext, expect, Page } from '@playwright/test';
import { DateTime } from 'luxon'; import { DateTime } from 'luxon';
import { TimelineAssetConfig } from 'src/ui/generators/timeline'; import { TimelineAssetConfig } from 'src/ui/generators/timeline';
import { waitForServiceWorker } from 'src/ui/mock-network/base-network';
export const sleep = (ms: number) => { export const sleep = (ms: number) => {
return new Promise((resolve) => setTimeout(resolve, ms)); return new Promise((resolve) => setTimeout(resolve, ms));
@@ -143,6 +144,7 @@ export const timelineUtils = {
return page.locator('#asset-grid'); return page.locator('#asset-grid');
}, },
async waitForTimelineLoad(page: Page) { async waitForTimelineLoad(page: Page) {
await waitForServiceWorker(page);
await expect(timelineUtils.locator(page)).toBeInViewport(); await expect(timelineUtils.locator(page)).toBeInViewport();
await expect.poll(() => thumbnailUtils.locator(page).count()).toBeGreaterThan(0); await expect.poll(() => thumbnailUtils.locator(page).count()).toBeGreaterThan(0);
}, },
@@ -163,6 +165,7 @@ export const assetViewerUtils = {
return page.locator('#immich-asset-viewer'); return page.locator('#immich-asset-viewer');
}, },
async waitForViewerLoad(page: Page, asset: TimelineAssetConfig) { async waitForViewerLoad(page: Page, asset: TimelineAssetConfig) {
await waitForServiceWorker(page);
await page await page
.locator( .locator(
`img[draggable="false"][src="/api/assets/${asset.id}/thumbnail?size=preview&c=${asset.thumbhash}&edited=true"]`, `img[draggable="false"][src="/api/assets/${asset.id}/thumbnail?size=preview&c=${asset.thumbhash}&edited=true"]`,
+9 -10
View File
@@ -71,7 +71,7 @@ import { io, type Socket } from 'socket.io-client';
import { loginDto, signupDto } from 'src/fixtures'; import { loginDto, signupDto } from 'src/fixtures';
import { makeRandomImage } from 'src/generators'; import { makeRandomImage } from 'src/generators';
import request from 'supertest'; import request from 'supertest';
import { playwrightDbHost, playwrightHost, playwriteBaseUrl } from '../playwright.config'; import { playwrightDbHost, playwrightDbPort, playwrightHost, playwriteBaseUrl } from '../playwright.config';
export type { Emitter } from '@socket.io/component-emitter'; export type { Emitter } from '@socket.io/component-emitter';
@@ -81,7 +81,7 @@ type WaitOptions = { event: EventType; id?: string; total?: number; timeout?: nu
type AdminSetupOptions = { onboarding?: boolean }; type AdminSetupOptions = { onboarding?: boolean };
type FileData = { bytes?: Buffer; filename: string }; type FileData = { bytes?: Buffer; filename: string };
const dbUrl = `postgres://postgres:postgres@${playwrightDbHost}:5435/immich`; const dbUrl = `postgres://postgres:postgres@${playwrightDbHost}:${playwrightDbPort}/immich`;
export const baseUrl = playwriteBaseUrl; export const baseUrl = playwriteBaseUrl;
export const shareUrl = `${baseUrl}/share`; export const shareUrl = `${baseUrl}/share`;
export const app = `${baseUrl}/api`; export const app = `${baseUrl}/api`;
@@ -522,13 +522,13 @@ export const utils = {
queueCommand: async (accessToken: string, name: QueueName, queueCommandDto: QueueCommandDto) => queueCommand: async (accessToken: string, name: QueueName, queueCommandDto: QueueCommandDto) =>
runQueueCommandLegacy({ name, queueCommandDto }, { headers: asBearerAuth(accessToken) }), runQueueCommandLegacy({ name, queueCommandDto }, { headers: asBearerAuth(accessToken) }),
setAuthCookies: async (context: BrowserContext, accessToken: string, domain = playwrightHost) => setAuthCookies: async (context: BrowserContext, accessToken: string, domain = playwrightHost, url?: string) => {
const origin = url ? { url } : { domain, path: '/' };
await context.addCookies([ await context.addCookies([
{ {
name: 'immich_access_token', name: 'immich_access_token',
value: accessToken, value: accessToken,
domain, ...origin,
path: '/',
expires: 2_058_028_213, expires: 2_058_028_213,
httpOnly: true, httpOnly: true,
secure: false, secure: false,
@@ -537,8 +537,7 @@ export const utils = {
{ {
name: 'immich_auth_type', name: 'immich_auth_type',
value: 'password', value: 'password',
domain, ...origin,
path: '/',
expires: 2_058_028_213, expires: 2_058_028_213,
httpOnly: true, httpOnly: true,
secure: false, secure: false,
@@ -547,14 +546,14 @@ export const utils = {
{ {
name: 'immich_is_authenticated', name: 'immich_is_authenticated',
value: 'true', value: 'true',
domain, ...origin,
path: '/',
expires: 2_058_028_213, expires: 2_058_028_213,
httpOnly: false, httpOnly: false,
secure: false, secure: false,
sameSite: 'Lax', sameSite: 'Lax',
}, },
]), ]);
},
setMaintenanceAuthCookie: async (context: BrowserContext, token: string, domain = '127.0.0.1') => setMaintenanceAuthCookie: async (context: BrowserContext, token: string, domain = '127.0.0.1') =>
await context.addCookies([ await context.addCookies([