zulip/.github/workflows/zulip-ci.yml

253 lines
9.1 KiB
YAML
Raw Normal View History

# NOTE: Everything test in this file should be in `tools/test-all`. If there's a
# reason not to run it there, it should be there as a comment
# explaining why.
name: Zulip CI
on:
push:
branches: ["*.x", chat.zulip.org, main]
tags: ["*"]
pull_request:
workflow_dispatch:
concurrency:
group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}"
cancel-in-progress: true
defaults:
run:
shell: bash
permissions:
contents: read
jobs:
tests:
github-actions: Use stratergy and if to deduplicate steps. This is a fine solution short-term until github implements the yaml anchors support. The limitation of this method is that we cannot re-use most of the steps again for production install test builds. Thanks, Anders for this solution. Verifying everything is migrated correctly is a pain. This script ensures everything is done correctly (previous commit message contains explainations for the steps being ignored if; in case of github-actions steps they are ignored because they are actions specific): """ This script prints out the ignore steps first. Then prints out each step of both circle and actions side-by-side. One step is out of order for bionic but verfying correction is still easier. Format: Actions: Install dependencies Circle CI: install dependencies .... """ import yaml with open('.circleci/config.yml') as f: circleci_config = yaml.safe_load(f) with open('.github/workflows/zulip-ci.yml') as f: actions_config = yaml.safe_load(f) circle_bionic_steps = [] circle_focal_steps = [] actions_bionic_steps = [] actions_focal_steps = [] """ We ignore casper artifact upload, save_cache, and store_tests_reports steps. """ def get_circleci_steps(job, arr): for step in circleci_config['jobs'][job]['steps']: if isinstance(step, str): arr.append(step) continue step_name = step.get('run', {}).get('name', False) if not step_name: if step.get('restore_cache'): key = step['restore_cache']['keys'][0].split('.')[0] step_name = f'<restore-cache> {key}' elif step.get('store_artifacts', False): destination = step['store_artifacts']['destination'] step_name = f'<store-artificats> {destination}' if destination == 'casper': \# This is no longer needed print('Ignoring step:') print(step) print() continue else: """ We don't care about save_cache; github-actions does this automatically, and store_tests_reports is circelci timing specific. """ print('Ignoring step:') print(step) print() continue if step_name != 'On fail': arr.append(step_name) get_circleci_steps('bionic-backend-frontend', circle_bionic_steps) get_circleci_steps('focal-backend', circle_focal_steps) """ We ignore there steps specific to github-actions""" for step in actions_config['jobs']['focal_bionic']['steps']: BOTH_OS = 'BOTH_OS' if_check = step.get('if', BOTH_OS) step_name = step.get('name') if step_name is None: step_name = step['uses'] if ( step_name == 'Upgrade git for bionic' or step_name == 'Add required permissions' or step_name == 'Move test reports to var' ): print('Ignoring step:') print(step) print() """These are github-actions specific; see comments""" continue if if_check == BOTH_OS: actions_bionic_steps.append(step_name) actions_focal_steps.append(step_name) elif 'is_bionic' in if_check: actions_bionic_steps.append(step_name) else: actions_focal_steps.append(step_name) bionic = zip(circle_bionic_steps, actions_bionic_steps) focal = zip(circle_focal_steps, actions_focal_steps) print('Bionic steps:') for (circle_step, actions_step) in bionic: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print() print('Focal steps:') for (circle_step, actions_step) in focal: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print()
2020-07-02 19:12:22 +02:00
strategy:
fail-fast: false
github-actions: Use stratergy and if to deduplicate steps. This is a fine solution short-term until github implements the yaml anchors support. The limitation of this method is that we cannot re-use most of the steps again for production install test builds. Thanks, Anders for this solution. Verifying everything is migrated correctly is a pain. This script ensures everything is done correctly (previous commit message contains explainations for the steps being ignored if; in case of github-actions steps they are ignored because they are actions specific): """ This script prints out the ignore steps first. Then prints out each step of both circle and actions side-by-side. One step is out of order for bionic but verfying correction is still easier. Format: Actions: Install dependencies Circle CI: install dependencies .... """ import yaml with open('.circleci/config.yml') as f: circleci_config = yaml.safe_load(f) with open('.github/workflows/zulip-ci.yml') as f: actions_config = yaml.safe_load(f) circle_bionic_steps = [] circle_focal_steps = [] actions_bionic_steps = [] actions_focal_steps = [] """ We ignore casper artifact upload, save_cache, and store_tests_reports steps. """ def get_circleci_steps(job, arr): for step in circleci_config['jobs'][job]['steps']: if isinstance(step, str): arr.append(step) continue step_name = step.get('run', {}).get('name', False) if not step_name: if step.get('restore_cache'): key = step['restore_cache']['keys'][0].split('.')[0] step_name = f'<restore-cache> {key}' elif step.get('store_artifacts', False): destination = step['store_artifacts']['destination'] step_name = f'<store-artificats> {destination}' if destination == 'casper': \# This is no longer needed print('Ignoring step:') print(step) print() continue else: """ We don't care about save_cache; github-actions does this automatically, and store_tests_reports is circelci timing specific. """ print('Ignoring step:') print(step) print() continue if step_name != 'On fail': arr.append(step_name) get_circleci_steps('bionic-backend-frontend', circle_bionic_steps) get_circleci_steps('focal-backend', circle_focal_steps) """ We ignore there steps specific to github-actions""" for step in actions_config['jobs']['focal_bionic']['steps']: BOTH_OS = 'BOTH_OS' if_check = step.get('if', BOTH_OS) step_name = step.get('name') if step_name is None: step_name = step['uses'] if ( step_name == 'Upgrade git for bionic' or step_name == 'Add required permissions' or step_name == 'Move test reports to var' ): print('Ignoring step:') print(step) print() """These are github-actions specific; see comments""" continue if if_check == BOTH_OS: actions_bionic_steps.append(step_name) actions_focal_steps.append(step_name) elif 'is_bionic' in if_check: actions_bionic_steps.append(step_name) else: actions_focal_steps.append(step_name) bionic = zip(circle_bionic_steps, actions_bionic_steps) focal = zip(circle_focal_steps, actions_focal_steps) print('Bionic steps:') for (circle_step, actions_step) in bionic: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print() print('Focal steps:') for (circle_step, actions_step) in focal: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print()
2020-07-02 19:12:22 +02:00
matrix:
include_documentation_tests: [false]
include_frontend_tests: [false]
github-actions: Use stratergy and if to deduplicate steps. This is a fine solution short-term until github implements the yaml anchors support. The limitation of this method is that we cannot re-use most of the steps again for production install test builds. Thanks, Anders for this solution. Verifying everything is migrated correctly is a pain. This script ensures everything is done correctly (previous commit message contains explainations for the steps being ignored if; in case of github-actions steps they are ignored because they are actions specific): """ This script prints out the ignore steps first. Then prints out each step of both circle and actions side-by-side. One step is out of order for bionic but verfying correction is still easier. Format: Actions: Install dependencies Circle CI: install dependencies .... """ import yaml with open('.circleci/config.yml') as f: circleci_config = yaml.safe_load(f) with open('.github/workflows/zulip-ci.yml') as f: actions_config = yaml.safe_load(f) circle_bionic_steps = [] circle_focal_steps = [] actions_bionic_steps = [] actions_focal_steps = [] """ We ignore casper artifact upload, save_cache, and store_tests_reports steps. """ def get_circleci_steps(job, arr): for step in circleci_config['jobs'][job]['steps']: if isinstance(step, str): arr.append(step) continue step_name = step.get('run', {}).get('name', False) if not step_name: if step.get('restore_cache'): key = step['restore_cache']['keys'][0].split('.')[0] step_name = f'<restore-cache> {key}' elif step.get('store_artifacts', False): destination = step['store_artifacts']['destination'] step_name = f'<store-artificats> {destination}' if destination == 'casper': \# This is no longer needed print('Ignoring step:') print(step) print() continue else: """ We don't care about save_cache; github-actions does this automatically, and store_tests_reports is circelci timing specific. """ print('Ignoring step:') print(step) print() continue if step_name != 'On fail': arr.append(step_name) get_circleci_steps('bionic-backend-frontend', circle_bionic_steps) get_circleci_steps('focal-backend', circle_focal_steps) """ We ignore there steps specific to github-actions""" for step in actions_config['jobs']['focal_bionic']['steps']: BOTH_OS = 'BOTH_OS' if_check = step.get('if', BOTH_OS) step_name = step.get('name') if step_name is None: step_name = step['uses'] if ( step_name == 'Upgrade git for bionic' or step_name == 'Add required permissions' or step_name == 'Move test reports to var' ): print('Ignoring step:') print(step) print() """These are github-actions specific; see comments""" continue if if_check == BOTH_OS: actions_bionic_steps.append(step_name) actions_focal_steps.append(step_name) elif 'is_bionic' in if_check: actions_bionic_steps.append(step_name) else: actions_focal_steps.append(step_name) bionic = zip(circle_bionic_steps, actions_bionic_steps) focal = zip(circle_focal_steps, actions_focal_steps) print('Bionic steps:') for (circle_step, actions_step) in bionic: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print() print('Focal steps:') for (circle_step, actions_step) in focal: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print()
2020-07-02 19:12:22 +02:00
include:
# Base images are built using `tools/ci/Dockerfile.prod.template`.
# The comments at the top explain how to build and upload these images.
# Ubuntu 20.04 ships with Python 3.8.10.
- docker_image: zulip/ci:focal
name: Ubuntu 20.04 (Python 3.8, backend + frontend)
github-actions: Use stratergy and if to deduplicate steps. This is a fine solution short-term until github implements the yaml anchors support. The limitation of this method is that we cannot re-use most of the steps again for production install test builds. Thanks, Anders for this solution. Verifying everything is migrated correctly is a pain. This script ensures everything is done correctly (previous commit message contains explainations for the steps being ignored if; in case of github-actions steps they are ignored because they are actions specific): """ This script prints out the ignore steps first. Then prints out each step of both circle and actions side-by-side. One step is out of order for bionic but verfying correction is still easier. Format: Actions: Install dependencies Circle CI: install dependencies .... """ import yaml with open('.circleci/config.yml') as f: circleci_config = yaml.safe_load(f) with open('.github/workflows/zulip-ci.yml') as f: actions_config = yaml.safe_load(f) circle_bionic_steps = [] circle_focal_steps = [] actions_bionic_steps = [] actions_focal_steps = [] """ We ignore casper artifact upload, save_cache, and store_tests_reports steps. """ def get_circleci_steps(job, arr): for step in circleci_config['jobs'][job]['steps']: if isinstance(step, str): arr.append(step) continue step_name = step.get('run', {}).get('name', False) if not step_name: if step.get('restore_cache'): key = step['restore_cache']['keys'][0].split('.')[0] step_name = f'<restore-cache> {key}' elif step.get('store_artifacts', False): destination = step['store_artifacts']['destination'] step_name = f'<store-artificats> {destination}' if destination == 'casper': \# This is no longer needed print('Ignoring step:') print(step) print() continue else: """ We don't care about save_cache; github-actions does this automatically, and store_tests_reports is circelci timing specific. """ print('Ignoring step:') print(step) print() continue if step_name != 'On fail': arr.append(step_name) get_circleci_steps('bionic-backend-frontend', circle_bionic_steps) get_circleci_steps('focal-backend', circle_focal_steps) """ We ignore there steps specific to github-actions""" for step in actions_config['jobs']['focal_bionic']['steps']: BOTH_OS = 'BOTH_OS' if_check = step.get('if', BOTH_OS) step_name = step.get('name') if step_name is None: step_name = step['uses'] if ( step_name == 'Upgrade git for bionic' or step_name == 'Add required permissions' or step_name == 'Move test reports to var' ): print('Ignoring step:') print(step) print() """These are github-actions specific; see comments""" continue if if_check == BOTH_OS: actions_bionic_steps.append(step_name) actions_focal_steps.append(step_name) elif 'is_bionic' in if_check: actions_bionic_steps.append(step_name) else: actions_focal_steps.append(step_name) bionic = zip(circle_bionic_steps, actions_bionic_steps) focal = zip(circle_focal_steps, actions_focal_steps) print('Bionic steps:') for (circle_step, actions_step) in bionic: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print() print('Focal steps:') for (circle_step, actions_step) in focal: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print()
2020-07-02 19:12:22 +02:00
os: focal
include_frontend_tests: true
# Debian 11 ships with Python 3.9.2.
- docker_image: zulip/ci:bullseye
name: Debian 11 (Python 3.9, backend + documentation)
os: bullseye
include_documentation_tests: true
# Ubuntu 22.04 ships with Python 3.10.4.
- docker_image: zulip/ci:jammy
name: Ubuntu 22.04 (Python 3.10, backend)
os: jammy
github-actions: Use stratergy and if to deduplicate steps. This is a fine solution short-term until github implements the yaml anchors support. The limitation of this method is that we cannot re-use most of the steps again for production install test builds. Thanks, Anders for this solution. Verifying everything is migrated correctly is a pain. This script ensures everything is done correctly (previous commit message contains explainations for the steps being ignored if; in case of github-actions steps they are ignored because they are actions specific): """ This script prints out the ignore steps first. Then prints out each step of both circle and actions side-by-side. One step is out of order for bionic but verfying correction is still easier. Format: Actions: Install dependencies Circle CI: install dependencies .... """ import yaml with open('.circleci/config.yml') as f: circleci_config = yaml.safe_load(f) with open('.github/workflows/zulip-ci.yml') as f: actions_config = yaml.safe_load(f) circle_bionic_steps = [] circle_focal_steps = [] actions_bionic_steps = [] actions_focal_steps = [] """ We ignore casper artifact upload, save_cache, and store_tests_reports steps. """ def get_circleci_steps(job, arr): for step in circleci_config['jobs'][job]['steps']: if isinstance(step, str): arr.append(step) continue step_name = step.get('run', {}).get('name', False) if not step_name: if step.get('restore_cache'): key = step['restore_cache']['keys'][0].split('.')[0] step_name = f'<restore-cache> {key}' elif step.get('store_artifacts', False): destination = step['store_artifacts']['destination'] step_name = f'<store-artificats> {destination}' if destination == 'casper': \# This is no longer needed print('Ignoring step:') print(step) print() continue else: """ We don't care about save_cache; github-actions does this automatically, and store_tests_reports is circelci timing specific. """ print('Ignoring step:') print(step) print() continue if step_name != 'On fail': arr.append(step_name) get_circleci_steps('bionic-backend-frontend', circle_bionic_steps) get_circleci_steps('focal-backend', circle_focal_steps) """ We ignore there steps specific to github-actions""" for step in actions_config['jobs']['focal_bionic']['steps']: BOTH_OS = 'BOTH_OS' if_check = step.get('if', BOTH_OS) step_name = step.get('name') if step_name is None: step_name = step['uses'] if ( step_name == 'Upgrade git for bionic' or step_name == 'Add required permissions' or step_name == 'Move test reports to var' ): print('Ignoring step:') print(step) print() """These are github-actions specific; see comments""" continue if if_check == BOTH_OS: actions_bionic_steps.append(step_name) actions_focal_steps.append(step_name) elif 'is_bionic' in if_check: actions_bionic_steps.append(step_name) else: actions_focal_steps.append(step_name) bionic = zip(circle_bionic_steps, actions_bionic_steps) focal = zip(circle_focal_steps, actions_focal_steps) print('Bionic steps:') for (circle_step, actions_step) in bionic: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print() print('Focal steps:') for (circle_step, actions_step) in focal: print(f'CircleCI: {circle_step}') print(f'Actions: {actions_step}') print()
2020-07-02 19:12:22 +02:00
runs-on: ubuntu-latest
name: ${{ matrix.name }}
container: ${{ matrix.docker_image }}
env:
# GitHub Actions sets HOME to /github/home which causes
# problem later in provision and frontend test that runs
# tools/setup/postgresql-init-dev-db because of the .pgpass
# location. PostgreSQL (psql) expects .pgpass to be at
# /home/github/.pgpass and setting home to `/home/github/`
# ensures it written there because we write it to ~/.pgpass.
HOME: /home/github/
steps:
- uses: actions/checkout@v3
- name: Create cache directories
run: |
dirs=(/srv/zulip-{npm,venv,emoji}-cache)
sudo mkdir -p "${dirs[@]}"
sudo chown -R github "${dirs[@]}"
- name: Restore node_modules cache
uses: actions/cache@v3
with:
path: /srv/zulip-npm-cache
key: v1-yarn-deps-${{ matrix.os }}-${{ hashFiles('package.json', 'yarn.lock') }}
restore-keys: v1-yarn-deps-${{ matrix.os }}
- name: Restore python cache
uses: actions/cache@v3
with:
path: /srv/zulip-venv-cache
key: v1-venv-${{ matrix.os }}-${{ hashFiles('requirements/dev.txt') }}
restore-keys: v1-venv-${{ matrix.os }}
- name: Restore emoji cache
uses: actions/cache@v3
with:
path: /srv/zulip-emoji-cache
key: v1-emoji-${{ matrix.os }}-${{ hashFiles('tools/setup/emoji/emoji_map.json', 'tools/setup/emoji/build_emoji', 'tools/setup/emoji/emoji_setup_utils.py', 'tools/setup/emoji/emoji_names.py', 'package.json') }}
restore-keys: v1-emoji-${{ matrix.os }}
- name: Install dependencies
run: |
# This is the main setup job for the test suite
./tools/ci/setup-backend --skip-dev-db-build
# Cleaning caches is mostly unnecessary in GitHub Actions, because
# most builds don't get to write to the cache.
# scripts/lib/clean_unused_caches.py --verbose --threshold 0
- name: Run tools test
run: |
source tools/ci/activate-venv
./tools/test-tools
- name: Run Codespell lint
run: |
source tools/ci/activate-venv
./tools/run-codespell
- name: Run backend lint
run: |
source tools/ci/activate-venv
echo "Test suite is running under $(python --version)."
./tools/lint --groups=backend --skip=gitlint,mypy # gitlint disabled because flaky
- name: Run frontend lint
if: ${{ matrix.include_frontend_tests }}
run: |
source tools/ci/activate-venv
./tools/lint --groups=frontend --skip=gitlint # gitlint disabled because flaky
- name: Run backend tests
run: |
source tools/ci/activate-venv
./tools/test-backend --coverage --include-webhooks --no-cov-cleanup --ban-console-output
- name: Run mypy
run: |
source tools/ci/activate-venv
# We run mypy after the backend tests so we get output from the
# backend tests, which tend to uncover more serious problems, first.
./tools/run-mypy --version
./tools/run-mypy
- name: Run miscellaneous tests
run: |
source tools/ci/activate-venv
# Currently our compiled requirements files will differ for different
# Python versions, so we will run test-locked-requirements only on the
# platform with the oldest one.
# ./tools/test-locked-requirements
# ./tools/test-run-dev # https://github.com/zulip/zulip/pull/14233
#
# This test has been persistently flaky at like 1% frequency, is slow,
# and is for a very specific single feature, so we don't run it by default:
# ./tools/test-queue-worker-reload
./tools/test-migrations
./tools/setup/optimize-svg --check
./tools/setup/generate_integration_bots_avatars.py --check-missing
./tools/ci/check-executables
# Ban check-database-compatibility.py from transitively
# relying on static/generated, because it might not be
# up-to-date at that point in upgrade-zulip-stage-2.
chmod 000 static/generated web/generated
./scripts/lib/check-database-compatibility.py
chmod 755 static/generated web/generated
- name: Run documentation and api tests
if: ${{ matrix.include_documentation_tests }}
run: |
source tools/ci/activate-venv
# In CI, we only test links we control in test-documentation to avoid flakes
./tools/test-documentation --skip-external-links
./tools/test-help-documentation --skip-external-links
./tools/test-api
- name: Run node tests
if: ${{ matrix.include_frontend_tests }}
run: |
source tools/ci/activate-venv
# Run the node tests first, since they're fast and deterministic
./tools/test-js-with-node --coverage --parallel=1
- name: Check schemas
if: ${{ matrix.include_frontend_tests }}
run: |
source tools/ci/activate-venv
# Check that various schemas are consistent. (is fast)
./tools/check-schemas
- name: Check capitalization of strings
if: ${{ matrix.include_frontend_tests }}
run: |
source tools/ci/activate-venv
./manage.py makemessages --locale en
PYTHONWARNINGS=ignore ./tools/check-capitalization --no-generate
PYTHONWARNINGS=ignore ./tools/check-frontend-i18n --no-generate
- name: Run puppeteer tests
if: ${{ matrix.include_frontend_tests }}
run: |
source tools/ci/activate-venv
./tools/test-js-with-puppeteer
- name: Check for untracked files
run: |
source tools/ci/activate-venv
# This final check looks for untracked files that may have been
# created by test-backend or provision.
untracked="$(git ls-files --exclude-standard --others)"
if [ -n "$untracked" ]; then
printf >&2 "Error: untracked files:\n%s\n" "$untracked"
exit 1
fi
- name: Test locked requirements
if: ${{ matrix.os == 'focal' }}
run: |
. /srv/zulip-py3-venv/bin/activate && \
./tools/test-locked-requirements
- name: Upload coverage reports
# Only upload coverage when both frontend and backend
# tests are run.
if: ${{ matrix.include_frontend_tests }}
uses: codecov/codecov-action@v3
with:
files: var/coverage.xml,var/node-coverage/lcov.info
- name: Store Puppeteer artifacts
# Upload these on failure, as well
if: ${{ always() && matrix.include_frontend_tests }}
uses: actions/upload-artifact@v3
with:
name: puppeteer
path: ./var/puppeteer
retention-days: 60
- name: Check development database build
run: ./tools/ci/setup-backend
- name: Generate failure report string
id: failure_report_string
if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }}
run: tools/ci/generate-failure-message >> $GITHUB_OUTPUT
- name: Report status to CZO
if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }}
uses: zulip/github-actions-zulip/send-message@v1
with:
api-key: ${{ secrets.ZULIP_BOT_KEY }}
email: "github-actions-bot@chat.zulip.org"
organization-url: "https://chat.zulip.org"
to: "automated testing"
topic: ${{ steps.failure_report_string.outputs.topic }}
type: "stream"
content: ${{ steps.failure_report_string.outputs.content }}