Skip readable #3
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: | |
| paths-ignore: ["*.md", "*.png", "*.svg", "LICENSE-*"] | |
| pull_request: | |
| branches: ["main"] | |
| paths-ignore: ["*.md", "*.png", "*.svg", "LICENSE-*"] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| RUST_BACKTRACE: 1 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref_name }} | |
| cancel-in-progress: true | |
| jobs: | |
| check: | |
| name: Build & test | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [windows-latest] | |
| # Don't increase beyond what Firefox is currently using: | |
| # https://firefox-source-docs.mozilla.org/writing-rust-code/update-policy.html#schedule | |
| rust-toolchain: [stable] | |
| type: [debug] | |
| env: | |
| BUILD_TYPE: ${{ matrix.type == 'release' && '--release' || '' }} | |
| runs-on: ${{ matrix.os }} | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: ./.github/actions/rust | |
| with: | |
| version: ${{ matrix.rust-toolchain }} | |
| components: rustfmt, clippy, llvm-tools-preview | |
| - name: Install dependencies (Linux) | |
| if: runner.os == 'Linux' | |
| env: | |
| DEBIAN_FRONTEND: noninteractive | |
| run: | | |
| sudo apt-get install -y --no-install-recommends gyp mercurial ninja-build lld | |
| curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash | |
| echo "RUSTFLAGS=-C link-arg=-fuse-ld=lld" >> "$GITHUB_ENV" | |
| # In addition to installing dependencies, first make sure System Integrity Protection (SIP) | |
| # is disabled on this MacOS runner. This is needed to allow the NSS libraries to be loaded | |
| # from the build directory and avoid various other test failures. This seems to always be | |
| # the case on any macos-13 runner, but not consistently on macos-latest (which is currently | |
| # macos-12, FWIW). | |
| - name: Install dependencies (MacOS) | |
| if: runner.os == 'MacOS' | |
| run: | | |
| csrutil status | grep disabled | |
| brew install ninja mercurial cargo-binstall llvm | |
| echo "/opt/homebrew/opt/llvm/bin" >> "$GITHUB_PATH" | |
| ln -s /opt/homebrew/bin/python3 /opt/homebrew/bin/python | |
| # python3 -m pip install gyp-next | |
| # Above does not work, since pypi only has gyp 0.15.0, which is too old | |
| # for the homebrew python3. Install from source instead. | |
| python3 -m pip install git+https://github.com/nodejs/gyp-next | |
| python3 -m pip install packaging | |
| echo "$(python3 -m site --user-base)/bin" >> "$GITHUB_PATH" | |
| echo "RUSTFLAGS=-C link-arg=-fuse-ld=lld" >> "$GITHUB_ENV" | |
| - name: Install dependencies (Windows) | |
| if: runner.os == 'Windows' | |
| shell: pwsh | |
| run: Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.ps1").Content | |
| - name: Use MSYS2 environment and install more dependencies (Windows) | |
| if: runner.os == 'Windows' | |
| run: | | |
| echo "C:\\msys64\\usr\\bin" >> "$GITHUB_PATH" | |
| echo "C:\\msys64\\mingw64\\bin" >> "$GITHUB_PATH" | |
| /c/msys64/usr/bin/pacman -S --noconfirm nsinstall lld | |
| python3 -m pip install git+https://github.com/nodejs/gyp-next | |
| echo "$(python3 -m site --user-base)/bin" >> "$GITHUB_PATH" | |
| echo "RUSTFLAGS=-C link-arg=-fuse-ld=lld.exe" >> "$GITHUB_ENV" | |
| - name: Set up MSVC build environment (Windows) | |
| if: runner.os == 'Windows' | |
| uses: ilammy/msvc-dev-cmd@v1 | |
| - name: Install Rust tools | |
| run: cargo +${{ matrix.rust-toolchain }} binstall --no-confirm cargo-llvm-cov cargo-nextest | |
| # This step might be removed if the distro included a recent enough | |
| # version of NSS. Ubuntu 20.04 only has 3.49, which is far too old. | |
| # (neqo-crypto/build.rs would also need to query pkg-config to get the | |
| # right build flags rather than building NSS.) | |
| # Clone from the main hg repo, because the GitHub mirror can be out of date. | |
| - name: Fetch NSS and NSPR | |
| uses: ./.github/actions/nss | |
| - name: Set up NSS/NSPR build environment (Windows) | |
| if: runner.os == 'Windows' | |
| run: | | |
| echo "GYP_MSVS_OVERRIDE_PATH=$VSINSTALLDIR" >> "$GITHUB_ENV" | |
| echo "GYP_MSVS_VERSION=2022" >> "$GITHUB_ENV" | |
| echo "BASH=$SHELL" >> "$GITHUB_ENV" | |
| # See https://github.com/ilammy/msvc-dev-cmd#name-conflicts-with-shell-bash | |
| rm /usr/bin/link.exe | |
| - name: Build | |
| run: | | |
| cargo +${{ matrix.rust-toolchain }} build $BUILD_TYPE --all-targets --features ci,bench | |
| echo "LD_LIBRARY_PATH=${{ github.workspace }}/dist/$LIB_DIR/lib" >> "$GITHUB_ENV" | |
| echo "DYLD_FALLBACK_LIBRARY_PATH=${{ github.workspace }}/dist/$LIB_DIR/lib" >> "$GITHUB_ENV" | |
| echo "${{ github.workspace }}/dist/$LIB_DIR/lib" >> "$GITHUB_PATH" | |
| env: | |
| LIB_DIR: ${{ matrix.type == 'release' && 'Release' || 'Debug' }} | |
| - name: Run tests and determine coverage | |
| run: | | |
| cargo +${{ matrix.rust-toolchain }} test -p neqo-common --all-targets --all-features datagram_tos -- --nocapture | |
| cargo +${{ matrix.rust-toolchain }} bench --features bench --no-run | |
| - name: Run client/server transfer | |
| run: | | |
| cargo +${{ matrix.rust-toolchain }} build $BUILD_TYPE --bin neqo-client --bin neqo-server | |
| cargo +${{ matrix.rust-toolchain }} run $BUILD_TYPE --bin neqo-server -- $HOST:4433 & | |
| PID=$! | |
| cargo +${{ matrix.rust-toolchain }} run $BUILD_TYPE --bin 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 | |
| - name: Check formatting | |
| run: | | |
| if [ "${{ matrix.rust-toolchain }}" != "nightly" ]; then | |
| export CONFIG_PATH="--config-path=$(mktemp)" | |
| fi | |
| cargo +${{ matrix.rust-toolchain }} fmt --all -- --check $CONFIG_PATH | |
| if: success() || failure() | |
| - name: Clippy | |
| run: cargo +${{ matrix.rust-toolchain }} clippy --all-targets -- -D warnings || ${{ matrix.rust-toolchain == 'nightly' }} | |
| 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@v4 | |
| with: | |
| file: lcov.info | |
| fail_ci_if_error: false | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| if: matrix.type == 'debug' && matrix.rust-toolchain == 'stable' | |
| bench: | |
| name: "Benchmark" | |
| needs: [check] | |
| uses: ./.github/workflows/bench.yml |