test(exapp_integration): add Playwright file action menu regression for #848

oleksandr-nc · oleksandr-nc · commit 3a3079d07d02 · 2026-04-30T11:43:45.000Z
Signed-off-by: Oleksander Piskun &lt;oleksandr2088@icloud.com&gt;
diff --git a/.github/workflows/tests-exapp-integration.yml b/.github/workflows/tests-exapp-integration.yml
@@ -0,0 +1,182 @@
+# SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+# SPDX-License-Identifier: MIT
+name: Tests - ExApp Integration
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: tests-exapp-integration-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  NEXTCLOUD_URL: "http://127.0.0.1:8080"
+  NEXTCLOUD_USER: "admin"
+  NEXTCLOUD_PASS: "admin"
+  APP_ID: "test_appapi"
+  APP_VERSION: "1.0.0"
+  APP_PORT: 9009
+  APP_HOST: "127.0.0.1"
+  APP_SECRET: "tC6vkwPhcppjMykD1r0n9NlI95uJMBYjs5blpIcA1PAdoPDmc5qoAjaBAkyocZ6E"
+
+jobs:
+  exapp-integration:
+    runs-on: ubuntu-22.04
+    name: ExApp integration (Playwright)
+
+    services:
+      postgres:
+        image: ghcr.io/nextcloud/continuous-integration-postgres-14:latest # zizmor: ignore[unpinned-images]
+        ports:
+          - 4444:5432/tcp
+        env:
+          POSTGRES_USER: root
+          POSTGRES_PASSWORD: rootpassword
+          POSTGRES_DB: nextcloud
+        options: --health-cmd pg_isready --health-interval 5s --health-timeout 2s --health-retries 5
+
+    steps:
+      - name: Set app env
+        run: echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
+
+      - name: Checkout server
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+          submodules: true
+          repository: nextcloud/server
+          ref: master
+
+      - name: Checkout AppAPI
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+          path: apps/${{ env.APP_NAME }}
+
+      - name: Set up php
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
+        with:
+          php-version: '8.3'
+          extensions: bz2, ctype, curl, dom, fileinfo, gd, iconv, intl, json, libxml, mbstring, openssl, pcntl, posix, session, simplexml, xmlreader, xmlwriter, zip, zlib, pgsql, pdo_pgsql
+          coverage: none
+          ini-file: development
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: '3.11'
+
+      - name: Read package.json node and npm engines version
+        uses: skjnldsv/read-package-engines-version-actions@06d6baf7d8f41934ab630e97d9e6c0bc9c9ac5e4 # v3
+        id: versions
+        with:
+          path: apps/${{ env.APP_NAME }}
+          fallbackNode: '^24'
+          fallbackNpm: '^11.3'
+
+      - name: Set up node ${{ steps.versions.outputs.nodeVersion }}
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version: ${{ steps.versions.outputs.nodeVersion }}
+
+      - name: Set up npm ${{ steps.versions.outputs.npmVersion }}
+        run: npm i -g 'npm@${{ steps.versions.outputs.npmVersion }}'
+
+      - name: Install AppAPI composer deps
+        working-directory: apps/${{ env.APP_NAME }}
+        run: composer i
+
+      - name: Build AppAPI frontend bundle
+        working-directory: apps/${{ env.APP_NAME }}
+        run: |
+          npm ci
+          npm run build
+
+      - name: Set up Nextcloud
+        env:
+          DB_PORT: 4444
+        run: |
+          mkdir data
+          ./occ maintenance:install --verbose --database=pgsql --database-name=nextcloud --database-host=127.0.0.1 \
+            --database-port=$DB_PORT --database-user=root --database-pass=rootpassword \
+            --admin-user "$NEXTCLOUD_USER" --admin-pass "$NEXTCLOUD_PASS"
+          ./occ config:system:set ratelimit.protection.enabled --value=false --type=boolean
+          ./occ app:enable --force ${{ env.APP_NAME }}
+
+      - name: Run Nextcloud
+        run: PHP_CLI_SERVER_WORKERS=4 php -S 127.0.0.1:8080 &
+
+      - name: Install integration test Python deps
+        run: python3 -m pip install -r apps/${{ env.APP_NAME }}/tests/exapp_integration/requirements.txt
+
+      - name: Install Playwright browser
+        run: python3 -m playwright install --with-deps chromium
+
+      - name: Register manual_daemon
+        run: php occ app_api:daemon:register manual_daemon "Manual Install" manual-install http "$APP_HOST" "$NEXTCLOUD_URL"
+
+      - name: Start test ExApp
+        run: |
+          cd apps/${{ env.APP_NAME }}/tests/exapp_integration
+          nohup python3 _test_app.py > /tmp/test_appapi.log 2>&1 &
+          echo $! > /tmp/test_appapi.pid
+          for _ in $(seq 1 30); do
+            curl -fs "http://$APP_HOST:$APP_PORT/heartbeat" >/dev/null && break
+            sleep 1
+          done
+          curl -fs "http://$APP_HOST:$APP_PORT/heartbeat"
+
+      - name: Register test ExApp
+        # No --wait-finish: the minimal _test_app.py /init handler returns 200
+        # without calling back to mark init progress = 100, so --wait-finish
+        # would loop forever. register_test_exapp.sh in the dev VM omits it for
+        # the same reason. Register itself flips enabled=1 in DB synchronously.
+        run: |
+          php occ app_api:app:register "$APP_ID" manual_daemon --json-info \
+            "{\"id\":\"$APP_ID\",\"name\":\"AppAPI Integration Test ExApp\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"port\":$APP_PORT,\"host\":\"$APP_HOST\",\"protocol\":\"http\",\"system_app\":0}"
+          php occ app_api:app:list | grep -q "^$APP_ID .* \[enabled\]$"
+
+      - name: Run pytest
+        working-directory: apps/${{ env.APP_NAME }}/tests/exapp_integration
+        env:
+          OCC_CMD: "php ${{ github.workspace }}/occ"
+        run: python3 -m pytest -v
+
+      - name: Stop test ExApp
+        if: always()
+        run: |
+          [ -f /tmp/test_appapi.pid ] && kill -15 "$(cat /tmp/test_appapi.pid)" || true
+
+      - name: Upload NC logs
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: exapp-integration-nextcloud.log
+          path: data/nextcloud.log
+          if-no-files-found: warn
+
+      - name: Upload test ExApp log
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: exapp-integration-test_appapi.log
+          path: /tmp/test_appapi.log
+          if-no-files-found: warn
+
+  tests-exapp-integration-success:
+    permissions:
+      contents: none
+    runs-on: ubuntu-22.04
+    needs: [exapp-integration]
+    name: TestsExAppIntegration-OK
+    steps:
+      - run: echo "ExApp integration tests passed"
diff --git a/tests/exapp_integration/conftest.py b/tests/exapp_integration/conftest.py
@@ -21,13 +21,19 @@
 from ._client import AppAPIClient
 
 NEXTCLOUD_URL = os.environ.get("NEXTCLOUD_URL", "http://nextcloud.appapi")
