Repository: hatoo/oha Branch: master Commit: 339ec3255827 Files: 38 Total size: 365.1 KB Directory structure: gitextract_llqd8vur/ ├── .dockerignore ├── .github/ │ ├── FUNDING.yml │ ├── dependabot.yml │ └── workflows/ │ ├── CI.yml │ ├── release-pgo.yml │ └── release.yml ├── .gitignore ├── CHANGELOG.md ├── Cargo.toml ├── Cross.toml ├── Dockerfile ├── LICENSE ├── README.md ├── pgo/ │ └── server/ │ ├── Cargo.toml │ └── src/ │ └── main.rs ├── pgo.js ├── schema.json ├── src/ │ ├── aws_auth.rs │ ├── cli.rs │ ├── client.rs │ ├── client_h3.rs │ ├── curl_compat.rs │ ├── db.rs │ ├── histogram.rs │ ├── lib.rs │ ├── main.rs │ ├── monitor.rs │ ├── pcg64si.rs │ ├── printer.rs │ ├── request_generator.rs │ ├── result_data.rs │ ├── timescale.rs │ ├── tls_config.rs │ └── url_generator.rs └── tests/ ├── common/ │ ├── mod.rs │ ├── server.cert │ └── server.key └── tests.rs ================================================ FILE CONTENTS ================================================ ================================================ FILE: .dockerignore ================================================ * !pgo !src !Cargo.* ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms github: hatoo # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: hatoo # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] ================================================ FILE: .github/dependabot.yml ================================================ # To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference version: 2 updates: - package-ecosystem: "cargo" # See documentation for possible values directories: # Locations of package manifests - "/" - "pgo/server" schedule: interval: "weekly" - package-ecosystem: "docker" directory: "/" schedule: interval: "weekly" - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" ================================================ FILE: .github/workflows/CI.yml ================================================ on: push: branches: - master pull_request: name: CI jobs: test: name: Test Suite runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, windows-latest, macos-latest, macos-14] additional_args: ["", "--no-default-features --features native-tls", "--features http3"] # vsock feature is only on linux include: - os: ["ubuntu-latest"] additional_args: "--features vsock" steps: # We need nasm to build aws-lc on windows - uses: ilammy/setup-nasm@v1 - uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@stable - uses: Swatinem/rust-cache@v2 - run: cargo test ${{ matrix.additional_args }} fmt: name: Rustfmt runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@stable with: components: rustfmt - name: Enforce formatting run: cargo fmt --all --check clippy: name: Clippy runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@stable with: components: clippy - uses: Swatinem/rust-cache@v2 - name: Linting run: cargo clippy --all-targets --all-features -- -D warnings ================================================ FILE: .github/workflows/release-pgo.yml ================================================ name: Publish PGO on: push: branches: - master tags: - "v*.*.*" pull_request: jobs: publish: name: Publish for ${{ matrix.target }} PGO runs-on: ${{ matrix.os }} strategy: matrix: include: - os: ubuntu-latest artifact_name: oha release_name: oha-linux-amd64-pgo target: x86_64-unknown-linux-musl additional_args: "--features vsock" # tikv-jemalloc-sys@0.6.0+5.3.0-1: background_threads_runtime_support not supported for aarch64-unknown-linux-musl # - os: ubuntu-24.04-arm # artifact_name: oha # release_name: oha-linux-arm64-pgo # target: aarch64-unknown-linux-musl # additional_args: "--features vsock" - os: windows-latest artifact_name: oha.exe release_name: oha-windows-amd64-pgo.exe target: x86_64-pc-windows-msvc additional_args: "" # - os: macos-14-large # artifact_name: oha # release_name: oha-macos-amd64-pgo # target: x86_64-apple-darwin # additional_args: "" # - os: macos-14 # artifact_name: oha # release_name: oha-macos-arm64-pgo # target: aarch64-apple-darwin # additional_args: "" steps: - uses: ilammy/setup-nasm@v1 - uses: actions/checkout@v6 - name: Install musl-tools on Linux run: sudo apt-get update --yes && sudo apt-get install --yes musl-tools if: contains(matrix.target, 'musl') - uses: dtolnay/rust-toolchain@stable with: targets: ${{ matrix.target }} components: llvm-tools-preview - uses: Swatinem/rust-cache@v2 - run: cargo install cargo-pgo --version 0.2.9 - uses: oven-sh/setup-bun@v2 - run: bun run pgo.js --target ${{ matrix.target }} ${{ matrix.additional_args }} - uses: actions/upload-artifact@v7 with: name: ${{ matrix.release_name }} path: target/${{ matrix.target }}/pgo/${{ matrix.artifact_name }} - name: Upload binaries to release uses: svenstaro/upload-release-action@v2 if: startsWith(github.ref, 'refs/tags/v') with: repo_token: ${{ secrets.GITHUB_TOKEN }} file: target/${{ matrix.target }}/pgo/${{ matrix.artifact_name }} asset_name: ${{ matrix.release_name }} ================================================ FILE: .github/workflows/release.yml ================================================ name: Publish on: push: branches: - master tags: - "v*.*.*" pull_request: jobs: publish: name: Publish for ${{ matrix.target }} runs-on: ${{ matrix.os }} strategy: matrix: include: - os: ubuntu-latest artifact_name: oha release_name: oha-linux-amd64 target: x86_64-unknown-linux-musl additional_args: "--features vsock" use_cross: false - os: windows-latest artifact_name: oha.exe release_name: oha-windows-amd64.exe target: x86_64-pc-windows-msvc additional_args: "" use_cross: false - os: macos-latest artifact_name: oha release_name: oha-macos-amd64 target: x86_64-apple-darwin additional_args: "" use_cross: false - os: ubuntu-latest artifact_name: oha release_name: oha-linux-arm64 target: aarch64-unknown-linux-musl additional_args: "--features vsock" use_cross: true - os: macos-14 artifact_name: oha release_name: oha-macos-arm64 target: aarch64-apple-darwin additional_args: "" use_cross: false env: BUILD_CMD: cargo steps: - uses: ilammy/setup-nasm@v1 - uses: actions/checkout@v6 - name: Install musl-tools on Linux run: sudo apt-get update --yes && sudo apt-get install --yes musl-tools if: contains(matrix.target, 'musl') - name: Install Rust toolchain uses: dtolnay/rust-toolchain@stable with: targets: ${{ matrix.target }} - name: Install cross if: matrix.use_cross uses: taiki-e/install-action@v2 with: tool: cross - uses: Swatinem/rust-cache@v2 - name: Overwrite build command env variable if: matrix.use_cross shell: bash run: echo "BUILD_CMD=cross" >> $GITHUB_ENV - name: Build shell: bash run: $BUILD_CMD build --profile release-ci --target ${{ matrix.target }} --locked --no-default-features --features rustls ${{ matrix.additional_args }} - name: Upload uses: actions/upload-artifact@v7 with: name: ${{ matrix.release_name }} path: target/${{ matrix.target }}/release-ci/${{ matrix.artifact_name }} - name: Upload binaries to release if: startsWith(github.ref, 'refs/tags/v') uses: svenstaro/upload-release-action@v2 with: repo_token: ${{ secrets.GITHUB_TOKEN }} file: target/${{ matrix.target }}/release-ci/${{ matrix.artifact_name }} asset_name: ${{ matrix.release_name }} tag: ${{ github.ref }} docker: name: Build and Push Docker Image runs-on: ubuntu-latest needs: publish if: startsWith(github.ref, 'refs/tags/v') permissions: contents: read packages: write steps: - uses: actions/checkout@v6 - name: Set up QEMU uses: docker/setup-qemu-action@v3 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - name: Login to GitHub Container Registry if: startsWith(github.ref, 'refs/tags/v') uses: docker/login-action@v3 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - name: Extract metadata (tags, labels) id: meta uses: docker/metadata-action@v5 with: images: ghcr.io/${{ github.repository }} tags: | type=semver,pattern={{version}} type=semver,pattern={{major}}.{{minor}} type=semver,pattern={{major}} type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/v') }} - name: Build and push uses: docker/build-push-action@v6 with: context: . platforms: linux/amd64,linux/arm64 push: ${{ startsWith(github.ref, 'refs/tags/v') }} tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} cache-from: type=gha cache-to: type=gha,mode=max ================================================ FILE: .gitignore ================================================ **/target /.idea /.vscode ================================================ FILE: CHANGELOG.md ================================================ # Unreleased # 1.14.0 - fix Possible bug with latency_correction #857 # 1.13.0 (2025-02-07) - Add first byte stats to JSON output#844 - On http3, bind ipv6 for ipv6#839 - Prefer ipv6 for localhost on macos#837 # 1.12.1 (2025-11-29) - feat: add official docker img with better caching #830 # 1.12.0 (2025-11-29) - Fix dns and connection time stats #816 - Add colors to --help/-h #822 - rename --disable-color to --no-color #824 - fixed --urls-from-file reuses host with path from different url #825 # 1.11.0 (2025-11-01) - feat:support decimal when using n_requests,such as 2.6k or 0.001m #808 - connect-to now doing tcp connect instead of dns caching #807 - feat: make connect timeout configurable #805 - feat: support k/m suffixes for n-requests #800 - feat: Add option to read request body line-by-line from file. #729 #789 # 1.10.0 (2025-09-06) - fix dns lookup on http2/http3 #771 - feat: add curl-compatible multipart form data support (-F option) #755 # 1.9.0 (2025-06-21) - Implement experimental HTTP3 support #746 - Allow appending to database if oha table has already been created #742 - Add -u/--time-unit option #741 - Add RequestResult.first_byte field for measuring first body byte latency #727 - Add support for results in csv format #725 - Add support for fractional QPS values #724 # 1.8.0 (2025-02-15) - Support mtls #687 - Support Proxy headers #688 - Randomize --connect-to if multiple matching options #695 # 1.7.0 (2025-02-01) - Impl support for calling AWS APIs with sigv4 #666 - support -o #669 # 1.6.0 (2025-01-11) - Feature: Reading Urls from file #639 - Add some optimized workers to `--no-tui` mode #646 # 1.5.0 (2024-12-07) - Add `--debug` option to check actual request/response - Switch colors to justified latency thresholds (fixes #609) #610 - Fix Running with -q hangs #603 - Support HTTP proxy #614 # 1.4.7 (2024-10-26) - [rustls] Cache HTTPS certs # 1.4.6 (2024-08-17) - Add `--wait-ongoing-requests-after-deadline` option - Add `--db-url` option to save results to SQLite database - Add `--dump-urls` option to debug random URL generation # 1.4.5 (2024-05-29) - Some performance improvements # 1.4.4 (2024-04-20) - support Termux #464 # 1.4.3 (2024-04-06) - fix rustls error #452 # 1.4.2 (2024-04-06) - Fix printing of Size/request #447 # 1.4.1 (2024-03-16) - Enable: Profile-Guided Optimization (PGO) #268 # 1.4.0 (2024-03-09) - No DNS lookup when unix socket or vsock #418 - Add HTTP over VSOCK support #416 # 1.3.0 (2024-02-04) - Optimize timeout #403 - Compact error #402 - fix tui layout #401 # 1.2.0 (2024-02-03) - Print help message when no argument is given #378 - Lookup DNS at beginning and cache it #391 - Report deadlined requests #392 - Fix MacOS Crash issues #384 # 1.1.0 (2024-01-16) - [HTTP2] Reconnect TCP connection when it fails #369 # 1.0.0 (2023-11-16) - Update hyper dependency to 1.0.0 # 1.0.0-rc.4.a8dcd7ca5df49c0701893c4d9d81ec8c1342f141 (2023-10-14) This is a RC release for 1.0.0. Please test it and report any issues. The version is named as same as `hyper`'s version and it's commit hash. Since this version depends on unreleased `hyper`'s version, we can't release on crates.io. Only on binary releases. - Support HTTP/2 #224 #201 - Make `rustls` as a default TLS backend #331 - Added `-p` option to set number of HTTP/2 parallel requests # 0.6.5 (2023-10-09) - Fix Apple Silicon's binary release #323 # 0.6.4 (2023-09-24) - Fix -H option to overwrite default value #309 - feat: display 99.90- and 99.99-percentile latency #315 # 0.6.3 (2023-09-05) - Add style and colors to the summary view #64 - Added a stats-success-breakdown flag for more detailed status code specific response statistics #212 # 0.6.2 (2023-08-12) - Support Burst feature #276 # 0.6.1 (2023-07-12) - Fix sending HTTP uri #255 - Add default user agent header #257 # 0.6.0 (2023-06-24) - Support IDNA #236 - Support randomly generated URL using rand_regex crate # 0.5.9 (2023-06-12) - Fix -H Header parser - Update printer #229 - Use percentage for Success rate summary value #228 - Latency distribution -> Response time distribution # 0.5.8 (2023-03-25) - Add `--unix-socket` on `unix` profiles for HTTP. #220 - Fix tui to not requiring True Color. #209 # 0.5.7 (2023-02-25) - Fix `--latency-correction` adds the time of DNS. #211 - Fix `-z` behaviour to cancel workers at the dead line. #211 - Fix align of histogram #210 # 0.5.6 (2023-02-02) - Update `clap` to version 4 - Release `musl` binaries #206 - Support [Ipv6] format requested_host in --connect-to #197 # 0.5.5 (2022-09-19) - Add colors to the tui view #64 # 0.5.4 (2022-08-27) - Support Ipv6 host #181 - Print min, max, average and pXX for Requests per second in JSON output like bombardier #177 - Add JSON Output #169 - Fix QPS control to send with correct rate for first 1 sec - Make histogram compatible to hey - closes #161 # 0.5.3 (2022-07-16) - Add support for bracketed IPv6 syntax in connect-to # 0.5.2 (2022-04-28) - Add `rustls` feature flag to build against `rustls` instead of `native-tls`. # 0.5.1 (2022-03-29) - Fix histogram to show correct response time - closes #157 # 0.5.0 (2022-01-01) - Use clap 3.0.0 instead of structopt - closes #131 # 0.4.6 (2021-07-05) - Add `--latency-correction` to avoid Coordinated Omission Problem. # 0.4.5 (2021-05-04) - Set '--no-tui' automatically when stdout isn't TTY # 0.4.4 (2020-11-18) - Bump `resolv-conf` to support `options edns0 trust-ad` on `/etc/resolv.conf` # 0.4.3 (2020-11-12) - Add --connect-to option to override DNS for a given host+port, similar to curl # 0.4.2 (2020-10-06) - Speed up on WSL Ubuntu 20.4 # 0.4.1 (2020-07-28) - Support -q 0 option for unlimited qps - Fix performance on limiting query/second ================================================ FILE: Cargo.toml ================================================ [package] authors = ["hatoo "] categories = [ "command-line-utilities", "network-programming", "web-programming::http-client", "development-tools::profiling", ] description = "Ohayou(おはよう), HTTP load generator, inspired by rakyll/hey with tui animation." edition = "2024" keywords = ["cli", "load-testing", "performance", "http"] license = "MIT" name = "oha" readme = "README.md" repository = "https://github.com/hatoo/oha" version = "1.14.0" rust-version = "1.87" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [features] default = ["rustls"] native-tls = ["dep:native-tls", "dep:tokio-native-tls"] rustls = [ "dep:rustls", "dep:tokio-rustls", "dep:rustls-native-certs", "dep:rustls-pki-types", ] vsock = ["dep:tokio-vsock"] http3 = ["dep:h3", "dep:h3-quinn", "dep:quinn-proto", "dep:quinn", "dep:http"] [dependencies] anyhow = "1.0.86" average = "0.16.0" byte-unit = "5.1.4" clap = { version = "4.5.9", features = ["derive", "env"] } clap_complete = "4" float-ord = "0.3.2" kanal = "0.1.1" humantime = "2.1.0" libc = "0.2.155" serde = { version = "1.0.204", features = ["derive"] } serde_json = "1.0" thiserror = "2.0.12" tokio = { version = "1.38.1", features = ["full"] } ratatui = { version = "0.30.0", default-features = false, features = [ "crossterm", ] } aws-sign-v4 = "0.3" chrono = "0.4" bytes = "1" hyper = { version = "1.4", features = ["client", "http1", "http2"] } # native-tls native-tls = { version = "0.2.12", features = ["alpn"], optional = true } tokio-native-tls = { version = "0.3.1", optional = true } rustls = { version = "0.23.18", optional = true } rustls-native-certs = { version = "0.8.0", optional = true } tokio-rustls = { version = "0.26.0", optional = true } rustls-pki-types = { version = "1.7.0", optional = true } h3 = { version = "0.0.8", optional = true } h3-quinn = { version = "0.0.10", optional = true } quinn-proto = { version = "0.11.10", optional = true, features = ["aws-lc-rs"] } http = { version = "1.4.0", optional = true } quinn = { version = "0.11.7", optional = true, features = [ "aws-lc-rs", "runtime-tokio", ] } base64 = "0.22.1" rand = "0.10.0" hickory-resolver = { version = "0.25.2", features = ["tokio"] } rand_regex = "0.19.0" regex-syntax = "0.8.5" url = "2.5.2" http-body-util = "0.1.2" hyper-util = { version = "0.1.6", features = ["tokio"] } tokio-vsock = { version = "0.7.2", optional = true } rusqlite = { version = "0.38.0", features = ["bundled"] } num_cpus = "1.16.0" tokio-util = "0.7.13" clap-cargo = "0.18.3" [target.'cfg(not(target_env = "msvc"))'.dependencies] tikv-jemallocator = "0.6" [target.'cfg(unix)'.dependencies] rlimit = "0.11.0" [dev-dependencies] axum = { version = "0.8.1", features = ["http2"] } axum-server = { version = "0.8.0", features = ["tls-rustls"] } bytes = "1.6" float-cmp = "0.10.0" http-mitm-proxy = { version = "0.18.0", default-features = false } jsonschema = "0.42.2" lazy_static = "1.5.0" predicates = "3.1.0" # features = ["aws_lc_rs"] is a workaround for mac & native-tls # https://github.com/sfackler/rust-native-tls/issues/225 rcgen = { version = "0.14.3", features = ["aws_lc_rs"] } regex = "1.10.5" tempfile = "3.10.1" rustls = "0.23.18" rstest = "0.26.0" rstest_reuse = "0.7.0" ctor = "0.6.1" [target.'cfg(unix)'.dev-dependencies] actix-web = "4" [profile.pgo] inherits = "release" # https://github.com/TechEmpower/FrameworkBenchmarks/blob/master/frameworks/Rust/faf/Cargo.toml + lto=true opt-level = 3 panic = 'abort' codegen-units = 1 lto = true debug = false incremental = false overflow-checks = false [profile.release-ci] inherits = "pgo" ================================================ FILE: Cross.toml ================================================ # For Asahi linux [target.aarch64-unknown-linux-gnu.env] passthrough = ["JEMALLOC_SYS_WITH_LG_PAGE=16"] [target.aarch64-unknown-linux-musl.env] passthrough = ["JEMALLOC_SYS_WITH_LG_PAGE=16"] ================================================ FILE: Dockerfile ================================================ ARG RUST_VERSION=slim FROM docker.io/library/rust:${RUST_VERSION} AS chef RUN cargo install cargo-chef --locked RUN apt-get update && apt-get install -y \ cmake \ && apt-get clean \ && rm -rf /var/lib/apt/lists/* WORKDIR /app FROM chef AS planner COPY . . RUN cargo chef prepare --recipe-path recipe.json FROM chef AS builder COPY --from=planner /app/recipe.json recipe.json RUN cargo chef cook --release --no-default-features --features rustls --recipe-path recipe.json COPY . . RUN cargo build --release --no-default-features --features rustls --bin oha RUN strip /app/target/release/oha FROM registry.fedoraproject.org/fedora-minimal AS runtime USER 65535 COPY --chown=65535:65535 --from=builder /app/target/release/oha /bin/ ENTRYPOINT ["/bin/oha"] ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2020 hatoo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================ # oha (おはよう) [![GitHub Actions](https://github.com/hatoo/oha/workflows/CI/badge.svg)](https://github.com/hatoo/oha/actions?query=workflow%3ACI) [![Crates.io](https://img.shields.io/crates/v/oha.svg)](https://crates.io/crates/oha) [![Arch Linux](https://img.shields.io/archlinux/v/extra/x86_64/oha)](https://archlinux.org/packages/extra/x86_64/oha/) [![Homebrew](https://img.shields.io/homebrew/v/oha)](https://formulae.brew.sh/formula/oha) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/hatoo) oha is a tiny program that sends some load to a web application and show realtime tui inspired by [rakyll/hey](https://github.com/rakyll/hey). This program is written in Rust and powered by [tokio](https://github.com/tokio-rs/tokio) and beautiful tui by [ratatui](https://github.com/ratatui-org/ratatui). ![demo](demo.gif) # Installation This program is built on stable Rust, with both `make` and `cmake` prerequisites to install via cargo. cargo install oha You can optionally build oha against [native-tls](https://github.com/sfackler/rust-native-tls) instead of [rustls](https://github.com/rustls/rustls). cargo install --no-default-features --features native-tls oha You can enable VSOCK support by enabling `vsock` feature. cargo install --features vsock oha You can enable experimental HTTP3 support by enabling the `http3` feature. This uses the [H3](https://github.com/hyperium/h3) library by the developers of Hyper. It will remain experimental as long as H3 is experimental. It currently depends on using `rustls` for TLS. ## Download pre-built binary You can download pre-built binary from [Release page](https://github.com/hatoo/oha/releases) for each version and from [Publish workflow](https://github.com/hatoo/oha/actions/workflows/release.yml) and [Publish PGO workflow](https://github.com/hatoo/oha/actions/workflows/release-pgo.yml) for each commit. ## On Arch Linux pacman -S oha ## On macOS (Homebrew) brew install oha ## On Windows (winget) winget install hatoo.oha ## On Debian ([Azlux's repository](http://packages.azlux.fr/)) echo "deb [signed-by=/usr/share/keyrings/azlux-archive-keyring.gpg] http://packages.azlux.fr/debian/ stable main" | sudo tee /etc/apt/sources.list.d/azlux.list sudo wget -O /usr/share/keyrings/azlux-archive-keyring.gpg https://azlux.fr/repo.gpg apt update apt install oha ## X-CMD (Linux, macOS, Windows WSL/GitBash) You can install with [x-cmd](https://www.x-cmd.com). ```sh x env use oha ``` ## Containerized ### Official Docker image [ghcr.io/hatoo/oha](https://github.com/hatoo/oha/pkgs/container/oha) ### Build image locally You can also build and create a container image including oha ```sh docker build -t hatoo/oha:latest . ``` Then you can use oha directly through the container ```sh docker run --rm -it --network=host hatoo/oha:latest https://example.com:3000 ``` ## Profile-Guided Optimization (PGO) You can build `oha` with PGO by using the following commands: ```sh bun run pgo.js ``` And the binary will be available at `target/[target-triple]/pgo/oha`. **Note**: Please keep in mind that in order to run the aforementioned command, you need to have installed `cargo-pgo` cargo package. You can install it via `cargo install cargo-pgo`. # Platform - Linux - Tested on Ubuntu 18.04 gnome-terminal - Windows 10 - Tested on Windows Powershell - MacOS - Tested on iTerm2 # Usage `-q` option works different from [rakyll/hey](https://github.com/rakyll/hey). It's set overall query per second instead of for each workers. ```sh Ohayou(おはよう), HTTP load generator, inspired by rakyll/hey with tui animation. Usage: oha [OPTIONS] Arguments: Target URL or file with multiple URLs. Options: -n Number of requests to run. Accepts plain numbers or suffixes: k = 1,000, m = 1,000,000 (e.g. 10k, 1m). [default: 200] -c Number of connections to run concurrently. You may should increase limit to number of open files for larger `-c`. [default: 50] -p Number of parallel requests to send on HTTP/2. `oha` will run c * p concurrent workers in total. [default: 1] -z Duration of application to send requests. On HTTP/1, When the duration is reached, ongoing requests are aborted and counted as "aborted due to deadline" You can change this behavior with `-w` option. Currently, on HTTP/2, When the duration is reached, ongoing requests are waited. `-w` option is ignored. Examples: -z 10s -z 3m. -w, --wait-ongoing-requests-after-deadline When the duration is reached, ongoing requests are waited -q Rate limit for all, in queries per second (QPS) --burst-delay Introduce delay between a predefined number of requests. Note: If qps is specified, burst will be ignored --burst-rate Rates of requests for burst. Default is 1 Note: If qps is specified, burst will be ignored --rand-regex-url Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alive do not work well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax. --urls-from-file Read the URLs to query from a file --max-repeat A parameter for the '--rand-regex-url'. The max_repeat parameter gives the maximum extra repeat counts the x*, x+ and x{n,} operators will become. [default: 4] --dump-urls Dump target Urls times to debug --rand-regex-url --latency-correction Correct latency to avoid coordinated omission problem. It's ignored if -q is not set. --no-tui No realtime tui --fps Frame per second for tui. [default: 16] -m, --method HTTP method [default: GET] -H Custom HTTP header. Examples: -H "foo: bar" --proxy-header Custom Proxy HTTP header. Examples: --proxy-header "foo: bar" -t Timeout for each request. Default to infinite. --connect-timeout Timeout for establishing a new connection. Default to 5s. [default: 5s] -A HTTP Accept Header. -d HTTP request body. -D HTTP request body from file. -Z HTTP request body from file line by line. -F, --form
Specify HTTP multipart POST data (curl compatible). Examples: -F 'name=value' -F 'file=@path/to/file' -T Content-Type. -a Basic authentication (username:password), or AWS credentials (access_key:secret_key) --aws-session AWS session token --aws-sigv4 AWS SigV4 signing params (format: aws:amz:region:service) -x HTTP proxy --proxy-http-version HTTP version to connect to proxy. Available values 0.9, 1.0, 1.1, 2. --proxy-http2 Use HTTP/2 to connect to proxy. Shorthand for --proxy-http-version=2 --http-version HTTP version. Available values 0.9, 1.0, 1.1, 2, 3 --http2 Use HTTP/2. Shorthand for --http-version=2 --host HTTP Host header --disable-compression Disable compression. -r, --redirect Limit for number of Redirect. Set 0 for no redirection. Redirection isn't supported for HTTP/2. [default: 10] --disable-keepalive Disable keep-alive, prevents re-use of TCP connections between different HTTP requests. This isn't supported for HTTP/2. --no-pre-lookup *Not* perform a DNS lookup at beginning to cache it --ipv6 Lookup only ipv6. --ipv4 Lookup only ipv4. --cacert (TLS) Use the specified certificate file to verify the peer. Native certificate store is used even if this argument is specified. --cert (TLS) Use the specified client certificate file. --key must be also specified --key (TLS) Use the specified client key file. --cert must be also specified --insecure Accept invalid certs. --connect-to Override DNS resolution and default port numbers with strings like 'example.org:443:localhost:8443' Note: if used several times for the same host:port:target_host:target_port, a random choice is made --no-color Disable the color scheme. [env: NO_COLOR=] --unix-socket Connect to a unix socket instead of the domain in the URL. Only for non-HTTPS URLs. --stats-success-breakdown Include a response status code successful or not successful breakdown for the time histogram and distribution statistics --db-url Write succeeded requests to sqlite database url E.G test.db --debug Perform a single request and dump the request and response -o, --output Output file to write the results to. If not specified, results are written to stdout. --output-format Output format [default: text] [possible values: text, json, csv, quiet] -u, --time-unit Time unit to be used. If not specified, the time unit is determined automatically. This option affects only text format. [possible values: ns, us, ms, s, m, h] -h, --help Print help -V, --version Print version ``` # Performance `oha` uses faster implementation when `--no-tui` option is set and both `-q` and `--burst-delay` are not set because it can avoid overhead to gather data realtime. # Output By default `oha` outputs a text summary of the results. `oha` prints JSON summary output when `--output-format json` option is set. The schema of JSON output is defined in [schema.json](./schema.json). When `--output-format csv` is used result of each request is printed as a line of comma separated values. # Tips ## Stress test in more realistic condition `oha` uses default options inherited from [rakyll/hey](https://github.com/rakyll/hey) but you may need to change options to stress test in more realistic condition. I suggest to run `oha` with following options. ```sh oha <-z or -n> -c -q --latency-correction --disable-keepalive ``` - --disable-keepalive In real, user doesn't query same URL using [Keep-Alive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Keep-Alive). You may want to run without `Keep-Alive`. - --latency-correction You can avoid `Coordinated Omission Problem` by using `--latency-correction`. ## Burst feature You can use `--burst-delay` along with `--burst-rate` option to introduce delay between a defined number of requests. ```sh oha -n 10 --burst-delay 2s --burst-rate 4 ``` In this particular scenario, every 2 seconds, 4 requests will be processed, and after 6s the total of 10 requests will be processed. *NOTE: If you don't set `--burst-rate` option, the amount is default to 1* ## Dynamic url feature You can use `--rand-regex-url` option to generate random url for each connection. ```sh oha --rand-regex-url http://127.0.0.1/[a-z][a-z][0-9] ``` Each Urls are generated by [rand_regex](https://github.com/kennytm/rand_regex) crate but regex's dot is disabled since it's not useful for this purpose and it's very inconvenient if url's dots are interpreted as regex's dot. Optionally you can set `--max-repeat` option to limit max repeat count for each regex. e.g http://127.0.0.1/[a-z]* with `--max-repeat 4` will generate url like http://127.0.0.1/[a-z]{0,4} Currently dynamic scheme, host and port with keep-alive are not works well. ## URLs from file feature You can use `--urls-from-file` to read the target URLs from a file. Each line of this file needs to contain one valid URL as in the example below. ``` http://domain.tld/foo/bar http://domain.tld/assets/vendors-node_modules_highlight_js_lib_index_js-node_modules_tanstack_react-query_build_modern-3fdf40-591fb51c8a6e.js http://domain.tld/images/test.png http://domain.tld/foo/bar?q=test http://domain.tld/foo ``` Such a file can for example be created from an access log to generate a more realistic load distribution over the different pages of a server. When this type of URL specification is used, every request goes to a random URL given in the file. # Contribution Feel free to help us! Here are some areas which need improving. - Write tests - Improve tui design. - Show more information? - Improve speed - I'm new to tokio. I think there are some space to optimize query scheduling. ================================================ FILE: pgo/server/Cargo.toml ================================================ [package] name = "server" version = "0.1.0" edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] axum = "0.8.1" tokio = { version = "1", features = ["full"] } ================================================ FILE: pgo/server/src/main.rs ================================================ use std::net::SocketAddr; use tokio::net::TcpListener; use axum::{routing::get, Router}; #[tokio::main] async fn main() { // build our application with a route let app = Router::new() // `GET /` goes to `root` .route("/", get(root)); // run our app with hyper // `axum::Server` is a re-export of `hyper::Server` let addr = SocketAddr::from(([127, 0, 0, 1], 8888)); let listener = TcpListener::bind(&addr).await.unwrap(); axum::serve(listener, app).await.unwrap(); } async fn root() -> &'static str { "Hello, World!" } ================================================ FILE: pgo.js ================================================ import { $ } from "bun"; let additional = []; if (Bun.argv.length >= 3) { additional = Bun.argv.slice(2); } let server = null; try { server = Bun.spawn(['cargo', 'run', '--release', '--manifest-path', 'pgo/server/Cargo.toml']); await $`cargo pgo run -- --profile pgo ${additional} -- -z 3m -c 900 --no-tui http://localhost:8888`; await $`cargo pgo optimize build -- --profile pgo ${additional}` } finally { if (server !== null) { server.kill(); } } ================================================ FILE: schema.json ================================================ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "JSON schema for the output of the `oha --output-format json`", "type": "object", "properties": { "summary": { "description": "Important statistics", "type": "object", "properties": { "successRate": { "description": "The number of success requests / All requests which isn't includes deadline", "type": "number" }, "total": { "description": "Total duration in seconds", "type": "number" }, "slowest": { "description": "The slowest request duration in seconds", "type": "number" }, "fastest": { "description": "The fastest request duration in seconds", "type": "number" }, "average": { "description": "The average request duration in seconds", "type": "number" }, "requestsPerSec": { "description": "The number of requests per second", "type": "number" }, "totalData": { "description": "Total data of HTTP bodies in bytes", "type": "integer" }, "sizePerRequest": { "description": "The average size of HTTP bodies in bytes", "type": "integer" }, "sizePerSec": { "description": "The average size of HTTP bodies per second in bytes", "type": "number" } }, "required": [ "successRate", "total", "slowest", "fastest", "average", "requestsPerSec", "totalData", "sizePerRequest", "sizePerSec" ] }, "responseTimeHistogram": { "description": "The histogram of response time in seconds. The key is the response time in seconds and the value is the number of requests", "type": "object", "additionalProperties": { "type": "integer" } }, "latencyPercentiles": { "description": "The latency percentiles in seconds", "type": "object", "properties": { "p10": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p90": { "type": "number" }, "p95": { "type": "number" }, "p99": { "type": "number" }, "p99.9": { "type": "number" }, "p99.99": { "type": "number" } }, "required": [ "p10", "p25", "p50", "p75", "p90", "p95", "p99", "p99.9", "p99.99" ] }, "firstByteHistogram": { "description": "The histogram of first byte time in seconds. The key is the first byte time in seconds and the value is the number of requests", "type": "object", "additionalProperties": { "type": "integer" } }, "firstBytePercentiles": { "description": "The first byte percentiles in seconds", "type": "object", "properties": { "p10": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p90": { "type": "number" }, "p95": { "type": "number" }, "p99": { "type": "number" }, "p99.9": { "type": "number" }, "p99.99": { "type": "number" } }, "required": [ "p10", "p25", "p50", "p75", "p90", "p95", "p99", "p99.9", "p99.99" ] }, "responseTimeHistogramSuccessful": { "description": "Only present if `--stats-success-breakdown` argument is passed. The histogram of response time in seconds for successful requests. The key is the response time in seconds and the value is the number of requests", "type": "object", "additionalProperties": { "type": "integer" } }, "latencyPercentileSuccessful": { "description": "Only present if `--stats-success-breakdown` argument is passed. The latency percentiles in seconds for successful requests", "type": "object", "properties": { "p10": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p90": { "type": "number" }, "p95": { "type": "number" }, "p99": { "type": "number" }, "p99.9": { "type": "number" }, "p99.99": { "type": "number" } }, "required": [ "p10", "p25", "p50", "p75", "p90", "p95", "p99", "p99.9", "p99.99" ] }, "responseTimeHistogramNotSuccessful": { "description": "Only present if `--stats-success-breakdown` argument is passed. The histogram of response time in seconds for not successful requests. The key is the response time in seconds and the value is the number of requests", "type": "object", "additionalProperties": { "type": "integer" } }, "latencyPercentileNotSuccessful": { "description": "Only present if `--stats-success-breakdown` argument is passed. The latency percentiles in seconds for not successful requests", "type": "object", "properties": { "p10": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p90": { "type": "number" }, "p95": { "type": "number" }, "p99": { "type": "number" }, "p99.9": { "type": "number" }, "p99.99": { "type": "number" } }, "required": [ "p10", "p25", "p50", "p75", "p90", "p95", "p99", "p99.9", "p99.99" ] }, "rps": { "description": "The statistics for requests per second. Note: the way of calculating rps over time isn't obvious, see source code for details.", "type": "object", "properties": { "mean": { "type": "number" }, "stddev": { "type": [ "number", "null" ] }, "max": { "type": "number" }, "min": { "type": "number" }, "percentiles": { "type": "object", "properties": { "p10": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p90": { "type": "number" }, "p95": { "type": "number" }, "p99": { "type": "number" }, "p99.9": { "type": "number" }, "p99.99": { "type": "number" } }, "required": [ "p10", "p25", "p50", "p75", "p90", "p95", "p99", "p99.9", "p99.99" ] } }, "required": [ "mean", "stddev", "max", "min", "percentiles" ] }, "details": { "description": "The details of connection time. Note: `oha` uses keep-alive connections in default. So, the connection time may added only for the first request.", "type": "object", "properties": { "DNSDialup": { "description": "The time of DNS resolution + TCP handshake in seconds", "type": "object", "properties": { "average": { "type": "number" }, "fastest": { "type": "number" }, "slowest": { "type": "number" } }, "required": [ "average", "fastest", "slowest" ] }, "DNSLookup": { "description": "The time of DNS resolution in seconds", "type": "object", "properties": { "average": { "type": "number" }, "fastest": { "type": "number" }, "slowest": { "type": "number" } }, "required": [ "average", "fastest", "slowest" ] }, "firstByte": { "description": "The time to first byte in seconds", "type": "object", "properties": { "average": { "type": "number" }, "fastest": { "type": "number" }, "slowest": { "type": "number" } }, "required": [ "average", "fastest", "slowest" ] } }, "required": [ "DNSDialup", "DNSLookup", "firstByte" ] }, "statusCodeDistribution": { "description": "The distribution of status codes. The key is the status code and the value is the number of requests", "type": "object", "propertyNames": { "type": "string", "pattern": "^[0-9]+$" }, "additionalProperties": { "type": "integer" }, "minProperties": 1 }, "errorDistribution": { "description": "The distribution of errors. The key is the error message and the value is the number of errors. Note: the error message is from internal libraries so the detail may change in future.", "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "summary", "responseTimeHistogram", "latencyPercentiles", "firstByteHistogram", "firstBytePercentiles", "rps", "details", "statusCodeDistribution", "errorDistribution" ] } ================================================ FILE: src/aws_auth.rs ================================================ use anyhow::Result; use bytes::Bytes; use hyper::{ HeaderMap, header::{self, HeaderName}, }; use thiserror::Error; use url::Url; pub struct AwsSignatureConfig { pub access_key: String, pub secret_key: String, pub session_token: Option, pub service: String, pub region: String, } #[derive(Error, Debug)] pub enum AwsSignatureError { #[error("URL must contain a host {0}")] NoHost(Url), #[error("Invalid host header name {0}")] InvalidHost(String), #[error("Invalid authorization header name {0}")] InvalidAuthorization(String), } // Initialize unsignable headers as a static constant static UNSIGNABLE_HEADERS: [HeaderName; 8] = [ header::ACCEPT, header::ACCEPT_ENCODING, header::USER_AGENT, header::EXPECT, header::RANGE, header::CONNECTION, HeaderName::from_static("presigned-expires"), HeaderName::from_static("x-amzn-trace-id"), ]; impl AwsSignatureConfig { pub fn sign_request( &self, method: &str, headers: &mut HeaderMap, url: &Url, body: &Bytes, ) -> Result<(), AwsSignatureError> { let datetime = chrono::Utc::now(); let header_amz_date = datetime .format("%Y%m%dT%H%M%SZ") .to_string() .parse() .unwrap(); if !headers.contains_key(header::HOST) { let host = url .host_str() .ok_or_else(|| AwsSignatureError::NoHost(url.clone()))?; headers.insert( header::HOST, host.parse() .map_err(|_| AwsSignatureError::InvalidHost(host.to_string()))?, ); } headers.insert("x-amz-date", header_amz_date); if let Some(session_token) = &self.session_token { headers.insert("x-amz-security-token", session_token.parse().unwrap()); } headers.remove(header::AUTHORIZATION); //remove and store headers in a vec from unsignable_headers let removed_headers: Vec<(header::HeaderName, header::HeaderValue)> = UNSIGNABLE_HEADERS .iter() .filter_map(|k| headers.remove(k).map(|v| (k.clone(), v))) .collect(); headers.insert( header::CONTENT_LENGTH, body.len().to_string().parse().unwrap(), ); let aws_sign = aws_sign_v4::AwsSign::new( method, url.as_str(), &datetime, headers, &self.region, &self.access_key, &self.secret_key, &self.service, body, ); let signature = aws_sign.sign(); //insert headers for (key, value) in removed_headers { headers.insert(key, value); } headers.insert( header::AUTHORIZATION, signature .parse() .map_err(|_| AwsSignatureError::InvalidAuthorization(signature.to_string()))?, ); Ok(()) } pub fn new( access_key: &str, secret_key: &str, signing_params: &str, session_token: Option, ) -> Result { let parts: Vec<&str> = signing_params .strip_prefix("aws:amz:") .unwrap_or_default() .split(':') .collect(); if parts.len() != 2 { anyhow::bail!("Invalid AWS signing params format. Expected aws:amz:region:service"); } Ok(Self { access_key: access_key.into(), secret_key: secret_key.into(), session_token, region: parts[0].to_string(), service: parts[1].to_string(), }) } } ================================================ FILE: src/cli.rs ================================================ use hyper::http::header::{HeaderName, HeaderValue}; use std::str::FromStr; pub fn parse_header(s: &str) -> Result<(HeaderName, HeaderValue), anyhow::Error> { let header = s.splitn(2, ':').collect::>(); anyhow::ensure!(header.len() == 2, anyhow::anyhow!("Parse header")); let name = HeaderName::from_str(header[0])?; let value = HeaderValue::from_str(header[1].trim_start_matches(' '))?; Ok::<(HeaderName, HeaderValue), anyhow::Error>((name, value)) } pub fn parse_n_requests(s: &str) -> Result { let s = s.trim().to_lowercase(); if let Some(num) = s.strip_suffix('k') { num.parse::() .map(|n| (n * 1000_f64) as usize) .map_err(|e| e.to_string()) } else if let Some(num) = s.strip_suffix('m') { num.parse::() .map(|n| (n * 1_000_000_f64) as usize) .map_err(|e| e.to_string()) } else { s.parse::().map_err(|e| e.to_string()) } } /// An entry specified by `connect-to` to override DNS resolution and default /// port numbers. For example, `example.org:80:localhost:5000` will connect to /// `localhost:5000` whenever `http://example.org` is requested. #[derive(Clone, Debug)] pub struct ConnectToEntry { pub requested_host: String, pub requested_port: u16, pub target_host: String, pub target_port: u16, } impl FromStr for ConnectToEntry { type Err = String; fn from_str(s: &str) -> Result { let expected_syntax: &str = "syntax for --connect-to is host:port:target_host:target_port"; let (s, target_port) = s.rsplit_once(':').ok_or(expected_syntax)?; let (s, target_host) = if s.ends_with(']') { // ipv6 let i = s.rfind(":[").ok_or(expected_syntax)?; (&s[..i], &s[i + 1..]) } else { s.rsplit_once(':').ok_or(expected_syntax)? }; let (requested_host, requested_port) = s.rsplit_once(':').ok_or(expected_syntax)?; Ok(ConnectToEntry { requested_host: requested_host.into(), requested_port: requested_port.parse().map_err(|err| { format!("requested port must be an u16, but got {requested_port}: {err}") })?, target_host: target_host.into(), target_port: target_port.parse().map_err(|err| { format!("target port must be an u16, but got {target_port}: {err}") })?, }) } } #[cfg(feature = "vsock")] pub fn parse_vsock_addr(s: &str) -> Result { let (cid, port) = s .split_once(':') .ok_or("syntax for --vsock-addr is cid:port")?; Ok(tokio_vsock::VsockAddr::new( cid.parse() .map_err(|err| format!("cid must be a u32, but got {cid}: {err}"))?, port.parse() .map_err(|err| format!("port must be a u32, but got {port}: {err}"))?, )) } ================================================ FILE: src/client.rs ================================================ use bytes::Bytes; #[cfg(test)] use hickory_resolver::config::{ResolverConfig, ResolverOpts}; use http_body_util::{BodyExt, Full}; use hyper::{Method, Request, http}; use hyper_util::rt::{TokioExecutor, TokioIo}; use rand::{prelude::*, rng}; use std::{ borrow::Cow, io::Write, sync::{ Arc, atomic::{AtomicBool, Ordering::Relaxed}, }, time::Instant, }; use thiserror::Error; use tokio::{ io::{AsyncRead, AsyncWrite}, net::TcpStream, }; use url::{ParseError, Url}; use crate::{ ConnectToEntry, pcg64si::Pcg64Si, request_generator::{RequestGenerationError, RequestGenerator}, url_generator::UrlGeneratorError, }; #[cfg(feature = "http3")] use crate::client_h3::send_debug_request_http3; type SendRequestHttp1 = hyper::client::conn::http1::SendRequest>; type SendRequestHttp2 = hyper::client::conn::http2::SendRequest>; fn format_host_port(host: &str, port: u16) -> String { if host.contains(':') && !(host.starts_with('[') && host.ends_with(']')) { format!("[{host}]:{port}") } else { format!("{host}:{port}") } } #[derive(Debug, Clone, Copy)] pub struct ConnectionTime { pub dns_lookup: std::time::Duration, pub dialup: std::time::Duration, } #[derive(Debug, Clone)] /// a result for a request pub struct RequestResult { pub rng: Pcg64Si, // When the query should started pub start_latency_correction: Option, /// When the query started pub start: std::time::Instant, /// DNS + dialup /// None when reuse connection pub connection_time: Option, /// First body byte received pub first_byte: Option, /// When the query ends pub end: std::time::Instant, /// HTTP status pub status: http::StatusCode, /// Length of body pub len_bytes: usize, } impl RequestResult { /// Duration the request takes. pub fn duration(&self) -> std::time::Duration { self.end - self.start_latency_correction.unwrap_or(self.start) } } // encapsulates the HTTP generation of the work type. Used internally only for conditional logic. #[derive(Debug, Clone, Copy, PartialEq)] enum HttpWorkType { H1, H2, #[cfg(feature = "http3")] H3, } pub struct Dns { pub connect_to: Vec, pub resolver: hickory_resolver::Resolver, } impl Dns { fn select_connect_to<'a, R: Rng>( &'a self, host: &str, port: u16, rng: &mut R, ) -> Option<&'a ConnectToEntry> { self.connect_to .iter() .filter(|entry| entry.requested_port == port && entry.requested_host == host) .collect::>() .choose(rng) .copied() } /// Perform a DNS lookup for a given url and returns (ip_addr, port) async fn lookup( &self, url: &Url, rng: &mut R, ) -> Result<(std::net::IpAddr, u16), ClientError> { let host = url.host_str().ok_or(ClientError::HostNotFound)?; let port = url .port_or_known_default() .ok_or(ClientError::PortNotFound)?; // Try to find an override (passed via `--connect-to`) that applies to this (host, port), // choosing one randomly if several match. let (host, port) = if let Some(entry) = self.select_connect_to(host, port, rng) { (entry.target_host.as_str(), entry.target_port) } else { (host, port) }; let host = if host.starts_with('[') && host.ends_with(']') { // host is [ipv6] format // remove first [ and last ] &host[1..host.len() - 1] } else { host }; // Perform actual DNS lookup, either on the original (host, port), or // on the (host, port) specified with `--connect-to`. let addrs = self .resolver .lookup_ip(host) .await .map_err(Box::new)? .iter() .collect::>(); let addr = *addrs.choose(rng).ok_or(ClientError::DNSNoRecord)?; Ok((addr, port)) } } #[derive(Error, Debug)] pub enum ClientError { #[error("failed to get port from URL")] PortNotFound, #[error("failed to get host from URL")] HostNotFound, #[error("No record returned from DNS")] DNSNoRecord, #[error("Redirection limit has reached")] TooManyRedirect, #[error(transparent)] // Use Box here because ResolveError is big. Resolve(#[from] Box), #[cfg(feature = "native-tls")] #[error(transparent)] NativeTls(#[from] native_tls::Error), #[cfg(feature = "rustls")] #[error(transparent)] Rustls(#[from] rustls::Error), #[cfg(feature = "rustls")] #[error(transparent)] InvalidDnsName(#[from] rustls_pki_types::InvalidDnsNameError), #[error(transparent)] Io(#[from] std::io::Error), #[error(transparent)] Http(#[from] http::Error), #[error(transparent)] Hyper(#[from] hyper::Error), #[error(transparent)] InvalidUriParts(#[from] http::uri::InvalidUriParts), #[error(transparent)] InvalidHeaderValue(#[from] http::header::InvalidHeaderValue), #[error("Failed to get header from builder")] GetHeaderFromBuilder, #[error(transparent)] HeaderToStr(#[from] http::header::ToStrError), #[error(transparent)] InvalidUri(#[from] http::uri::InvalidUri), #[error("timeout")] Timeout, #[error("aborted due to deadline")] Deadline, #[error(transparent)] UrlGenerator(#[from] UrlGeneratorError), #[error(transparent)] UrlParse(#[from] ParseError), #[error("Request generation error: {0}")] RequestGeneration(#[from] RequestGenerationError), #[cfg(feature = "http3")] #[error(transparent)] Http3(#[from] crate::client_h3::Http3Error), } pub struct Client { pub request_generator: RequestGenerator, pub proxy_http_version: http::Version, pub proxy_headers: http::header::HeaderMap, pub dns: Dns, pub timeout: Option, pub connect_timeout: std::time::Duration, pub redirect_limit: usize, pub disable_keepalive: bool, pub proxy_url: Option, #[cfg(unix)] pub unix_socket: Option, #[cfg(feature = "vsock")] pub vsock_addr: Option, #[cfg(feature = "rustls")] pub rustls_configs: crate::tls_config::RuslsConfigs, #[cfg(all(feature = "native-tls", not(feature = "rustls")))] pub native_tls_connectors: crate::tls_config::NativeTlsConnectors, } #[cfg(test)] impl Default for Client { fn default() -> Self { use crate::request_generator::BodyGenerator; let (resolver_config, resolver_opts) = crate::system_resolv_conf() .unwrap_or_else(|_| (ResolverConfig::default(), ResolverOpts::default())); let resolver = hickory_resolver::Resolver::builder_with_config( resolver_config, hickory_resolver::name_server::TokioConnectionProvider::default(), ) .with_options(resolver_opts) .build(); Self { request_generator: RequestGenerator { url_generator: crate::url_generator::UrlGenerator::new_static( "http://example.com".parse().unwrap(), ), https: false, http_proxy: None, method: http::Method::GET, version: http::Version::HTTP_11, headers: http::header::HeaderMap::new(), body_generator: BodyGenerator::Static(Bytes::new()), aws_config: None, }, proxy_http_version: http::Version::HTTP_11, proxy_headers: http::header::HeaderMap::new(), dns: Dns { resolver, connect_to: Vec::new(), }, timeout: None, connect_timeout: std::time::Duration::from_secs(5), redirect_limit: 0, disable_keepalive: false, proxy_url: None, #[cfg(unix)] unix_socket: None, #[cfg(feature = "vsock")] vsock_addr: None, #[cfg(feature = "rustls")] rustls_configs: crate::tls_config::RuslsConfigs::new(false, None, None), #[cfg(all(feature = "native-tls", not(feature = "rustls")))] native_tls_connectors: crate::tls_config::NativeTlsConnectors::new(false, None, None), } } } struct ClientStateHttp1 { rng: Pcg64Si, send_request: Option, } impl Default for ClientStateHttp1 { fn default() -> Self { Self { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: None, } } } struct ClientStateHttp2 { rng: Pcg64Si, send_request: SendRequestHttp2, } pub enum QueryLimit { Qps(f64), Burst(std::time::Duration, usize), } // To avoid dynamic dispatch // I'm not sure how much this is effective pub(crate) enum Stream { Tcp(TcpStream), #[cfg(all(feature = "native-tls", not(feature = "rustls")))] Tls(tokio_native_tls::TlsStream), #[cfg(feature = "rustls")] // Box for large variant Tls(Box>), #[cfg(unix)] Unix(tokio::net::UnixStream), #[cfg(feature = "vsock")] Vsock(tokio_vsock::VsockStream), #[cfg(feature = "http3")] Quic(quinn::Connection), } impl Stream { async fn handshake_http1(self, with_upgrade: bool) -> Result { match self { Stream::Tcp(stream) => { let (send_request, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream)).await?; if with_upgrade { tokio::spawn(conn.with_upgrades()); } else { tokio::spawn(conn); } Ok(send_request) } Stream::Tls(stream) => { let (send_request, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream)).await?; if with_upgrade { tokio::spawn(conn.with_upgrades()); } else { tokio::spawn(conn); } Ok(send_request) } #[cfg(unix)] Stream::Unix(stream) => { let (send_request, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream)).await?; if with_upgrade { tokio::spawn(conn.with_upgrades()); } else { tokio::spawn(conn); } Ok(send_request) } #[cfg(feature = "vsock")] Stream::Vsock(stream) => { let (send_request, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream)).await?; if with_upgrade { tokio::spawn(conn.with_upgrades()); } else { tokio::spawn(conn); } Ok(send_request) } #[cfg(feature = "http3")] Stream::Quic(_) => { panic!("quic is not supported in http1") } } } async fn handshake_http2(self) -> Result { let mut builder = hyper::client::conn::http2::Builder::new(TokioExecutor::new()); builder // from nghttp2's default .initial_stream_window_size((1 << 30) - 1) .initial_connection_window_size((1 << 30) - 1); match self { Stream::Tcp(stream) => { let (send_request, conn) = builder.handshake(TokioIo::new(stream)).await?; tokio::spawn(conn); Ok(send_request) } Stream::Tls(stream) => { let (send_request, conn) = builder.handshake(TokioIo::new(stream)).await?; tokio::spawn(conn); Ok(send_request) } #[cfg(unix)] Stream::Unix(stream) => { let (send_request, conn) = builder.handshake(TokioIo::new(stream)).await?; tokio::spawn(conn); Ok(send_request) } #[cfg(feature = "vsock")] Stream::Vsock(stream) => { let (send_request, conn) = builder.handshake(TokioIo::new(stream)).await?; tokio::spawn(conn); Ok(send_request) } #[cfg(feature = "http3")] Stream::Quic(_) => { panic!("quic is not supported in http2") } } } } impl Client { #[inline] fn is_http2(&self) -> bool { self.request_generator.version == http::Version::HTTP_2 } #[inline] fn is_proxy_http2(&self) -> bool { self.proxy_http_version == http::Version::HTTP_2 } fn is_work_http2(&self) -> bool { if self.proxy_url.is_some() { if self.request_generator.https { self.is_http2() } else { self.is_proxy_http2() } } else { self.is_http2() } } fn work_type(&self) -> HttpWorkType { #[cfg(feature = "http3")] if self.request_generator.version == http::Version::HTTP_3 { return HttpWorkType::H3; } if self.is_work_http2() { HttpWorkType::H2 } else { HttpWorkType::H1 } } /// Perform a DNS lookup to cache it /// This is useful to avoid DNS lookup latency at the first concurrent requests pub async fn pre_lookup(&self) -> Result<(), ClientError> { // If the client is using a unix socket, we don't need to do a DNS lookup #[cfg(unix)] if self.unix_socket.is_some() { return Ok(()); } // If the client is using a vsock address, we don't need to do a DNS lookup #[cfg(feature = "vsock")] if self.vsock_addr.is_some() { return Ok(()); } let mut rng = rand::rng(); let url = self.request_generator.url_generator.generate(&mut rng)?; // It automatically caches the result self.dns.lookup(&url, &mut rng).await?; Ok(()) } #[allow(clippy::type_complexity)] pub fn generate_request( &self, rng: &mut R, ) -> Result<(Cow<'_, Url>, Request>, R), ClientError> { let snapshot = *rng; let (url, mut req) = self.request_generator.generate(rng)?; if self.proxy_url.is_some() && req.uri().scheme_str() == Some("http") { if let Some(authority) = req.uri().authority() { let requested_host = authority.host(); let requested_port = authority.port_u16().unwrap_or(80); if let Some(entry) = self .dns .select_connect_to(requested_host, requested_port, rng) { let new_authority: http::uri::Authority = format_host_port(entry.target_host.as_str(), entry.target_port).parse()?; let mut parts = req.uri().clone().into_parts(); parts.authority = Some(new_authority); let new_uri = http::Uri::from_parts(parts)?; *req.uri_mut() = new_uri; } } } Ok((url, req, snapshot)) } /** * Returns a stream of the underlying transport. NOT a HTTP client */ pub(crate) async fn client( &self, url: &Url, rng: &mut R, http_version: http::Version, ) -> Result<(Instant, Stream), ClientError> { let timeout_duration = self.connect_timeout; #[cfg(feature = "http3")] if http_version == http::Version::HTTP_3 { let addr = self.dns.lookup(url, rng).await?; let dns_lookup = Instant::now(); let stream = tokio::time::timeout(timeout_duration, self.quic_client(addr, url)).await; return match stream { Ok(Ok(stream)) => Ok((dns_lookup, stream)), Ok(Err(err)) => Err(err), Err(_) => Err(ClientError::Timeout), }; } if url.scheme() == "https" { let addr = self.dns.lookup(url, rng).await?; let dns_lookup = Instant::now(); // If we do not put a timeout here then the connections attempts will // linger long past the configured timeout let stream = tokio::time::timeout(timeout_duration, self.tls_client(addr, url, http_version)) .await; return match stream { Ok(Ok(stream)) => Ok((dns_lookup, stream)), Ok(Err(err)) => Err(err), Err(_) => Err(ClientError::Timeout), }; } #[cfg(unix)] if let Some(socket_path) = &self.unix_socket { let dns_lookup = Instant::now(); let stream = tokio::time::timeout( timeout_duration, tokio::net::UnixStream::connect(socket_path), ) .await; return match stream { Ok(Ok(stream)) => Ok((dns_lookup, Stream::Unix(stream))), Ok(Err(err)) => Err(ClientError::Io(err)), Err(_) => Err(ClientError::Timeout), }; } #[cfg(feature = "vsock")] if let Some(addr) = self.vsock_addr { let dns_lookup = Instant::now(); let stream = tokio::time::timeout(timeout_duration, tokio_vsock::VsockStream::connect(addr)) .await; return match stream { Ok(Ok(stream)) => Ok((dns_lookup, Stream::Vsock(stream))), Ok(Err(err)) => Err(ClientError::Io(err)), Err(_) => Err(ClientError::Timeout), }; } // HTTP let addr = self.dns.lookup(url, rng).await?; let dns_lookup = Instant::now(); let stream = tokio::time::timeout(timeout_duration, tokio::net::TcpStream::connect(addr)).await; match stream { Ok(Ok(stream)) => { stream.set_nodelay(true)?; Ok((dns_lookup, Stream::Tcp(stream))) } Ok(Err(err)) => Err(ClientError::Io(err)), Err(_) => Err(ClientError::Timeout), } } async fn tls_client( &self, addr: (std::net::IpAddr, u16), url: &Url, http_version: http::Version, ) -> Result { let stream = tokio::net::TcpStream::connect(addr).await?; stream.set_nodelay(true)?; let stream = self.connect_tls(stream, url, http_version).await?; Ok(Stream::Tls(stream)) } #[cfg(all(feature = "native-tls", not(feature = "rustls")))] async fn connect_tls( &self, stream: S, url: &Url, http_version: http::Version, ) -> Result, ClientError> where S: AsyncRead + AsyncWrite + Unpin, { let connector = self .native_tls_connectors .connector(http_version >= http::Version::HTTP_2); let stream = connector .connect(url.host_str().ok_or(ClientError::HostNotFound)?, stream) .await?; Ok(stream) } #[cfg(feature = "rustls")] async fn connect_tls( &self, stream: S, url: &Url, http_version: http::Version, ) -> Result>, ClientError> where S: AsyncRead + AsyncWrite + Unpin, { let connector = tokio_rustls::TlsConnector::from(self.rustls_configs.config(http_version).clone()); let domain = rustls_pki_types::ServerName::try_from( url.host_str().ok_or(ClientError::HostNotFound)?, )?; let stream = connector.connect(domain.to_owned(), stream).await?; Ok(Box::new(stream)) } async fn client_http1( &self, url: &Url, rng: &mut R, ) -> Result<(Instant, SendRequestHttp1), ClientError> { if let Some(proxy_url) = &self.proxy_url { let http_proxy_version = if self.is_proxy_http2() { http::Version::HTTP_2 } else { http::Version::HTTP_11 }; let (dns_lookup, stream) = self.client(proxy_url, rng, http_proxy_version).await?; if url.scheme() == "https" { let requested_host = url.host_str().ok_or(ClientError::HostNotFound)?; let requested_port = url .port_or_known_default() .ok_or(ClientError::PortNotFound)?; let (connect_host, connect_port) = if let Some(entry) = self.dns .select_connect_to(requested_host, requested_port, rng) { (entry.target_host.as_str(), entry.target_port) } else { (requested_host, requested_port) }; let connect_authority = format_host_port(connect_host, connect_port); // Do CONNECT request to proxy let req = { let mut builder = http::Request::builder() .method(Method::CONNECT) .uri(connect_authority); *builder .headers_mut() .ok_or(ClientError::GetHeaderFromBuilder)? = self.proxy_headers.clone(); builder.body(http_body_util::Full::default())? }; let res = if self.proxy_http_version == http::Version::HTTP_2 { let mut send_request = stream.handshake_http2().await?; send_request.send_request(req).await? } else { let mut send_request = stream.handshake_http1(true).await?; send_request.send_request(req).await? }; let stream = hyper::upgrade::on(res).await?; let stream = self .connect_tls(TokioIo::new(stream), url, self.request_generator.version) .await?; let (send_request, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream)).await?; tokio::spawn(conn); Ok((dns_lookup, send_request)) } else { // Send full URL in request() for HTTP proxy Ok((dns_lookup, stream.handshake_http1(false).await?)) } } else { let (dns_lookup, stream) = self.client(url, rng, http::Version::HTTP_11).await?; Ok((dns_lookup, stream.handshake_http1(false).await?)) } } async fn work_http1( &self, client_state: &mut ClientStateHttp1, ) -> Result { let do_req = async { let (url, request, rng) = self.generate_request(&mut client_state.rng)?; let mut start = std::time::Instant::now(); let mut first_byte: Option = None; let mut connection_time: Option = None; let mut send_request = if let Some(send_request) = client_state.send_request.take() { send_request } else { let (dns_lookup, send_request) = self.client_http1(&url, &mut client_state.rng).await?; let dialup = std::time::Instant::now(); connection_time = Some(ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }); send_request }; while send_request.ready().await.is_err() { // This gets hit when the connection for HTTP/1.1 faults // This re-connects start = std::time::Instant::now(); let (dns_lookup, send_request_) = self.client_http1(&url, &mut client_state.rng).await?; send_request = send_request_; let dialup = std::time::Instant::now(); connection_time = Some(ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }); } match send_request.send_request(request).await { Ok(res) => { let (parts, mut stream) = res.into_parts(); let mut status = parts.status; let mut len_bytes = 0; while let Some(chunk) = stream.frame().await { if first_byte.is_none() { first_byte = Some(std::time::Instant::now()) } len_bytes += chunk?.data_ref().map(|d| d.len()).unwrap_or_default(); } if self.redirect_limit != 0 { if let Some(location) = parts.headers.get("Location") { let (send_request_redirect, new_status, len) = self .redirect( url, rng, send_request, location, self.redirect_limit, &mut client_state.rng, ) .await?; send_request = send_request_redirect; status = new_status; len_bytes = len; } } let end = std::time::Instant::now(); let result = RequestResult { rng, start_latency_correction: None, start, first_byte, end, status, len_bytes, connection_time, }; if !self.disable_keepalive { client_state.send_request = Some(send_request); } Ok::<_, ClientError>(result) } Err(e) => { client_state.send_request = Some(send_request); Err(e.into()) } } }; if let Some(timeout) = self.timeout { tokio::select! { res = do_req => { res } _ = tokio::time::sleep(timeout) => { Err(ClientError::Timeout) } } } else { do_req.await } } async fn connect_http2( &self, url: &Url, rng: &mut R, ) -> Result<(ConnectionTime, SendRequestHttp2), ClientError> { let start = std::time::Instant::now(); if let Some(proxy_url) = &self.proxy_url { let http_proxy_version = if self.is_proxy_http2() { http::Version::HTTP_2 } else { http::Version::HTTP_11 }; let (dns_lookup, stream) = self.client(proxy_url, rng, http_proxy_version).await?; if url.scheme() == "https" { let requested_host = url.host_str().ok_or(ClientError::HostNotFound)?; let requested_port = url .port_or_known_default() .ok_or(ClientError::PortNotFound)?; let (connect_host, connect_port) = if let Some(entry) = self.dns .select_connect_to(requested_host, requested_port, rng) { (entry.target_host.as_str(), entry.target_port) } else { (requested_host, requested_port) }; let connect_authority = format_host_port(connect_host, connect_port); let req = { let mut builder = http::Request::builder() .method(Method::CONNECT) .uri(connect_authority); *builder .headers_mut() .ok_or(ClientError::GetHeaderFromBuilder)? = self.proxy_headers.clone(); builder.body(http_body_util::Full::default())? }; let res = if self.proxy_http_version == http::Version::HTTP_2 { let mut send_request = stream.handshake_http2().await?; send_request.send_request(req).await? } else { let mut send_request = stream.handshake_http1(true).await?; send_request.send_request(req).await? }; let stream = hyper::upgrade::on(res).await?; let stream = self .connect_tls(TokioIo::new(stream), url, http::Version::HTTP_2) .await?; let (send_request, conn) = hyper::client::conn::http2::Builder::new(TokioExecutor::new()) // from nghttp2's default .initial_stream_window_size((1 << 30) - 1) .initial_connection_window_size((1 << 30) - 1) .handshake(TokioIo::new(stream)) .await?; tokio::spawn(conn); let dialup = std::time::Instant::now(); Ok(( ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }, send_request, )) } else { let send_request = stream.handshake_http2().await?; let dialup = std::time::Instant::now(); Ok(( ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }, send_request, )) } } else { let (dns_lookup, stream) = self .client(url, rng, self.request_generator.version) .await?; let send_request = stream.handshake_http2().await?; let dialup = std::time::Instant::now(); Ok(( ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }, send_request, )) } } async fn work_http2( &self, client_state: &mut ClientStateHttp2, ) -> Result { let do_req = async { let (_url, request, rng) = self.generate_request(&mut client_state.rng)?; let start = std::time::Instant::now(); let mut first_byte: Option = None; let connection_time: Option = None; match client_state.send_request.send_request(request).await { Ok(res) => { let (parts, mut stream) = res.into_parts(); let status = parts.status; let mut len_bytes = 0; while let Some(chunk) = stream.frame().await { if first_byte.is_none() { first_byte = Some(std::time::Instant::now()) } len_bytes += chunk?.data_ref().map(|d| d.len()).unwrap_or_default(); } let end = std::time::Instant::now(); let result = RequestResult { rng, start_latency_correction: None, start, first_byte, end, status, len_bytes, connection_time, }; Ok::<_, ClientError>(result) } Err(e) => Err(e.into()), } }; if let Some(timeout) = self.timeout { tokio::select! { res = do_req => { res } _ = tokio::time::sleep(timeout) => { Err(ClientError::Timeout) } } } else { do_req.await } } #[allow(clippy::type_complexity)] async fn redirect( &self, base_url: Cow<'_, Url>, seed: R, send_request: SendRequestHttp1, location: &http::header::HeaderValue, limit: usize, rng: &mut R, ) -> Result<(SendRequestHttp1, http::StatusCode, usize), ClientError> { if limit == 0 { return Err(ClientError::TooManyRedirect); } let url = match Url::parse(location.to_str()?) { Ok(url) => url, Err(ParseError::RelativeUrlWithoutBase) => Url::options() .base_url(Some(&base_url)) .parse(location.to_str()?)?, Err(err) => Err(err)?, }; let (mut send_request, send_request_base) = if base_url.authority() == url.authority() && !self.disable_keepalive { // reuse connection (send_request, None) } else { let (_dns_lookup, stream) = self.client_http1(&url, rng).await?; (stream, Some(send_request)) }; while send_request.ready().await.is_err() { let (_dns_lookup, stream) = self.client_http1(&url, rng).await?; send_request = stream; } let mut request = self.generate_request(&mut seed.clone())?.1; if url.authority() != base_url.authority() { request.headers_mut().insert( http::header::HOST, http::HeaderValue::from_str(url.authority())?, ); } *request.uri_mut() = if self.proxy_url.is_some() && url.scheme() == "http" { // Full URL in request() for HTTP proxy url.as_str().parse()? } else { url[url::Position::BeforePath..].parse()? }; if self.proxy_url.is_some() && request.uri().scheme_str() == Some("http") { if let Some(authority) = request.uri().authority() { let requested_host = authority.host(); let requested_port = authority.port_u16().unwrap_or(80); if let Some(entry) = self .dns .select_connect_to(requested_host, requested_port, rng) { let new_authority: http::uri::Authority = format_host_port(entry.target_host.as_str(), entry.target_port).parse()?; let mut parts = request.uri().clone().into_parts(); parts.authority = Some(new_authority); let new_uri = http::Uri::from_parts(parts)?; *request.uri_mut() = new_uri; } } } let res = send_request.send_request(request).await?; let (parts, mut stream) = res.into_parts(); let mut status = parts.status; let mut len_bytes = 0; while let Some(chunk) = stream.frame().await { len_bytes += chunk?.data_ref().map(|d| d.len()).unwrap_or_default(); } if let Some(location) = parts.headers.get("Location") { let (send_request_redirect, new_status, len) = Box::pin(self.redirect(base_url, seed, send_request, location, limit - 1, rng)) .await?; send_request = send_request_redirect; status = new_status; len_bytes = len; } if let Some(send_request_base) = send_request_base { Ok((send_request_base, status, len_bytes)) } else { Ok((send_request, status, len_bytes)) } } } /// Check error and decide whether to cancel the connection pub(crate) fn is_cancel_error(res: &Result) -> bool { matches!(res, Err(ClientError::Deadline)) || is_too_many_open_files(res) } /// Check error was "Too many open file" fn is_too_many_open_files(res: &Result) -> bool { res.as_ref() .err() .map(|err| match err { ClientError::Io(io_error) => io_error.raw_os_error() == Some(libc::EMFILE), _ => false, }) .unwrap_or(false) } /// Check error was any Hyper error (primarily for HTTP2 connection errors) fn is_hyper_error(res: &Result) -> bool { res.as_ref() .err() .map(|err| match err { // REVIEW: IoErrors, if indicating the underlying connection has failed, // should also cause a stop of HTTP2 requests ClientError::Io(_) => true, ClientError::Hyper(_) => true, _ => false, }) .unwrap_or(false) } async fn setup_http2( client: &Client, rng: &mut R, ) -> Result<(ConnectionTime, SendRequestHttp2), ClientError> { let url = client.request_generator.url_generator.generate(rng)?; let (connection_time, send_request) = client.connect_http2(&url, rng).await?; Ok((connection_time, send_request)) } async fn work_http2_once( client: &Client, client_state: &mut ClientStateHttp2, report_tx: &kanal::Sender>, connection_time: ConnectionTime, start_latency_correction: Option, ) -> (bool, bool) { let mut res = client.work_http2(client_state).await; let is_cancel = is_cancel_error(&res); let is_reconnect = is_hyper_error(&res); set_connection_time(&mut res, connection_time); if let Some(start_latency_correction) = start_latency_correction { set_start_latency_correction(&mut res, start_latency_correction); } report_tx.send(res).unwrap(); (is_cancel, is_reconnect) } pub(crate) fn set_connection_time( res: &mut Result, connection_time: ConnectionTime, ) { if let Ok(res) = res { res.connection_time = Some(connection_time); } } pub(crate) fn set_start_latency_correction( res: &mut Result, start_latency_correction: std::time::Instant, ) { if let Ok(res) = res { res.start_latency_correction = Some(start_latency_correction); } } pub async fn work_debug(w: &mut W, client: Arc) -> Result<(), ClientError> { let mut rng = Pcg64Si::from_rng(&mut rng()); let (url, request, _) = client.generate_request(&mut rng)?; writeln!(w, "{request:#?}")?; let response = match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => { let (_, (h3_connection, client_state)) = client.connect_http3(&url, &mut rng).await?; send_debug_request_http3(h3_connection, client_state, request).await? } HttpWorkType::H2 => { let (_, mut client_state) = client.connect_http2(&url, &mut rng).await?; let response = client_state.send_request(request).await?; let (parts, body) = response.into_parts(); let body = body.collect().await.unwrap().to_bytes(); http::Response::from_parts(parts, body) } HttpWorkType::H1 => { let (_dns_lookup, mut send_request) = client.client_http1(&url, &mut rng).await?; let response = send_request.send_request(request).await?; let (parts, body) = response.into_parts(); let body = body.collect().await.unwrap().to_bytes(); http::Response::from_parts(parts, body) } }; writeln!(w, "{response:#?}")?; Ok(()) } /// Run n tasks by m workers pub async fn work( client: Arc, report_tx: kanal::Sender>, n_tasks: usize, n_connections: usize, n_http2_parallel: usize, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work(client, report_tx, n_tasks, n_connections, n_http2_parallel).await; return; } use std::sync::atomic::{AtomicUsize, Ordering}; let counter = Arc::new(AtomicUsize::new(0)); match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); tokio::spawn(async move { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http2_parallel) .map(|_| { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; tokio::spawn(async move { while counter.fetch_add(1, Ordering::Relaxed) < n_tasks { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, None, ) .await; if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { return; } } Err(err) => { if counter.fetch_add(1, Ordering::Relaxed) < n_tasks { report_tx.send(Err(err)).unwrap(); } else { return; } } } } }) }) .collect::>(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); tokio::spawn(async move { let mut client_state = ClientStateHttp1::default(); while counter.fetch_add(1, Ordering::Relaxed) < n_tasks { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel { break; } } }) }) .collect::>(); for f in futures { let _ = f.await; } } }; } /// n tasks by m workers limit to qps works in a second pub async fn work_with_qps( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, n_tasks: usize, n_connections: usize, n_http_parallel: usize, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work_with_qps( client, report_tx, query_limit, n_tasks, n_connections, n_http_parallel, ) .await; return; } let (tx, rx) = kanal::unbounded::<()>(); let work_queue = async move { match query_limit { QueryLimit::Qps(qps) => { let start = std::time::Instant::now(); for i in 0..n_tasks { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; tx.send(())?; } } QueryLimit::Burst(duration, rate) => { let mut n = 0; // Handle via rate till n_tasks out of bound while n + rate < n_tasks { tokio::time::sleep(duration).await; for _ in 0..rate { tx.send(())?; } n += rate; } // Handle the remaining tasks if n_tasks > n { tokio::time::sleep(duration).await; for _ in 0..n_tasks - n { tx.send(())?; } } } } // tx gone drop(tx); Ok::<(), kanal::SendError>(()) }; let rx = rx.to_async(); match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); tokio::spawn(async move { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http_parallel) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; tokio::spawn(async move { while let Ok(()) = rx.recv().await { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, None, ) .await; if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { return; } } Err(err) => { // Consume a task if let Ok(()) = rx.recv().await { report_tx.send(Err(err)).unwrap(); } else { return; } } } } }) }) .collect::>(); work_queue.await.unwrap(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); tokio::spawn(async move { let mut client_state = ClientStateHttp1::default(); while let Ok(()) = rx.recv().await { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel { break; } } }) }) .collect::>(); work_queue.await.unwrap(); for f in futures { let _ = f.await; } } }; } /// n tasks by m workers limit to qps works in a second with latency correction pub async fn work_with_qps_latency_correction( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, n_tasks: usize, n_connections: usize, n_http2_parallel: usize, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work_with_qps_latency_correction( client, report_tx, query_limit, n_tasks, n_connections, n_http2_parallel, ) .await; return; } let (tx, rx) = kanal::unbounded(); let work_queue = async move { match query_limit { QueryLimit::Qps(qps) => { let start = std::time::Instant::now(); for i in 0..n_tasks { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let now = std::time::Instant::now(); tx.send(now)?; } } QueryLimit::Burst(duration, rate) => { let mut n = 0; // Handle via rate till n_tasks out of bound while n + rate < n_tasks { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); for _ in 0..rate { tx.send(now)?; } n += rate; } // Handle the remaining tasks if n_tasks > n { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); for _ in 0..n_tasks - n { tx.send(now)?; } } } } // tx gone drop(tx); Ok::<(), kanal::SendError>(()) }; let rx = rx.to_async(); match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); tokio::spawn(async move { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http2_parallel) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; tokio::spawn(async move { while let Ok(start) = rx.recv().await { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, Some(start), ) .await; if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { return; } } Err(err) => { // Consume a task if rx.recv().await.is_ok() { report_tx.send(Err(err)).unwrap(); } else { return; } } } } }) }) .collect::>(); work_queue.await.unwrap(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let futures = (0..n_connections) .map(|_| { let client = client.clone(); let mut client_state = ClientStateHttp1::default(); let report_tx = report_tx.clone(); let rx = rx.clone(); tokio::spawn(async move { while let Ok(start) = rx.recv().await { let mut res = client.work_http1(&mut client_state).await; set_start_latency_correction(&mut res, start); let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel { break; } } }) }) .collect::>(); work_queue.await.unwrap(); for f in futures { let _ = f.await; } } } } /// Run until dead_line by n workers pub async fn work_until( client: Arc, report_tx: kanal::Sender>, dead_line: std::time::Instant, n_connections: usize, n_http_parallel: usize, wait_ongoing_requests_after_deadline: bool, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work_until( client, report_tx, dead_line, n_connections, n_http_parallel, wait_ongoing_requests_after_deadline, ) .await; return; } match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { // Using semaphore to control the deadline // Maybe there is a better concurrent primitive to do this let s = Arc::new(tokio::sync::Semaphore::new(0)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let s = s.clone(); tokio::spawn(async move { let s = s.clone(); // Keep trying to establish or re-establish connections up to the deadline let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { // Setup the parallel workers for each HTTP2 connection let futures = (0..n_http_parallel) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; let s = s.clone(); tokio::spawn(async move { // This is where HTTP2 loops to make all the requests for a given client and worker loop { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, None, ) .await; let is_cancel = is_cancel || s.is_closed(); if is_cancel || is_reconnect { break is_cancel; } } }) }) .collect::>(); let mut connection_gone = false; for f in futures { tokio::select! { r = f => { match r { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } _ = s.acquire() => { report_tx.send(Err(ClientError::Deadline)).unwrap(); connection_gone = true; } } } if connection_gone { return; } } Err(err) => { report_tx.send(Err(err)).unwrap(); if s.is_closed() { break; } } } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; s.close(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let is_end = Arc::new(AtomicBool::new(false)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let mut client_state = ClientStateHttp1::default(); let is_end = is_end.clone(); tokio::spawn(async move { loop { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel || is_end.load(Relaxed) { break; } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; is_end.store(true, Relaxed); if wait_ongoing_requests_after_deadline { for f in futures { let _ = f.await; } } else { for f in futures { f.abort(); if let Err(e) = f.await { if e.is_cancelled() { report_tx.send(Err(ClientError::Deadline)).unwrap(); } } } } } }; } /// Run until dead_line by n workers limit to qps works in a second #[allow(clippy::too_many_arguments)] pub async fn work_until_with_qps( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, start: std::time::Instant, dead_line: std::time::Instant, n_connections: usize, n_http2_parallel: usize, wait_ongoing_requests_after_deadline: bool, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work_until_with_qps( client, report_tx, query_limit, start, dead_line, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; return; } let rx = match query_limit { QueryLimit::Qps(qps) => { let (tx, rx) = kanal::unbounded::<()>(); tokio::spawn(async move { for i in 0.. { if std::time::Instant::now() > dead_line { break; } tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let _ = tx.send(()); } // tx gone }); rx } QueryLimit::Burst(duration, rate) => { let (tx, rx) = kanal::unbounded(); tokio::spawn(async move { // Handle via rate till deadline is reached for _ in 0.. { if std::time::Instant::now() > dead_line { break; } tokio::time::sleep(duration).await; for _ in 0..rate { let _ = tx.send(()); } } // tx gone }); rx } }; let rx = rx.to_async(); match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { let s = Arc::new(tokio::sync::Semaphore::new(0)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let rx = rx.clone(); let s = s.clone(); tokio::spawn(async move { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http2_parallel) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let rx = rx.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; let s = s.clone(); tokio::spawn(async move { while let Ok(()) = rx.recv().await { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, None, ) .await; let is_cancel = is_cancel || s.is_closed(); if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); let mut connection_gone = false; for f in futures { tokio::select! { r = f => { match r { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } _ = s.acquire() => { report_tx.send(Err(ClientError::Deadline)).unwrap(); connection_gone = true; } } } if connection_gone { return; } } Err(err) => { // Consume a task if rx.recv().await.is_ok() { report_tx.send(Err(err)).unwrap(); } else { return; } if s.is_closed() { return; } } } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; s.close(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let is_end = Arc::new(AtomicBool::new(false)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let mut client_state = ClientStateHttp1::default(); let report_tx = report_tx.clone(); let rx = rx.clone(); let is_end = is_end.clone(); tokio::spawn(async move { while let Ok(()) = rx.recv().await { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel || is_end.load(Relaxed) { break; } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; is_end.store(true, Relaxed); if wait_ongoing_requests_after_deadline { for f in futures { let _ = f.await; } } else { for f in futures { f.abort(); if let Err(e) = f.await { if e.is_cancelled() { report_tx.send(Err(ClientError::Deadline)).unwrap(); } } } } } } } /// Run until dead_line by n workers limit to qps works in a second with latency correction #[allow(clippy::too_many_arguments)] pub async fn work_until_with_qps_latency_correction( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, start: std::time::Instant, dead_line: std::time::Instant, n_connections: usize, n_http2_parallel: usize, wait_ongoing_requests_after_deadline: bool, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::work_until_with_qps_latency_correction( client, report_tx, query_limit, start, dead_line, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; return; } let (tx, rx) = kanal::unbounded(); match query_limit { QueryLimit::Qps(qps) => { tokio::spawn(async move { for i in 0.. { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let now = std::time::Instant::now(); if now > dead_line { break; } let _ = tx.send(now); } // tx gone }); } QueryLimit::Burst(duration, rate) => { tokio::spawn(async move { // Handle via rate till deadline is reached loop { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); if now > dead_line { break; } for _ in 0..rate { let _ = tx.send(now); } } // tx gone }); } }; let rx = rx.to_async(); match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { let s = Arc::new(tokio::sync::Semaphore::new(0)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let rx = rx.clone(); let s = s.clone(); tokio::spawn(async move { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http2_parallel) .map(|_| { let client = client.clone(); let report_tx = report_tx.clone(); let rx = rx.clone(); let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; let s = s.clone(); tokio::spawn(async move { while let Ok(start) = rx.recv().await { let (is_cancel, is_reconnect) = work_http2_once( &client, &mut client_state, &report_tx, connection_time, Some(start), ) .await; let is_cancel = is_cancel || s.is_closed(); if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); let mut connection_gone = false; for f in futures { tokio::select! { r = f => { match r { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } _ = s.acquire() => { report_tx.send(Err(ClientError::Deadline)).unwrap(); connection_gone = true; } } } if connection_gone { return; } } Err(err) => { if rx.recv().await.is_ok() { report_tx.send(Err(err)).unwrap(); } else { return; } if s.is_closed() { return; } } } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; s.close(); for f in futures { let _ = f.await; } } HttpWorkType::H1 => { let is_end = Arc::new(AtomicBool::new(false)); let futures = (0..n_connections) .map(|_| { let client = client.clone(); let mut client_state = ClientStateHttp1::default(); let report_tx = report_tx.clone(); let rx = rx.clone(); let is_end = is_end.clone(); tokio::spawn(async move { while let Ok(start) = rx.recv().await { let mut res = client.work_http1(&mut client_state).await; set_start_latency_correction(&mut res, start); let is_cancel = is_cancel_error(&res); report_tx.send(res).unwrap(); if is_cancel || is_end.load(Relaxed) { break; } } }) }) .collect::>(); tokio::time::sleep_until(dead_line.into()).await; is_end.store(true, Relaxed); if wait_ongoing_requests_after_deadline { for f in futures { let _ = f.await; } } else { for f in futures { f.abort(); if let Err(e) = f.await { if e.is_cancelled() { report_tx.send(Err(ClientError::Deadline)).unwrap(); } } } } } } } /// Optimized workers for `--no-tui` mode pub mod fast { use std::sync::{ Arc, atomic::{AtomicBool, AtomicIsize, Ordering}, }; use rand::SeedableRng; use crate::{ client::{ ClientError, ClientStateHttp1, ClientStateHttp2, HttpWorkType, is_cancel_error, is_hyper_error, set_connection_time, setup_http2, }, pcg64si::Pcg64Si, result_data::ResultData, }; use super::Client; /// Run n tasks by m workers pub async fn work( client: Arc, report_tx: kanal::Sender, n_tasks: usize, n_connections: usize, n_http_parallel: usize, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::fast::work( client, report_tx, n_tasks, n_connections, n_http_parallel, ) .await; return; } let counter = Arc::new(AtomicIsize::new(n_tasks as isize)); let num_threads = num_cpus::get_physical(); let connections = (0..num_threads).filter_map(|i| { let num_connection = n_connections / num_threads + (if (n_connections % num_threads) > i { 1 } else { 0 }); if num_connection > 0 { Some(num_connection) } else { None } }); let token = tokio_util::sync::CancellationToken::new(); let handles = match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { connections .map(|num_connections| { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); std::thread::spawn(move || { let client = client.clone(); let local = tokio::task::LocalSet::new(); for _ in 0..num_connections { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); let token = token.clone(); local.spawn_local(Box::pin(async move { let mut has_err = false; let mut result_data_err = ResultData::default(); let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { let client = client.clone(); match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http_parallel) .map(|_| { let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng( &mut rand::rng(), ), send_request: send_request.clone(), }; let counter = counter.clone(); let client = client.clone(); let report_tx = report_tx.clone(); let token = token.clone(); tokio::task::spawn_local(async move { let mut result_data = ResultData::default(); let work = async { while counter .fetch_sub(1, Ordering::Relaxed) > 0 { let mut res = client .work_http2( &mut client_state, ) .await; let is_cancel = is_cancel_error(&res); let is_reconnect = is_hyper_error(&res); set_connection_time( &mut res, connection_time, ); result_data.push(res); if is_cancel || is_reconnect { return is_cancel; } } true }; let is_cancel = tokio::select! { is_cancel = work => { is_cancel } _ = token.cancelled() => { true } }; report_tx.send(result_data).unwrap(); is_cancel }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { break; } } Err(err) => { if counter.fetch_sub(1, Ordering::Relaxed) > 0 { has_err = true; result_data_err.push(Err(err)); } else { break; } } } } if has_err { report_tx.send(result_data_err).unwrap(); } })); } rt.block_on(local); }) }) .collect::>() } HttpWorkType::H1 => connections .map(|num_connection| { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); std::thread::spawn(move || { let local = tokio::task::LocalSet::new(); for _ in 0..num_connection { let report_tx = report_tx.clone(); let counter = counter.clone(); let client = client.clone(); let token = token.clone(); local.spawn_local(Box::pin(async move { let mut result_data = ResultData::default(); tokio::select! { _ = token.cancelled() => {} _ = async { let mut client_state = ClientStateHttp1::default(); while counter.fetch_sub(1, Ordering::Relaxed) > 0 { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); result_data.push(res); if is_cancel { break; } } } => {} } report_tx.send(result_data).unwrap(); })); } rt.block_on(local); }) }) .collect::>(), }; tokio::spawn(async move { tokio::signal::ctrl_c().await.unwrap(); token.cancel(); }); tokio::task::block_in_place(|| { for handle in handles { let _ = handle.join(); } }); } /// Run until dead_line by n workers pub async fn work_until( client: Arc, report_tx: kanal::Sender, dead_line: std::time::Instant, n_connections: usize, n_http_parallel: usize, wait_ongoing_requests_after_deadline: bool, ) { #[cfg(feature = "http3")] if matches!(client.work_type(), HttpWorkType::H3) { crate::client_h3::fast::work_until( client, report_tx, dead_line, n_connections, n_http_parallel, wait_ongoing_requests_after_deadline, ) .await; return; } let num_threads = num_cpus::get_physical(); let is_end = Arc::new(AtomicBool::new(false)); let connections = (0..num_threads).filter_map(|i| { let num_connection = n_connections / num_threads + (if (n_connections % num_threads) > i { 1 } else { 0 }); if num_connection > 0 { Some(num_connection) } else { None } }); let token = tokio_util::sync::CancellationToken::new(); let handles = match client.work_type() { #[cfg(feature = "http3")] HttpWorkType::H3 => unreachable!(), HttpWorkType::H2 => { connections .map(|num_connections| { let report_tx = report_tx.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); let is_end = is_end.clone(); std::thread::spawn(move || { let client = client.clone(); let local = tokio::task::LocalSet::new(); for _ in 0..num_connections { let report_tx = report_tx.clone(); let client = client.clone(); let token = token.clone(); let is_end = is_end.clone(); local.spawn_local(Box::pin(async move { let mut has_err = false; let mut result_data_err = ResultData::default(); let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { let client = client.clone(); match setup_http2(&client, &mut rng).await { Ok((connection_time, send_request)) => { let futures = (0..n_http_parallel) .map(|_| { let mut client_state = ClientStateHttp2 { rng: SeedableRng::from_rng(&mut rand::rng()), send_request: send_request.clone(), }; let client = client.clone(); let report_tx = report_tx.clone(); let token = token.clone(); let is_end = is_end.clone(); tokio::task::spawn_local(async move { let mut result_data = ResultData::default(); let work = async { loop { let mut res = client .work_http2(&mut client_state) .await; let is_cancel = is_cancel_error(&res) || is_end.load(Ordering::Relaxed); let is_reconnect = is_hyper_error(&res); set_connection_time( &mut res, connection_time, ); result_data.push(res); if is_cancel || is_reconnect { return is_cancel; } } }; let is_cancel = tokio::select! { is_cancel = work => { is_cancel } _ = token.cancelled() => { result_data.push(Err(ClientError::Deadline)); true } }; report_tx.send(result_data).unwrap(); is_cancel }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { break; } } Err(err) => { has_err = true; result_data_err.push(Err(err)); if is_end.load(Ordering::Relaxed) { break; } } } } if has_err { report_tx.send(result_data_err).unwrap(); } })); } rt.block_on(local); }) }) .collect::>() } HttpWorkType::H1 => connections .map(|num_connection| { let report_tx = report_tx.clone(); let is_end = is_end.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); std::thread::spawn(move || { let local = tokio::task::LocalSet::new(); for _ in 0..num_connection { let report_tx = report_tx.clone(); let is_end = is_end.clone(); let client = client.clone(); let token = token.clone(); local.spawn_local(Box::pin(async move { let mut result_data = ResultData::default(); let work = async { let mut client_state = ClientStateHttp1::default(); loop { let res = client.work_http1(&mut client_state).await; let is_cancel = is_cancel_error(&res); result_data.push(res); if is_cancel || is_end.load(Ordering::Relaxed) { break; } } }; tokio::select! { _ = work => { } _ = token.cancelled() => { result_data.push(Err(ClientError::Deadline)); } } report_tx.send(result_data).unwrap(); })); } rt.block_on(local); }) }) .collect::>(), }; tokio::select! { _ = tokio::time::sleep_until(dead_line.into()) => { } _ = tokio::signal::ctrl_c() => { } } is_end.store(true, Ordering::Relaxed); if !wait_ongoing_requests_after_deadline { token.cancel(); } tokio::task::block_in_place(|| { for handle in handles { let _ = handle.join(); } }); } } ================================================ FILE: src/client_h3.rs ================================================ use bytes::Buf; use bytes::Bytes; use core::sync::atomic::Ordering; use http::Request; use http_body_util::BodyExt; use hyper::http; use kanal::AsyncReceiver; use quinn::default_runtime; use std::net::SocketAddr; use std::net::UdpSocket; use std::sync::Arc; use std::sync::atomic::AtomicBool; use std::sync::atomic::AtomicIsize; use std::time::Instant; use tokio::sync::Semaphore; use url::Url; pub type SendRequestHttp3 = ( h3::client::Connection, h3::client::SendRequest, ); // HTTP3-specific error types #[derive(thiserror::Error, Debug)] pub enum Http3Error { #[error("QUIC Client: {0}")] QuicClientConfig(#[from] quinn::crypto::rustls::NoInitialCipherSuite), #[error("QUIC connect: {0}")] QuicConnect(#[from] quinn::ConnectError), #[error("QUIC connection: {0}")] QuicConnection(#[from] quinn::ConnectionError), #[error("Quic connection closed earlier than expected")] QuicDriverClosedEarly(#[from] tokio::sync::oneshot::error::RecvError), #[error("HTTP3 connection: {0}")] H3Connection(#[from] h3::error::ConnectionError), #[error("HTTP3 Stream: {0}")] H3Stream(#[from] h3::error::StreamError), } use crate::client::QueryLimit; use crate::client::{ Client, ClientError, ConnectionTime, RequestResult, Stream, is_cancel_error, set_connection_time, set_start_latency_correction, }; use crate::pcg64si::Pcg64Si; use crate::result_data::ResultData; use rand::SeedableRng; use rand::prelude::Rng; pub(crate) struct ClientStateHttp3 { pub(crate) rng: Pcg64Si, pub(crate) send_request: h3::client::SendRequest, } impl ClientStateHttp3 { fn new(send_request: h3::client::SendRequest) -> Self { Self { rng: SeedableRng::from_rng(&mut rand::rng()), send_request, } } } impl Client { pub(crate) async fn connect_http3( &self, url: &Url, rng: &mut R, ) -> Result<(ConnectionTime, SendRequestHttp3), ClientError> { let start = std::time::Instant::now(); let (dns_lookup, stream) = self.client(url, rng, http::Version::HTTP_3).await?; let send_request = stream.handshake_http3().await?; let dialup = std::time::Instant::now(); Ok(( ConnectionTime { dns_lookup: dns_lookup - start, dialup: dialup - start, }, send_request, )) } pub(crate) async fn quic_client( &self, addr: (std::net::IpAddr, u16), url: &Url, ) -> Result { let endpoint_config = h3_quinn::quinn::EndpointConfig::default(); let local_socket = if addr.0.is_ipv6() { UdpSocket::bind("[::]:0").expect("couldn't bind to address") } else { UdpSocket::bind("0.0.0.0:0").expect("couldn't bind to address") }; // If we can set the right build flags, we can use `h3_quinn::quinn::Endpoint::client` instead let mut client_endpoint = h3_quinn::quinn::Endpoint::new( endpoint_config, None, local_socket, default_runtime().unwrap(), ) .unwrap(); let tls_config = self.rustls_configs.config(http::Version::HTTP_3).clone(); let client_config = quinn::ClientConfig::new(Arc::new( quinn::crypto::rustls::QuicClientConfig::try_from(tls_config) .map_err(Http3Error::from)?, )); client_endpoint.set_default_client_config(client_config); let remote_socket_address = SocketAddr::new(addr.0, addr.1); let server_name = url.host_str().ok_or(ClientError::HostNotFound)?; let conn = client_endpoint .connect(remote_socket_address, server_name) .map_err(Http3Error::from)? .await .map_err(Http3Error::from)?; Ok(Stream::Quic(conn)) } pub(crate) async fn work_http3( &self, client_state: &mut ClientStateHttp3, ) -> Result { let do_req = async { let (_url, request, rng) = self.generate_request(&mut client_state.rng)?; let start = std::time::Instant::now(); let connection_time: Option = None; let mut first_byte: Option = None; // if we implement http_body::Body on our H3 SendRequest, we can do some nice streaming stuff // with the response here. However as we don't really use the response we can get away // with not doing this for now let (head, mut req_body) = request.into_parts(); let request = http::request::Request::from_parts(head, ()); let mut stream = client_state .send_request .send_request(request) .await .map_err(Http3Error::from)?; // send the request body now if let Some(Ok(frame)) = req_body.frame().await { if let Ok(data) = frame.into_data() { stream.send_data(data).await.map_err(Http3Error::from)?; } } stream.finish().await.map_err(Http3Error::from)?; // now read the response headers let response = stream.recv_response().await.map_err(Http3Error::from)?; let (parts, _) = response.into_parts(); let status = parts.status; // now read the response body let mut len_bytes = 0; while let Some(chunk) = stream.recv_data().await.map_err(Http3Error::from)? { if first_byte.is_none() { first_byte = Some(std::time::Instant::now()) } len_bytes += chunk.remaining(); } let end = std::time::Instant::now(); let result = RequestResult { rng, start_latency_correction: None, start, first_byte, end, status, len_bytes, connection_time, }; Ok::<_, ClientError>(result) }; if let Some(timeout) = self.timeout { tokio::select! { res = do_req => { res } _ = tokio::time::sleep(timeout) => { Err(ClientError::Timeout) } } } else { do_req.await } } } impl Stream { async fn handshake_http3(self) -> Result { let Stream::Quic(quic_conn) = self else { panic!("You cannot call http3 handshake on a non-quic stream"); }; let h3_quinn_conn = h3_quinn::Connection::new(quic_conn); // TODO add configuration settings to allow 'send_grease' etc. Ok(h3::client::new(h3_quinn_conn).await?) } } pub(crate) async fn send_debug_request_http3( h3_connection: h3::client::Connection, mut client_state: h3::client::SendRequest, request: Request>, ) -> Result, Http3Error> { // Prepare a channel to stop the driver thread let (shutdown_tx, shutdown_rx) = tokio::sync::oneshot::channel(); // Run the driver let http3_driver = spawn_http3_driver(h3_connection, shutdown_rx); let (head, mut req_body) = request.into_parts(); let request = http::request::Request::from_parts(head, ()); let mut stream = client_state.send_request(request).await?; if let Some(Ok(frame)) = req_body.frame().await { if let Ok(data) = frame.into_data() { stream.send_data(data).await?; } } stream.finish().await?; let response = stream.recv_response().await.unwrap_or_else(|err| { panic!("{}", err); }); let mut body_bytes = bytes::BytesMut::new(); while let Some(mut chunk) = stream.recv_data().await? { let bytes = chunk.copy_to_bytes(chunk.remaining()); body_bytes.extend_from_slice(&bytes); } let body = body_bytes.freeze(); let (parts, _) = response.into_parts(); let _ = shutdown_tx.send(()); let _ = http3_driver.await.unwrap(); Ok(http::Response::from_parts(parts, body)) } /** * Create `n_connections` parallel HTTP3 connections (on independent QUIC connections). * On each of those, run `n_http3_parallel` requests continuously until `deadline` is reached. */ pub(crate) async fn parallel_work_http3( n_connections: usize, n_http_parallel: usize, rx: AsyncReceiver>, report_tx: kanal::Sender>, client: Arc, deadline: Option, ) -> Vec> { let s = Arc::new(tokio::sync::Semaphore::new(0)); let has_deadline = deadline.is_some(); let futures = (0..n_connections) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); let s = s.clone(); tokio::spawn(create_and_load_up_single_connection_http3( n_http_parallel, rx, report_tx, client, s, )) }) .collect::>(); if has_deadline { tokio::time::sleep_until(deadline.unwrap().into()).await; s.close(); } futures } /** * For use in the 'slow' functions - send a report of every response in real time for display to the end-user. * Semaphore is closed to shut down all the tasks. * Very similar to how http2 loops work, just that we explicitly spawn the HTTP3 connection driver. */ async fn create_and_load_up_single_connection_http3( n_http_parallel: usize, rx: AsyncReceiver>, report_tx: kanal::Sender>, client: Arc, s: Arc, ) { let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { // create a HTTP3 connection match setup_http3(&client, &mut rng).await { Ok((connection_time, (h3_connection, send_request))) => { let (shutdown_tx, shutdown_rx) = tokio::sync::oneshot::channel(); let http3_driver = spawn_http3_driver(h3_connection, shutdown_rx); let futures = (0..n_http_parallel) .map(|_| { let report_tx = report_tx.clone(); let rx = rx.clone(); let client = client.clone(); let mut client_state = ClientStateHttp3::new(send_request.clone()); let s = s.clone(); tokio::spawn(async move { // This is where HTTP3 loops to make all the requests for a given client and worker while let Ok(start_time_option) = rx.recv().await { let (is_cancel, is_reconnect) = work_http3_once( &client, &mut client_state, &report_tx, connection_time, start_time_option, ) .await; let is_cancel = is_cancel || s.is_closed(); if is_cancel || is_reconnect { return is_cancel; } } true }) }) .collect::>(); drop(send_request); // collect all the requests we have spawned, and end the process if/when the semaphore says let mut connection_gone = false; for f in futures { tokio::select! { r = f => { match r { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } _ = s.acquire() => { report_tx.send(Err(ClientError::Deadline)).unwrap(); connection_gone = true; } } } if connection_gone { // Try and politely shut down the HTTP3 connection let _ = shutdown_tx.send(()); let _ = http3_driver.await; return; } } Err(err) => { if s.is_closed() { break; // Consume a task } else if rx.recv().await.is_ok() { report_tx.send(Err(err)).unwrap(); } else { return; } } } } } /** * This is structured to work very similarly to the `setup_http2` * function in `client.rs` */ pub(crate) async fn setup_http3( client: &Client, rng: &mut R, ) -> Result<(ConnectionTime, SendRequestHttp3), ClientError> { let url = client.request_generator.url_generator.generate(rng)?; // Whatever rng state, all urls should have the same authority let (connection_time, send_request) = client.connect_http3(&url, rng).await?; Ok((connection_time, send_request)) } pub(crate) fn spawn_http3_driver( mut h3_connection: h3::client::Connection, shutdown_rx: tokio::sync::oneshot::Receiver<()>, ) -> tokio::task::JoinHandle> { tokio::spawn(async move { tokio::select! { // Drive the connection closed = std::future::poll_fn(|cx| h3_connection.poll_close(cx)) => { if closed.is_h3_no_error() { Ok(()) } else { Err(Http3Error::H3Connection(closed)) } }, // Listen for shutdown condition _ = shutdown_rx => { // Initiate shutdown h3_connection.shutdown(0).await?; // Wait for ongoing work to complete let closed = std::future::poll_fn(|cx| h3_connection.poll_close(cx)).await; if closed.is_h3_no_error() { Ok(()) } else { Err(Http3Error::H3Connection(closed)) } } } }) } pub(crate) async fn work_http3_once( client: &Client, client_state: &mut ClientStateHttp3, report_tx: &kanal::Sender>, connection_time: ConnectionTime, start_latency_correction: Option, ) -> (bool, bool) { let mut res = client.work_http3(client_state).await; let is_cancel = is_cancel_error(&res); let is_reconnect = is_h3_error(&res); set_connection_time(&mut res, connection_time); if let Some(start_latency_correction) = start_latency_correction { set_start_latency_correction(&mut res, start_latency_correction); } report_tx.send(res).unwrap(); (is_cancel, is_reconnect) } fn is_h3_error(res: &Result) -> bool { res.as_ref() .err() .map(|err| matches!(err, ClientError::Http3(_) | ClientError::Io(_))) .unwrap_or(false) } /** * 'Fast' implementation of HTTP3 load generation. * If `n_tasks` is set, it will generate up to that many tasks. * Othrwise it will terminate when `is_end` becomes set to true. */ #[allow(clippy::too_many_arguments)] pub(crate) fn http3_connection_fast_work_until( num_connections: usize, n_http_parallel: usize, report_tx: kanal::Sender, client: Arc, token: tokio_util::sync::CancellationToken, counter: Option>, is_end: Arc, rt: tokio::runtime::Runtime, ) { let is_counting_tasks = counter.is_some(); let client = client.clone(); let local = tokio::task::LocalSet::new(); for _ in 0..num_connections { let report_tx = report_tx.clone(); let client = client.clone(); let token = token.clone(); let is_end = is_end.clone(); let counter = counter.clone(); local.spawn_local(Box::pin(async move { let mut has_err = false; let mut result_data_err = ResultData::default(); let mut rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); loop { let client = client.clone(); match setup_http3(&client, &mut rng).await { Ok((connection_time, (h3_connection, send_request))) => { let (shutdown_tx, shutdown_rx) = tokio::sync::oneshot::channel(); let http3_driver = spawn_http3_driver(h3_connection, shutdown_rx); let futures = (0..n_http_parallel) .map(|_| { let mut client_state = ClientStateHttp3::new(send_request.clone()); let client = client.clone(); let report_tx = report_tx.clone(); let token = token.clone(); let is_end = is_end.clone(); let counter = counter.clone(); tokio::task::spawn_local(async move { let mut result_data = ResultData::default(); let work = async { loop { if is_counting_tasks && counter .as_ref() .unwrap() .fetch_sub(1, Ordering::Relaxed) <= 0 { return true; } let mut res = client.work_http3(&mut client_state).await; let is_cancel = is_cancel_error(&res) || is_end.load(Ordering::Relaxed); let is_reconnect = is_h3_error(&res); set_connection_time(&mut res, connection_time); result_data.push(res); if is_cancel || is_reconnect { return is_cancel; } } }; let is_cancel = tokio::select! { is_cancel = work => { is_cancel } _ = token.cancelled() => { result_data.push(Err(ClientError::Deadline)); true } }; report_tx.send(result_data).unwrap(); is_cancel }) }) .collect::>(); let mut connection_gone = false; for f in futures { match f.await { Ok(true) => { // All works done connection_gone = true; } Err(_) => { // Unexpected connection_gone = true; } _ => {} } } if connection_gone { let _ = shutdown_tx.send(()); let _ = http3_driver.await; break; } } Err(err) => { has_err = true; result_data_err.push(Err(err)); if is_end.load(Ordering::Relaxed) || (is_counting_tasks && counter.as_ref().unwrap().fetch_sub(1, Ordering::Relaxed) <= 0) { break; } } } } if has_err { report_tx.send(result_data_err).unwrap(); } })); } rt.block_on(local); } /// Work function for HTTP3 client that generates `n_tasks` tasks. pub async fn work( client: Arc, report_tx: kanal::Sender>, n_tasks: usize, n_connections: usize, n_http2_parallel: usize, ) { let (tx, rx) = kanal::unbounded::>(); let rx = rx.to_async(); let n_tasks_emitter = async move { for _ in 0..n_tasks { tx.send(None)? } drop(tx); Ok::<(), kanal::SendError>(()) }; let futures = parallel_work_http3(n_connections, n_http2_parallel, rx, report_tx, client, None).await; n_tasks_emitter.await.unwrap(); for f in futures { let _ = f.await; } } /// n tasks by m workers limit to qps works in a second pub async fn work_with_qps( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, n_tasks: usize, n_connections: usize, n_http_parallel: usize, ) { let (tx, rx) = kanal::unbounded::>(); let work_queue = async move { match query_limit { QueryLimit::Qps(qps) => { let start = std::time::Instant::now(); for i in 0..n_tasks { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; tx.send(None)?; } } QueryLimit::Burst(duration, rate) => { let mut n = 0; // Handle via rate till n_tasks out of bound while n + rate < n_tasks { tokio::time::sleep(duration).await; for _ in 0..rate { tx.send(None)?; } n += rate; } // Handle the remaining tasks if n_tasks > n { tokio::time::sleep(duration).await; for _ in 0..n_tasks - n { tx.send(None)?; } } } } // tx gone drop(tx); Ok::<(), kanal::SendError>(()) }; let rx = rx.to_async(); let futures = parallel_work_http3(n_connections, n_http_parallel, rx, report_tx, client, None).await; work_queue.await.unwrap(); for f in futures { let _ = f.await; } } /// n tasks by m workers limit to qps works in a second with latency correction pub async fn work_with_qps_latency_correction( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, n_tasks: usize, n_connections: usize, n_http2_parallel: usize, ) { let (tx, rx) = kanal::unbounded(); let _work_queue = async move { match query_limit { QueryLimit::Qps(qps) => { let start = std::time::Instant::now(); for i in 0..n_tasks { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let now = std::time::Instant::now(); tx.send(Some(now))?; } } QueryLimit::Burst(duration, rate) => { let mut n = 0; // Handle via rate till n_tasks out of bound while n + rate < n_tasks { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); for _ in 0..rate { tx.send(Some(now))?; } n += rate; } // Handle the remaining tasks if n_tasks > n { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); for _ in 0..n_tasks - n { tx.send(Some(now))?; } } } } // tx gone drop(tx); Ok::<(), kanal::SendError>(()) }; let rx = rx.to_async(); let futures = parallel_work_http3(n_connections, n_http2_parallel, rx, report_tx, client, None).await; for f in futures { let _ = f.await; } } /// Run until dead_line by n workers pub async fn work_until( client: Arc, report_tx: kanal::Sender>, dead_line: std::time::Instant, n_connections: usize, n_http_parallel: usize, _wait_ongoing_requests_after_deadline: bool, ) { let (tx, rx) = kanal::bounded_async::>(5000); // This emitter is used for H3 to give it unlimited tokens to emit work. let cancel_token = tokio_util::sync::CancellationToken::new(); let emitter_handle = endless_emitter(cancel_token.clone(), tx).await; let futures = parallel_work_http3( n_connections, n_http_parallel, rx, report_tx.clone(), client.clone(), Some(dead_line), ) .await; for f in futures { let _ = f.await; } // Cancel the emitter when we're done with the futures cancel_token.cancel(); // Wait for the emitter to exit cleanly let _ = emitter_handle.await; } /// Run until dead_line by n workers limit to qps works in a second #[allow(clippy::too_many_arguments)] pub async fn work_until_with_qps( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, start: std::time::Instant, dead_line: std::time::Instant, n_connections: usize, n_http2_parallel: usize, _wait_ongoing_requests_after_deadline: bool, ) { let rx = match query_limit { QueryLimit::Qps(qps) => { let (tx, rx) = kanal::unbounded::>(); tokio::spawn(async move { for i in 0.. { if std::time::Instant::now() > dead_line { break; } tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let _ = tx.send(None); } // tx gone }); rx } QueryLimit::Burst(duration, rate) => { let (tx, rx) = kanal::unbounded(); tokio::spawn(async move { // Handle via rate till deadline is reached for _ in 0.. { if std::time::Instant::now() > dead_line { break; } tokio::time::sleep(duration).await; for _ in 0..rate { let _ = tx.send(None); } } // tx gone }); rx } }; let rx = rx.to_async(); let futures = parallel_work_http3( n_connections, n_http2_parallel, rx, report_tx, client, Some(dead_line), ) .await; for f in futures { let _ = f.await; } } /// Run until dead_line by n workers limit to qps works in a second with latency correction #[allow(clippy::too_many_arguments)] pub async fn work_until_with_qps_latency_correction( client: Arc, report_tx: kanal::Sender>, query_limit: QueryLimit, start: std::time::Instant, dead_line: std::time::Instant, n_connections: usize, n_http2_parallel: usize, _wait_ongoing_requests_after_deadline: bool, ) { let (tx, rx) = kanal::unbounded(); match query_limit { QueryLimit::Qps(qps) => { tokio::spawn(async move { for i in 0.. { tokio::time::sleep_until( (start + std::time::Duration::from_secs_f64(i as f64 * 1f64 / qps)).into(), ) .await; let now = std::time::Instant::now(); if now > dead_line { break; } let _ = tx.send(Some(now)); } // tx gone }); } QueryLimit::Burst(duration, rate) => { tokio::spawn(async move { // Handle via rate till deadline is reached loop { tokio::time::sleep(duration).await; let now = std::time::Instant::now(); if now > dead_line { break; } for _ in 0..rate { let _ = tx.send(Some(now)); } } // tx gone }); } }; let rx = rx.to_async(); let futures = parallel_work_http3( n_connections, n_http2_parallel, rx, report_tx, client, Some(dead_line), ) .await; for f in futures { let _ = f.await; } } #[cfg(feature = "http3")] async fn endless_emitter( cancellation_token: tokio_util::sync::CancellationToken, tx: kanal::AsyncSender>, ) -> tokio::task::JoinHandle<()> { tokio::spawn(async move { loop { tokio::select! { _ = cancellation_token.cancelled() => { break; } _ = async { // As we our `work_http2_once` function is limited by the number of `tx` we send, but we only // want to stop when our semaphore is closed, just dump unlimited `Nones` into the tx to un-constrain it let _ = tx.send(None).await; } => {} } } }) } pub mod fast { use std::sync::{ Arc, atomic::{AtomicBool, AtomicIsize, Ordering}, }; use crate::{ client::Client, client_h3::http3_connection_fast_work_until, result_data::ResultData, }; /// Run n tasks by m workers pub async fn work( client: Arc, report_tx: kanal::Sender, n_tasks: usize, n_connections: usize, n_http_parallel: usize, ) { let counter = Arc::new(AtomicIsize::new(n_tasks as isize)); let num_threads = num_cpus::get_physical(); let connections = (0..num_threads).filter_map(|i| { let num_connection = n_connections / num_threads + (if (n_connections % num_threads) > i { 1 } else { 0 }); if num_connection > 0 { Some(num_connection) } else { None } }); let token = tokio_util::sync::CancellationToken::new(); let handles = connections .map(|num_connections| { let report_tx = report_tx.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); let counter = counter.clone(); // will let is_end just stay false permanently let is_end = Arc::new(AtomicBool::new(false)); std::thread::spawn(move || { http3_connection_fast_work_until( num_connections, n_http_parallel, report_tx, client, token, Some(counter), is_end, rt, ) }) }) .collect::>(); tokio::spawn(async move { tokio::signal::ctrl_c().await.unwrap(); token.cancel(); }); tokio::task::block_in_place(|| { for handle in handles { let _ = handle.join(); } }); } /// Run until dead_line by n workers pub async fn work_until( client: Arc, report_tx: kanal::Sender, dead_line: std::time::Instant, n_connections: usize, n_http_parallel: usize, wait_ongoing_requests_after_deadline: bool, ) { let num_threads = num_cpus::get_physical(); let is_end = Arc::new(AtomicBool::new(false)); let connections = (0..num_threads).filter_map(|i| { let num_connection = n_connections / num_threads + (if (n_connections % num_threads) > i { 1 } else { 0 }); if num_connection > 0 { Some(num_connection) } else { None } }); let token = tokio_util::sync::CancellationToken::new(); let handles = connections .map(|num_connections| { let report_tx = report_tx.clone(); let client = client.clone(); let rt = tokio::runtime::Builder::new_current_thread() .enable_all() .build() .unwrap(); let token = token.clone(); let is_end = is_end.clone(); std::thread::spawn(move || { http3_connection_fast_work_until( num_connections, n_http_parallel, report_tx, client, token, None, is_end, rt, ) }) }) .collect::>(); tokio::select! { _ = tokio::time::sleep_until(dead_line.into()) => { } _ = tokio::signal::ctrl_c() => { } } is_end.store(true, Ordering::Relaxed); if !wait_ongoing_requests_after_deadline { token.cancel(); } tokio::task::block_in_place(|| { for handle in handles { let _ = handle.join(); } }); } } ================================================ FILE: src/curl_compat.rs ================================================ //! Curl compatibility utilities use std::str::FromStr; pub struct Form { pub boundary: String, pub parts: Vec, } pub struct FormPart { pub name: String, pub filename: Option, pub content_type: Option, pub data: Vec, } impl Form { pub fn new() -> Self { Self { boundary: Self::generate_boundary(), parts: Vec::new(), } } pub fn add_part(&mut self, part: FormPart) { self.parts.push(part); } pub fn content_type(&self) -> String { format!("multipart/form-data; boundary={}", self.boundary) } pub fn body(&self) -> Vec { let mut body = Vec::new(); for part in &self.parts { // Add boundary separator body.extend_from_slice(b"--"); body.extend_from_slice(self.boundary.as_bytes()); body.extend_from_slice(b"\r\n"); // Add Content-Disposition header body.extend_from_slice(b"Content-Disposition: form-data; name=\""); body.extend_from_slice(part.name.as_bytes()); body.extend_from_slice(b"\""); // Add filename if present if let Some(filename) = &part.filename { body.extend_from_slice(b"; filename=\""); body.extend_from_slice(filename.as_bytes()); body.extend_from_slice(b"\""); } body.extend_from_slice(b"\r\n"); // Add Content-Type header if present if let Some(content_type) = &part.content_type { body.extend_from_slice(b"Content-Type: "); body.extend_from_slice(content_type.as_bytes()); body.extend_from_slice(b"\r\n"); } // Empty line before data body.extend_from_slice(b"\r\n"); // Add the actual data body.extend_from_slice(&part.data); body.extend_from_slice(b"\r\n"); } // Add final boundary body.extend_from_slice(b"--"); body.extend_from_slice(self.boundary.as_bytes()); body.extend_from_slice(b"--\r\n"); body } fn generate_boundary() -> String { let random_bytes: [u8; 16] = rand::random(); // Convert to hex string manually to avoid external hex dependency let hex_string = random_bytes .iter() .map(|b| format!("{b:02x}")) .collect::(); format!("----formdata-oha-{hex_string}") } } impl FromStr for FormPart { type Err = anyhow::Error; /// Parse curl's -F format string /// Supports formats like: /// - `name=value` /// - `name=@filename` (file upload with filename) /// - `name= Result { // Split on first '=' to separate name from value/options let (name, rest) = s .split_once('=') .ok_or_else(|| anyhow::anyhow!("Invalid form format: missing '=' in '{}'", s))?; let name = name.to_string(); // Parse the value part which may contain semicolon-separated options let parts: Vec<&str> = rest.split(';').collect(); let value_part = parts[0]; let mut filename = None; let mut content_type = None; let data; // Check if this is a file upload (@filename or { filename = Some(value.trim().to_string()); } "type" => { content_type = Some(value.trim().to_string()); } _ => { // Ignore unknown options for compatibility } } } } Ok(FormPart { name, filename, content_type, data, }) } } #[cfg(test)] mod tests { use super::*; #[test] fn test_parse_simple_field() { let part: FormPart = "name=value".parse().unwrap(); assert_eq!(part.name, "name"); assert_eq!(part.data, b"value"); assert_eq!(part.filename, None); assert_eq!(part.content_type, None); } #[test] fn test_parse_field_with_filename() { let part: FormPart = "upload=data;filename=test.txt".parse().unwrap(); assert_eq!(part.name, "upload"); assert_eq!(part.data, b"data"); assert_eq!(part.filename, Some("test.txt".to_string())); assert_eq!(part.content_type, None); } #[test] fn test_parse_field_with_type() { let part: FormPart = "data=content;type=text/plain".parse().unwrap(); assert_eq!(part.name, "data"); assert_eq!(part.data, b"content"); assert_eq!(part.filename, None); assert_eq!(part.content_type, Some("text/plain".to_string())); } #[test] fn test_parse_field_with_filename_and_type() { let part: FormPart = "file=content;filename=test.txt;type=text/plain" .parse() .unwrap(); assert_eq!(part.name, "file"); assert_eq!(part.data, b"content"); assert_eq!(part.filename, Some("test.txt".to_string())); assert_eq!(part.content_type, Some("text/plain".to_string())); } #[test] fn test_parse_invalid_format() { let result: Result = "invalid".parse(); assert!(result.is_err()); } #[test] fn test_parse_file_upload() { // Create a temporary file for testing let temp_dir = std::env::temp_dir(); let test_file = temp_dir.join("test_form_upload.txt"); std::fs::write(&test_file, b"test file content").unwrap(); let form_str = format!("upload=@{}", test_file.display()); let part: FormPart = form_str.parse().unwrap(); assert_eq!(part.name, "upload"); assert_eq!(part.data, b"test file content"); assert_eq!(part.filename, Some("test_form_upload.txt".to_string())); assert_eq!(part.content_type, None); // Clean up std::fs::remove_file(&test_file).ok(); } #[test] fn test_parse_file_upload_without_filename() { // Create a temporary file for testing let temp_dir = std::env::temp_dir(); let test_file = temp_dir.join("test_form_upload_no_filename.txt"); std::fs::write(&test_file, b"test file content without filename").unwrap(); let form_str = format!("upload=<{}", test_file.display()); let part: FormPart = form_str.parse().unwrap(); assert_eq!(part.name, "upload"); assert_eq!(part.data, b"test file content without filename"); assert_eq!(part.filename, None); // No filename set for '<' format assert_eq!(part.content_type, None); // Clean up std::fs::remove_file(&test_file).ok(); } #[test] fn test_form_creation_and_body_generation() { let mut form = Form::new(); // Add a simple text field let text_part: FormPart = "name=John".parse().unwrap(); form.add_part(text_part); // Add a field with filename let file_part: FormPart = "file=content;filename=test.txt;type=text/plain" .parse() .unwrap(); form.add_part(file_part); let body = form.body(); let body_str = String::from_utf8_lossy(&body); // Check that boundary is present assert!(body_str.contains(&format!("--{}", form.boundary))); // Check Content-Disposition headers assert!(body_str.contains("Content-Disposition: form-data; name=\"name\"")); assert!( body_str .contains("Content-Disposition: form-data; name=\"file\"; filename=\"test.txt\"") ); // Check Content-Type header assert!(body_str.contains("Content-Type: text/plain")); // Check data content assert!(body_str.contains("John")); assert!(body_str.contains("content")); // Check final boundary assert!(body_str.ends_with(&format!("--{}--\r\n", form.boundary))); } #[test] fn test_form_content_type() { let form = Form::new(); let content_type = form.content_type(); assert!(content_type.starts_with("multipart/form-data; boundary=")); assert!(content_type.contains(&form.boundary)); } #[test] fn test_empty_form_body() { let form = Form::new(); let body = form.body(); let body_str = String::from_utf8_lossy(&body); // Should only contain final boundary for empty form assert_eq!(body_str, format!("--{}--\r\n", form.boundary)); } #[test] fn test_form_with_file_upload() { // Create a temporary file for testing let temp_dir = std::env::temp_dir(); let test_file = temp_dir.join("form_test_upload.txt"); std::fs::write(&test_file, b"file content for form").unwrap(); let mut form = Form::new(); // Parse and add file upload part let form_str = format!("upload=@{}", test_file.display()); let file_part: FormPart = form_str.parse().unwrap(); form.add_part(file_part); let body = form.body(); let body_str = String::from_utf8_lossy(&body); // Check file upload formatting assert!(body_str.contains( "Content-Disposition: form-data; name=\"upload\"; filename=\"form_test_upload.txt\"" )); assert!(body_str.contains("file content for form")); // Clean up std::fs::remove_file(&test_file).ok(); } #[test] fn test_boundary_generation_is_random() { let form1 = Form::new(); let form2 = Form::new(); // Boundaries should be different for different forms assert_ne!(form1.boundary, form2.boundary); // Boundaries should follow the expected format assert!(form1.boundary.starts_with("----formdata-oha-")); assert!(form2.boundary.starts_with("----formdata-oha-")); // Boundaries should have the expected length (prefix + 32 hex chars) assert_eq!(form1.boundary.len(), "----formdata-oha-".len() + 32); assert_eq!(form2.boundary.len(), "----formdata-oha-".len() + 32); } } ================================================ FILE: src/db.rs ================================================ use rusqlite::Connection; use crate::client::{Client, RequestResult}; fn create_db(conn: &Connection) -> Result { conn.execute( "CREATE TABLE IF NOT EXISTS oha ( url TEXT NOT NULL, start REAL NOT NULL, start_latency_correction REAL, end REAL NOT NULL, duration REAL NOT NULL, status INTEGER NOT NULL, len_bytes INTEGER NOT NULL, run INTEGER NOT NULL )", (), ) } pub fn store( client: &Client, db_url: &str, start: std::time::Instant, request_records: &[RequestResult], run: i64, ) -> Result { let mut conn = Connection::open(db_url)?; create_db(&conn)?; let t = conn.transaction()?; let mut affected_rows = 0; for request in request_records { let req = client.generate_request(&mut request.rng.clone()).unwrap().1; let url = req.uri(); affected_rows += t.execute( "INSERT INTO oha (url, start, start_latency_correction, end, duration, status, len_bytes, run) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)", ( url.to_string(), (request.start - start).as_secs_f64(), request.start_latency_correction.map(|d| (d - start).as_secs_f64()), (request.end - start).as_secs_f64(), request.duration().as_secs_f64(), request.status.as_u16() as i64, request.len_bytes as i64, run , ), )?; } t.commit()?; Ok(affected_rows) } #[cfg(test)] mod test_db { use rand::SeedableRng; use super::*; #[test] fn test_store() { let run = std::time::SystemTime::now() .duration_since(std::time::UNIX_EPOCH) .unwrap() .as_secs() as i64; let start = std::time::Instant::now(); let test_val = RequestResult { rng: SeedableRng::seed_from_u64(0), status: hyper::StatusCode::OK, len_bytes: 100, start_latency_correction: None, start: std::time::Instant::now(), connection_time: None, first_byte: None, end: std::time::Instant::now(), }; let test_vec = vec![test_val.clone(), test_val.clone()]; let client = Client::default(); let result = store(&client, ":memory:", start, &test_vec, run); assert_eq!(result.unwrap(), 2); } } ================================================ FILE: src/histogram.rs ================================================ pub fn histogram(values: &[f64], bins: usize) -> Vec<(f64, usize)> { assert!(bins >= 2); let mut bucket: Vec = vec![0; bins]; let min = values.iter().collect::().min(); let max = values.iter().collect::().max(); let step = (max - min) / (bins - 1) as f64; for &v in values { let i = std::cmp::min(((v - min) / step).ceil() as usize, bins - 1); bucket[i] += 1; } bucket .into_iter() .enumerate() .map(|(i, v)| (min + step * i as f64, v)) .collect() } #[cfg(test)] mod tests { use super::*; #[test] fn test_histogram() { let values1: [f64; 10] = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0]; assert_eq!( histogram(&values1, 10), vec![ (1.0, 1), (2.0, 1), (3.0, 1), (4.0, 1), (5.0, 1), (6.0, 1), (7.0, 1), (8.0, 1), (9.0, 1), (10.0, 1) ] ); assert_eq!( histogram(&values1, 4), vec![(1.0, 1), (4.0, 3), (7.0, 3), (10.0, 3)] ); assert_eq!( histogram(&values1, 17), vec![ (1.0, 1), (1.5625, 0), (2.125, 1), (2.6875, 0), (3.25, 1), (3.8125, 0), (4.375, 1), (4.9375, 0), (5.5, 1), (6.0625, 1), (6.625, 0), (7.1875, 1), (7.75, 0), (8.3125, 1), (8.875, 0), (9.4375, 1), (10.0, 1) ] ); let values2: [f64; 10] = [1.0, 1.0, 1.0, 1.0, 1.0, 10.0, 10.0, 10.0, 10.0, 10.0]; assert_eq!( histogram(&values2, 10), vec![ (1.0, 5), (2.0, 0), (3.0, 0), (4.0, 0), (5.0, 0), (6.0, 0), (7.0, 0), (8.0, 0), (9.0, 0), (10.0, 5) ] ); assert_eq!(histogram(&values2, 2), vec![(1.0, 5), (10.0, 5)]); } } ================================================ FILE: src/lib.rs ================================================ use anyhow::Context; use aws_auth::AwsSignatureConfig; use bytes::Bytes; use clap::Parser; use crossterm::tty::IsTty; use hickory_resolver::config::{ResolverConfig, ResolverOpts}; use humantime::Duration; use hyper::{ HeaderMap, http::{self, header::HeaderName, header::HeaderValue}, }; use printer::{PrintConfig, PrintMode}; use rand_regex::Regex; use ratatui::crossterm; use result_data::ResultData; use std::{ env, fs::File, io::{BufRead, BufReader, Read}, path::{Path, PathBuf}, pin::Pin, sync::Arc, }; use timescale::TimeScale; use url::Url; use url_generator::UrlGenerator; mod aws_auth; mod cli; mod client; #[cfg(feature = "http3")] mod client_h3; mod curl_compat; mod db; mod histogram; mod monitor; mod pcg64si; mod printer; mod request_generator; mod result_data; mod timescale; mod tls_config; mod url_generator; #[cfg(not(target_env = "msvc"))] use tikv_jemallocator::Jemalloc; use crate::{ cli::{ConnectToEntry, parse_header}, request_generator::{BodyGenerator, Proxy, RequestGenerator}, }; #[cfg(not(target_env = "msvc"))] #[global_allocator] static GLOBAL: Jemalloc = Jemalloc; #[derive(Parser)] #[command(version, about, long_about = None)] #[command(arg_required_else_help(true))] #[command(styles = clap_cargo::style::CLAP_STYLING)] pub struct Opts { #[arg(help = "Target URL or file with multiple URLs.")] url: Option, #[arg(long = "completions", hide = true)] pub completions: Option, #[arg( help = "Number of requests to run. Accepts plain numbers or suffixes: k = 1,000, m = 1,000,000 (e.g. 10k, 1m).", short = 'n', default_value = "200", conflicts_with = "duration", value_parser = cli::parse_n_requests )] n_requests: usize, #[arg( help = "Number of connections to run concurrently. You may should increase limit to number of open files for larger `-c`.", short = 'c', default_value = "50" )] n_connections: usize, #[arg( help = "Number of parallel requests to send on HTTP/2. `oha` will run c * p concurrent workers in total.", short = 'p', default_value = "1" )] n_http2_parallel: usize, #[arg( help = "Duration of application to send requests. On HTTP/1, When the duration is reached, ongoing requests are aborted and counted as \"aborted due to deadline\" You can change this behavior with `-w` option. Currently, on HTTP/2, When the duration is reached, ongoing requests are waited. `-w` option is ignored. Examples: -z 10s -z 3m.", short = 'z', conflicts_with = "n_requests" )] duration: Option, #[arg( help = "When the duration is reached, ongoing requests are waited", short, long, default_value = "false", requires = "duration" )] wait_ongoing_requests_after_deadline: bool, #[arg(help = "Rate limit for all, in queries per second (QPS)", short = 'q', conflicts_with_all = ["burst_duration", "burst_requests"])] query_per_second: Option, #[arg( help = "Introduce delay between a predefined number of requests. Note: If qps is specified, burst will be ignored", long = "burst-delay", requires = "burst_requests", conflicts_with = "query_per_second" )] burst_duration: Option, #[arg( help = "Rates of requests for burst. Default is 1 Note: If qps is specified, burst will be ignored", long = "burst-rate", requires = "burst_duration", conflicts_with = "query_per_second" )] burst_requests: Option, #[arg( help = "Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alive do not work well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax.", default_value = "false", long )] rand_regex_url: bool, #[arg( help = "Read the URLs to query from a file", default_value = "false", long )] urls_from_file: bool, #[arg( help = "A parameter for the '--rand-regex-url'. The max_repeat parameter gives the maximum extra repeat counts the x*, x+ and x{n,} operators will become.", default_value = "4", long, requires = "rand_regex_url" )] max_repeat: u32, #[arg( help = "Dump target Urls times to debug --rand-regex-url", long )] dump_urls: Option, #[arg( help = "Correct latency to avoid coordinated omission problem. It's ignored if -q is not set.", long = "latency-correction" )] latency_correction: bool, #[arg(help = "No realtime tui", long = "no-tui")] no_tui: bool, #[arg(help = "Frame per second for tui.", default_value = "16", long = "fps")] fps: usize, #[arg( help = "HTTP method", short = 'm', long = "method", default_value = "GET" )] method: http::Method, #[arg(help = "Custom HTTP header. Examples: -H \"foo: bar\"", short = 'H', value_parser = parse_header)] headers: Vec<(HeaderName, HeaderValue)>, #[arg( help = "Custom Proxy HTTP header. Examples: --proxy-header \"foo: bar\"", long = "proxy-header", value_parser = parse_header )] proxy_headers: Vec<(HeaderName, HeaderValue)>, #[arg(help = "Timeout for each request. Default to infinite.", short = 't')] timeout: Option, #[arg( help = "Timeout for establishing a new connection. Default to 5s.", long = "connect-timeout", default_value = "5s" )] connect_timeout: humantime::Duration, #[arg(help = "HTTP Accept Header.", short = 'A')] accept_header: Option, #[arg(help = "HTTP request body.", short = 'd', conflicts_with_all = ["body_path", "body_path_lines", "form"])] body_string: Option, #[arg(help = "HTTP request body from file.", short = 'D', conflicts_with_all = ["body_string", "body_path_lines", "form"])] body_path: Option, #[arg(help = "HTTP request body from file line by line.", short = 'Z', conflicts_with_all = ["body_string", "body_path", "form"])] body_path_lines: Option, #[arg( help = "Specify HTTP multipart POST data (curl compatible). Examples: -F 'name=value' -F 'file=@path/to/file'", short = 'F', long = "form", conflicts_with_all = ["body_string", "body_path", "body_path_lines"] )] form: Vec, #[arg(help = "Content-Type.", short = 'T')] content_type: Option, #[arg( help = "Basic authentication (username:password), or AWS credentials (access_key:secret_key)", short = 'a' )] basic_auth: Option, #[arg(help = "AWS session token", long = "aws-session")] aws_session: Option, #[arg( help = "AWS SigV4 signing params (format: aws:amz:region:service)", long = "aws-sigv4" )] aws_sigv4: Option, #[arg(help = "HTTP proxy", short = 'x')] proxy: Option, #[arg( help = "HTTP version to connect to proxy. Available values 0.9, 1.0, 1.1, 2.", long = "proxy-http-version" )] proxy_http_version: Option, #[arg( help = "Use HTTP/2 to connect to proxy. Shorthand for --proxy-http-version=2", long = "proxy-http2" )] proxy_http2: bool, #[arg( help = "HTTP version. Available values 0.9, 1.0, 1.1, 2, 3", long = "http-version" )] http_version: Option, #[arg(help = "Use HTTP/2. Shorthand for --http-version=2", long = "http2")] http2: bool, #[arg(help = "HTTP Host header", long = "host")] host: Option, #[arg(help = "Disable compression.", long = "disable-compression")] disable_compression: bool, #[arg( help = "Limit for number of Redirect. Set 0 for no redirection. Redirection isn't supported for HTTP/2.", default_value = "10", short = 'r', long = "redirect" )] redirect: usize, #[arg( help = "Disable keep-alive, prevents re-use of TCP connections between different HTTP requests. This isn't supported for HTTP/2.", long = "disable-keepalive" )] disable_keepalive: bool, #[arg( help = "*Not* perform a DNS lookup at beginning to cache it", long = "no-pre-lookup", default_value = "false" )] no_pre_lookup: bool, #[arg(help = "Lookup only ipv6.", long = "ipv6")] ipv6: bool, #[arg(help = "Lookup only ipv4.", long = "ipv4")] ipv4: bool, #[arg( help = "(TLS) Use the specified certificate file to verify the peer. Native certificate store is used even if this argument is specified.", long )] cacert: Option, #[arg( help = "(TLS) Use the specified client certificate file. --key must be also specified", long, requires = "key" )] cert: Option, #[arg( help = "(TLS) Use the specified client key file. --cert must be also specified", long, requires = "cert" )] key: Option, #[arg(help = "Accept invalid certs.", long = "insecure")] insecure: bool, #[arg( help = "Override DNS resolution and default port numbers with strings like 'example.org:443:localhost:8443' Note: if used several times for the same host:port:target_host:target_port, a random choice is made", long = "connect-to" )] connect_to: Vec, #[arg( help = "Disable the color scheme.", alias = "disable-color", long = "no-color", env = "NO_COLOR" )] no_color: bool, #[cfg(unix)] #[arg( help = "Connect to a unix socket instead of the domain in the URL. Only for non-HTTPS URLs.", long = "unix-socket", group = "socket-type" )] unix_socket: Option, #[cfg(feature = "vsock")] #[arg( help = "Connect to a VSOCK socket using 'cid:port' instead of the domain in the URL. Only for non-HTTPS URLs.", long = "vsock-addr", value_parser = cli::parse_vsock_addr, group = "socket-type" )] vsock_addr: Option, #[arg( help = "Include a response status code successful or not successful breakdown for the time histogram and distribution statistics", long = "stats-success-breakdown" )] stats_success_breakdown: bool, #[arg( help = "Write succeeded requests to sqlite database url E.G test.db", long = "db-url" )] db_url: Option, #[arg( long, help = "Perform a single request and dump the request and response" )] debug: bool, #[arg( help = "Output file to write the results to. If not specified, results are written to stdout.", long, short )] output: Option, #[arg(help = "Output format", long, default_value = "text")] output_format: Option, #[arg( help = "Time unit to be used. If not specified, the time unit is determined automatically. This option affects only text format.", long, short = 'u' )] time_unit: Option, } pub async fn run(mut opts: Opts) -> anyhow::Result<()> { let work_mode = opts.work_mode(); let url = opts.url.expect("URL is required"); // Parse AWS credentials from basic auth if AWS signing is requested let aws_config = if let Some(signing_params) = opts.aws_sigv4 { if let Some(auth) = &opts.basic_auth { let parts: Vec<&str> = auth.split(':').collect(); if parts.len() != 2 { anyhow::bail!("Invalid AWS credentials format. Expected access_key:secret_key"); } let access_key = parts[0]; let secret_key = parts[1]; let session_token = opts.aws_session.take(); Some(AwsSignatureConfig::new( access_key, secret_key, &signing_params, session_token, )?) } else { anyhow::bail!("AWS credentials (--auth) required when using --aws-sigv4"); } } else { None }; let parse_http_version = |is_http2: bool, version: Option<&str>| match (is_http2, version) { (true, Some(_)) => anyhow::bail!("--http2 and --http-version are exclusive"), (true, None) => Ok(http::Version::HTTP_2), (false, Some(http_version)) => match http_version.trim() { "0.9" => Ok(http::Version::HTTP_09), "1.0" => Ok(http::Version::HTTP_10), "1.1" => Ok(http::Version::HTTP_11), "2.0" | "2" => Ok(http::Version::HTTP_2), #[cfg(feature = "http3")] "3.0" | "3" => Ok(http::Version::HTTP_3), #[cfg(not(feature = "http3"))] "3.0" | "3" => anyhow::bail!( "Your Oha instance has not been built with HTTP/3 support. Try recompiling with the feature enabled." ), _ => anyhow::bail!("Unknown HTTP version. Valid versions are 0.9, 1.0, 1.1, 2, 3"), }, (false, None) => Ok(http::Version::HTTP_11), }; let http_version: http::Version = parse_http_version(opts.http2, opts.http_version.as_deref())?; let proxy_http_version: http::Version = parse_http_version(opts.proxy_http2, opts.proxy_http_version.as_deref())?; let url_generator = if opts.rand_regex_url { // Almost URL has dot in domain, so disable dot in regex for convenience. let dot_disabled: String = url .chars() .map(|c| { if c == '.' { regex_syntax::escape(".") } else { c.to_string() } }) .collect(); UrlGenerator::new_dynamic(Regex::compile(&dot_disabled, opts.max_repeat)?) } else if opts.urls_from_file { let path = Path::new(url.as_str()); let file = File::open(path)?; let reader = std::io::BufReader::new(file); let urls: Vec = reader .lines() .map_while(Result::ok) .filter(|line| !line.trim().is_empty()) .map(|url_str| Url::parse(&url_str)) .collect::, _>>()?; UrlGenerator::new_multi_static(urls) } else { UrlGenerator::new_static(Url::parse(&url)?) }; if let Some(n) = opts.dump_urls { let mut rng = rand::rng(); for _ in 0..n { let url = url_generator.generate(&mut rng)?; println!("{url}"); } return Ok(()); } let url = url_generator.generate(&mut rand::rng())?; // Process form data or regular body first let has_form_data = !opts.form.is_empty(); let (body_generator, form_content_type): (BodyGenerator, Option) = if has_form_data { let mut form = curl_compat::Form::new(); for form_str in opts.form { let part: curl_compat::FormPart = form_str .parse() .with_context(|| format!("Failed to parse form data: {form_str}"))?; form.add_part(part); } let form_body = form.body(); let content_type = form.content_type(); (BodyGenerator::Static(form_body.into()), Some(content_type)) } else if let Some(body_string) = opts.body_string { (BodyGenerator::Static(body_string.into()), None) } else if let Some(body_path) = opts.body_path { let mut buf = Vec::new(); std::fs::File::open(body_path)?.read_to_end(&mut buf)?; (BodyGenerator::Static(buf.into()), None) } else if let Some(body_path_lines) = opts.body_path_lines { let lines = BufReader::new(std::fs::File::open(body_path_lines)?) .lines() .map_while(Result::ok) .map(Bytes::from) .collect::>(); (BodyGenerator::Random(lines), None) } else { (BodyGenerator::Static(Bytes::new()), None) }; // Set method to POST if form data is used and method is GET let method = if has_form_data && opts.method == http::Method::GET { http::Method::POST } else { opts.method }; let headers = { let mut headers: http::header::HeaderMap = Default::default(); // Accept all headers.insert( http::header::ACCEPT, http::header::HeaderValue::from_static("*/*"), ); // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding if !opts.disable_compression { headers.insert( http::header::ACCEPT_ENCODING, http::header::HeaderValue::from_static("gzip, compress, deflate, br"), ); } // User agent headers .entry(http::header::USER_AGENT) .or_insert(HeaderValue::from_static(concat!( "oha/", env!("CARGO_PKG_VERSION") ))); if let Some(h) = opts.accept_header { headers.insert(http::header::ACCEPT, HeaderValue::from_bytes(h.as_bytes())?); } if let Some(h) = opts.content_type.or(form_content_type) { headers.insert( http::header::CONTENT_TYPE, HeaderValue::from_bytes(h.as_bytes())?, ); } if let Some(h) = opts.host { headers.insert(http::header::HOST, HeaderValue::from_bytes(h.as_bytes())?); } if let Some(auth) = opts.basic_auth { let u_p = auth.splitn(2, ':').collect::>(); anyhow::ensure!(u_p.len() == 2, anyhow::anyhow!("Parse auth")); let mut header_value = b"Basic ".to_vec(); { use std::io::Write; let username = u_p[0]; let password = if u_p[1].is_empty() { None } else { Some(u_p[1]) }; let mut encoder = base64::write::EncoderWriter::new( &mut header_value, &base64::engine::general_purpose::STANDARD, ); // The unwraps here are fine because Vec::write* is infallible. write!(encoder, "{username}:").unwrap(); if let Some(password) = password { write!(encoder, "{password}").unwrap(); } } headers.insert( http::header::AUTHORIZATION, HeaderValue::from_bytes(&header_value)?, ); } if opts.disable_keepalive && http_version == http::Version::HTTP_11 { headers.insert(http::header::CONNECTION, HeaderValue::from_static("close")); } for (k, v) in opts.headers.into_iter() { headers.insert(k, v); } headers }; let proxy_headers = opts.proxy_headers.into_iter().collect::>(); let ip_strategy = match (opts.ipv4, opts.ipv6) { (false, false) => { if cfg!(target_os = "macos") && (url.host_str() == Some("localhost")) { // #784 // On macOS, localhost resolves to ::1 first, So web servers that bind to localhost tend to listen ipv6 only. // So prefer ipv6 on macos for localhost. hickory_resolver::config::LookupIpStrategy::Ipv6thenIpv4 } else { Default::default() } } (true, false) => hickory_resolver::config::LookupIpStrategy::Ipv4Only, (false, true) => hickory_resolver::config::LookupIpStrategy::Ipv6Only, (true, true) => hickory_resolver::config::LookupIpStrategy::Ipv4AndIpv6, }; let (config, mut resolver_opts) = system_resolv_conf()?; resolver_opts.ip_strategy = ip_strategy; let resolver = hickory_resolver::Resolver::builder_with_config( config, hickory_resolver::name_server::TokioConnectionProvider::default(), ) .with_options(resolver_opts) .build(); let cacert = opts.cacert.as_deref().map(std::fs::read).transpose()?; let client_auth = match (opts.cert, opts.key) { (Some(cert), Some(key)) => Some((std::fs::read(cert)?, std::fs::read(key)?)), (None, None) => None, // Not possible because of clap requires _ => anyhow::bail!("Both --cert and --key must be specified"), }; let url = url.into_owned(); let client = Arc::new(client::Client { request_generator: RequestGenerator { url_generator, https: url.scheme() == "https", version: http_version, aws_config, method, headers, body_generator, http_proxy: if opts.proxy.is_some() && url.scheme() == "http" { Some(Proxy { headers: proxy_headers.clone(), version: proxy_http_version, }) } else { None }, }, proxy_http_version, proxy_headers, dns: client::Dns { resolver, connect_to: opts.connect_to, }, timeout: opts.timeout.map(|d| d.into()), connect_timeout: opts.connect_timeout.into(), redirect_limit: opts.redirect, disable_keepalive: opts.disable_keepalive, proxy_url: opts.proxy, #[cfg(unix)] unix_socket: opts.unix_socket, #[cfg(feature = "vsock")] vsock_addr: opts.vsock_addr, #[cfg(feature = "rustls")] rustls_configs: tls_config::RuslsConfigs::new( opts.insecure, cacert.as_deref(), client_auth .as_ref() .map(|(cert, key)| (cert.as_slice(), key.as_slice())), ), #[cfg(all(feature = "native-tls", not(feature = "rustls")))] native_tls_connectors: tls_config::NativeTlsConnectors::new( opts.insecure, cacert.as_deref(), client_auth .as_ref() .map(|(cert, key)| (cert.as_slice(), key.as_slice())), ), }); if !opts.no_pre_lookup { client.pre_lookup().await?; } let no_tui = opts.no_tui || !std::io::stdout().is_tty() || opts.debug; let print_config = { let mode = opts.output_format.unwrap_or_default(); let disable_style = opts.no_color || !std::io::stdout().is_tty() || opts.output.is_some(); let output: Box = if let Some(output) = opts.output { Box::new(File::create(output)?) } else { Box::new(std::io::stdout()) }; PrintConfig { mode, output, disable_style, stats_success_breakdown: opts.stats_success_breakdown, time_unit: opts.time_unit, } }; let run = std::time::SystemTime::now() .duration_since(std::time::UNIX_EPOCH)? .as_secs(); let start = std::time::Instant::now(); let data_collect_future: Pin>> = match work_mode { WorkMode::Debug => { let mut print_config = print_config; client::work_debug(&mut print_config.output, client).await?; return Ok(()); } WorkMode::FixedNumber { n_requests, n_connections, n_http2_parallel, query_limit: None, latency_correction: _, } if no_tui => { // Use optimized worker of no_tui mode. let (result_tx, result_rx) = kanal::unbounded(); client::fast::work( client.clone(), result_tx, n_requests, n_connections, n_http2_parallel, ) .await; Box::pin(async move { let mut res = ResultData::default(); for r in result_rx { res.merge(r); } (res, print_config) }) } WorkMode::Until { duration, n_connections, n_http2_parallel, query_limit: None, latency_correction: _, wait_ongoing_requests_after_deadline, } if no_tui => { // Use optimized worker of no_tui mode. let (result_tx, result_rx) = kanal::unbounded(); client::fast::work_until( client.clone(), result_tx, start + duration, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; Box::pin(async move { let mut res = ResultData::default(); for r in result_rx { res.merge(r); } (res, print_config) }) } mode => { let (result_tx, result_rx) = kanal::unbounded(); let data_collector = if no_tui { // When `--no-tui` is enabled, just collect all data. let token = tokio_util::sync::CancellationToken::new(); let result_rx_ctrl_c = result_rx.clone(); let token_ctrl_c = token.clone(); let ctrl_c = tokio::spawn(async move { tokio::select! { _ = tokio::signal::ctrl_c() => { let mut all: ResultData = Default::default(); let mut buf = Vec::new(); let _ = result_rx_ctrl_c.drain_into(&mut buf); for res in buf { all.push(res); } let _ = printer::print_result(print_config, start, &all, start.elapsed()); std::process::exit(libc::EXIT_SUCCESS); } _ = token_ctrl_c.cancelled() => { print_config } } }); Box::pin(async move { token.cancel(); let config = ctrl_c.await.unwrap(); let mut all = ResultData::default(); while let Ok(res) = result_rx.recv() { all.push(res); } (all, config) }) as Pin>> } else { // Spawn monitor future which draws realtime tui let join_handle = tokio::spawn( monitor::Monitor { print_config, end_line: opts .duration .map(|d| monitor::EndLine::Duration(d.into())) .unwrap_or(monitor::EndLine::NumQuery(opts.n_requests)), report_receiver: result_rx, start, fps: opts.fps, disable_color: opts.no_color, time_unit: opts.time_unit, } .monitor(), ); Box::pin(async { join_handle.await.unwrap().unwrap() }) as Pin>> }; match mode { WorkMode::Debug => unreachable!("Must be already handled"), WorkMode::FixedNumber { n_requests, n_connections, n_http2_parallel, query_limit, latency_correction, } => { if let Some(query_limit) = query_limit { if latency_correction { client::work_with_qps_latency_correction( client.clone(), result_tx, query_limit, n_requests, n_connections, n_http2_parallel, ) .await; } else { client::work_with_qps( client.clone(), result_tx, query_limit, n_requests, n_connections, n_http2_parallel, ) .await; } } else { client::work( client.clone(), result_tx, n_requests, n_connections, n_http2_parallel, ) .await; } } WorkMode::Until { duration, n_connections, n_http2_parallel, query_limit, latency_correction, wait_ongoing_requests_after_deadline, } => { if let Some(query_limit) = query_limit { if latency_correction { client::work_until_with_qps_latency_correction( client.clone(), result_tx, query_limit, start, start + duration, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; } else { client::work_until_with_qps( client.clone(), result_tx, query_limit, start, start + duration, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; } } else { client::work_until( client.clone(), result_tx, start + duration, n_connections, n_http2_parallel, wait_ongoing_requests_after_deadline, ) .await; } } } data_collector } }; let duration = start.elapsed(); let (res, print_config) = data_collect_future.await; printer::print_result(print_config, start, &res, duration)?; if let Some(db_url) = opts.db_url { eprintln!("Storing results to {db_url}"); db::store(&client, &db_url, start, res.success(), run as i64)?; } Ok(()) } pub(crate) fn system_resolv_conf() -> anyhow::Result<(ResolverConfig, ResolverOpts)> { // check if we are running in termux https://github.com/termux/termux-app #[cfg(unix)] if env::var("TERMUX_VERSION").is_ok() { let prefix = env::var("PREFIX")?; let path = format!("{prefix}/etc/resolv.conf"); return match std::fs::read(&path) { Ok(conf_data) => hickory_resolver::system_conf::parse_resolv_conf(conf_data) .context(format!("DNS: failed to parse {path}")), Err(err) => { fallback_resolver_config(anyhow::anyhow!("DNS: failed to load {path}: {err}")) } }; } match hickory_resolver::system_conf::read_system_conf() { Ok(conf) => Ok(conf), Err(err) => fallback_resolver_config(anyhow::anyhow!( "DNS: failed to load /etc/resolv.conf: {err}" )), } } fn fallback_resolver_config(err: anyhow::Error) -> anyhow::Result<(ResolverConfig, ResolverOpts)> { // Notify the user that we had to fall back to a default resolver configuration. eprintln!("{err}"); let config = ResolverConfig::default(); let opts = ResolverOpts::default(); Ok((config, opts)) } enum WorkMode { Debug, FixedNumber { n_requests: usize, n_connections: usize, n_http2_parallel: usize, query_limit: Option, // ignored when query_limit is None latency_correction: bool, }, Until { duration: std::time::Duration, n_connections: usize, n_http2_parallel: usize, query_limit: Option, // ignored when query_limit is None latency_correction: bool, wait_ongoing_requests_after_deadline: bool, }, } impl Opts { fn work_mode(&self) -> WorkMode { if self.debug { WorkMode::Debug } else if let Some(duration) = self.duration { WorkMode::Until { duration: duration.into(), n_connections: self.n_connections, n_http2_parallel: self.n_http2_parallel, query_limit: match self.query_per_second { Some(0f64) | None => self.burst_duration.map(|burst_duration| { client::QueryLimit::Burst( burst_duration.into(), self.burst_requests.unwrap_or(1), ) }), Some(qps) => Some(client::QueryLimit::Qps(qps)), }, latency_correction: self.latency_correction, wait_ongoing_requests_after_deadline: self.wait_ongoing_requests_after_deadline, } } else { let mut n_connections = self.n_connections; let max_useful = self.n_requests.div_ceil(self.n_http2_parallel); if n_connections > max_useful { n_connections = max_useful; } WorkMode::FixedNumber { n_requests: self.n_requests, n_connections, n_http2_parallel: self.n_http2_parallel, query_limit: match self.query_per_second { Some(0f64) | None => self.burst_duration.map(|burst_duration| { client::QueryLimit::Burst( burst_duration.into(), self.burst_requests.unwrap_or(1), ) }), Some(qps) => Some(client::QueryLimit::Qps(qps)), }, latency_correction: self.latency_correction, } } } } ================================================ FILE: src/main.rs ================================================ use clap::{CommandFactory, Parser}; use oha::{Opts, run}; fn main() { let num_workers_threads = std::env::var("TOKIO_WORKER_THREADS") .ok() .and_then(|s| s.parse().ok()) // Prefer to use physical cores rather than logical one because it's more performant empirically. .unwrap_or(num_cpus::get_physical()); let rt = tokio::runtime::Builder::new_multi_thread() .worker_threads(num_workers_threads) .enable_all() .build() .unwrap(); let opts = Opts::parse(); if let Some(shell) = opts.completions { clap_complete::generate(shell, &mut Opts::command(), "oha", &mut std::io::stdout()); return; } if let Err(e) = rt.block_on(run(opts)) { eprintln!("Error: {e}"); std::process::exit(libc::EXIT_FAILURE); } } ================================================ FILE: src/monitor.rs ================================================ use byte_unit::Byte; use crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers}; use hyper::http; use ratatui::{DefaultTerminal, crossterm}; use ratatui::{ layout::{Constraint, Direction, Layout}, style::{Color, Style}, text::{Line, Span}, widgets::{BarChart, Block, Borders, Gauge, Paragraph}, }; use std::collections::BTreeMap; use crate::{ client::{ClientError, RequestResult}, printer::PrintConfig, result_data::{MinMaxMean, ResultData}, timescale::{TimeLabel, TimeScale}, }; /// When the monitor ends pub enum EndLine { /// After a duration Duration(std::time::Duration), /// After n query done NumQuery(usize), } struct ColorScheme { light_blue: Option, green: Option, yellow: Option, } impl ColorScheme { fn new() -> ColorScheme { ColorScheme { light_blue: None, green: None, yellow: None, } } fn set_colors(&mut self) { self.light_blue = Some(Color::Cyan); self.green = Some(Color::Green); self.yellow = Some(Color::Yellow); } } pub struct Monitor { pub print_config: PrintConfig, pub end_line: EndLine, /// All workers sends each result to this channel pub report_receiver: kanal::Receiver>, // When started pub start: std::time::Instant, // Frame per second of TUI pub fps: usize, pub disable_color: bool, pub time_unit: Option, } struct IntoRawMode; impl IntoRawMode { pub fn new() -> Result<(Self, DefaultTerminal), std::io::Error> { let terminal = ratatui::try_init()?; Ok((Self, terminal)) } } impl Drop for IntoRawMode { fn drop(&mut self) { ratatui::restore(); } } impl Monitor { pub async fn monitor(self) -> Result<(ResultData, PrintConfig), std::io::Error> { let (raw_mode, mut terminal) = IntoRawMode::new()?; // Return this when ends to application print summary // We must not read all data from this due to computational cost. let mut all: ResultData = Default::default(); // stats for HTTP status let mut status_dist: BTreeMap = Default::default(); #[cfg(unix)] // Limit for number open files. eg. ulimit -n let nofile_limit = rlimit::getrlimit(rlimit::Resource::NOFILE); // None means auto timescale which depends on how long it takes let mut timescale_auto = self.time_unit; let mut colors = ColorScheme::new(); if !self.disable_color { colors.set_colors(); } let mut buf = Vec::new(); loop { let frame_start = std::time::Instant::now(); let is_disconnected = self.report_receiver.is_disconnected(); let _ = self.report_receiver.drain_into(&mut buf); for report in buf.drain(..) { if let Ok(report) = report.as_ref() { *status_dist.entry(report.status).or_default() += 1; } all.push(report); } if is_disconnected { break; } let now = std::time::Instant::now(); let progress = match &self.end_line { EndLine::Duration(d) => { ((now - self.start).as_secs_f64() / d.as_secs_f64()).clamp(0.0, 1.0) } EndLine::NumQuery(n) => (all.len() as f64 / *n as f64).clamp(0.0, 1.0), }; let count = 32; // Make ms smallest timescale viewable for TUI let timescale = (if let Some(timescale) = timescale_auto { timescale } else { TimeScale::from_elapsed(self.start.elapsed()) }) .max(TimeScale::Millisecond); let bin = timescale.as_secs_f64(); let mut bar_num_req = vec![0u64; count]; let short_bin = (now - self.start).as_secs_f64() % bin; for r in all.success().iter().rev() { let past = (now - r.end).as_secs_f64(); let i = if past <= short_bin { 0 } else { 1 + ((past - short_bin) / bin) as usize }; if i >= bar_num_req.len() { break; } bar_num_req[i] += 1; } let cols = bar_num_req .iter() .map(|x| x.to_string().chars().count()) .max() .unwrap_or(0); let bar_num_req: Vec<(String, u64)> = bar_num_req .into_iter() .enumerate() .map(|(i, n)| { ( { let mut s = TimeLabel { x: i, timescale }.to_string(); if cols > s.len() { for _ in 0..cols - s.len() { s.push(' '); } } s }, n, ) }) .collect(); let bar_num_req_str: Vec<(&str, u64)> = bar_num_req.iter().map(|(a, b)| (a.as_str(), *b)).collect(); #[cfg(unix)] let nofile = std::fs::read_dir("/dev/fd").map(|dir| dir.count()); terminal.draw(|f| { let row4 = Layout::default() .direction(Direction::Vertical) .constraints( [ Constraint::Length(3), Constraint::Length(8), Constraint::Length(all.error_distribution().len() as u16 + 2), Constraint::Fill(1), ] .as_ref(), ) .split(f.area()); let mid = Layout::default() .direction(Direction::Horizontal) .constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref()) .split(row4[1]); let bottom = Layout::default() .direction(Direction::Horizontal) .constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref()) .split(row4[3]); let gauge_label = match &self.end_line { EndLine::Duration(d) => format!( "{} / {}", humantime::Duration::from(std::time::Duration::from_secs( (now - self.start).as_secs_f64() as u64 )), humantime::Duration::from(*d) ), EndLine::NumQuery(n) => format!("{} / {}", all.len(), n), }; let gauge = Gauge::default() .block(Block::default().title("Progress").borders(Borders::ALL)) .gauge_style(Style::default().fg(colors.light_blue.unwrap_or(Color::White))) .label(Span::raw(gauge_label)) .ratio(progress); f.render_widget(gauge, row4[0]); let last_1_timescale = { let success = all.success(); let index = match success.binary_search_by(|probe| { (now - probe.end) .as_secs_f64() .partial_cmp(×cale.as_secs_f64()) // Should be fine .unwrap() .reverse() }) { Ok(i) => i, Err(i) => i, }; &success[index..] }; let last_1_minmaxmean: MinMaxMean = last_1_timescale .iter() .map(|r| r.duration().as_secs_f64()) .collect(); let stats_text = vec![ Line::from(format!("Requests : {}", last_1_timescale.len())), Line::from(vec![Span::styled( format!("Slowest: {:.4} secs", last_1_minmaxmean.max(),), Style::default().fg(colors.yellow.unwrap_or(Color::Reset)), )]), Line::from(vec![Span::styled( format!("Fastest: {:.4} secs", last_1_minmaxmean.min(),), Style::default().fg(colors.green.unwrap_or(Color::Reset)), )]), Line::from(vec![Span::styled( format!("Average: {:.4} secs", last_1_minmaxmean.mean(),), Style::default().fg(colors.light_blue.unwrap_or(Color::Reset)), )]), Line::from(format!( "Data: {:.2}", Byte::from_u64( last_1_timescale .iter() .map(|r| r.len_bytes as u64) .sum::() ) .get_appropriate_unit(byte_unit::UnitType::Binary) )), #[cfg(unix)] // Note: Windows can open 255 * 255 * 255 files. So not showing on windows is OK. Line::from(format!( "Number of open files: {} / {}", nofile .map(|c| c.to_string()) .unwrap_or_else(|_| "Error".to_string()), nofile_limit .as_ref() .map(|(s, _h)| s.to_string()) .unwrap_or_else(|_| "Unknown".to_string()) )), ]; let stats_title = format!("Stats for last {timescale}"); let stats = Paragraph::new(stats_text).block( Block::default() .title(Span::raw(stats_title)) .borders(Borders::ALL), ); f.render_widget(stats, mid[0]); let mut status_v: Vec<(http::StatusCode, usize)> = status_dist.clone().into_iter().collect(); status_v.sort_by_key(|t| std::cmp::Reverse(t.1)); let stats2_text = status_v .into_iter() .map(|(status, count)| { Line::from(format!("[{}] {} responses", status.as_str(), count)) }) .collect::>(); let stats2 = Paragraph::new(stats2_text).block( Block::default() .title("Status code distribution") .borders(Borders::ALL), ); f.render_widget(stats2, mid[1]); let mut error_v: Vec<(String, usize)> = all.error_distribution().clone().into_iter().collect(); error_v.sort_by_key(|t| std::cmp::Reverse(t.1)); let errors_text = error_v .into_iter() .map(|(e, count)| Line::from(format!("[{count}] {e}"))) .collect::>(); let errors = Paragraph::new(errors_text).block( Block::default() .title("Error distribution") .borders(Borders::ALL), ); f.render_widget(errors, row4[2]); let title = format!( "Requests / past {}{}. press -/+/a to change", timescale, if timescale_auto.is_none() { " (auto)" } else { "" } ); let barchart = BarChart::default() .block( Block::default() .title(Span::raw(title)) .style( Style::default() .fg(colors.green.unwrap_or(Color::Reset)) .bg(Color::Reset), ) .borders(Borders::ALL), ) .data(bar_num_req_str.as_slice()) .bar_width( bar_num_req .iter() .map(|(s, _)| s.chars().count()) .max() .map(|w| w + 2) .unwrap_or(1) as u16, ); f.render_widget(barchart, bottom[0]); let resp_histo_width = 7; let resp_histo_data: Vec<(String, u64)> = { let bins = if bottom[1].width < 2 { 0 } else { (bottom[1].width as usize - 2) / (resp_histo_width + 1) } .max(2); let values = last_1_timescale .iter() .map(|r| r.duration().as_secs_f64()) .collect::>(); let histo = crate::histogram::histogram(&values, bins); histo .into_iter() .map(|(label, v)| (format!("{label:.4}"), v as u64)) .collect() }; let resp_histo_data_str: Vec<(&str, u64)> = resp_histo_data .iter() .map(|(l, v)| (l.as_str(), *v)) .collect(); let resp_histo = BarChart::default() .block( Block::default() .title("Response time histogram") .style( Style::default() .fg(colors.yellow.unwrap_or(Color::Reset)) .bg(Color::Reset), ) .borders(Borders::ALL), ) .data(resp_histo_data_str.as_slice()) .bar_width(resp_histo_width as u16); f.render_widget(resp_histo, bottom[1]); })?; while crossterm::event::poll(std::time::Duration::from_secs(0))? { match crossterm::event::read()? { Event::Key(KeyEvent { code: KeyCode::Char('+'), .. }) => { // Make ms the smallest timescale viewable in TUI timescale_auto = Some(timescale.dec().max(TimeScale::Millisecond)) } Event::Key(KeyEvent { code: KeyCode::Char('-'), .. }) => timescale_auto = Some(timescale.inc()), Event::Key(KeyEvent { code: KeyCode::Char('a'), .. }) => { if timescale_auto.is_some() { timescale_auto = None; } else { timescale_auto = Some(timescale) } } // User pressed q or ctrl-c Event::Key(KeyEvent { code: KeyCode::Char('q'), .. }) | Event::Key(KeyEvent { code: KeyCode::Char('c'), modifiers: KeyModifiers::CONTROL, .. }) => { drop(terminal); drop(raw_mode); let _ = crate::printer::print_result( self.print_config, self.start, &all, now - self.start, ); std::process::exit(libc::EXIT_SUCCESS); } _ => (), } } let per_frame = std::time::Duration::from_secs(1) / self.fps as u32; let elapsed = frame_start.elapsed(); if per_frame > elapsed { tokio::time::sleep(per_frame - elapsed).await; } } Ok((all, self.print_config)) } } ================================================ FILE: src/pcg64si.rs ================================================ use std::convert::Infallible; // https://github.com/imneme/pcg-c use rand::{SeedableRng, TryRng, rand_core::utils::fill_bytes_via_next_word}; #[derive(Debug, Copy, Clone)] #[repr(transparent)] pub struct Pcg64Si { state: u64, } impl TryRng for Pcg64Si { type Error = Infallible; fn try_next_u32(&mut self) -> Result { Ok(self.try_next_u64()? as u32) } fn try_next_u64(&mut self) -> Result { let old_state = self.state; self.state = self .state .wrapping_mul(6364136223846793005) .wrapping_add(1442695040888963407); let word = ((old_state >> ((old_state >> 59) + 5)) ^ old_state).wrapping_mul(12605985483714917081); Ok((word >> 43) ^ word) } fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Self::Error> { fill_bytes_via_next_word(dest, || self.try_next_u64()) } } impl SeedableRng for Pcg64Si { type Seed = [u8; 8]; fn from_seed(seed: Self::Seed) -> Pcg64Si { Pcg64Si { state: u64::from_le_bytes(seed), } } } #[cfg(test)] mod tests { use super::*; use rand::Rng; use std::collections::HashSet; // For a given seed the RNG is deterministic // thus we can perform some basic tests consistently #[test] fn test_rng_next() { let mut rng = Pcg64Si::from_seed([1, 2, 3, 4, 5, 6, 7, 8]); let mut values_set: HashSet = HashSet::new(); // Generate 1000 values modulus 100 (so each value is between 0 and 99) for _ in 0..1000 { values_set.insert(rng.next_u32() % 100); } // Expect to generate every number between 0 and 99 (the generated values are somewhat evenly distributed) assert_eq!(values_set.len(), 100); } #[test] fn test_rng_from_seed() { // Different seeds should result in a different RNG state let rng1 = Pcg64Si::from_seed([1, 2, 3, 4, 5, 6, 7, 8]); let rng2 = Pcg64Si::from_seed([1, 2, 3, 4, 5, 6, 7, 7]); assert_ne!(rng1.state, rng2.state); } #[test] fn test_rng_fill_bytes() { // This uses the next_u64/u32 functions underneath, so don't need to test the pseudo randomness again let mut array: [u8; 8] = [0, 0, 0, 0, 0, 0, 0, 0]; let mut rng = Pcg64Si::from_seed([1, 2, 3, 4, 5, 6, 7, 8]); rng.fill_bytes(&mut array); assert_ne!(array, [0, 0, 0, 0, 0, 0, 0, 0]); } } ================================================ FILE: src/printer.rs ================================================ use crate::{result_data::ResultData, timescale::TimeScale}; use average::{Max, Min, Variance}; use byte_unit::Byte; use crossterm::style::{StyledContent, Stylize}; use hyper::http::{self, StatusCode}; use ratatui::crossterm; use std::{ collections::BTreeMap, io::Write, time::{Duration, Instant}, }; #[derive(Clone, Copy)] struct StyleScheme { style_enabled: bool, } impl StyleScheme { fn no_style(self, text: &str) -> StyledContent<&str> { StyledContent::new(crossterm::style::ContentStyle::new(), text) } fn heading(self, text: &str) -> StyledContent<&str> { if self.style_enabled { text.bold().underlined() } else { self.no_style(text) } } fn success_rate(self, text: &str, success_rate: f64) -> StyledContent<&str> { if self.style_enabled { if success_rate >= 100.0 { text.green().bold() } else if success_rate >= 99.0 { text.yellow().bold() } else { text.red().bold() } } else { self.no_style(text) } } fn fastest(self, text: &str) -> StyledContent<&str> { if self.style_enabled { text.green() } else { self.no_style(text) } } fn slowest(self, text: &str) -> StyledContent<&str> { if self.style_enabled { text.yellow() } else { self.no_style(text) } } fn average(self, text: &str) -> StyledContent<&str> { if self.style_enabled { text.cyan() } else { self.no_style(text) } } fn latency_distribution(self, text: &str, label: f64) -> StyledContent<&str> { // See #609 for justification of these thresholds const LATENCY_YELLOW_THRESHOLD: f64 = 0.1; const LATENCY_RED_THRESHOLD: f64 = 0.4; if self.style_enabled { if label <= LATENCY_YELLOW_THRESHOLD { text.green() } else if label <= LATENCY_RED_THRESHOLD { text.yellow() } else { text.red() } } else { self.no_style(text) } } fn status_distribution(self, text: &str, status: StatusCode) -> StyledContent<&str> { if self.style_enabled { if status.is_success() { text.green() } else if status.is_client_error() { text.yellow() } else if status.is_server_error() { text.red() } else { text.white() } } else { self.no_style(text) } } } #[derive(Clone, Copy, Debug, Default, clap::ValueEnum)] pub enum PrintMode { #[default] Text, Json, Csv, Quiet, } pub struct PrintConfig { pub output: Box, pub mode: PrintMode, pub disable_style: bool, pub stats_success_breakdown: bool, pub time_unit: Option, } pub fn print_result( mut config: PrintConfig, start: Instant, res: &ResultData, total_duration: Duration, ) -> anyhow::Result<()> { match config.mode { PrintMode::Text => print_summary( &mut config.output, res, total_duration, config.disable_style, config.stats_success_breakdown, config.time_unit, )?, PrintMode::Json => print_json( &mut config.output, start, res, total_duration, config.stats_success_breakdown, )?, PrintMode::Csv => print_csv(&mut config.output, start, res)?, PrintMode::Quiet => { /* Do nothing */ } } Ok(()) } /// Print all summary as JSON fn print_json( w: &mut W, start: Instant, res: &ResultData, total_duration: Duration, stats_success_breakdown: bool, ) -> serde_json::Result<()> { use serde::Serialize; #[derive(Serialize)] struct Summary { #[serde(rename = "successRate")] success_rate: f64, total: f64, slowest: f64, fastest: f64, average: f64, #[serde(rename = "requestsPerSec")] requests_per_sec: f64, #[serde(rename = "totalData")] total_data: u64, #[serde(rename = "sizePerRequest")] size_per_request: Option, #[serde(rename = "sizePerSec")] size_per_sec: f64, } #[derive(Serialize)] struct Triple { average: f64, fastest: f64, slowest: f64, } #[derive(Serialize)] struct Details { #[serde(rename = "DNSDialup")] dns_dialup: Triple, #[serde(rename = "DNSLookup")] dns_lookup: Triple, #[serde(rename = "firstByte")] first_byte: Triple, } #[derive(Serialize)] struct Rps { mean: f64, stddev: f64, max: f64, min: f64, percentiles: BTreeMap, } #[derive(Serialize)] struct Result { summary: Summary, #[serde(rename = "responseTimeHistogram")] response_time_histogram: BTreeMap, #[serde(rename = "latencyPercentiles")] latency_percentiles: BTreeMap, #[serde(rename = "firstByteHistogram")] first_byte_histogram: BTreeMap, #[serde(rename = "firstBytePercentiles")] first_byte_percentiles: BTreeMap, #[serde( rename = "responseTimeHistogramSuccessful", skip_serializing_if = "Option::is_none" )] response_time_histogram_successful: Option>, #[serde( rename = "latencyPercentilesSuccessful", skip_serializing_if = "Option::is_none" )] latency_percentiles_successful: Option>, #[serde( rename = "responseTimeHistogramNotSuccessful", skip_serializing_if = "Option::is_none" )] response_time_histogram_not_successful: Option>, #[serde( rename = "latencyPercentilesNotSuccessful", skip_serializing_if = "Option::is_none" )] latency_percentiles_not_successful: Option>, #[serde(rename = "rps")] rps: Rps, details: Details, #[serde(rename = "statusCodeDistribution")] status_code_distribution: BTreeMap, #[serde(rename = "errorDistribution")] error_distribution: BTreeMap, } let latency_stat = res.latency_stat(); let summary = Summary { success_rate: res.success_rate(), total: total_duration.as_secs_f64(), slowest: latency_stat.max(), fastest: latency_stat.min(), average: latency_stat.mean(), requests_per_sec: res.len() as f64 / total_duration.as_secs_f64(), total_data: res.total_data() as u64, size_per_request: res.size_per_request(), size_per_sec: res.total_data() as f64 / total_duration.as_secs_f64(), }; let durations_statistics = res.duration_all_statistics(); let response_time_histogram = durations_statistics .histogram .into_iter() .map(|(k, v)| (k.to_string(), v)) .collect(); let latency_percentiles = durations_statistics .percentiles .into_iter() .map(|(p, v)| (format!("p{p}"), v)) .collect(); let first_byte_statistics = res.first_byte_all_statistics(); let first_byte_histogram = first_byte_statistics .histogram .into_iter() .map(|(k, v)| (k.to_string(), v)) .collect(); let first_byte_percentiles = first_byte_statistics .percentiles .into_iter() .map(|(p, v)| (format!("p{p}"), v)) .collect(); let mut response_time_histogram_successful: Option> = None; let mut latency_percentiles_successful: Option> = None; let mut response_time_histogram_not_successful: Option> = None; let mut latency_percentiles_not_successful: Option> = None; if stats_success_breakdown { let durations_successful_statistics = res.duration_successful_statistics(); response_time_histogram_successful = Some( durations_successful_statistics .histogram .into_iter() .map(|(k, v)| (k.to_string(), v)) .collect(), ); latency_percentiles_successful = Some( durations_successful_statistics .percentiles .into_iter() .map(|(p, v)| (format!("p{p}"), v)) .collect(), ); let durations_not_successful_statistics = res.duration_not_successful_statistics(); response_time_histogram_not_successful = Some( durations_not_successful_statistics .histogram .into_iter() .map(|(k, v)| (k.to_string(), v)) .collect(), ); latency_percentiles_not_successful = Some( durations_not_successful_statistics .percentiles .into_iter() .map(|(p, v)| (format!("p{p}"), v)) .collect(), ); } let mut ends = res .end_times_from_start(start) .map(|d| d.as_secs_f64()) .collect::>(); ends.push(0.0); float_ord::sort(&mut ends); let mut rps: Vec = Vec::new(); // 10ms const INTERVAL: f64 = 0.01; let mut r = 0; loop { let prev_r = r; // increment at least 1 if r + 1 < ends.len() { r += 1; } while r + 1 < ends.len() && ends[prev_r] + INTERVAL > ends[r + 1] { r += 1; } if r == prev_r { break; } let n = r - prev_r; let t = ends[r] - ends[prev_r]; rps.push(n as f64 / t); } let rps_percentiles = percentiles(&mut rps); let variance = rps.iter().collect::(); let rps = Rps { mean: variance.mean(), stddev: variance.sample_variance().sqrt(), max: rps.iter().collect::().max(), min: rps.iter().collect::().min(), percentiles: rps_percentiles, }; let status_code_distribution = res.status_code_distribution(); let dns_dialup_stat = res.dns_dialup_stat(); let dns_lookup_stat = res.dns_lookup_stat(); let first_byte_stat = res.first_byte_stat(); let details = Details { dns_dialup: Triple { average: dns_dialup_stat.mean(), fastest: dns_dialup_stat.min(), slowest: dns_dialup_stat.max(), }, dns_lookup: Triple { average: dns_lookup_stat.mean(), fastest: dns_lookup_stat.min(), slowest: dns_lookup_stat.max(), }, first_byte: Triple { average: first_byte_stat.mean(), fastest: first_byte_stat.min(), slowest: first_byte_stat.max(), }, }; serde_json::to_writer_pretty( w, &Result { summary, response_time_histogram, latency_percentiles, first_byte_histogram, first_byte_percentiles, response_time_histogram_successful, latency_percentiles_successful, response_time_histogram_not_successful, latency_percentiles_not_successful, rps, details, status_code_distribution: status_code_distribution .into_iter() .map(|(k, v)| (k.as_u16().to_string(), v)) .collect(), error_distribution: res.error_distribution().clone(), }, ) } fn print_csv(w: &mut W, start: Instant, res: &ResultData) -> std::io::Result<()> { // csv header writeln!( w, "request-start,DNS,DNS+dialup,Response-delay,request-duration,bytes,status" )?; let mut success_requests = res.success().to_vec(); success_requests.sort_by_key(|r| r.start); for request in success_requests { let dns_and_dialup = match request.connection_time { Some(connection_time) => (connection_time.dns_lookup, connection_time.dialup), None => (std::time::Duration::ZERO, std::time::Duration::ZERO), }; let first_byte = match request.first_byte { Some(first_byte) => first_byte - request.start, None => std::time::Duration::ZERO, }; writeln!( w, "{},{},{},{},{},{},{}", (request.start - start).as_secs_f64(), dns_and_dialup.0.as_secs_f64(), dns_and_dialup.1.as_secs_f64(), first_byte.as_secs_f64(), request.duration().as_secs_f64(), request.len_bytes, request.status.as_u16(), )?; } Ok(()) } /// Print all summary as Text fn print_summary( w: &mut W, res: &ResultData, total_duration: Duration, disable_style: bool, stats_success_breakdown: bool, time_unit: Option, ) -> std::io::Result<()> { let style = StyleScheme { style_enabled: !disable_style, }; writeln!(w, "{}", style.heading("Summary:"))?; let success_rate = 100.0 * res.success_rate(); writeln!( w, "{}", style.success_rate( &format!(" Success rate:\t{success_rate:.2}%"), success_rate ) )?; let latency_stat = res.latency_stat(); // Determine timescale automatically let timescale = if let Some(timescale) = time_unit { timescale } else { // Use max latency (slowest request) TimeScale::from_f64(latency_stat.max()) }; writeln!( w, " Total:\t{:.4} {timescale}", total_duration.as_secs_f64() / timescale.as_secs_f64() )?; writeln!( w, "{}", style.slowest(&format!( " Slowest:\t{:.4} {timescale}", latency_stat.max() / timescale.as_secs_f64() )) )?; writeln!( w, "{}", style.fastest(&format!( " Fastest:\t{:.4} {timescale}", latency_stat.min() / timescale.as_secs_f64() )) )?; writeln!( w, "{}", style.average(&format!( " Average:\t{:.4} {timescale}", latency_stat.mean() / timescale.as_secs_f64() )) )?; writeln!( w, " Requests/sec:\t{:.4}", res.len() as f64 / total_duration.as_secs_f64() )?; writeln!(w)?; writeln!( w, " Total data:\t{:.2}", Byte::from_u64(res.total_data() as u64).get_appropriate_unit(byte_unit::UnitType::Binary) )?; if let Some(size) = res .size_per_request() .map(|n| Byte::from_u64(n).get_appropriate_unit(byte_unit::UnitType::Binary)) { writeln!(w, " Size/request:\t{size:.2}")?; } else { writeln!(w, " Size/request:\tNaN")?; } writeln!( w, " Size/sec:\t{:.2}", Byte::from_u64((res.total_data() as f64 / total_duration.as_secs_f64()) as u64) .get_appropriate_unit(byte_unit::UnitType::Binary) )?; writeln!(w)?; let duration_all_statistics = res.duration_all_statistics(); writeln!(w, "{}", style.heading("Response time histogram:"))?; print_histogram(w, &duration_all_statistics.histogram, style, timescale)?; writeln!(w)?; writeln!(w, "{}", style.heading("Response time distribution:"))?; print_distribution(w, &duration_all_statistics.percentiles, style, timescale)?; writeln!(w)?; if stats_success_breakdown { let durations_successful_statics = res.duration_successful_statistics(); writeln!( w, "{}", style.heading("Response time histogram (2xx only):") )?; print_histogram(w, &durations_successful_statics.histogram, style, timescale)?; writeln!(w)?; writeln!( w, "{}", style.heading("Response time distribution (2xx only):") )?; print_distribution( w, &durations_successful_statics.percentiles, style, timescale, )?; writeln!(w)?; let durations_not_successful = res.duration_not_successful_statistics(); writeln!( w, "{}", style.heading("Response time histogram (4xx + 5xx only):") )?; print_histogram(w, &durations_not_successful.histogram, style, timescale)?; writeln!(w)?; writeln!( w, "{}", style.heading("Response time distribution (4xx + 5xx only):") )?; print_distribution(w, &durations_not_successful.percentiles, style, timescale)?; writeln!(w)?; } writeln!(w)?; let dns_dialup_stat = res.dns_dialup_stat(); let dns_lookup_stat = res.dns_lookup_stat(); writeln!( w, "{}", style.heading("Details (average, fastest, slowest):") )?; writeln!( w, " DNS+dialup:\t{:.4} {timescale}, {:.4} {timescale}, {:.4} {timescale}", dns_dialup_stat.mean() / timescale.as_secs_f64(), dns_dialup_stat.min() / timescale.as_secs_f64(), dns_dialup_stat.max() / timescale.as_secs_f64() )?; writeln!( w, " DNS-lookup:\t{:.4} {timescale}, {:.4} {timescale}, {:.4} {timescale}", dns_lookup_stat.mean() / timescale.as_secs_f64(), dns_lookup_stat.min() / timescale.as_secs_f64(), dns_lookup_stat.max() / timescale.as_secs_f64() )?; writeln!(w)?; let status_dist: BTreeMap = res.status_code_distribution(); let mut status_v: Vec<(http::StatusCode, usize)> = status_dist.into_iter().collect(); status_v.sort_by_key(|t| std::cmp::Reverse(t.1)); writeln!(w, "{}", style.heading("Status code distribution:"))?; for (status, count) in status_v { writeln!( w, "{}", style.status_distribution( &format!(" [{}] {} responses", status.as_str(), count), status ) )?; } let mut error_v: Vec<(String, usize)> = res .error_distribution() .iter() .map(|(k, v)| (k.clone(), *v)) .collect(); error_v.sort_by_key(|t| std::cmp::Reverse(t.1)); if !error_v.is_empty() { writeln!(w)?; writeln!(w, "Error distribution:")?; for (error, count) in error_v { writeln!(w, " [{count}] {error}")?; } } Ok(()) } /// This is used to print histogram of response time. fn print_histogram( w: &mut W, data: &[(f64, usize)], style: StyleScheme, timescale: TimeScale, ) -> std::io::Result<()> { let max_bar = data.iter().map(|t| t.1).max().unwrap(); let str_len_max = max_bar.to_string().len(); let width = data .iter() .map(|t| ((t.0 / timescale.as_secs_f64()) as u64).to_string().len()) .max() .unwrap() + 4; for (label, b) in data.iter() { let indent = str_len_max - b.to_string().len(); write!( w, "{}", style.latency_distribution( &format!( " {:>width$.3} {timescale} [{}]{} |", label / timescale.as_secs_f64(), b, " ".repeat(indent), width = width ), *label ) )?; bar(w, *b as f64 / max_bar as f64, style, *label)?; writeln!(w)?; } Ok(()) } // Print Bar like ■■■■■■■■■ fn bar(w: &mut W, ratio: f64, style: StyleScheme, label: f64) -> std::io::Result<()> { // TODO: Use more block element code to show more precise bar let width = 32; for _ in 0..(width as f64 * ratio) as usize { write!(w, "{}", style.latency_distribution("■", label))?; } Ok(()) } fn percentile_iter(values: &mut [f64]) -> impl Iterator + '_ { float_ord::sort(values); [10.0, 25.0, 50.0, 75.0, 90.0, 95.0, 99.0, 99.9, 99.99] .iter() .map(move |&p| { let i = (p / 100.0 * values.len() as f64) as usize; (p, *values.get(i).unwrap_or(&f64::NAN)) }) } /// Print distribution of collection of f64 fn print_distribution( w: &mut W, percentiles: &[(f64, f64)], style: StyleScheme, timescale: TimeScale, ) -> std::io::Result<()> { for (p, v) in percentiles { writeln!( w, "{}", style.latency_distribution( &format!( " {p:.2}% in {:.4} {timescale}", v / timescale.as_secs_f64() ), *v ) )?; } Ok(()) } fn percentiles(values: &mut [f64]) -> BTreeMap { percentile_iter(values) .map(|(p, v)| (format!("p{p}"), v)) .collect() } #[cfg(test)] mod tests { use float_cmp::assert_approx_eq; use super::*; #[test] fn test_percentile_iter() { let mut values: [f64; 40] = [ 5.0, 5.0, 5.0, 5.0, 5.0, 10.0, 10.0, 10.0, 10.0, 10.0, 11.0, 11.0, 11.0, 11.0, 11.0, 11.0, 11.0, 11.0, 11.0, 11.0, 12.0, 12.0, 12.0, 12.0, 12.0, 12.0, 12.0, 12.0, 12.0, 12.0, 15.0, 15.0, 15.0, 15.0, 15.0, 20.0, 20.0, 20.0, 25.0, 30.0, ]; let result: Vec<(f64, f64)> = percentile_iter(&mut values).collect(); assert_approx_eq!(&[f64], &[result[0].0, result[0].1], &[10.0, 5_f64]); assert_approx_eq!(&[f64], &[result[1].0, result[1].1], &[25.0, 11_f64]); assert_approx_eq!(&[f64], &[result[2].0, result[2].1], &[50.0, 12_f64]); assert_approx_eq!(&[f64], &[result[3].0, result[3].1], &[75.0, 15_f64]); assert_approx_eq!(&[f64], &[result[4].0, result[4].1], &[90.0, 20_f64]); assert_approx_eq!(&[f64], &[result[5].0, result[5].1], &[95.0, 25_f64]); assert_approx_eq!(&[f64], &[result[6].0, result[6].1], &[99.0, 30_f64]); assert_approx_eq!(&[f64], &[result[7].0, result[7].1], &[99.9, 30_f64]); assert_approx_eq!(&[f64], &[result[8].0, result[8].1], &[99.99, 30_f64]); } } ================================================ FILE: src/request_generator.rs ================================================ use std::borrow::Cow; use bytes::Bytes; use http_body_util::Full; use hyper::http; use hyper::{HeaderMap, Method, Version}; use rand::Rng; use rand::seq::IndexedRandom; use thiserror::Error; use url::Url; use crate::aws_auth::{self, AwsSignatureConfig}; use crate::url_generator; pub struct Proxy { pub headers: HeaderMap, pub version: Version, } pub enum BodyGenerator { Static(Bytes), Random(Vec), } pub struct RequestGenerator { pub url_generator: url_generator::UrlGenerator, pub https: bool, // Only if http with proxy pub http_proxy: Option, pub method: Method, pub version: Version, pub headers: HeaderMap, pub body_generator: BodyGenerator, pub aws_config: Option, } #[derive(Error, Debug)] pub enum RequestGenerationError { #[error("URL generation error: {0}")] UrlGeneration(#[from] url_generator::UrlGeneratorError), #[error("Request building error: {0}")] RequestBuild(#[from] http::Error), #[error("AWS Signature error: {0}")] AwsSignature(#[from] aws_auth::AwsSignatureError), } impl RequestGenerator { #[inline] fn is_http1(&self) -> bool { self.version <= Version::HTTP_11 } fn generate_body(&self, rng: &mut R) -> Bytes { match &self.body_generator { BodyGenerator::Static(b) => b.clone(), BodyGenerator::Random(choices) => choices.choose(rng).cloned().unwrap_or_default(), } } pub fn generate( &self, rng: &mut R, ) -> Result<(Cow<'_, Url>, hyper::Request>), RequestGenerationError> { let url = self.url_generator.generate(rng)?; let body = self.generate_body(rng); let mut builder = hyper::Request::builder() .uri(if !self.is_http1() || self.http_proxy.is_some() { &url[..] } else { &url[url::Position::BeforePath..] }) .method(self.method.clone()) .version( self.http_proxy .as_ref() .map(|p| p.version) .unwrap_or(self.version), ); let mut headers = self.headers.clone(); // Apply AWS SigV4 if configured if let Some(aws_config) = &self.aws_config { aws_config.sign_request(self.method.as_str(), &mut headers, &url, &body)?; } if let Some(proxy) = &self.http_proxy { for (key, value) in proxy.headers.iter() { headers.insert(key, value.clone()); } } if self.version < Version::HTTP_2 { headers .entry(http::header::HOST) .or_insert_with(|| http::header::HeaderValue::from_str(url.authority()).unwrap()); } *builder.headers_mut().unwrap() = headers; let req = builder.body(Full::new(body))?; Ok((url, req)) } } ================================================ FILE: src/result_data.rs ================================================ use std::{ collections::BTreeMap, time::{Duration, Instant}, }; use average::{Estimate, Max, Mean, Min, concatenate}; use hyper::StatusCode; use crate::{ client::{ClientError, RequestResult}, histogram::histogram, }; /// Data container for the results of the all requests /// When a request is successful, the result is pushed to the `success` vector and the memory consumption will not be a problem because the number of successful requests is limited by network overhead. /// When a request fails, the error message is pushed to the `error` map because the number of error messages may huge. #[derive(Debug, Default)] pub struct ResultData { success: Vec, error_distribution: BTreeMap, } concatenate!(pub MinMaxMean, [Min, min], [Max, max], [Mean, mean]); pub struct Statistics { pub percentiles: Vec<(f64, f64)>, pub histogram: Vec<(f64, usize)>, } impl Statistics { /* private */ fn new(data: &mut [f64]) -> Self { float_ord::sort(data); Self { percentiles: percentile_iter(data).collect(), histogram: histogram(data, 11), } } } fn percentile_iter(values: &mut [f64]) -> impl Iterator + '_ { float_ord::sort(values); [10.0, 25.0, 50.0, 75.0, 90.0, 95.0, 99.0, 99.9, 99.99] .iter() .map(move |&p| { let i = (p / 100.0 * values.len() as f64) as usize; (p, *values.get(i).unwrap_or(&f64::NAN)) }) } impl ResultData { #[inline] pub fn push(&mut self, result: Result) { match result { Ok(result) => self.success.push(result), Err(err) => { let count = self.error_distribution.entry(err.to_string()).or_insert(0); *count += 1; } } } pub fn len(&self) -> usize { self.success.len() + self.error_distribution.values().sum::() } pub fn merge(&mut self, other: ResultData) { self.success.extend(other.success); for (k, v) in other.error_distribution { let count = self.error_distribution.entry(k).or_insert(0); *count += v; } } // An existence of this method doesn't prevent us to using hdrhistogram. // Because this is only called from `monitor` and `monitor` can collect own data. pub fn success(&self) -> &[RequestResult] { &self.success } // It's very happy if you can provide all below methods without array (= non liner memory consumption) and fast `push` runtime. pub fn success_rate(&self) -> f64 { let dead_line = ClientError::Deadline.to_string(); // We ignore deadline errors which are because of `-z` option, not because of the server let denominator = self.success.len() + self .error_distribution .iter() .filter_map(|(k, v)| if k == &dead_line { None } else { Some(v) }) .sum::(); let numerator = self.success.len(); numerator as f64 / denominator as f64 } pub fn latency_stat(&self) -> MinMaxMean { self.success .iter() .map(|result| result.duration().as_secs_f64()) .collect() } pub fn error_distribution(&self) -> &BTreeMap { &self.error_distribution } pub fn end_times_from_start(&self, start: Instant) -> impl Iterator + '_ { self.success.iter().map(move |result| result.end - start) } pub fn status_code_distribution(&self) -> BTreeMap { let mut dist = BTreeMap::new(); for result in &self.success { let count = dist.entry(result.status).or_insert(0); *count += 1; } dist } pub fn dns_dialup_stat(&self) -> MinMaxMean { self.success .iter() .filter_map(|r| r.connection_time.map(|ct| ct.dialup.as_secs_f64())) .collect() } pub fn dns_lookup_stat(&self) -> MinMaxMean { self.success .iter() .filter_map(|r| r.connection_time.map(|ct| ct.dns_lookup.as_secs_f64())) .collect() } pub fn first_byte_stat(&self) -> MinMaxMean { self.success .iter() .filter_map(|r| r.first_byte.map(|fb| (fb - r.start).as_secs_f64())) .collect() } pub fn total_data(&self) -> usize { self.success.iter().map(|r| r.len_bytes).sum() } pub fn size_per_request(&self) -> Option { self.success .iter() .map(|r| r.len_bytes as u64) .sum::() .checked_div(self.success.len() as u64) } pub fn duration_all_statistics(&self) -> Statistics { let mut data = self .success .iter() .map(|r| r.duration().as_secs_f64()) .collect::>(); Statistics::new(&mut data) } pub fn first_byte_all_statistics(&self) -> Statistics { let mut data = self .success .iter() .filter_map(|r| r.first_byte.map(|fb| (fb - r.start).as_secs_f64())) .collect::>(); Statistics::new(&mut data) } pub fn duration_successful_statistics(&self) -> Statistics { let mut data = self .success .iter() .filter(|r| r.status.is_success()) .map(|r| r.duration().as_secs_f64()) .collect::>(); Statistics::new(&mut data) } pub fn duration_not_successful_statistics(&self) -> Statistics { let mut data = self .success .iter() .filter(|r| !r.status.is_success()) .map(|r| r.duration().as_secs_f64()) .collect::>(); Statistics::new(&mut data) } } #[cfg(test)] mod tests { use float_cmp::assert_approx_eq; use rand::SeedableRng; use super::*; use crate::client::{ClientError, ConnectionTime, RequestResult}; use std::time::{Duration, Instant}; fn build_mock_request_result( status: StatusCode, request_time: u64, connection_time_dns_lookup: u64, connection_time_dialup: u64, first_byte: u64, size: usize, ) -> Result { let now = Instant::now(); Ok(RequestResult { rng: SeedableRng::seed_from_u64(0), start_latency_correction: None, start: now, connection_time: Some(ConnectionTime { dns_lookup: Duration::from_millis(connection_time_dns_lookup), dialup: Duration::from_millis(connection_time_dialup), }), first_byte: Some(now.checked_add(Duration::from_millis(first_byte)).unwrap()), end: now .checked_add(Duration::from_millis(request_time)) .unwrap(), status, len_bytes: size, }) } fn build_mock_request_results() -> ResultData { let mut results = ResultData::default(); results.push(build_mock_request_result( StatusCode::OK, 1000, 200, 50, 300, 100, )); results.push(build_mock_request_result( StatusCode::BAD_REQUEST, 100000, 250, 100, 400, 200, )); results.push(build_mock_request_result( StatusCode::INTERNAL_SERVER_ERROR, 1000000, 300, 150, 500, 300, )); results } #[test] fn test_calculate_success_rate() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.success_rate(), 1.0); } #[test] fn test_calculate_slowest_request() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.latency_stat().max(), 1000.0); } #[test] fn test_calculate_average_request() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.latency_stat().mean(), 367.0); } #[test] fn test_calculate_total_data() { let res = build_mock_request_results(); assert_eq!(res.total_data(), 600); } #[test] fn test_calculate_size_per_request() { let res = build_mock_request_results(); assert_eq!(res.size_per_request(), Some(200)); } #[test] fn test_calculate_connection_times_dns_dialup_average() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_dialup_stat().mean(), 0.1); } #[test] fn test_calculate_connection_times_dns_dialup_fastest() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_dialup_stat().min(), 0.05); } #[test] fn test_calculate_connection_times_dns_dialup_slowest() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_dialup_stat().max(), 0.15); } #[test] fn test_calculate_connection_times_dns_lookup_average() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_lookup_stat().mean(), 0.25); } #[test] fn test_calculate_connection_times_dns_lookup_fastest() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_lookup_stat().min(), 0.2); } #[test] fn test_calculate_connection_times_dns_lookup_slowest() { let res = build_mock_request_results(); assert_approx_eq!(f64, res.dns_lookup_stat().max(), 0.3); } } ================================================ FILE: src/timescale.rs ================================================ use std::{fmt, time::Duration}; #[derive(Clone, Copy, PartialEq, Eq, Debug, PartialOrd, Ord)] pub enum TimeScale { Nanosecond, // 1e-9 Microsecond, // 1e-6 Millisecond, // 1e-3 Second, // 1 TenSeconds, // 10 Minute, // 60 TenMinutes, // 600 Hour, // 3600 } #[derive(Clone, Copy, PartialEq, Eq, Debug)] pub struct TimeLabel { pub x: usize, pub timescale: TimeScale, } impl fmt::Display for TimeScale { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { TimeScale::Nanosecond => write!(f, "ns"), TimeScale::Microsecond => write!(f, "us"), TimeScale::Millisecond => write!(f, "ms"), TimeScale::Second => write!(f, "sec"), TimeScale::TenSeconds => write!(f, "10 sec"), TimeScale::Minute => write!(f, "min"), TimeScale::TenMinutes => write!(f, "10 min"), TimeScale::Hour => write!(f, "hr"), } } } impl fmt::Display for TimeLabel { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { TimeLabel { x, timescale: TimeScale::Nanosecond, } => write!(f, "{x}ns"), TimeLabel { x, timescale: TimeScale::Microsecond, } => write!(f, "{x}us"), TimeLabel { x, timescale: TimeScale::Millisecond, } => write!(f, "{x}ms"), TimeLabel { x, timescale: TimeScale::Second, } => write!(f, "{x}s"), TimeLabel { x, timescale: TimeScale::TenSeconds, } => write!(f, "{}s", 10 * x), TimeLabel { x, timescale: TimeScale::Minute, } => write!(f, "{x}m"), TimeLabel { x, timescale: TimeScale::TenMinutes, } => write!(f, "{}m", 10 * x), TimeLabel { x, timescale: TimeScale::Hour, } => write!(f, "{x}h"), } } } impl clap::ValueEnum for TimeScale { fn value_variants<'a>() -> &'a [Self] { &[ Self::Nanosecond, Self::Microsecond, Self::Millisecond, Self::Second, Self::Minute, Self::Hour, ] } fn to_possible_value(&self) -> Option { match self { TimeScale::Nanosecond => Some(clap::builder::PossibleValue::new("ns")), TimeScale::Microsecond => Some(clap::builder::PossibleValue::new("us")), TimeScale::Millisecond => Some(clap::builder::PossibleValue::new("ms")), TimeScale::Second => Some(clap::builder::PossibleValue::new("s")), TimeScale::Minute => Some(clap::builder::PossibleValue::new("m")), TimeScale::Hour => Some(clap::builder::PossibleValue::new("h")), TimeScale::TenSeconds | TimeScale::TenMinutes => None, } } } impl TimeScale { pub fn as_secs_f64(&self) -> f64 { match self { TimeScale::Nanosecond => 1e-9, TimeScale::Microsecond => 1e-6, TimeScale::Millisecond => 1e-3, TimeScale::Second => 1.0, TimeScale::TenSeconds => 10.0, TimeScale::Minute => 60.0, TimeScale::TenMinutes => 10.0 * 60.0, TimeScale::Hour => 60.0 * 60.0, } } /// From seconds as f64 pub fn from_f64(seconds: f64) -> Self { for ts in &[ TimeScale::Hour, TimeScale::TenMinutes, TimeScale::Minute, TimeScale::TenSeconds, TimeScale::Second, TimeScale::Millisecond, TimeScale::Microsecond, TimeScale::Nanosecond, ] { if seconds > ts.as_secs_f64() { return *ts; } } TimeScale::Nanosecond } pub fn from_elapsed(duration: Duration) -> Self { Self::from_f64(duration.as_secs_f64()) } pub fn inc(&self) -> Self { match self { TimeScale::Nanosecond => TimeScale::Microsecond, TimeScale::Microsecond => TimeScale::Millisecond, TimeScale::Millisecond => TimeScale::Second, TimeScale::Second => TimeScale::TenSeconds, TimeScale::TenSeconds => TimeScale::Minute, TimeScale::Minute => TimeScale::TenMinutes, TimeScale::TenMinutes => TimeScale::Hour, TimeScale::Hour => TimeScale::Hour, } } pub fn dec(&self) -> Self { match self { TimeScale::Nanosecond => TimeScale::Nanosecond, TimeScale::Microsecond => TimeScale::Nanosecond, TimeScale::Millisecond => TimeScale::Microsecond, TimeScale::Second => TimeScale::Millisecond, TimeScale::TenSeconds => TimeScale::Second, TimeScale::Minute => TimeScale::TenSeconds, TimeScale::TenMinutes => TimeScale::Minute, TimeScale::Hour => TimeScale::TenMinutes, } } } #[cfg(test)] mod tests { use super::*; fn assert_timescale_correct_for_seconds_range( range: [f64; 2], expected_timescale: TimeScale, expected_timescale_str: &str, expected_timescale_as_secs: f64, ) { for durations in range { let timescale = TimeScale::from_elapsed(Duration::from_secs_f64(durations)); assert_eq!(timescale, expected_timescale); assert_eq!(format!("{timescale}"), expected_timescale_str); assert_eq!(timescale.as_secs_f64(), expected_timescale_as_secs); } } #[test] fn test_timescale_ranges() { assert_timescale_correct_for_seconds_range( [f64::MIN_POSITIVE, 1e-6], TimeScale::Nanosecond, "ns", 1e-9, ); assert_timescale_correct_for_seconds_range( [0.000_001_1, 1e-3], TimeScale::Microsecond, "us", 1e-6, ); assert_timescale_correct_for_seconds_range( [0.001_1, 1.0], TimeScale::Millisecond, "ms", 1e-3, ); assert_timescale_correct_for_seconds_range([1.1, 10.0], TimeScale::Second, "sec", 1.0); assert_timescale_correct_for_seconds_range( [10.1, 60.0], TimeScale::TenSeconds, "10 sec", 10.0, ); assert_timescale_correct_for_seconds_range([60.1, 600.0], TimeScale::Minute, "min", 60.0); assert_timescale_correct_for_seconds_range( [600.1, 3600.0], TimeScale::TenMinutes, "10 min", 600.0, ); assert_timescale_correct_for_seconds_range( [3600.1, 31536000.0], TimeScale::Hour, "hr", 3600.0, ); } #[test] fn test_timescale_inc() { let timescale = TimeScale::from_elapsed(Duration::from_secs_f64(1e-10)); let timescale_microsecond = timescale.inc(); assert_eq!(timescale_microsecond, TimeScale::Microsecond); let timescale_millisecond = timescale_microsecond.inc(); assert_eq!(timescale_millisecond, TimeScale::Millisecond); let timescale_second = timescale_millisecond.inc(); assert_eq!(timescale_second, TimeScale::Second); let timescale_ten_seconds = timescale_second.inc(); assert_eq!(timescale_ten_seconds, TimeScale::TenSeconds); let timescale_minute = timescale_ten_seconds.inc(); assert_eq!(timescale_minute, TimeScale::Minute); let timescale_ten_minutes = timescale_minute.inc(); assert_eq!(timescale_ten_minutes, TimeScale::TenMinutes); let timescale_hour = timescale_ten_minutes.inc(); assert_eq!(timescale_hour, TimeScale::Hour); } #[test] fn test_timescale_dec() { let timescale = TimeScale::from_elapsed(Duration::from_secs_f64(31536000.0)); let timescale_ten_minutes = timescale.dec(); assert_eq!(timescale_ten_minutes, TimeScale::TenMinutes); let timescale_minute = timescale_ten_minutes.dec(); assert_eq!(timescale_minute, TimeScale::Minute); let timescale_ten_seconds = timescale_minute.dec(); assert_eq!(timescale_ten_seconds, TimeScale::TenSeconds); let timescale_second = timescale_ten_seconds.dec(); assert_eq!(timescale_second, TimeScale::Second); let timescale_millisecond = timescale_second.dec(); assert_eq!(timescale_millisecond, TimeScale::Millisecond); let timescale_microsecond = timescale_millisecond.dec(); assert_eq!(timescale_microsecond, TimeScale::Microsecond); let timescale_nanosecond = timescale_microsecond.dec(); assert_eq!(timescale_nanosecond, TimeScale::Nanosecond); } } ================================================ FILE: src/tls_config.rs ================================================ #[cfg(feature = "rustls")] pub struct RuslsConfigs { no_alpn: std::sync::Arc, alpn_h2: std::sync::Arc, alpn_h3: std::sync::Arc, } #[cfg(feature = "rustls")] impl RuslsConfigs { pub fn new( insecure: bool, cacert_pem: Option<&[u8]>, client_auth: Option<(&[u8], &[u8])>, ) -> Self { use rustls_pki_types::pem::PemObject; use std::sync::Arc; let mut root_cert_store = rustls::RootCertStore::empty(); for cert in rustls_native_certs::load_native_certs().expect("could not load platform certs") { root_cert_store.add(cert).unwrap(); } if let Some(cacert_pem) = cacert_pem { for der in rustls_pki_types::CertificateDer::pem_slice_iter(cacert_pem) { root_cert_store.add(der.unwrap()).unwrap(); } } let _ = rustls::crypto::CryptoProvider::install_default( rustls::crypto::aws_lc_rs::default_provider(), ); let builder = rustls::ClientConfig::builder().with_root_certificates(root_cert_store); let mut config = if let Some((cert, key)) = client_auth { let certs = rustls_pki_types::CertificateDer::pem_slice_iter(cert) .collect::, _>>() .unwrap(); let key = rustls_pki_types::PrivateKeyDer::from_pem_slice(key).unwrap(); builder.with_client_auth_cert(certs, key).unwrap() } else { builder.with_no_client_auth() }; if insecure { config .dangerous() .set_certificate_verifier(Arc::new(AcceptAnyServerCert)); } let mut no_alpn = config.clone(); no_alpn.alpn_protocols = vec![]; let mut alpn_h2 = config.clone(); alpn_h2.alpn_protocols = vec![b"h2".to_vec()]; let mut alpn_h3 = config; alpn_h3.alpn_protocols = vec![b"h3".to_vec()]; alpn_h3.enable_early_data = true; Self { no_alpn: Arc::new(no_alpn), alpn_h2: Arc::new(alpn_h2), alpn_h3: Arc::new(alpn_h3), } } pub fn config(&self, http: hyper::http::Version) -> &std::sync::Arc { use hyper::http; match http { http::Version::HTTP_09 | http::Version::HTTP_10 | http::Version::HTTP_11 => { &self.no_alpn } http::Version::HTTP_2 => &self.alpn_h2, http::Version::HTTP_3 => &self.alpn_h3, _ => panic!("nonsupported HTTP version"), } } } #[cfg(all(feature = "native-tls", not(feature = "rustls")))] pub struct NativeTlsConnectors { pub no_alpn: tokio_native_tls::TlsConnector, pub alpn_h2: tokio_native_tls::TlsConnector, } #[cfg(all(feature = "native-tls", not(feature = "rustls")))] impl NativeTlsConnectors { pub fn new( insecure: bool, cacert_pem: Option<&[u8]>, client_auth: Option<(&[u8], &[u8])>, ) -> Self { let new = |is_http2: bool| { let mut connector_builder = native_tls::TlsConnector::builder(); if let Some(cacert_pem) = cacert_pem { let cert = native_tls::Certificate::from_pem(cacert_pem) .expect("Failed to parse cacert_pem"); connector_builder.add_root_certificate(cert); } if insecure { connector_builder .danger_accept_invalid_certs(true) .danger_accept_invalid_hostnames(true); } if let Some((cert, key)) = client_auth { let cert = native_tls::Identity::from_pkcs8(cert, key) .expect("Failed to parse client_auth cert/key"); connector_builder.identity(cert); } if is_http2 { connector_builder.request_alpns(&["h2"]); } connector_builder .build() .expect("Failed to build native_tls::TlsConnector") .into() }; Self { no_alpn: new(false), alpn_h2: new(true), } } pub fn connector(&self, is_http2: bool) -> &tokio_native_tls::TlsConnector { if is_http2 { &self.alpn_h2 } else { &self.no_alpn } } } /// A server certificate verifier that accepts any certificate. #[cfg(feature = "rustls")] #[derive(Debug)] pub struct AcceptAnyServerCert; #[cfg(feature = "rustls")] impl rustls::client::danger::ServerCertVerifier for AcceptAnyServerCert { fn verify_server_cert( &self, _end_entity: &rustls_pki_types::CertificateDer<'_>, _intermediates: &[rustls_pki_types::CertificateDer<'_>], _server_name: &rustls_pki_types::ServerName<'_>, _ocsp_response: &[u8], _now: rustls_pki_types::UnixTime, ) -> Result { Ok(rustls::client::danger::ServerCertVerified::assertion()) } fn verify_tls12_signature( &self, _message: &[u8], _cert: &rustls_pki_types::CertificateDer<'_>, _dss: &rustls::DigitallySignedStruct, ) -> Result { Ok(rustls::client::danger::HandshakeSignatureValid::assertion()) } fn verify_tls13_signature( &self, _message: &[u8], _cert: &rustls_pki_types::CertificateDer<'_>, _dss: &rustls::DigitallySignedStruct, ) -> Result { Ok(rustls::client::danger::HandshakeSignatureValid::assertion()) } fn supported_verify_schemes(&self) -> Vec { rustls::crypto::CryptoProvider::get_default() .unwrap() .signature_verification_algorithms .supported_schemes() } } ================================================ FILE: src/url_generator.rs ================================================ use std::{borrow::Cow, string::FromUtf8Error}; use rand::prelude::*; use rand_regex::Regex; use thiserror::Error; use url::{ParseError, Url}; #[derive(Clone, Debug)] pub enum UrlGenerator { Static(Url), MultiStatic(Vec), Dynamic(Regex), } #[derive(Error, Debug)] pub enum UrlGeneratorError { #[error("{0}, generated url: {1}")] Parse(ParseError, String), #[error(transparent)] FromUtf8(#[from] FromUtf8Error), #[error("No valid URLs found")] NoURLs(), #[error(transparent)] Io(#[from] std::io::Error), } impl UrlGenerator { pub fn new_static(url: Url) -> Self { Self::Static(url) } pub fn new_multi_static(urls: Vec) -> Self { assert!(!urls.is_empty()); Self::MultiStatic(urls) } pub fn new_dynamic(regex: Regex) -> Self { Self::Dynamic(regex) } pub fn generate(&self, rng: &mut R) -> Result, UrlGeneratorError> { match self { Self::Static(url) => Ok(Cow::Borrowed(url)), Self::MultiStatic(urls) => { if let Some(random_url) = urls.choose(rng) { Ok(Cow::Borrowed(random_url)) } else { Err(UrlGeneratorError::NoURLs()) } } Self::Dynamic(regex) => { let generated = Distribution::>::sample(regex, rng)?; Ok(Cow::Owned( Url::parse(generated.as_str()) .map_err(|e| UrlGeneratorError::Parse(e, generated))?, )) } } } } #[cfg(test)] mod tests { use crate::pcg64si::Pcg64Si; use super::*; use rand_regex::Regex as RandRegex; use regex::Regex; use std::net::Ipv4Addr; use url::{Host, Url}; #[test] fn test_url_generator_static() { let url_generator = UrlGenerator::new_static(Url::parse("http://127.0.0.1/test").unwrap()); let url = url_generator.generate(&mut rand::rng()).unwrap(); assert_eq!(url.host(), Some(Host::Ipv4(Ipv4Addr::new(127, 0, 0, 1)))); assert_eq!(url.path(), "/test"); } #[test] fn test_url_generator_multistatic() { let urls = [ "http://127.0.0.1/a1", "http://127.0.0.1/b2", "http://127.0.0.1/c3", ]; let url_generator = UrlGenerator::new_multi_static(urls.iter().map(|u| Url::parse(u).unwrap()).collect()); for _ in 0..10 { let url = url_generator.generate(&mut rand::rng()).unwrap(); assert_eq!(url.host(), Some(Host::Ipv4(Ipv4Addr::new(127, 0, 0, 1)))); assert!(urls.contains(&url.as_str())); } } #[test] fn test_url_generator_dynamic() { let path_regex = "/[a-z][a-z][0-9]"; let url_generator = UrlGenerator::new_dynamic( RandRegex::compile(&format!(r"http://127\.0\.0\.1{path_regex}"), 4).unwrap(), ); let url = url_generator.generate(&mut rand::rng()).unwrap(); assert_eq!(url.host(), Some(Host::Ipv4(Ipv4Addr::new(127, 0, 0, 1)))); assert!( Regex::new(path_regex) .unwrap() .captures(url.path()) .is_some() ); } #[test] fn test_url_generator_dynamic_consistency() { let url_generator = UrlGenerator::new_dynamic( RandRegex::compile(r"http://127\.0\.0\.1/[a-z][a-z][0-9]", 4).unwrap(), ); for _ in 0..100 { let rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); assert_eq!( url_generator.generate(&mut rng.clone()).unwrap(), url_generator.generate(&mut rng.clone()).unwrap() ); } } #[test] fn test_url_generator_multi_consistency() { let urls = [ "http://example.com/a1", "http://example.com/a2", "http://example.com/a3", "http://example.com/a4", "http://example.com/a5", ]; let url_generator = UrlGenerator::new_multi_static(urls.iter().map(|u| Url::parse(u).unwrap()).collect()); for _ in 0..100 { let rng: Pcg64Si = SeedableRng::from_rng(&mut rand::rng()); assert_eq!( url_generator.generate(&mut rng.clone()).unwrap(), url_generator.generate(&mut rng.clone()).unwrap() ); } } } ================================================ FILE: tests/common/mod.rs ================================================ use std::{net::SocketAddr, sync::Arc}; use bytes::{Buf, Bytes}; use http::{Request, Response}; use kanal::Sender; use rustls::pki_types::{CertificateDer, PrivateKeyDer}; use h3::{quic::BidiStream, server::RequestStream}; use h3_quinn::quinn::{self, crypto::rustls::QuicServerConfig}; static ALPN: &[u8] = b"h3"; // This would be much cleaner if it took `process_request` as a callback, similar to the hyper service_fn. pub async fn h3_server( tx: Sender>, port: u16, ) -> Result<(), Box> { let listen = SocketAddr::new("127.0.0.1".parse().unwrap(), port); // Get the directory of the current file let current_file = file!(); let current_dir = std::path::Path::new(current_file) .parent() .unwrap_or_else(|| std::path::Path::new("")); // Construct paths to cert and key files let cert_path = current_dir.join("server.cert"); let key_path = current_dir.join("server.key"); // both cert and key must be DER-encoded let cert = CertificateDer::from(std::fs::read(&cert_path)?); let key = PrivateKeyDer::try_from(std::fs::read(&key_path)?)?; let _ = rustls::crypto::CryptoProvider::install_default( rustls::crypto::aws_lc_rs::default_provider(), ); let mut tls_config = rustls::ServerConfig::builder() .with_no_client_auth() .with_single_cert(vec![cert], key)?; tls_config.max_early_data_size = u32::MAX; tls_config.alpn_protocols = vec![ALPN.into()]; let server_config = quinn::ServerConfig::with_crypto(Arc::new(QuicServerConfig::try_from(tls_config)?)); let endpoint = quinn::Endpoint::server(server_config, listen)?; // handle incoming connections and requests while let Some(new_conn) = endpoint.accept().await { let tx = tx.clone(); let _ = tokio::spawn(async move { match new_conn.await { Ok(conn) => { let mut h3_conn = h3::server::Connection::new(h3_quinn::Connection::new(conn)) .await .unwrap(); let tx = tx.clone(); match h3_conn.accept().await { Ok(Some(request_resolver)) => { let (req, stream) = request_resolver.resolve_request().await.unwrap(); process_request(req, stream, tx).await } // indicating no more streams to be received Ok(None) => Ok(()), Err(_err) => { unimplemented!() // error!("error on accept {}", err); /* match err.get_error_level() { ErrorLevel::ConnectionError => break, ErrorLevel::StreamError => continue, } */ } } } Err(_err) => Ok(()), } }) .await?; } // shut down gracefully // wait for connections to be closed before exiting endpoint.wait_idle().await; Ok(()) } async fn process_request( req: Request<()>, mut stream: RequestStream, tx: Sender>, ) -> Result<(), h3::error::StreamError> where T: BidiStream, { let (parts, _) = req.into_parts(); let mut body_bytes = bytes::BytesMut::new(); while let Some(mut chunk) = stream.recv_data().await? { let bytes = chunk.copy_to_bytes(chunk.remaining()); body_bytes.extend_from_slice(&bytes); } let body = body_bytes.freeze(); let req = Request::from_parts(parts, body); tx.send(req).unwrap(); let resp = Response::new(()); stream.send_response(resp).await?; stream.send_data("Hello world".into()).await?; stream.finish().await } ================================================ FILE: tests/tests.rs ================================================ use std::{ convert::Infallible, error::Error as StdError, fs::File, future::Future, io::Write, net::{Ipv6Addr, SocketAddr}, str::FromStr, sync::{Arc, OnceLock, atomic::AtomicU16}, }; use axum::{Router, extract::Path, response::Redirect, routing::get}; use bytes::Bytes; use clap::Parser; use http::{HeaderMap, Request, Response}; use http_body_util::BodyExt; use http_mitm_proxy::MitmProxy; use hyper::{ body::{Body, Incoming}, http, service::{HttpService, service_fn}, }; use hyper_util::rt::{TokioExecutor, TokioIo}; use rstest::rstest; use rstest_reuse::{self, *}; #[cfg(feature = "http3")] mod common; async fn run<'a>(args: impl Iterator) { let opts = oha::Opts::parse_from( ["oha", "--no-tui", "--output-format", "quiet"] .into_iter() .chain(args), ); oha::run(opts).await.unwrap(); } // Port 5111- is reserved for testing static PORT: AtomicU16 = AtomicU16::new(5111); fn next_port() -> u16 { PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed) } #[ctor::ctor] fn install_crypto_provider() { static INSTALL: OnceLock<()> = OnceLock::new(); INSTALL.get_or_init(|| { let _ = rustls::crypto::CryptoProvider::install_default( rustls::crypto::aws_lc_rs::default_provider(), ); }); } async fn bind_port(port: u16) -> tokio::net::TcpListener { let addr = SocketAddr::new("127.0.0.1".parse().unwrap(), port); tokio::net::TcpListener::bind(addr).await.unwrap() } async fn bind_port_and_increment() -> (tokio::net::TcpListener, u16) { let port = next_port(); let listener = bind_port(port).await; (listener, port) } async fn bind_port_ipv6(port: u16) -> tokio::net::TcpListener { let addr = SocketAddr::new(std::net::IpAddr::V6(Ipv6Addr::LOCALHOST), port); tokio::net::TcpListener::bind(addr).await.unwrap() } #[derive(Clone, Copy, PartialEq)] enum HttpWorkType { H1, H2, #[cfg(feature = "http3")] H3, } fn http_work_type(args: &[&str]) -> HttpWorkType { // Check for HTTP/2 if args.contains(&"--http2") || args.windows(2).any(|w| w == ["--http-version", "2"]) { return HttpWorkType::H2; } // Check for HTTP/3 when the feature is enabled #[cfg(feature = "http3")] if args.contains(&"--http3") || args.windows(2).any(|w| w == ["--http-version", "3"]) { return HttpWorkType::H3; } // Default to HTTP/1.1 HttpWorkType::H1 } #[cfg(feature = "http3")] #[template] #[rstest] #[case("1.1")] #[case("2")] #[case("3")] fn test_all_http_versions(#[case] http_version_param: &str) {} #[cfg(not(feature = "http3"))] #[template] #[rstest] #[case("1.1")] #[case("2")] fn test_all_http_versions(#[case] http_version_param: &str) {} async fn get_req(path: &str, args: &[&str]) -> Request { let (tx, rx) = kanal::unbounded(); let port = next_port(); let work_type = http_work_type(args); let listener = bind_port(port).await; tokio::spawn(async move { match work_type { HttpWorkType::H2 => loop { let (tcp, _) = listener.accept().await.unwrap(); let tx = tx.clone(); let _ = hyper::server::conn::http2::Builder::new(TokioExecutor::new()) .serve_connection( TokioIo::new(tcp), service_fn(move |req: Request| { let tx = tx.clone(); async move { let (parts, body) = req.into_parts(); let body_bytes = body.collect().await.unwrap().to_bytes(); let req = Request::from_parts(parts, body_bytes); tx.send(req).unwrap(); Ok::<_, Infallible>(Response::new("Hello World".to_string())) } }), ) .await; }, HttpWorkType::H1 => { let (tcp, _) = listener.accept().await.unwrap(); hyper::server::conn::http1::Builder::new() .serve_connection( TokioIo::new(tcp), service_fn(move |req: Request| { let tx = tx.clone(); async move { let (parts, body) = req.into_parts(); let body_bytes = body.collect().await.unwrap().to_bytes(); let req = Request::from_parts(parts, body_bytes); tx.send(req).unwrap(); Ok::<_, Infallible>(Response::new("Hello World".to_string())) } }), ) .await .unwrap(); } #[cfg(feature = "http3")] HttpWorkType::H3 => { drop(listener); common::h3_server(tx, port).await.unwrap(); } } }); let mut args = args.iter().map(|s| s.to_string()).collect::>(); args.push("-n".to_string()); args.push("1".to_string()); match work_type { HttpWorkType::H1 | HttpWorkType::H2 => { args.push(format!("http://127.0.0.1:{port}{path}")); } #[cfg(feature = "http3")] HttpWorkType::H3 => { args.push("--insecure".to_string()); args.push(format!("https://127.0.0.1:{port}{path}")); } } run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap() } async fn redirect(n: usize, is_relative: bool, limit: usize) -> bool { let (tx, rx) = kanal::unbounded(); let (listener, port) = bind_port_and_increment().await; let app = Router::new().route( "/{n}", get(move |Path(x): Path| async move { Ok::<_, Infallible>(if x == n { tx.send(()).unwrap(); Redirect::permanent("/end") } else if is_relative { Redirect::permanent(&format!("/{}", x + 1)) } else { Redirect::permanent(&format!("http://localhost:{}/{}", port, x + 1)) }) }), ); tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), "--redirect".to_string(), limit.to_string(), format!("http://127.0.0.1:{port}/0"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().is_some() } async fn get_host_with_connect_to(host: &'static str) -> String { let (tx, rx) = kanal::unbounded(); let app = Router::new().route( "/", get(|header: HeaderMap| async move { tx.send(header.get("host").unwrap().to_str().unwrap().to_string()) .unwrap(); "Hello World" }), ); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), format!("http://{host}/"), "--connect-to".to_string(), format!("{host}:80:localhost:{port}"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap() } async fn get_host_with_connect_to_ipv6_target(host: &'static str) -> String { let (tx, rx) = kanal::unbounded(); let app = Router::new().route( "/", get(|header: HeaderMap| async move { tx.send(header.get("host").unwrap().to_str().unwrap().to_string()) .unwrap(); "Hello World" }), ); let port = next_port(); let listener = bind_port_ipv6(port).await; tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), format!("http://{host}/"), "--connect-to".to_string(), format!("{host}:80:[::1]:{port}"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap() } async fn get_host_with_connect_to_ipv6_requested() -> String { let (tx, rx) = kanal::unbounded(); let app = Router::new().route( "/", get(|header: HeaderMap| async move { tx.send(header.get("host").unwrap().to_str().unwrap().to_string()) .unwrap(); "Hello World" }), ); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), "http://[::1]/".to_string(), "--connect-to".to_string(), format!("[::1]:80:localhost:{port}"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap() } async fn get_host_with_connect_to_redirect(host: &'static str) -> String { let (tx, rx) = kanal::unbounded(); let app = Router::new() .route( "/source", get(move || async move { Redirect::permanent(&format!("http://{host}/destination")) }), ) .route( "/destination", get(move || async move { tx.send(host.to_string()).unwrap(); "Hello World" }), ); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), format!("http://{host}/source"), "--connect-to".to_string(), format!("{host}:80:localhost:{port}"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap() } async fn test_request_count(args: &[&str]) -> usize { let (tx, rx) = kanal::unbounded(); let app = Router::new().route( "/", get(|| async move { tx.send(()).unwrap(); "Success" }), ); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); let mut args: Vec = args.iter().map(|s| s.to_string()).collect(); args.push(format!("http://127.0.0.1:{port}")); run(args.iter().map(|s| s.as_str())).await; let mut count = 0; while let Ok(Some(())) = rx.try_recv() { count += 1; } count } // Randomly spread 100 requests on two matching --connect-to targets, and return a count for each async fn distribution_on_two_matching_connect_to(host: &'static str) -> (i32, i32) { let (tx1, rx1) = kanal::unbounded(); let (tx2, rx2) = kanal::unbounded(); let app1 = Router::new().route( "/", get(move || async move { tx1.send(()).unwrap(); "Success1" }), ); let app2 = Router::new().route( "/", get(move || async move { tx2.send(()).unwrap(); "Success2" }), ); let (listener1, port1) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener1, app1).await }); let (listener2, port2) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener2, app2).await }); let args = [ "--disable-keepalive".to_string(), "-n".to_string(), "100".to_string(), format!("http://{host}/"), "--connect-to".to_string(), format!("{host}:80:localhost:{port1}"), "--connect-to".to_string(), format!("{host}:80:localhost:{port2}"), ]; run(args.iter().map(|s| s.as_str())).await; let mut count1 = 0; let mut count2 = 0; loop { if rx1.try_recv().unwrap().is_some() { count1 += 1; } else if rx2.try_recv().unwrap().is_some() { count2 += 1; } else { break; } } (count1, count2) } #[apply(test_all_http_versions)] #[tokio::test(flavor = "multi_thread")] async fn test_enable_compression_default(http_version_param: &str) { let req = get_req("/", &["--http-version", http_version_param]).await; let accept_encoding: Vec<&str> = req .headers() .get("accept-encoding") .unwrap() .to_str() .unwrap() .split(", ") .collect(); assert!(accept_encoding.contains(&"gzip")); assert!(accept_encoding.contains(&"br")); } #[apply(test_all_http_versions)] #[tokio::test(flavor = "multi_thread")] async fn test_setting_custom_header(http_version_param: &str) { let req = get_req( "/", &["--http-version", http_version_param, "-H", "foo: bar"], ) .await; assert_eq!(req.headers().get("foo").unwrap().to_str().unwrap(), "bar"); } #[tokio::test(flavor = "multi_thread")] #[apply(test_all_http_versions)] async fn test_setting_accept_header(http_version_param: &str) { let req = get_req( "/", &["-A", "text/html", "--http-version", http_version_param], ) .await; assert_eq!( req.headers().get("accept").unwrap().to_str().unwrap(), "text/html" ); let req = get_req( "/", &[ "-H", "accept:text/html", "--http-version", http_version_param, ], ) .await; assert_eq!( req.headers().get("accept").unwrap().to_str().unwrap(), "text/html" ); } #[tokio::test(flavor = "multi_thread")] #[apply(test_all_http_versions)] async fn test_setting_body(http_version_param: &str) { let req = get_req( "/", &["-d", "hello body", "--http-version", http_version_param], ) .await; assert_eq!( req.into_body(), &b"hello body"[..] /* This looks dirty... Any suggestion? */ ); } #[tokio::test(flavor = "multi_thread")] async fn test_setting_content_type_header() { let req = get_req("/", &["-T", "text/html"]).await; assert_eq!( req.headers().get("content-type").unwrap().to_str().unwrap(), "text/html" ); let req = get_req("/", &["-H", "content-type:text/html"]).await; assert_eq!( req.headers().get("content-type").unwrap().to_str().unwrap(), "text/html" ); let req = get_req("/", &["--http2", "-T", "text/html"]).await; assert_eq!( req.headers().get("content-type").unwrap().to_str().unwrap(), "text/html" ); let req = get_req("/", &["--http2", "-H", "content-type:text/html"]).await; assert_eq!( req.headers().get("content-type").unwrap().to_str().unwrap(), "text/html" ); } #[apply(test_all_http_versions)] #[tokio::test(flavor = "multi_thread")] async fn test_setting_basic_auth(http_version_param: &str) { let req = get_req( "/", &["-a", "hatoo:pass", "--http-version", http_version_param], ) .await; assert_eq!( req.headers() .get("authorization") .unwrap() .to_str() .unwrap(), "Basic aGF0b286cGFzcw==" ); } #[tokio::test(flavor = "multi_thread")] async fn test_setting_host() { let req = get_req("/", &["--host", "hatoo.io"]).await; assert_eq!( req.headers().get("host").unwrap().to_str().unwrap(), "hatoo.io" ); let req = get_req("/", &["-H", "host:hatoo.io"]).await; assert_eq!( req.headers().get("host").unwrap().to_str().unwrap(), "hatoo.io" ); // You shouldn't set host header when using HTTP/2 // Use --connect-to instead } #[tokio::test(flavor = "multi_thread")] async fn test_setting_method() { assert_eq!(get_req("/", &[]).await.method(), http::method::Method::GET); assert_eq!( get_req("/", &["-m", "GET"]).await.method(), http::method::Method::GET ); assert_eq!( get_req("/", &["-m", "POST"]).await.method(), http::method::Method::POST ); assert_eq!( get_req("/", &["-m", "CONNECT"]).await.method(), http::method::Method::CONNECT ); assert_eq!( get_req("/", &["-m", "DELETE"]).await.method(), http::method::Method::DELETE ); assert_eq!( get_req("/", &["-m", "HEAD"]).await.method(), http::method::Method::HEAD ); assert_eq!( get_req("/", &["-m", "OPTIONS"]).await.method(), http::method::Method::OPTIONS ); assert_eq!( get_req("/", &["-m", "PATCH"]).await.method(), http::method::Method::PATCH ); assert_eq!( get_req("/", &["-m", "PUT"]).await.method(), http::method::Method::PUT ); assert_eq!( get_req("/", &["-m", "TRACE"]).await.method(), http::method::Method::TRACE ); assert_eq!( get_req("/", &["--http2"]).await.method(), http::method::Method::GET ); assert_eq!( get_req("/", &["--http2", "-m", "GET"]).await.method(), http::method::Method::GET ); assert_eq!( get_req("/", &["--http2", "-m", "POST"]).await.method(), http::method::Method::POST ); assert_eq!( get_req("/", &["--http2", "-m", "DELETE"]).await.method(), http::method::Method::DELETE ); assert_eq!( get_req("/", &["--http2", "-m", "HEAD"]).await.method(), http::method::Method::HEAD ); assert_eq!( get_req("/", &["--http2", "-m", "OPTIONS"]).await.method(), http::method::Method::OPTIONS ); assert_eq!( get_req("/", &["--http2", "-m", "PATCH"]).await.method(), http::method::Method::PATCH ); assert_eq!( get_req("/", &["--http2", "-m", "PUT"]).await.method(), http::method::Method::PUT ); assert_eq!( get_req("/", &["--http2", "-m", "TRACE"]).await.method(), http::method::Method::TRACE ); } #[tokio::test(flavor = "multi_thread")] async fn test_query() { assert_eq!( get_req("/index?a=b&c=d", &[]).await.uri().to_string(), "/index?a=b&c=d".to_string() ); assert_eq!( get_req("/index?a=b&c=d", &["--http2"]) .await .uri() .to_string() .split('/') .next_back() .unwrap(), "index?a=b&c=d".to_string() ); } #[tokio::test(flavor = "multi_thread")] async fn test_query_rand_regex() { let req = get_req("/[a-z][0-9][a-z]", &["--rand-regex-url"]).await; let chars = req .uri() .to_string() .trim_start_matches('/') .chars() .collect::>(); assert_eq!(chars.len(), 3); assert!(chars[0].is_ascii_lowercase()); assert!(chars[1].is_ascii_digit()); assert!(chars[2].is_ascii_lowercase()); let req = get_req("/[a-z][0-9][a-z]", &["--http2", "--rand-regex-url"]).await; let chars = req .uri() .to_string() .split('/') .next_back() .unwrap() .chars() .collect::>(); assert_eq!(chars.len(), 3); assert!(chars[0].is_ascii_lowercase()); assert!(chars[1].is_ascii_digit()); assert!(chars[2].is_ascii_lowercase()); } #[tokio::test(flavor = "multi_thread")] async fn test_redirect() { for n in 1..=5 { assert!(redirect(n, true, 10).await); assert!(redirect(n, false, 10).await); } for n in 11..=15 { assert!(!redirect(n, true, 10).await); assert!(!redirect(n, false, 10).await); } } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to() { assert_eq!( get_host_with_connect_to("invalid.example.org").await, "invalid.example.org" ) } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_randomness() { let (count1, count2) = distribution_on_two_matching_connect_to("invalid.example.org").await; assert!(count1 + count2 == 100); assert!(count1 >= 10 && count2 >= 10); // should not be too flaky with 100 coin tosses } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_ipv6_target() { assert_eq!( get_host_with_connect_to_ipv6_target("invalid.example.org").await, "invalid.example.org" ) } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_ipv6_requested() { assert_eq!(get_host_with_connect_to_ipv6_requested().await, "[::1]") } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_redirect() { assert_eq!( get_host_with_connect_to_redirect("invalid.example.org").await, "invalid.example.org" ) } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_http_proxy_override() { let (tx, rx) = kanal::unbounded(); let proxy_port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let listener = tokio::net::TcpListener::bind(("127.0.0.1", proxy_port)) .await .unwrap(); tokio::spawn(async move { let (stream, _) = listener.accept().await.unwrap(); let tx = tx.clone(); hyper::server::conn::http1::Builder::new() .preserve_header_case(true) .title_case_headers(true) .serve_connection( TokioIo::new(stream), service_fn(move |req: Request| { let tx = tx.clone(); async move { let authority = req .uri() .authority() .map(|a| a.to_string()) .expect("proxy received origin-form request"); let host = req .headers() .get("host") .and_then(|v| v.to_str().ok()) .map(|s| s.to_string()) .unwrap_or_default(); tx.send((authority, host)).unwrap(); Ok::<_, Infallible>(Response::new("proxy".to_string())) } }), ) .await .unwrap(); }); let override_port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let args = [ "-n".to_string(), "1".to_string(), "-x".to_string(), format!("http://127.0.0.1:{proxy_port}"), "--connect-to".to_string(), format!("example.test:80:127.0.0.1:{override_port}"), "http://example.test/".to_string(), ]; run(args.iter().map(|s| s.as_str())).await; let (authority, host) = rx.try_recv().unwrap().unwrap(); assert_eq!(authority, format!("127.0.0.1:{override_port}")); assert_eq!(host, "example.test"); } #[tokio::test(flavor = "multi_thread")] async fn test_connect_to_https_proxy_connect_override() { let (connect_tx, connect_rx) = kanal::unbounded(); let (host_tx, host_rx) = kanal::unbounded(); let service = service_fn(move |req: Request| { let host_tx = host_tx.clone(); async move { let host = req .headers() .get("host") .and_then(|h| h.to_str().ok()) .map(|s| s.to_string()) .unwrap_or_default(); host_tx.send(host).unwrap(); Ok::<_, Infallible>(Response::new("Hello World".to_string())) } }); let (proxy_port, proxy_serve) = bind_proxy_with_recorder(service, false, connect_tx.clone()).await; tokio::spawn(proxy_serve); let override_port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let args = vec![ "-n".to_string(), "1".to_string(), "--insecure".to_string(), "-x".to_string(), format!("http://127.0.0.1:{proxy_port}"), "--proxy-header".to_string(), "proxy-authorization: test".to_string(), "--connect-to".to_string(), format!("example.test:443:127.0.0.1:{override_port}"), "https://example.test/".to_string(), ]; run(args.iter().map(|s| s.as_str())).await; let connect_target = connect_rx.try_recv().unwrap().unwrap(); assert_eq!(connect_target, format!("127.0.0.1:{override_port}")); let host_header = host_rx.try_recv().unwrap().unwrap(); assert_eq!(host_header, "example.test"); } #[tokio::test(flavor = "multi_thread")] async fn test_ipv6() { let (tx, rx) = kanal::unbounded(); let app = Router::new().route( "/", get(|| async move { tx.send(()).unwrap(); "Hello World" }), ); let port = next_port(); let listener = bind_port_ipv6(port).await; tokio::spawn(async { axum::serve(listener, app).await }); let args = [ "-n".to_string(), "1".to_string(), format!("http://[::1]:{port}/"), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap(); } #[tokio::test(flavor = "multi_thread")] async fn test_query_limit() { // burst 10 requests with delay of 2s and rate of 4 let mut args = vec!["-n", "10", "--burst-delay", "2s", "--burst-rate", "4"]; assert_eq!(test_request_count(args.as_slice()).await, 10); args.push("--http2"); assert_eq!(test_request_count(args.as_slice()).await, 10); } #[tokio::test(flavor = "multi_thread")] async fn test_query_limit_with_time_limit() { // 1.75 qps for 2sec = expect 4 requests at times 0, 0.571, 1.142, 1,714sec assert_eq!(test_request_count(&["-z", "2s", "-q", "1.75"]).await, 4); } #[tokio::test(flavor = "multi_thread")] async fn test_http_versions() { assert_eq!(get_req("/", &[]).await.version(), http::Version::HTTP_11); assert_eq!( get_req("/", &["--http2"]).await.version(), http::Version::HTTP_2 ); assert_eq!( get_req("/", &["--http-version", "2"]).await.version(), http::Version::HTTP_2 ); #[cfg(feature = "http3")] assert_eq!( get_req("/", &["--http-version", "3"]).await.version(), http::Version::HTTP_3 ); } #[cfg(unix)] #[tokio::test(flavor = "multi_thread")] async fn test_unix_socket() { let (tx, rx) = kanal::unbounded(); let tmp = tempfile::tempdir().unwrap(); let path = tmp.path().join("socket"); let listener = std::os::unix::net::UnixListener::bind(&path).unwrap(); tokio::spawn(async move { actix_web::HttpServer::new(move || { let tx = actix_web::web::Data::new(tx.clone()); actix_web::App::new().service(actix_web::web::resource("/").to(move || { let tx = tx.clone(); async move { tx.send(()).unwrap(); "Hello World" } })) }) .listen_uds(listener) .unwrap() .run() .await .unwrap(); }); let args = [ "-n".to_string(), "1".to_string(), "--unix-socket".to_string(), path.to_str().unwrap().to_string(), "http://unix-socket.invalid-tld/".to_string(), ]; run(args.iter().map(|s| s.as_str())).await; rx.try_recv().unwrap().unwrap(); } fn make_root_issuer() -> rcgen::Issuer<'static, rcgen::KeyPair> { let mut params = rcgen::CertificateParams::default(); params.distinguished_name = rcgen::DistinguishedName::new(); params.distinguished_name.push( rcgen::DnType::CommonName, rcgen::DnValue::Utf8String("".to_string()), ); params.key_usages = vec![ rcgen::KeyUsagePurpose::KeyCertSign, rcgen::KeyUsagePurpose::CrlSign, ]; params.is_ca = rcgen::IsCa::Ca(rcgen::BasicConstraints::Unconstrained); let signing_key = rcgen::KeyPair::generate().unwrap(); rcgen::Issuer::new(params, signing_key) } async fn bind_proxy(service: S, http2: bool) -> (u16, impl Future) where S: HttpService + Clone + Send + 'static, S::Error: Into>, S::ResBody: Send + Sync + 'static, ::Data: Send, ::Error: Into>, S::Future: Send, { let port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let tcp_listener = tokio::net::TcpListener::bind(("127.0.0.1", port)) .await .unwrap(); let issuer = make_root_issuer(); let proxy = Arc::new(http_mitm_proxy::MitmProxy::new(Some(issuer), None)); let serve = async move { let (stream, _) = tcp_listener.accept().await.unwrap(); let proxy = proxy.clone(); let service = service.clone(); let outer = service_fn(move |req| { // Test --proxy-header option assert_eq!( req.headers() .get("proxy-authorization") .unwrap() .to_str() .unwrap(), "test" ); MitmProxy::wrap_service(proxy.clone(), service.clone()).call(req) }); tokio::spawn(async move { if http2 { let _ = hyper::server::conn::http2::Builder::new(TokioExecutor::new()) .serve_connection(TokioIo::new(stream), outer) .await; } else { let _ = hyper::server::conn::http1::Builder::new() .preserve_header_case(true) .title_case_headers(true) .serve_connection(TokioIo::new(stream), outer) .with_upgrades() .await; } }); }; (port, serve) } async fn bind_proxy_with_recorder( service: S, http2: bool, recorder: kanal::Sender, ) -> (u16, impl Future) where S: HttpService + Clone + Send + 'static, S::Error: Into>, S::ResBody: Send + Sync + 'static, ::Data: Send, ::Error: Into>, S::Future: Send, { let port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let tcp_listener = tokio::net::TcpListener::bind(("127.0.0.1", port)) .await .unwrap(); let issuer = make_root_issuer(); let proxy = Arc::new(http_mitm_proxy::MitmProxy::new(Some(issuer), None)); let serve = async move { let (stream, _) = tcp_listener.accept().await.unwrap(); let proxy = proxy.clone(); let service = service.clone(); let recorder = recorder.clone(); let outer = service_fn(move |req| { let recorder = recorder.clone(); if req.method() == hyper::Method::CONNECT { recorder.send(req.uri().to_string()).unwrap(); } assert_eq!( req.headers() .get("proxy-authorization") .unwrap() .to_str() .unwrap(), "test" ); MitmProxy::wrap_service(proxy.clone(), service.clone()).call(req) }); tokio::spawn(async move { if http2 { let _ = hyper::server::conn::http2::Builder::new(TokioExecutor::new()) .serve_connection(TokioIo::new(stream), outer) .await; } else { let _ = hyper::server::conn::http1::Builder::new() .preserve_header_case(true) .title_case_headers(true) .serve_connection(TokioIo::new(stream), outer) .with_upgrades() .await; } }); }; (port, serve) } async fn test_proxy_with_setting(https: bool, http2: bool, proxy_http2: bool) { let (proxy_port, proxy_serve) = bind_proxy( service_fn(|_req| async { let res = Response::new("Hello World".to_string()); Ok::<_, Infallible>(res) }), proxy_http2, ) .await; tokio::spawn(proxy_serve); let mut args = Vec::new(); let scheme = if https { "https" } else { "http" }; args.extend( [ "--no-tui", "-n", "1", "--no-tui", "--output-format", "quiet", "--insecure", "-x", ] .into_iter() .map(|s| s.to_string()), ); args.push(format!("http://127.0.0.1:{proxy_port}/")); args.extend( ["--proxy-header", "proxy-authorization: test"] .into_iter() .map(|s| s.to_string()), ); args.push(format!("{scheme}://example.com/")); if http2 { args.push("--http2".to_string()); } if proxy_http2 { args.push("--proxy-http2".to_string()); } use clap::Parser; let opts = oha::Opts::try_parse_from(args).unwrap(); oha::run(opts).await.unwrap(); } #[tokio::test(flavor = "multi_thread")] async fn test_proxy() { for https in [false, true] { for http2 in [false, true] { for proxy_http2 in [false, true] { test_proxy_with_setting(https, http2, proxy_http2).await; } } } } #[tokio::test(flavor = "multi_thread")] async fn test_google() { let temp_path = tempfile::NamedTempFile::new().unwrap().into_temp_path(); let args = vec![ "oha".to_string(), "--no-tui".to_string(), "-n".to_string(), "1".to_string(), "https://www.google.com/".to_string(), "--output".to_string(), temp_path.to_str().unwrap().to_string(), ]; let opts = oha::Opts::try_parse_from(args).unwrap(); oha::run(opts).await.unwrap(); let output = std::fs::read_to_string(&temp_path).unwrap(); assert!(output.contains("[200] 1 responses\n")); } #[tokio::test(flavor = "multi_thread")] async fn test_json_schema() { let app = Router::new().route("/", get(|| async move { "Hello World" })); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); const SCHEMA: &str = include_str!("../schema.json"); let schema_value: serde_json::Value = serde_json::from_str(SCHEMA).unwrap(); let validator = jsonschema::validator_for(&schema_value).unwrap(); let temp_path = tempfile::NamedTempFile::new().unwrap().into_temp_path(); let args = vec![ "oha".to_string(), "--no-tui".to_string(), "-n".to_string(), "10".to_string(), "--output-format".to_string(), "json".to_string(), format!("http://127.0.0.1:{port}/"), "--output".to_string(), temp_path.to_str().unwrap().to_string(), ]; let opts = oha::Opts::try_parse_from(args).unwrap(); oha::run(opts).await.unwrap(); let output_json = std::fs::read_to_string(&temp_path).unwrap(); let temp_path = tempfile::NamedTempFile::new().unwrap().into_temp_path(); let args = vec![ "oha".to_string(), "--no-tui".to_string(), "-n".to_string(), "10".to_string(), "--output-format".to_string(), "json".to_string(), "--stats-success-breakdown".to_string(), format!("http://127.0.0.1:{port}/"), "--output".to_string(), temp_path.to_str().unwrap().to_string(), ]; let opts = oha::Opts::try_parse_from(args).unwrap(); oha::run(opts).await.unwrap(); let output_json_stats_success_breakdown = std::fs::read_to_string(&temp_path).unwrap(); let value: serde_json::Value = serde_json::from_str(&output_json).unwrap(); let value_stats_success_breakdown: serde_json::Value = serde_json::from_str(&output_json_stats_success_breakdown).unwrap(); if validator.validate(&value).is_err() { for error in validator.iter_errors(&value) { eprintln!("{error}"); } panic!("JSON schema validation failed\n{output_json}"); } if validator.validate(&value_stats_success_breakdown).is_err() { for error in validator.iter_errors(&value_stats_success_breakdown) { eprintln!("{error}"); } panic!("JSON schema validation failed\n{output_json_stats_success_breakdown}"); } } #[tokio::test(flavor = "multi_thread")] async fn test_csv_output() { let app = Router::new().route("/", get(|| async move { "Hello World" })); let (listener, port) = bind_port_and_increment().await; tokio::spawn(async { axum::serve(listener, app).await }); let temp_path = tempfile::NamedTempFile::new().unwrap().into_temp_path(); let args = vec![ "oha".to_string(), "--no-tui".to_string(), "-n".to_string(), "5".to_string(), "--output-format".to_string(), "csv".to_string(), format!("http://127.0.0.1:{port}/"), "--output".to_string(), temp_path.to_str().unwrap().to_string(), ]; let opts = oha::Opts::try_parse_from(args).unwrap(); oha::run(opts).await.unwrap(); let output_csv = std::fs::read_to_string(&temp_path).unwrap(); // Validate that we get CSV output in following format, // header and one row for each request: // request-start,DNS,DNS+dialup,Response-delay,request-duration,bytes,status // 0.002211678,0.000374078,0.001148565,0.002619327,0.002626127,11,200 // ... let lines: Vec<&str> = output_csv.lines().collect(); assert_eq!(lines.len(), 6); assert_eq!( lines[0], "request-start,DNS,DNS+dialup,Response-delay,request-duration,bytes,status" ); let mut latest_start = 0f64; for line in lines.iter().skip(1) { let parts: Vec<&str> = line.split(",").collect(); assert_eq!(parts.len(), 7); // validate that the requests are in ascending time order let current_start = f64::from_str(parts[0]).unwrap(); assert!(current_start >= latest_start); latest_start = current_start; assert!(f64::from_str(parts[1]).unwrap() >= 0f64); assert!(f64::from_str(parts[2]).unwrap() >= 0f64); assert!(f64::from_str(parts[3]).unwrap() > 0f64); assert!(f64::from_str(parts[4]).unwrap() > 0f64); assert_eq!(usize::from_str(parts[5]).unwrap(), 11); assert_eq!(u16::from_str(parts[6]).unwrap(), 200); } } fn setup_mtls_server( dir: std::path::PathBuf, ) -> (u16, impl Future>) { let port = PORT.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let addr = SocketAddr::from(([127, 0, 0, 1], port)); // build our application with a route let app = Router::new() // `GET /` goes to `root` .route("/", get(|| async { "Hello, World" })); let make_cert = || { // Workaround for mac & native-tls // https://github.com/sfackler/rust-native-tls/issues/225 let key_pair = rcgen::KeyPair::generate_for(&rcgen::PKCS_RSA_SHA256).unwrap(); let params = rcgen::CertificateParams::new(vec!["localhost".to_string()]).unwrap(); let cert = params.self_signed(&key_pair).unwrap(); (cert, key_pair) }; let server_cert = make_cert(); let client_cert = make_cert(); let mut roots = rustls::RootCertStore::empty(); roots.add(client_cert.0.der().clone()).unwrap(); let _ = rustls::crypto::CryptoProvider::install_default( rustls::crypto::aws_lc_rs::default_provider(), ); let verifier = rustls::server::WebPkiClientVerifier::builder(Arc::new(roots)) .build() .unwrap(); let config = rustls::ServerConfig::builder() .with_client_cert_verifier(verifier) .with_single_cert( vec![server_cert.0.der().clone()], rustls::pki_types::PrivateKeyDer::Pkcs8(rustls::pki_types::PrivatePkcs8KeyDer::from( server_cert.1.serialize_der(), )), ) .unwrap(); let config = axum_server::tls_rustls::RustlsConfig::from_config(Arc::new(config)); File::create(dir.join("server.crt")) .unwrap() .write_all(server_cert.0.pem().as_bytes()) .unwrap(); File::create(dir.join("client.crt")) .unwrap() .write_all(client_cert.0.pem().as_bytes()) .unwrap(); File::create(dir.join("client.key")) .unwrap() .write_all(client_cert.1.serialize_pem().as_bytes()) .unwrap(); ( port, axum_server::bind_rustls(addr, config).serve(app.into_make_service()), ) } #[tokio::test(flavor = "multi_thread")] async fn test_mtls() { let dir = tempfile::tempdir().unwrap(); let (port, server) = setup_mtls_server(dir.path().to_path_buf()); tokio::spawn(server); let args = vec![ "-n".to_string(), "1".to_string(), "--cacert".to_string(), dir.path().join("server.crt").to_string_lossy().to_string(), "--cert".to_string(), dir.path().join("client.crt").to_string_lossy().to_string(), "--key".to_string(), dir.path().join("client.key").to_string_lossy().to_string(), format!("https://localhost:{port}/"), ]; run(args.iter().map(|s| s.as_str())).await; } #[tokio::test(flavor = "multi_thread")] async fn test_body_path_lines() { let body = "0\n1\n2"; let mut tmp = tempfile::NamedTempFile::new().unwrap(); tmp.write_all(body.as_bytes()).unwrap(); let tmp_path = tmp.path().to_str().unwrap(); let mut counts = [0; 3]; for _ in 0..32 { let req = get_req("/", ["-Z", tmp_path, "-m", "POST"].as_slice()).await; let req_body = req.into_body(); let line = std::str::from_utf8(&req_body).unwrap(); counts[line.parse::().unwrap()] += 1; } // test failure rate should be very low assert!(counts.iter().all(|&c| c > 0)); }