opendesk

1name: UI Tests
2
3on:
4  pull_request:
5    branches:
6      - develop
7    paths:
8      - "desk/**"
9      - "shared/**"
10      - "studio/**"
11      - "e2e/**"
12      - "playwright.config.ts"
13      - "package.json"
14      - "yarn.lock"
15      - ".github/workflows/ui-tests.yml"
16  workflow_dispatch:
17
18concurrency:
19  group: ui-tests-opendesk-${{ github.event.number || github.ref }}
20  cancel-in-progress: true
21
22env:
23  FRAPPE_BRANCH: develop
24  SITE: opendesk.test
25
26jobs:
27  ui-tests:
28    name: Playwright E2E Tests (${{ matrix.shard }}/2)
29    runs-on: ubuntu-latest
30    timeout-minutes: 60
31    strategy:
32      fail-fast: false
33      matrix:
34        shard: [1, 2]
35
36    services:
37      redis-cache:
38        image: redis/redis-stack-server:latest
39        ports:
40          - 13000:6379
41      redis-queue:
42        image: redis:alpine
43        ports:
44          - 11000:6379
45      mariadb:
46        image: mariadb:10.6
47        env:
48          MARIADB_ROOT_PASSWORD: root
49        ports:
50          - 3306:3306
51        options: --health-cmd="mariadb-admin ping" --health-interval=5s --health-timeout=2s --health-retries=3
52
53    steps:
54      - name: Clone
55        uses: actions/checkout@v4
56
57      - name: Setup Python
58        uses: actions/setup-python@v5
59        with:
60          python-version: "3.14"
61
62      - name: Setup Node
63        uses: actions/setup-node@v4
64        with:
65          node-version: 24
66          check-latest: true
67
68      - name: Cache pip
69        uses: actions/cache@v4
70        with:
71          path: ~/.cache/pip
72          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
73          restore-keys: ${{ runner.os }}-pip-
74
75      - name: Cache yarn
76        uses: actions/cache@v4
77        with:
78          path: ~/.cache/yarn
79          key: ${{ runner.os }}-yarn-ui-${{ hashFiles('**/yarn.lock') }}
80          restore-keys: ${{ runner.os }}-yarn-ui-
81
82      - name: Cache Playwright browsers
83        uses: actions/cache@v4
84        with:
85          path: ~/.cache/ms-playwright
86          key: ${{ runner.os }}-playwright-${{ hashFiles('yarn.lock') }}
87
88      - name: Install MariaDB Client
89        run: |
90          sudo apt update
91          sudo apt install -y mariadb-client
92
93      - name: Setup Bench
94        run: |
95          pip install frappe-bench
96          bench init --skip-redis-config-generation --skip-assets --frappe-branch "$FRAPPE_BRANCH" --python "$(which python)" ~/frappe-bench
97          mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"
98          mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"
99
100      - name: Install Opendesk
101        working-directory: /home/runner/frappe-bench
102        run: |
103          bench get-app telephony
104          # get-app builds opendesk's Studio portal with frappe's Studio toolchain,
105          # which --skip-assets left without its node_modules
106          (cd apps/frappe/studio/frontend && yarn install --frozen-lockfile)
107          bench get-app opendesk $GITHUB_WORKSPACE
108          bench setup requirements --dev
109          bench new-site --db-root-password root --admin-password admin --install-app opendesk $SITE
110          bench use $SITE
111          bench --site $SITE set-config host_name "http://localhost:8000"
112          # The suite creates more users in an hour than the default limit (60) allows.
113          bench --site $SITE set-config -p throttle_user_limit 10000
114          bench build --apps frappe,opendesk
115        env:
116          CI: "Yes"
117
118      - name: Start Frappe Server
119        working-directory: /home/runner/frappe-bench
120        run: |
121          sed -i 's/^watch:/# watch:/g' Procfile
122          sed -i 's/^schedule:/# schedule:/g' Procfile
123          bench start &> bench_start.log &
124          timeout 120 bash -c "until curl -s http://localhost:8000 > /dev/null; do sleep 2; done"
125
126      - name: Install Playwright
127        run: |
128          yarn install --frozen-lockfile --ignore-scripts
129          npx playwright install --with-deps chromium
130
131      - name: Run Playwright Tests
132        run: npx playwright test --shard=${{ matrix.shard }}/2
133        env:
134          # localhost is a secure context, which crypto.randomUUID in frappe/ui needs.
135          BASE_URL: http://localhost:8000
136          ADMIN_PASSWORD: admin
137
138      - name: Upload Blob Report
139        uses: actions/upload-artifact@v4
140        if: always()
141        with:
142          name: blob-report-${{ matrix.shard }}
143          path: blob-report/
144          retention-days: 1
145
146      - name: Upload Test Results
147        uses: actions/upload-artifact@v4
148        if: failure()
149        with:
150          name: test-results-${{ matrix.shard }}
151          path: test-results/
152          retention-days: 7
153
154      - name: Show Bench Logs on Failure
155        if: failure()
156        working-directory: /home/runner/frappe-bench
157        run: |
158          cat bench_start.log || true
159          cat logs/*.log || true
160
161  merge-reports:
162    name: Merge Playwright Reports
163    needs: ui-tests
164    if: always()
165    runs-on: ubuntu-latest
166
167    steps:
168      - name: Clone
169        uses: actions/checkout@v4
170
171      - name: Setup Node
172        uses: actions/setup-node@v4
173        with:
174          node-version: 24
175
176      - name: Install Playwright
177        run: yarn install --frozen-lockfile --ignore-scripts
178
179      - name: Download Blob Reports
180        uses: actions/download-artifact@v4
181        with:
182          path: all-blob-reports
183          pattern: blob-report-*
184          merge-multiple: true
185
186      - name: Merge Into HTML Report
187        run: npx playwright merge-reports --reporter html ./all-blob-reports
188
189      - name: Upload Playwright Report
190        uses: actions/upload-artifact@v4
191        with:
192          name: playwright-report
193          path: playwright-report/
194          retention-days: 7
195