s #2703
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: UI | |
| on: | |
| pull_request: | |
| workflow_dispatch: | |
| schedule: | |
| # Run everday at midnight UTC / 5:30 IST | |
| - cron: "0 0 * * *" | |
| concurrency: | |
| group: ui-develop-${{ github.event_name }}-${{ github.event.number }} | |
| cancel-in-progress: true | |
| permissions: | |
| # Do not change this as GITHUB_TOKEN is being used by roulette | |
| contents: read | |
| jobs: | |
| checkrun: | |
| name: Build Check | |
| runs-on: ubuntu-latest | |
| outputs: | |
| build: ${{ steps.check-build.outputs.build }} | |
| steps: | |
| - name: Clone | |
| uses: actions/checkout@v4 | |
| - name: Check if build should be run | |
| id: check-build | |
| run: | | |
| python "${GITHUB_WORKSPACE}/.github/helper/roulette.py" | |
| env: | |
| TYPE: "ui" | |
| PR_NUMBER: ${{ github.event.number }} | |
| REPO_NAME: ${{ github.repository }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| test: | |
| runs-on: ubuntu-latest | |
| needs: checkrun | |
| if: ${{ needs.checkrun.outputs.build == 'strawberry' && github.repository_owner == 'frappe' }} | |
| timeout-minutes: 60 | |
| env: | |
| NODE_ENV: "production" | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| # Make sure you modify coverage submission file list if changing this | |
| container: [1, 2, 3] | |
| name: UI Tests (Cypress) | |
| services: | |
| mariadb: | |
| image: mariadb:11.3 | |
| env: | |
| MARIADB_ROOT_PASSWORD: db_root | |
| ports: | |
| - 3306:3306 | |
| options: --health-cmd="healthcheck.sh --connect --innodb_initialized" --health-interval=5s --health-timeout=2s --health-retries=3 | |
| steps: | |
| - name: Clone | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Check for valid Python & Merge Conflicts | |
| run: | | |
| python -m compileall -q -f "${GITHUB_WORKSPACE}" | |
| if grep -lr --exclude-dir=node_modules "^<<<<<<< " "${GITHUB_WORKSPACE}" | |
| then echo "Found merge conflicts" | |
| exit 1 | |
| fi | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| check-latest: true | |
| - name: Add to Hosts | |
| run: | | |
| echo "127.0.0.1 test_site" | sudo tee -a /etc/hosts | |
| - name: Cache pip | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| ${{ runner.os }}- | |
| - name: Get yarn cache directory path | |
| id: yarn-cache-dir-path | |
| run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT | |
| - uses: actions/cache@v4 | |
| id: yarn-cache | |
| with: | |
| path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | |
| key: ${{ runner.os }}-yarn-ui-${{ hashFiles('**/yarn.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-yarn-ui- | |
| - name: Cache cypress binary | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/Cypress | |
| key: ${{ runner.os }}-cypress | |
| - name: Install Dependencies | |
| run: | | |
| bash ${GITHUB_WORKSPACE}/.github/helper/install_dependencies.sh | |
| - name: Init Bench | |
| run: | | |
| bash ${GITHUB_WORKSPACE}/.github/helper/install_bench.sh | |
| env: | |
| TYPE: ui | |
| - name: Init Test Site | |
| run: | | |
| bash ${GITHUB_WORKSPACE}/.github/helper/install_site.sh | |
| env: | |
| BEFORE: ${{ env.GITHUB_EVENT_PATH.before }} | |
| AFTER: ${{ env.GITHUB_EVENT_PATH.after }} | |
| FRAPPE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }} | |
| TYPE: ui | |
| DB: mariadb | |
| - name: Verify yarn.lock | |
| run: | | |
| cd ~/frappe-bench/apps/frappe | |
| git diff --exit-code yarn.lock | |
| - name: Instrument Source Code | |
| run: cd ~/frappe-bench/apps/frappe/ && npx nyc instrument -x 'frappe/public/dist/**' -x 'frappe/public/js/lib/**' -x '**/*.bundle.js' --compact=false --in-place frappe | |
| - name: Build | |
| run: cd ~/frappe-bench/ && bench build --apps frappe | |
| - name: Site Setup | |
| run: | | |
| cd ~/frappe-bench/ | |
| bench --site test_site execute frappe.utils.install.complete_setup_wizard | |
| bench --site test_site execute frappe.tests.ui_test_helpers.create_test_user | |
| - name: UI Tests | |
| run: cd ~/frappe-bench/ && bench --site test_site run-ui-tests frappe --with-coverage --headless --parallel --ci-build-id $GITHUB_RUN_ID-$GITHUB_RUN_ATTEMPT | |
| env: | |
| CYPRESS_RECORD_KEY: 4a48f41c-11b3-425b-aa88-c58048fa69eb | |
| - name: Stop server and wait for coverage file | |
| if: github.event_name != 'pull_request' | |
| run: | | |
| ps -ef | grep "[f]rappe serve" | awk '{print $2}' | xargs kill -s SIGINT | |
| sleep 5 | |
| ( tail -f /home/runner/frappe-bench/sites/coverage.xml & ) | grep -q "\/coverage" | |
| - name: Upload JS coverage data | |
| uses: actions/upload-artifact@v3 | |
| if: github.event_name != 'pull_request' | |
| with: | |
| name: coverage-js-${{ matrix.container }} | |
| path: /home/runner/frappe-bench/apps/frappe/.cypress-coverage/clover.xml | |
| - name: Upload python coverage data | |
| uses: actions/upload-artifact@v3 | |
| if: github.event_name != 'pull_request' | |
| with: | |
| name: coverage-py-${{ matrix.container }} | |
| path: /home/runner/frappe-bench/sites/coverage.xml | |
| - name: Show bench output | |
| if: ${{ always() }} | |
| run: | | |
| cd ~/frappe-bench | |
| cat bench_start.log || true | |
| cd logs | |
| for f in ./*.log*; do | |
| echo "Printing log: $f"; | |
| cat $f | |
| done | |
| faux-test: | |
| runs-on: ubuntu-latest | |
| needs: checkrun | |
| if: ${{ needs.checkrun.outputs.build != 'strawberry' && github.repository_owner == 'frappe' }} | |
| name: UI Tests (Cypress) | |
| strategy: | |
| matrix: | |
| container: [1, 2, 3] | |
| steps: | |
| - name: Pass skipped tests unconditionally | |
| run: "echo Skipped" | |
| coverage: | |
| name: Coverage Wrap Up | |
| needs: [test, checkrun] | |
| if: ${{ needs.checkrun.outputs.build == 'strawberry' && github.event_name != 'pull_request' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone | |
| uses: actions/checkout@v4 | |
| - name: Download artifacts | |
| uses: actions/[email protected] | |
| - name: Upload python coverage data | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| name: UIBackend | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| verbose: true | |
| files: ./coverage-py-1/coverage.xml,./coverage-py-2/coverage.xml,./coverage-py-3/coverage.xml | |
| flags: server-ui | |
| - name: Upload JS coverage data | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| name: Cypress | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| files: ./coverage-js-1/clover.xml,./coverage-js-2/clover.xml,./coverage-js-3/clover.xml | |
| verbose: true | |
| flags: ui-tests |