Owned option #14
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: CI | |
| on: | |
| push: | |
| branches: ["main"] | |
| paths-ignore: ["*.md", "*.png", "*.svg", "LICENSE-*"] | |
| pull_request: | |
| branches: ["main"] | |
| paths-ignore: ["*.md", "*.png", "*.svg", "LICENSE-*"] | |
| merge_group: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| RUST_BACKTRACE: 1 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref_name }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| check: | |
| name: Build & test | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-14, windows-latest] | |
| # Don't increase beyond what Firefox is currently using: | |
| # https://searchfox.org/mozilla-central/search?q=MINIMUM_RUST_VERSION&path=python/mozboot/mozboot/util.py | |
| # Keep in sync with Cargo.toml | |
| rust-toolchain: [1.76.0, stable, nightly] | |
| type: [debug] | |
| include: | |
| - os: ubuntu-latest | |
| rust-toolchain: stable | |
| type: release | |
| env: | |
| BUILD_TYPE: ${{ matrix.type == 'release' && '--release' || '' }} | |
| runs-on: ${{ matrix.os }} | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Install Rust | |
| uses: ./.github/actions/rust | |
| with: | |
| version: ${{ matrix.rust-toolchain }} | |
| components: rustfmt, clippy, llvm-tools-preview | |
| tools: cargo-llvm-cov, cargo-nextest, cargo-hack, cargo-fuzz, cargo-machete | |
| - name: Get minimum NSS version | |
| id: nss-version | |
| run: echo "minimum=$(cat neqo-crypto/min_version.txt)" >> "$GITHUB_OUTPUT" | |
| - name: Install NSS | |
| uses: ./.github/actions/nss | |
| with: | |
| minimum-version: ${{ steps.nss-version.outputs.minimum }} | |
| - name: Build | |
| run: | | |
| # shellcheck disable=SC2086 | |
| cargo +${{ matrix.rust-toolchain }} build $BUILD_TYPE --all-targets --features ci | |
| - name: Run tests and determine coverage | |
| run: | | |
| # shellcheck disable=SC2086 | |
| RUST_LOG=trace cargo +${{ matrix.rust-toolchain }} llvm-cov nextest $BUILD_TYPE --features ci --no-fail-fast --lcov --output-path lcov.info | |
| cargo +${{ matrix.rust-toolchain }} bench --features bench --no-run | |
| - name: Run client/server transfer | |
| run: | | |
| # shellcheck disable=SC2086 | |
| cargo +${{ matrix.rust-toolchain }} build $BUILD_TYPE --bin neqo-client --bin neqo-server | |
| "target/$BUILD_DIR/neqo-server" "$HOST:4433" & | |
| PID=$! | |
| # Give the server time to start. | |
| sleep 1 | |
| "target/$BUILD_DIR/neqo-client" --output-dir . "https://$HOST:4433/$SIZE" | |
| kill $PID | |
| [ "$(wc -c <"$SIZE")" -eq "$SIZE" ] || exit 1 | |
| env: | |
| HOST: localhost | |
| SIZE: 54321 | |
| RUST_LOG: warn | |
| BUILD_DIR: ${{ matrix.type == 'release' && 'release' || 'debug' }} | |
| - name: Check formatting | |
| run: | | |
| if [ "${{ matrix.rust-toolchain }}" != "nightly" ]; then | |
| CONFIG_PATH="--config-path=$(mktemp)" | |
| fi | |
| # shellcheck disable=SC2086 | |
| cargo +${{ matrix.rust-toolchain }} fmt --all -- --check $CONFIG_PATH | |
| if: success() || failure() | |
| - name: Check for unused dependencies | |
| run: | | |
| # --with-metadata has false positives, see https://github.com/bnjbvr/cargo-machete/issues/127 | |
| cargo +${{ matrix.rust-toolchain }} machete | |
| - name: Clippy | |
| run: | | |
| # Use cargo-hack to run clippy on each crate individually with its | |
| # respective default features only. Can reveal warnings otherwise | |
| # hidden given that a plain cargo clippy combines all features of the | |
| # workspace. See e.g. https://github.com/mozilla/neqo/pull/1695. | |
| cargo +${{ matrix.rust-toolchain }} hack clippy --all-targets --feature-powerset --exclude-features gecko -- -D warnings || ${{ matrix.rust-toolchain == 'nightly' }} | |
| # Check that the fuzz targets also build | |
| if [ ${{ matrix.rust-toolchain }} == 'nightly' ]; then | |
| cargo +${{ matrix.rust-toolchain }} fuzz check | |
| fi | |
| if: success() || failure() | |
| - name: Check rustdoc links | |
| run: cargo +${{ matrix.rust-toolchain }} doc --workspace --no-deps --document-private-items | |
| env: | |
| RUSTDOCFLAGS: "--deny rustdoc::broken_intra_doc_links --deny warnings" | |
| if: success() || failure() | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0 | |
| with: | |
| file: lcov.info | |
| fail_ci_if_error: false | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verbose: true | |
| if: matrix.type == 'debug' && matrix.rust-toolchain == 'stable' | |
| bench: | |
| name: "Benchmark" | |
| needs: [check] | |
| uses: ./.github/workflows/bench.yml |