mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-19 10:54:17 -05:00
7010a3d015
ruff is a flake8-compatible Python linter written in Rust. It supports the flake8 plugins that we use and is significantly faster in testing.
576 lines
19 KiB
YAML
576 lines
19 KiB
YAML
name: Tests
|
|
|
|
on:
|
|
push:
|
|
branches: ["develop", "release-*"]
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
# Job to detect what has changed so we don't run e.g. Rust checks on PRs that
|
|
# don't modify Rust code.
|
|
changes:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
rust: ${{ !startsWith(github.ref, 'refs/pull/') || steps.filter.outputs.rust }}
|
|
steps:
|
|
- uses: dorny/paths-filter@v2
|
|
id: filter
|
|
# We only check on PRs
|
|
if: startsWith(github.ref, 'refs/pull/')
|
|
with:
|
|
filters: |
|
|
rust:
|
|
- 'rust/**'
|
|
- 'Cargo.toml'
|
|
- 'Cargo.lock'
|
|
|
|
check-sampleconfig:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.x"
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
extras: "all"
|
|
- run: poetry run scripts-dev/generate_sample_config.sh --check
|
|
- run: poetry run scripts-dev/config-lint.sh
|
|
|
|
check-schema-delta:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.x"
|
|
- run: "pip install 'click==8.1.1' 'GitPython>=3.1.20'"
|
|
- run: scripts-dev/check_schema_delta.py --force-colors
|
|
|
|
lint:
|
|
uses: "matrix-org/backend-meta/.github/workflows/python-poetry-ci.yml@v2"
|
|
with:
|
|
typechecking-extras: "all"
|
|
|
|
lint-crlf:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Check line endings
|
|
run: scripts-dev/check_line_terminators.sh
|
|
|
|
lint-newsfile:
|
|
if: ${{ (github.base_ref == 'develop' || contains(github.base_ref, 'release-')) && github.actor != 'dependabot[bot]' }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
fetch-depth: 0
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.x"
|
|
- run: "pip install 'towncrier>=18.6.0rc1'"
|
|
- run: scripts-dev/check-newsfragment.sh
|
|
env:
|
|
PULL_REQUEST_NUMBER: ${{ github.event.number }}
|
|
|
|
lint-pydantic:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
extras: "all"
|
|
- run: poetry run scripts-dev/check_pydantic_models.py
|
|
|
|
lint-clippy:
|
|
runs-on: ubuntu-latest
|
|
needs: changes
|
|
if: ${{ needs.changes.outputs.rust == 'true' }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
components: clippy
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- run: cargo clippy -- -D warnings
|
|
|
|
# We also lint against a nightly rustc so that we can lint the benchmark
|
|
# suite, which requires a nightly compiler.
|
|
lint-clippy-nightly:
|
|
runs-on: ubuntu-latest
|
|
needs: changes
|
|
if: ${{ needs.changes.outputs.rust == 'true' }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: nightly-2022-12-01
|
|
components: clippy
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- run: cargo clippy --all-features -- -D warnings
|
|
|
|
lint-rustfmt:
|
|
runs-on: ubuntu-latest
|
|
needs: changes
|
|
if: ${{ needs.changes.outputs.rust == 'true' }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
components: rustfmt
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- run: cargo fmt --check
|
|
|
|
# Dummy step to gate other tests on without repeating the whole list
|
|
linting-done:
|
|
if: ${{ !cancelled() }} # Run this even if prior jobs were skipped
|
|
needs:
|
|
- lint
|
|
- lint-crlf
|
|
- lint-newsfile
|
|
- lint-pydantic
|
|
- check-sampleconfig
|
|
- check-schema-delta
|
|
- lint-clippy
|
|
- lint-rustfmt
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: "true"
|
|
|
|
calculate-test-jobs:
|
|
if: ${{ !cancelled() && !failure() }} # Allow previous steps to be skipped, but not fail
|
|
needs: linting-done
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.x"
|
|
- id: get-matrix
|
|
run: .ci/scripts/calculate_jobs.py
|
|
outputs:
|
|
trial_test_matrix: ${{ steps.get-matrix.outputs.trial_test_matrix }}
|
|
sytest_test_matrix: ${{ steps.get-matrix.outputs.sytest_test_matrix }}
|
|
|
|
trial:
|
|
if: ${{ !cancelled() && !failure() }} # Allow previous steps to be skipped, but not fail
|
|
needs: calculate-test-jobs
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
job: ${{ fromJson(needs.calculate-test-jobs.outputs.trial_test_matrix) }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- run: sudo apt-get -qq install xmlsec1
|
|
- name: Set up PostgreSQL ${{ matrix.job.postgres-version }}
|
|
if: ${{ matrix.job.postgres-version }}
|
|
# 1. Mount postgres data files onto a tmpfs in-memory filesystem to reduce overhead of docker's overlayfs layer.
|
|
# 2. Expose the unix socket for postgres. This removes latency of using docker-proxy for connections.
|
|
run: |
|
|
docker run -d -p 5432:5432 \
|
|
--tmpfs /var/lib/postgres:rw,size=6144m \
|
|
--mount 'type=bind,src=/var/run/postgresql,dst=/var/run/postgresql' \
|
|
-e POSTGRES_PASSWORD=postgres \
|
|
-e POSTGRES_INITDB_ARGS="--lc-collate C --lc-ctype C --encoding UTF8" \
|
|
postgres:${{ matrix.job.postgres-version }}
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
python-version: ${{ matrix.job.python-version }}
|
|
extras: ${{ matrix.job.extras }}
|
|
- name: Await PostgreSQL
|
|
if: ${{ matrix.job.postgres-version }}
|
|
timeout-minutes: 2
|
|
run: until pg_isready -h localhost; do sleep 1; done
|
|
- run: poetry run trial --jobs=6 tests
|
|
env:
|
|
SYNAPSE_POSTGRES: ${{ matrix.job.database == 'postgres' || '' }}
|
|
SYNAPSE_POSTGRES_HOST: /var/run/postgresql
|
|
SYNAPSE_POSTGRES_USER: postgres
|
|
SYNAPSE_POSTGRES_PASSWORD: postgres
|
|
- name: Dump logs
|
|
# Logs are most useful when the command fails, always include them.
|
|
if: ${{ always() }}
|
|
# Note: Dumps to workflow logs instead of using actions/upload-artifact
|
|
# This keeps logs colocated with failing jobs
|
|
# It also ignores find's exit code; this is a best effort affair
|
|
run: >-
|
|
find _trial_temp -name '*.log'
|
|
-exec echo "::group::{}" \;
|
|
-exec cat {} \;
|
|
-exec echo "::endgroup::" \;
|
|
|| true
|
|
|
|
trial-olddeps:
|
|
# Note: sqlite only; no postgres
|
|
if: ${{ !cancelled() && !failure() }} # Allow previous steps to be skipped, but not fail
|
|
needs: linting-done
|
|
runs-on: ubuntu-20.04
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
# There aren't wheels for some of the older deps, so we need to install
|
|
# their build dependencies
|
|
- run: |
|
|
sudo apt-get -qq install build-essential libffi-dev python-dev \
|
|
libxml2-dev libxslt-dev xmlsec1 zlib1g-dev libjpeg-dev libwebp-dev
|
|
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.7'
|
|
|
|
# Calculating the old-deps actually takes a bunch of time, so we cache the
|
|
# pyproject.toml / poetry.lock. We need to cache pyproject.toml as
|
|
# otherwise the `poetry install` step will error due to the poetry.lock
|
|
# file being outdated.
|
|
#
|
|
# This caches the output of `Prepare old deps`, which should generate the
|
|
# same `pyproject.toml` and `poetry.lock` for a given `pyproject.toml` input.
|
|
- uses: actions/cache@v3
|
|
id: cache-poetry-old-deps
|
|
name: Cache poetry.lock
|
|
with:
|
|
path: |
|
|
poetry.lock
|
|
pyproject.toml
|
|
key: poetry-old-deps2-${{ hashFiles('pyproject.toml') }}
|
|
- name: Prepare old deps
|
|
if: steps.cache-poetry-old-deps.outputs.cache-hit != 'true'
|
|
run: .ci/scripts/prepare_old_deps.sh
|
|
|
|
# We only now install poetry so that `setup-python-poetry` caches the
|
|
# right poetry.lock's dependencies.
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
python-version: '3.7'
|
|
extras: "all test"
|
|
|
|
- run: poetry run trial -j6 tests
|
|
- name: Dump logs
|
|
# Logs are most useful when the command fails, always include them.
|
|
if: ${{ always() }}
|
|
# Note: Dumps to workflow logs instead of using actions/upload-artifact
|
|
# This keeps logs colocated with failing jobs
|
|
# It also ignores find's exit code; this is a best effort affair
|
|
run: >-
|
|
find _trial_temp -name '*.log'
|
|
-exec echo "::group::{}" \;
|
|
-exec cat {} \;
|
|
-exec echo "::endgroup::" \;
|
|
|| true
|
|
|
|
trial-pypy:
|
|
# Very slow; only run if the branch name includes 'pypy'
|
|
# Note: sqlite only; no postgres. Completely untested since poetry move.
|
|
if: ${{ contains(github.ref, 'pypy') && !failure() && !cancelled() }}
|
|
needs: linting-done
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
python-version: ["pypy-3.7"]
|
|
extras: ["all"]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
# Install libs necessary for PyPy to build binary wheels for dependencies
|
|
- run: sudo apt-get -qq install xmlsec1 libxml2-dev libxslt-dev
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
extras: ${{ matrix.extras }}
|
|
- run: poetry run trial --jobs=2 tests
|
|
- name: Dump logs
|
|
# Logs are most useful when the command fails, always include them.
|
|
if: ${{ always() }}
|
|
# Note: Dumps to workflow logs instead of using actions/upload-artifact
|
|
# This keeps logs colocated with failing jobs
|
|
# It also ignores find's exit code; this is a best effort affair
|
|
run: >-
|
|
find _trial_temp -name '*.log'
|
|
-exec echo "::group::{}" \;
|
|
-exec cat {} \;
|
|
-exec echo "::endgroup::" \;
|
|
|| true
|
|
|
|
sytest:
|
|
if: ${{ !failure() && !cancelled() }}
|
|
needs: calculate-test-jobs
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: matrixdotorg/sytest-synapse:${{ matrix.job.sytest-tag }}
|
|
volumes:
|
|
- ${{ github.workspace }}:/src
|
|
env:
|
|
SYTEST_BRANCH: ${{ github.head_ref }}
|
|
POSTGRES: ${{ matrix.job.postgres && 1}}
|
|
MULTI_POSTGRES: ${{ (matrix.job.postgres == 'multi-postgres') && 1}}
|
|
WORKERS: ${{ matrix.job.workers && 1 }}
|
|
BLACKLIST: ${{ matrix.job.workers && 'synapse-blacklist-with-workers' }}
|
|
TOP: ${{ github.workspace }}
|
|
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
job: ${{ fromJson(needs.calculate-test-jobs.outputs.sytest_test_matrix) }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Prepare test blacklist
|
|
run: cat sytest-blacklist .ci/worker-blacklist > synapse-blacklist-with-workers
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- name: Run SyTest
|
|
run: /bootstrap.sh synapse
|
|
working-directory: /src
|
|
- name: Summarise results.tap
|
|
if: ${{ always() }}
|
|
run: /sytest/scripts/tap_to_gha.pl /logs/results.tap
|
|
- name: Upload SyTest logs
|
|
uses: actions/upload-artifact@v3
|
|
if: ${{ always() }}
|
|
with:
|
|
name: Sytest Logs - ${{ job.status }} - (${{ join(matrix.job.*, ', ') }})
|
|
path: |
|
|
/logs/results.tap
|
|
/logs/**/*.log*
|
|
|
|
export-data:
|
|
if: ${{ !failure() && !cancelled() }} # Allow previous steps to be skipped, but not fail
|
|
needs: [linting-done, portdb]
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
TOP: ${{ github.workspace }}
|
|
|
|
services:
|
|
postgres:
|
|
image: postgres
|
|
ports:
|
|
- 5432:5432
|
|
env:
|
|
POSTGRES_PASSWORD: "postgres"
|
|
POSTGRES_INITDB_ARGS: "--lc-collate C --lc-ctype C --encoding UTF8"
|
|
options: >-
|
|
--health-cmd pg_isready
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- run: sudo apt-get -qq install xmlsec1 postgresql-client
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
extras: "postgres"
|
|
- run: .ci/scripts/test_export_data_command.sh
|
|
env:
|
|
PGHOST: localhost
|
|
PGUSER: postgres
|
|
PGPASSWORD: postgres
|
|
PGDATABASE: postgres
|
|
|
|
|
|
portdb:
|
|
if: ${{ !failure() && !cancelled() }} # Allow previous steps to be skipped, but not fail
|
|
needs: linting-done
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
include:
|
|
- python-version: "3.7"
|
|
postgres-version: "11"
|
|
|
|
- python-version: "3.11"
|
|
postgres-version: "15"
|
|
|
|
services:
|
|
postgres:
|
|
image: postgres:${{ matrix.postgres-version }}
|
|
ports:
|
|
- 5432:5432
|
|
env:
|
|
POSTGRES_PASSWORD: "postgres"
|
|
POSTGRES_INITDB_ARGS: "--lc-collate C --lc-ctype C --encoding UTF8"
|
|
options: >-
|
|
--health-cmd pg_isready
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Add PostgreSQL apt repository
|
|
# We need a version of pg_dump that can handle the version of
|
|
# PostgreSQL being tested against. The Ubuntu package repository lags
|
|
# behind new releases, so we have to use the PostreSQL apt repository.
|
|
# Steps taken from https://www.postgresql.org/download/linux/ubuntu/
|
|
run: |
|
|
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
|
|
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
|
|
sudo apt-get update
|
|
- run: sudo apt-get -qq install xmlsec1 postgresql-client
|
|
- uses: matrix-org/setup-python-poetry@v1
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
extras: "postgres"
|
|
- run: .ci/scripts/test_synapse_port_db.sh
|
|
id: run_tester_script
|
|
env:
|
|
PGHOST: localhost
|
|
PGUSER: postgres
|
|
PGPASSWORD: postgres
|
|
PGDATABASE: postgres
|
|
- name: "Upload schema differences"
|
|
uses: actions/upload-artifact@v3
|
|
if: ${{ failure() && !cancelled() && steps.run_tester_script.outcome == 'failure' }}
|
|
with:
|
|
name: Schema dumps
|
|
path: |
|
|
unported.sql
|
|
ported.sql
|
|
schema_diff
|
|
|
|
complement:
|
|
if: "${{ !failure() && !cancelled() }}"
|
|
needs: linting-done
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- arrangement: monolith
|
|
database: SQLite
|
|
|
|
- arrangement: monolith
|
|
database: Postgres
|
|
|
|
- arrangement: workers
|
|
database: Postgres
|
|
|
|
steps:
|
|
- name: Run actions/checkout@v3 for synapse
|
|
uses: actions/checkout@v3
|
|
with:
|
|
path: synapse
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- name: Prepare Complement's Prerequisites
|
|
run: synapse/.ci/scripts/setup_complement_prerequisites.sh
|
|
|
|
- run: |
|
|
set -o pipefail
|
|
POSTGRES=${{ (matrix.database == 'Postgres') && 1 || '' }} WORKERS=${{ (matrix.arrangement == 'workers') && 1 || '' }} COMPLEMENT_DIR=`pwd`/complement synapse/scripts-dev/complement.sh -json 2>&1 | synapse/.ci/scripts/gotestfmt
|
|
shell: bash
|
|
name: Run Complement Tests
|
|
|
|
cargo-test:
|
|
if: ${{ needs.changes.outputs.rust == 'true' }}
|
|
runs-on: ubuntu-latest
|
|
needs:
|
|
- linting-done
|
|
- changes
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Rust
|
|
# There don't seem to be versioned releases of this action per se: for each rust
|
|
# version there is a branch which gets constantly rebased on top of master.
|
|
# We pin to a specific commit for paranoia's sake.
|
|
uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
|
|
with:
|
|
toolchain: 1.58.1
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- run: cargo test
|
|
|
|
# a job which marks all the other jobs as complete, thus allowing PRs to be merged.
|
|
tests-done:
|
|
if: ${{ always() }}
|
|
needs:
|
|
- trial
|
|
- trial-olddeps
|
|
- sytest
|
|
- export-data
|
|
- portdb
|
|
- complement
|
|
- cargo-test
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: matrix-org/done-action@v2
|
|
with:
|
|
needs: ${{ toJSON(needs) }}
|
|
|
|
# The newsfile lint may be skipped on non PR builds
|
|
# Cargo test is skipped if there is no changes on Rust code
|
|
skippable: |
|
|
lint-newsfile
|
|
cargo-test
|