schemathesis 3.25.5__tar.gz → 4.0.0a1__tar.gz

schemathesis-4.0.0a1/.github/workflows/build.yml

@@ -0,0 +1,123 @@
+name: CI
+
+on:
+  pull_request:
+    paths:
+      - "**.py"
+      - ".github/workflows/*.yml"
+      - ".pre-commit-config.yaml"
+      - ".relint.yml"
+      - ".yamllint"
+      - "pyproject.toml"
+      - "tox.ini"
+      - "mypy.ini"
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1"
+  TOX_TESTENV_PASSENV: FORCE_COLOR
+
+jobs:
+  pre-commit:
+    name: Generic pre-commit checks
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uvx pre-commit run --all-files
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+      - uses: ammaraskar/sphinx-action@7.0.0
+        with:
+          docs-folder: "docs/"
+
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-2019]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+
+    name: Tests (Python ${{ matrix.python }} on ${{ matrix.os }} ${{ matrix.tox_env }})
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - if: ${{ matrix.tox_env }}
+        run: uvx --with="tox" --with="tox-gh-actions" --with="tox-uv" tox -e ${{ matrix.tox_env }}
+
+      - if: ${{ !matrix.tox_env }}
+        run: uvx --with="tox" --with="tox-gh-actions" --with="tox-uv" tox
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5.1.2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # On windows redirecting output to a file could lead to an error due to the default IO encoding being CP-1252
+  tests-pipe-with-encoding:
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-2019]
+      fail-fast: false
+    name: Test piping output to a file with CP1252 encoding on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uv tool install ".[dev]"
+
+      - run: uv tool run schemathesis run /openapi.json --app=cp1252_app:app -c custom_check > out.txt || true
+        working-directory: ./test/apps
+        env:
+          SCHEMATHESIS_HOOKS: hooks
+          PYTHONIOENCODING: cp1252
+
+      - run: |
+          if grep -Fq "UnicodeEncodeError" "out.txt"; then
+            echo "Failed!"
+            exit 1
+          fi
+        working-directory: ./test/apps
+        shell: bash
+
+  spell-check:
+    name: Spell Check
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: crate-ci/typos@master

schemathesis-4.0.0a1/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,66 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: "0 15 * * 5"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ["python"]
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4.2.1
+        with:
+          # We must fetch at least the immediate parents so that if this is
+          # a pull request then we can checkout the head.
+          fetch-depth: 2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3.28.0
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3.28.0
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3.28.0

schemathesis-4.0.0a1/.github/workflows/codspeed.yml

