schemathesis 3.39.16__tar.gz → 4.0.0__tar.gz

schemathesis-4.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: "Status: Needs Triage, Type: Bug"
+assignees: Stranger6667
+---
+
+### Checklist
+
+- [ ] I checked the [FAQ section](https://schemathesis.readthedocs.io/en/stable/faq/) of the documentation
+- [ ] I looked for similar issues in the [issue tracker](https://github.com/schemathesis/schemathesis/issues)
+- [ ] I am using the latest version of Schemathesis
+
+### Describe the bug
+
+Clearly describe the issue you're facing.
+
+### To Reproduce
+
+🚨 **Mandatory** 🚨: Steps to reproduce the behavior:
+
+1. Run this command '...'
+2. See error
+
+Please include a minimal API schema causing this issue:
+
+```yaml
+{ "openapi": "3.0.2", ... }
+```
+
+### Expected behavior
+
+Clearly describe your expected outcome.
+
+### Environment
+
+```
+- OS: [e.g. Linux or Windows]
+- Python version: [e.g. 3.13]
+- Schemathesis version: [e.g. 4.0.0]
+- Spec version: [e.g. Open API 3.1.0]
+```
+
+### Additional context
+
+Include any other relevant details, like logs or screenshots.

schemathesis-4.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+🚨Please review the [Contributing Guidelines](https://github.com/schemathesis/schemathesis/blob/master/CONTRIBUTING.md).
+
+### Description
+
+Briefly describe your changes.
+
+### Checklist
+
+- [ ] Added failing tests for the change
+- [ ] All new and existing tests pass
+- [ ] Added changelog entry
+- [ ] Updated README/documentation, if necessary

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

@@ -0,0 +1,112 @@
+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: astral-sh/setup-uv@v6
+
+      - run: uvx pre-commit run --all-files
+
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-2022]
+        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: astral-sh/setup-uv@v6
+
+      - 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.4.3
+        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-2022]
+      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: astral-sh/setup-uv@v6
+
+      - 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.0/.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.19
+        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.19
+
+      # ℹ️ 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.19

schemathesis-4.0.0/.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: astral-sh/setup-uv@v6
+
+      - 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.0/.github/workflows/example-build.yml

@@ -0,0 +1,38 @@
+name: Manual build API example
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/example-build.yml"
+      - "examples/**"
+  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: "./examples/booking"
+
+      # Runs positive Schemathesis tests
+      - uses: schemathesis/action@v1
+        continue-on-error: true
+        with:
+          # A local API schema location
+          schema: "http://127.0.0.1:8080/openapi.json"
+          max-examples: "10"
+          # To avoid failing the build
+          args: "--include-path does-not-exist"
+
+      - name: Stop containers
+        if: always()
+        run: docker compose down
+        working-directory: "./examples/booking"

schemathesis-4.0.0/.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.0/.github/workflows/release.yml

@@ -0,0 +1,98 @@
+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: Detect pre-release
+        id: detect-prerelease
+        run: |
+          TAG_NAME="${{ github.event.release.tag_name }}"
+          if [ "${{ github.event.release.prerelease }}" == "true" ] || [[ "$TAG_NAME" =~ -(alpha|beta|rc)[0-9]*$ ]]; then
+            echo "is_prerelease=true" >> $GITHUB_ENV
+          else
+            echo "is_prerelease=false" >> $GITHUB_ENV
+          fi
+        shell: bash
+
+      - 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 }}
+            ${{ env.is_prerelease == 'false' && '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: astral-sh/setup-uv@v6
+
+      - 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.0/.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: astral-sh/setup-uv@v6
+
+      - 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: astral-sh/setup-uv@v6
+
+      - run: uvx --from=".[tests]" pytest test-corpus -n auto -k test_coverage_phase

schemathesis-4.0.0/.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: astral-sh/setup-uv@v6
+
+      - run: uvx --from=".[tests]" pytest -m hypothesis -m hypothesis_nested --hypothesis-profile CI test

schemathesis-4.0.0/.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: astral-sh/setup-uv@v6
+
+      - 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.0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+        exclude: ^.*\.raw$
+      - id: trailing-whitespace
+        exclude: ^.*\.(md|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.37.1
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.0
+    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.11.13
+    hooks:
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.13
+    hooks:
+      - id: ruff-check

schemathesis-4.0.0/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --extra docs --link-mode=copy
+
+mkdocs:
+  configuration: mkdocs.yml

schemathesis-4.0.0/ARCHITECTURE.md

@@ -0,0 +1,71 @@
+# Architecture
+
+This document outlines the internal structure of Schemathesis for developers working on the codebase.
+
+## Overview
+
+
+Schemathesis follows a layered architecture that separates logic into multiple groups:
+
+- **Core Layer**: Framework-agnostic utilities and data structures
+- **Generation Layer**: Hypothesis-powered test case generation and execution
+- **Interface Layer**: CLI, pytest integration, and user-facing APIs
+- **Engine**: Test orchestration, reporting, and execution management
+
+## Core Layer
+
+Framework-agnostic foundation with no external dependencies on testing frameworks.
+
+### `core/loaders`
+Load and parse API schemas from files, URLs, and applications into internal representations.
+
+### `core/transports` 
+Transport abstractions for HTTP communication, providing unified interfaces for different client libraries.
+
+### `core/output`
+Output formatting, sanitization, and rendering logic for CLI and reporting.
+
+### `core/marks`
+Metadata attachment system for integrating with external testing frameworks (pytest, unittest).
+
+### `core/failures`
+Failure classification and structured error representations for different types of API validation issues.
+
+### `core/config`
+Configuration management and validation for project settings and runtime options.
+
+## Generation Layer
+
+Test case generation and execution built on Hypothesis.
+
+### `generation/hypothesis`
+Integration with Hypothesis framework:
+
+- Strategy creation from API schemas
+- Test case generation
+- Example collection and management
+
+### `generation/case`
+The `Case` data structure containing all test data (headers, body, parameters) for API requests.
+
+### `generation/stateful`
+State machine implementations for testing API operation sequences using OpenAPI links.
+
+### `checks`
+Built-in validation checks for API responses (schema conformance, status codes, headers).
+
+### `hooks`
+Extension system for customizing test generation and execution at various lifecycle points.
+
+## Internal Subsystems
+
+### Engine
+
+- Test execution orchestration
+- Event system for tracking test progress
+- Test phases management
+
+### API Specifications
+
+- OpenAPI implementation
+- GraphQL implementation