+NEXTCLOUD_USER = os.environ.get("NEXTCLOUD_USER", "admin")
+NEXTCLOUD_PASS = os.environ.get("NEXTCLOUD_PASS", "admin")
 APP_ID = os.environ.get("APP_ID", "test_appapi")
 APP_VERSION = os.environ.get("APP_VERSION", "1.0.0")
 APP_SECRET = os.environ["APP_SECRET"]
 TEST_APP_URL = os.environ.get("TEST_APP_URL", "http://127.0.0.1:9009")
 
-OCC = ["docker", "exec", "appapi-nextcloud-1",
-       "sudo", "-u", "www-data", "php", "occ"]
+# OCC invocation. Override with `OCC_CMD` (space-separated) when running
+# outside the dev VM (e.g. in CI where Nextcloud is on the host via php -S).
+OCC = os.environ.get(
+    "OCC_CMD",
+    "docker exec appapi-nextcloud-1 sudo -u www-data php occ",
+).split()
 
 
 @pytest.fixture(scope="session")
@@ -58,6 +64,16 @@ def test_app_url() -> str:
     return TEST_APP_URL
 
 
+@pytest.fixture(scope="session")
+def nextcloud_url() -> str:
+    return NEXTCLOUD_URL
+
+
+@pytest.fixture(scope="session")
+def admin_credentials() -> tuple[str, str]:
+    return NEXTCLOUD_USER, NEXTCLOUD_PASS
+
+
 @pytest.fixture(scope="session", autouse=True)
 def _ensure_test_app_registered() -> None:
     r = subprocess.run(OCC + ["app_api:app:list"], capture_output=True, text=True, check=True)
@@ -67,3 +83,19 @@ def _ensure_test_app_registered() -> None:
         )
     if "[enabled]" not in next((line for line in r.stdout.splitlines() if APP_ID in line), ""):
         raise RuntimeError(f"ExApp '{APP_ID}' is registered but not enabled.")
