schemathesis 4.0.0a11__tar.gz → 4.0.0b1__tar.gz

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

@@ -0,0 +1,30 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material "mkdocstrings[python]"
+      - run: mkdocs gh-deploy --force

schemathesis-4.0.0b1/.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 --experimental=openapi-3.1"
+
+      - name: Stop containers
+        if: always()
+        run: docker compose down
+        working-directory: "./examples/booking"

schemathesis-4.0.0b1/.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.12
+    hooks:
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.12
+    hooks:
+      - id: ruff-check

schemathesis-4.0.0b1/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