@@ -0,0 +1,29 @@
+name: Benchmarks
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+  workflow_dispatch:
+
+env:
+  SCHEMATHESIS_BENCHMARK_SEED: "42"
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.1
+      - uses: actions/setup-python@v5
+        with:
+          # Python 3.12 for flamegraph support
+          python-version: "3.12"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: uvx --from=".[bench]" pytest benches/* --codspeed -p no:schemathesis -p no:hypothesispytest -p no:subtests -p no:anyio

schemathesis-4.0.0a1/.github/workflows/commit.yml

@@ -0,0 +1,19 @@
+name: Checks for every commit
+
+on:
+  pull_request: ~
+  push:
+    branches:
+      - master
+
+jobs:
+  commitsar:
+    name: Verify commit messages
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 0
+      - name: Run commitsar
+        uses: aevea/commitsar@v0.20.2

schemathesis-4.0.0a1/.github/workflows/example-build.yml

@@ -0,0 +1,40 @@
+name: Manual build API example
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/example-build.yml"
+      - "example/**"
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  local-ci:
+    name: Example app
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4.2.1
+
+      - name: Start containers
+        run: docker compose up -d --build
+        working-directory: "./example"
+
+      # Runs positive Schemathesis tests
+      - uses: schemathesis/action@v1
+        continue-on-error: true
+        with:
+          # A local API schema location
+          schema: "http://127.0.0.1:5123/openapi.json"
+          # Set your token from secrets
+          token: ${{ secrets.SCHEMATHESIS_TOKEN }}
+          max-examples: "10"
+          # To avoid failing the build
+          args: "-E does-not-exist"
+
+      - name: Stop containers
+        if: always()
+        run: docker compose down
+        working-directory: "./example"

schemathesis-4.0.0a1/.github/workflows/master_update.yml

@@ -0,0 +1,53 @@
+name: Post-update master jobs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  containers:
+    name: Build container images
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - dockerfile: Dockerfile
+            tag: "latest"
+          - dockerfile: Dockerfile.bookworm
+            tag: "latest-bookworm"
+
+    steps:
+      - uses: actions/checkout@v4.2.1
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ${{ matrix.dockerfile }}
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: |
+            schemathesis/schemathesis:${{ matrix.tag }}
+            ghcr.io/schemathesis/schemathesis:${{ matrix.tag }}

schemathesis-4.0.0a1/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Post-release jobs
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  containers:
+    name: Build container images
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - dockerfile: Dockerfile
+            tag-suffix: ""
+          - dockerfile: Dockerfile.bookworm
+            tag-suffix: "-bookworm"
+
+    steps:
+      - uses: actions/checkout@v4.2.1
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          flavor: |
+            latest=false
+          images: |
+            schemathesis/schemathesis
+            ghcr.io/schemathesis/schemathesis
+          tags: |
+            type=semver,pattern={{raw}}${{ matrix.tag-suffix }}
+            type=semver,pattern={{version}}${{ matrix.tag-suffix }}
+            type=raw,value=stable${{ matrix.tag-suffix }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ${{ matrix.dockerfile }}
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  release_package:
+    name: Build and publish package to pypi.org
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Build package
+        run: uvx hatchling build
+
+      - name: Publish distribution package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

schemathesis-4.0.0a1/.github/workflows/test-corpus.yml

@@ -0,0 +1,43 @@
+name: Run corpus tests
+
+on:
+  schedule:
+    # Every day at 00:00
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+
+  corpus-default:
+    name: Default corpus tests
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+          submodules: true
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uvx --from=".[tests]" pytest test-corpus -n auto -k test_default
+
+  corpus-coverage:
+    name: Corpus tests for the coverage phase
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+          submodules: true
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uvx --from=".[tests]" pytest test-corpus -n auto -k test_coverage_phase

schemathesis-4.0.0a1/.github/workflows/test-hypothesis.yml

@@ -0,0 +1,24 @@
+name: Hypothesis tests
+
+on:
+  schedule:
+    # Every day at 00:00
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+  hypothesis-tests:
+    name: Hypothesis tests with CI profile
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uvx --from=".[tests]" pytest -m hypothesis -m hypothesis_nested --hypothesis-profile CI test

schemathesis-4.0.0a1/.github/workflows/update-pre-commit.yml

@@ -0,0 +1,32 @@
+name: Update pre-commit
+
+on:
+  schedule:
+    - cron: 0 0 * * 0
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Update pre-commit
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4.2.1
+        with:
+          fetch-depth: 1
+          submodules: true
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uvx pre-commit autoupdate
+
+      - name: Open pull request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          delete-branch: true
+          title: Update pre-commit
+          body: Automatically update pre-commit
+          commit-message: 'chore: Update pre-commit'
+          committer: 'CI on behalf of the Schemathesis team <team@schemathesis.io>'
+          author: 'CI on behalf of the Schemathesis team <team@schemathesis.io>'
+          branch: "create-pull-request/update-pre-commit"

schemathesis-4.0.0a1/.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^.*\.(md|rst|raw)$
+      - id: debug-statements
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: check-merge-conflict
+
+  - repo: https://github.com/jorisroovers/gitlint
+    rev: v0.19.1
+    hooks:
+      - id: gitlint
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        exclude: ^(docs/|test/|test-corpus/|example/|benches/).*$
+        args: ["--ignore-missing-imports"]
+        additional_dependencies: [types-requests, types-PyYAML]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.1
+    hooks:
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.1
+    hooks:
+      - id: ruff
+
+  - repo: https://github.com/myint/rstcheck
+    rev: v6.2.4
+    hooks:
+      - id: rstcheck
+        additional_dependencies:
+          - sphinx==7.1.2
+          - sphinx_rtd_theme==1.3
+          - sphinx-click==5.1
+        args:
+          - --ignore-roles=issue,version

schemathesis-4.0.0a1/ARCHITECTURE.md

@@ -0,0 +1,121 @@
+# Architecture
+
+This document describes the high-level architecture of Schemathesis.
+
+## Core concepts
+
+Schemathesis is initially built around Hypothesis, a framework for property-based testing and inherits a lot of design decisions from it. These are the main steps of how Schemathesis tests API:
+
+1. Break down an API schema into a set of data generators 
+2. Generate test cases with these generators and send them to the API under test
+3. Run a set of checks on the received responses
+4. Report any found failures
+
+Steps 2 to 4 follow the common action - assert pattern and either generated by Schemathesis dynamically, or exposed via its Python API so the users can extend this flow. 
+
+However, to run the generators, store results, de-duplicate failures and such, Schemathesis runs this test flow by means provided by Hypothesis. That is, Schemathesis generates a test and provides tools to configure it, then this test is executed by Hypothesis.
+
+It is important to note that Schemathesis has a Python API and integrates with `pytest`, however, it is main usage scenario is a CLI.
+
+## `core` - low-level core components
+
+These components do not depend on any API specification.
+
+### `core/schemas`
+
+The first layer is how Schemathesis works with API schemas. This package contains various functions to facilitate easy access to different components of API schemas based on a spec.
+
+- `core/schemas/selection`. Tools to select a subset of a schema.
+
+### `core/generator`
+
+Another component is data generation where Schemathesis uses Hypothesis & its plugins to produce data samples of needed shape and form. This package contains:
+
+- `core/generator/filters` - facilities to detect whether generated samples can be used for a test.
+
+Generally, Schemathesis' generators try to create data without using filters to avoid spending resources on generation, but it is not always easily possible, and `filters` contain rather performance-sensitive code.
+
+### `core/errors`
+
+Base error handling that is not tied to any specific API specification or execution context. Contains fundamental error types for:
+
+- Schema processing
+- Data serialization
+- Generic validation
+
+### `core/marks`
+
+A mechanism for attaching Schemathesis-specific metadata to test functions. Since Schemathesis integrates with external testing frameworks (Hypothesis, pytest) that primarily operate on test functions, we need a way to associate additional context with these functions.
+
+### `core/checks`
+
+Tools to check API responses.
+
+### `core/hooks`
+
+A system to extend Schemathesis
+
+### `core/loaders`
+
+Loading API schemas.
+
+### `core/transports`
+
+Utilities for sending & receiving data.
+
+- `core/rate_limit`
+
+### `core/output`
+
+Utilities to work with how Schemathesis output its results.
+
+## Intermediate-level API
+
+This layer is built on top of `core` and combines its different components to provide building blocks for concrete API specification.
+Some parts are re-exported to the public API in order to provide a way to extend Schemathesis.
+
+### `openapi`
+
+- `openapi/checks`. Open API-specific checks
+
+### `graphql`
+
+- `graphql/checks`. GraphQL-specific checks
+
+### `engine`
+
+Schemathesis Engine brings together other low-level components and executes tests. It is designed to be embeddable and powers Schemathesis CLI. Its execution flow contains separate phases that may share context to improve subsequent phases. The main interface it provides is a stream of events. During execution, the engine 
+collects information about the API and uses it to improve data generation in subsequent phases.
+
+- `engine/phases/probes`. Makes requests to learn about API capabilities, for example, whether it accepts `NULL` bytes or immediately rejects it, so Schemathesis won't spend time generating data with `NULL` bytes.
+- `engine/phases/explicit`. Tests based on examples specified in the schema with minimal data generation. 
+- `engine/phases/coverage`. Deterministically generates test cases to cover common "positive" and "negative" testing scenarios depending on the configuration. 
+- `engine/phases/unit`. Unit testing phase. Each available API operation is tested in isolation.
+- `engine/phases/stateful`. Stateful testing phase. This phase builds connections between different API endpoints and tests them in random sequences reusing response data as input for other operations.
+
+### `service`
+
+Integration with SaaS
+
+## High-level API
+
+### `cli`
+
+CLI is built on top of `engine` and consumes events coming from it. The execution process is based on a set of event handlers that process events. Other than that, handlers use actor-based communication model to share information among other handlers (i.e. ask the output handler to print to stdout or report handler to add an entry to report). This model is intended to decouple handlers, allow graceful error handling, and centralize output tasks (especially for stdout).
+
+- `cli/commands`
+- `cli/bus`
+- `cli/validation`
+- `cli/handlers/junit`
+- `cli/handlers/vcr`
+- `cli/handlers/har`
+- `cli/handlers/debug`
+- `cli/handlers/stdout`
+
+### `python`
+
+A public Python API to core components. Some core components are re-exported here.
+
+- `pytest_plugin`. Schemathesis' pytest plugin.
+- `asgi`. ASGI integration
+- `wsgi`. WSGI integration