+
+
+@pytest.fixture
+def logged_in_page(page, nextcloud_url, admin_credentials):
+    """Yield a Playwright Page authenticated as admin.
+
+    Uses the standard NC login form (no app password / no token plumbing) so
+    the test exercises the same client-side bootstrap path real users hit.
+    """
+    user, password = admin_credentials
+    page.goto(f"{nextcloud_url}/index.php/login")
+    page.get_by_label("Account name or email").fill(user)
+    page.get_by_label("Password", exact=True).fill(password)
+    page.get_by_role("button", name="Log in", exact=True).click()
+    page.wait_for_url(lambda url: "/login" not in url, timeout=15_000)
+    return page
diff --git a/tests/exapp_integration/requirements.txt b/tests/exapp_integration/requirements.txt
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+# SPDX-License-Identifier: AGPL-3.0-or-later
+fastapi
+pytest
+pytest-playwright
+requests
+uvicorn
diff --git a/tests/exapp_integration/test_file_actions_menu.py b/tests/exapp_integration/test_file_actions_menu.py
@@ -0,0 +1,102 @@
+# SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""Browser test for ExApp-registered FileActionMenu entries.
+
+Regression for https://github.com/nextcloud/app_api/issues/848: an ExApp's
+FileActionMenu V2 entry is registered server-side (DB row exists, OCS GET
+returns it) but does not appear in the Files app dropdown because AppAPI's
+bundled @nextcloud/files version stored actions in a registry the NC server's
+Files app no longer reads.
+
+The test registers a file action via OCS, uploads a matching test file, and
+drives a real browser through the Files UI to assert the entry is visible.
+"""
+
+from __future__ import annotations
+
+import requests
+from playwright.sync_api import Page, expect
+
+from ._client import AppAPIClient
+
+ACTION_NAME = "test_appapi_fileaction"
+ACTION_DISPLAY = "AppAPI Integration FileAction"
+TEST_FILE_NAME = "test_appapi_fileaction.txt"
+
+
+def _ocs_register_file_action(client: AppAPIClient) -> None:
+    body = {
+        "name": ACTION_NAME,
+        "displayName": ACTION_DISPLAY,
+        "actionHandler": "/file-action",
+        "icon": "",
+        # mime is matched by substring against node mime; "text" hits text/plain.
+        "mime": "text",
+        "permissions": 31,
+        "order": 0,
+    }
+    r = client.request(
+        "POST",
+        "/ocs/v1.php/apps/app_api/api/v2/ui/files-actions-menu",
+        json=body,
+    )
+    assert r.status_code == 200, f"register OCS call failed: {r.status_code} {r.text}"
+
+
+def _ocs_unregister_file_action(client: AppAPIClient) -> None:
+    client.request(
+        "DELETE",
+        "/ocs/v1.php/apps/app_api/api/v1/ui/files-actions-menu",
+        json={"name": ACTION_NAME},
+    )
+
+
+def _webdav_put(nextcloud_url: str, user: str, password: str, name: str, content: bytes) -> None:
+    r = requests.put(
+        f"{nextcloud_url}/remote.php/dav/files/{user}/{name}",
+        auth=(user, password),
+        data=content,
+        headers={"OCS-APIRequest": "true"},
+        timeout=30,
+    )
+    assert r.status_code in (201, 204), f"WebDAV PUT failed: {r.status_code} {r.text}"
+
+
+def _webdav_delete(nextcloud_url: str, user: str, password: str, name: str) -> None:
+    requests.delete(
+        f"{nextcloud_url}/remote.php/dav/files/{user}/{name}",
+        auth=(user, password),
+        headers={"OCS-APIRequest": "true"},
+        timeout=30,
+    )
+
+
+def test_file_action_visible_in_files_menu(
+    client: AppAPIClient,
+    logged_in_page: Page,
+    nextcloud_url: str,
+    admin_credentials: tuple[str, str],
+) -> None:
+    user, password = admin_credentials
+
+    _ocs_register_file_action(client)
+    _webdav_put(nextcloud_url, user, password, TEST_FILE_NAME, b"hello 848")
+    try:
+        page = logged_in_page
+        page.goto(f"{nextcloud_url}/index.php/apps/files/files")
+
+        # The Files app renders rows lazily (virtualised list). Wait for the
+        # specific row keyed by the data-cy attribute to land in the DOM
+        # before clicking on its Actions button.
+        file_row = page.locator(
+            f'[data-cy-files-list-row-name="{TEST_FILE_NAME}"]'
+        ).first
+        file_row.wait_for(state="visible", timeout=15_000)
+        file_row.get_by_role("button", name="Actions").click()
+
+        expect(
+            page.get_by_role("menuitem", name=ACTION_DISPLAY)
+        ).to_be_visible(timeout=5_000)
+    finally:
+        _webdav_delete(nextcloud_url, user, password, TEST_FILE_NAME)
+        _ocs_unregister_file_action(client)
diff --git a/tests/exapp_integration/test_lifecycle.py b/tests/exapp_integration/test_lifecycle.py
@@ -8,10 +8,13 @@
 callback (otherwise the OCC enable command itself would fail).
 """
 
+import os
 import subprocess
 
-OCC = ["docker", "exec", "appapi-nextcloud-1",
-       "sudo", "-u", "www-data", "php", "occ"]
+OCC = os.environ.get(
+    "OCC_CMD",
+    "docker exec appapi-nextcloud-1 sudo -u www-data php occ",
+).split()
 
 
 def _is_enabled(app_id: str) -> bool:
