schemathesis 4.0.0a3__tar.gz → 4.0.0a5__tar.gz

schemathesis-4.0.0a5/.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@8.1.3
+        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.3.1
+        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.0a5/.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.9
+        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.9
+
+      # ℹ️ 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.9

schemathesis-4.0.0a5/.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.15.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.9.7
+    hooks:
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    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.0a5/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: schemathesis
+Version: 4.0.0a5
+Summary: Property-based testing framework for Open API and GraphQL based apps
+Project-URL: Documentation, https://schemathesis.readthedocs.io/en/stable/
+Project-URL: Changelog, https://schemathesis.readthedocs.io/en/stable/changelog.html
+Project-URL: Bug Tracker, https://github.com/schemathesis/schemathesis
+Project-URL: Funding, https://github.com/sponsors/Stranger6667
+Project-URL: Source Code, https://github.com/schemathesis/schemathesis
+Author-email: Dmitry Dygalo <dmitry@dygalo.dev>
+Maintainer-email: Dmitry Dygalo <dmitry@dygalo.dev>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: graphql,hypothesis,openapi,pytest,testing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Hypothesis
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: backoff<3.0,>=2.1.2
+Requires-Dist: click<9.0,>=8.0
+Requires-Dist: colorama<1.0,>=0.4
+Requires-Dist: harfile<1.0,>=0.3.0
+Requires-Dist: httpx<1.0,>=0.22.0
+Requires-Dist: hypothesis-graphql<1,>=0.11.1
+Requires-Dist: hypothesis-jsonschema<0.24,>=0.23.1
+Requires-Dist: hypothesis<7,>=6.108.0
+Requires-Dist: jsonschema[format]<5.0,>=4.18.0
+Requires-Dist: junit-xml<2.0,>=1.9
+Requires-Dist: pyrate-limiter<4.0,>=3.0
+Requires-Dist: pytest-subtests<0.15.0,>=0.11
+Requires-Dist: pytest<9,>=8
+Requires-Dist: pyyaml<7.0,>=5.1
+Requires-Dist: requests<3,>=2.22
+Requires-Dist: rich>=13.9.4
+Requires-Dist: starlette-testclient<1,>=0.4.1
+Requires-Dist: typing-extensions>=4.12.2
+Requires-Dist: werkzeug<4,>=0.16.0
+Provides-Extra: bench
+Requires-Dist: pytest-codspeed==2.2.1; extra == 'bench'
+Provides-Extra: cov
+Requires-Dist: coverage-enable-subprocess; extra == 'cov'
+Requires-Dist: coverage[toml]>=5.3; extra == 'cov'
+Provides-Extra: dev
+Requires-Dist: aiohttp<4.0,>=3.9.1; extra == 'dev'
+Requires-Dist: coverage-enable-subprocess; extra == 'dev'
+Requires-Dist: coverage>=6; extra == 'dev'
+Requires-Dist: coverage[toml]>=5.3; extra == 'dev'
+Requires-Dist: fastapi>=0.86.0; extra == 'dev'
+Requires-Dist: flask<3.0,>=2.1.1; extra == 'dev'
+Requires-Dist: hypothesis-openapi<1,>=0.2; (python_version >= '3.10') and extra == 'dev'
+Requires-Dist: pydantic>=1.10.2; extra == 'dev'
+Requires-Dist: pytest-asyncio<1.0,>=0.18.0; extra == 'dev'
+Requires-Dist: pytest-codspeed==2.2.1; extra == 'dev'
+Requires-Dist: pytest-httpserver<2.0,>=1.0; extra == 'dev'
+Requires-Dist: pytest-mock<4.0,>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-trio<1.0,>=0.8; extra == 'dev'
+Requires-Dist: pytest-xdist<4.0,>=3; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-click; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Requires-Dist: strawberry-graphql[fastapi]>=0.109.0; extra == 'dev'
+Requires-Dist: syrupy<5.0,>=2; extra == 'dev'
+Requires-Dist: trustme<1.0,>=0.9.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-click; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: aiohttp<4.0,>=3.9.1; extra == 'tests'
+Requires-Dist: coverage>=6; extra == 'tests'
+Requires-Dist: fastapi>=0.86.0; extra == 'tests'
+Requires-Dist: flask<3.0,>=2.1.1; extra == 'tests'
+Requires-Dist: hypothesis-openapi<1,>=0.2; (python_version >= '3.10') and extra == 'tests'
+Requires-Dist: pydantic>=1.10.2; extra == 'tests'
+Requires-Dist: pytest-asyncio<1.0,>=0.18.0; extra == 'tests'
+Requires-Dist: pytest-httpserver<2.0,>=1.0; extra == 'tests'
+Requires-Dist: pytest-mock<4.0,>=3.7.0; extra == 'tests'
+Requires-Dist: pytest-trio<1.0,>=0.8; extra == 'tests'
+Requires-Dist: pytest-xdist<4.0,>=3; extra == 'tests'
+Requires-Dist: strawberry-graphql[fastapi]>=0.109.0; extra == 'tests'
+Requires-Dist: syrupy<5.0,>=2; extra == 'tests'
+Requires-Dist: trustme<1.0,>=0.9.0; extra == 'tests'
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <a href="https://github.com/schemathesis/schemathesis/actions" target="_blank">
+        <img src="https://github.com/schemathesis/schemathesis/actions/workflows/build.yml/badge.svg" alt="Build">
+    </a>
+    <a href="https://codecov.io/gh/schemathesis/schemathesis/branch/master" target="_blank">
+        <img src="https://codecov.io/gh/schemathesis/schemathesis/branch/master/graph/badge.svg" alt="Coverage">
+    </a>
+    <a href="https://pypi.org/project/schemathesis/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/schemathesis.svg" alt="Version">
+    </a>
+    <a href="https://pypi.org/project/schemathesis/" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/schemathesis.svg" alt="Python versions">
+    </a>
+    <a href="https://discord.gg/R9ASRAmHnA" target="_blank">
+        <img src="https://img.shields.io/discord/938139740912369755" alt="Discord">
+    </a>
+    <a href="https://opensource.org/licenses/MIT" target="_blank">
+        <img src="https://img.shields.io/pypi/l/schemathesis.svg" alt="License">
+    </a>
+</p>
+
+## Schemathesis
+
+> ⚠️ You are viewing the Schemathesis V4 README (Work in Progress) ⚠️
+
+> This branch is under active development, with substantial changes expected before stabilization. While V4 is fully functional and passing tests, some features are missing, and the documentation may be outdated.
+
+> For the stable release, see the [V3 branch](https://github.com/schemathesis/schemathesis/tree/v3).
+
+> 💡 Have feedback? Share your thoughts in [this discussion](https://github.com/schemathesis/schemathesis/discussions/2677)!
+
+Schemathesis is an API testing tool that automatically finds crashes and validates spec compliance.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/demo.gif" alt="Schemathesis Demo"/>
+</p>
+
+<p align="center">
+  <i>Finding server crashes in the Demo API.</i>
+</p>
+
+### Highlights
+
+- 🎯 **Catches Hard-to-Find Bugs**: Automatically uncover crashes and spec violations that manual testing might miss.
+
+- ⚡ **Accelerates Testing**: Generate a wide range of test cases directly from your API schema.
+
+- 🧩 **Integrates Seamlessly**: Works with popular API formats such as OpenAPI and GraphQL, and easily integrates into your existing CI/CD workflows.
+
+- 🔧 **Customizable and Extendable**: Leverage Python extensions to configure and extend your test generation.
+
+- 🐞 **Simplifies Debugging**: Detailed reports and reproducible test cases with cURL commands streamline troubleshooting.
+
+- 🔬 **Proven by Research**: Validated through academic studies on API testing automation, featured in the [ICSE 2022 paper](https://ieeexplore.ieee.org/document/9793781) on semantics-aware fuzzing, and recognized in an [ACM survey](https://dl.acm.org/doi/10.1145/3617175) as a state-of-the-art RESTful API testing tool.
+
+## Installation
+
+Use Schemathesis via Docker, or install it from [PyPI](https://pypi.org/project/schemathesis/)
+
+```console
+# Via Docker.
+$ docker pull schemathesis/schemathesis:stable
+
+# With pip.
+$ pip install schemathesis
+```
+
+## Getting Started
+
+Schemathesis works as a standalone CLI:
+
+```console
+docker run schemathesis/schemathesis:stable
+   run --checks all https://example.schemathesis.io/openapi.json
+# Or when installed with pip
+schemathesis run --checks all https://example.schemathesis.io/openapi.json
+```
+
+Or a Python library:
+
+```python
+import schemathesis
+
+schema = schemathesis.openapi.from_url("https://example.schemathesis.io/openapi.json")
+
+
+@schema.parametrize()
+def test_api(case):
+    case.call_and_validate()
+```
+
+See a complete working example project in the [/example](https://github.com/schemathesis/schemathesis/tree/master/example) directory.
+
+Schemathesis can be easily integrated into your CI/CD pipeline using GitHub Actions. Add this block to your GitHub Actions to run Schemathesis against your API:
+
+```yaml
+api-tests:
+  runs-on: ubuntu-latest
+  steps:
+    - uses: schemathesis/action@v1
+      with:
+        schema: "https://example.schemathesis.io/openapi.json"
+```
+
+For more details, check out our [GitHub Action](https://github.com/schemathesis/action) repository or see our [GitHub Tutorial](https://docs.schemathesis.io/tutorials/github).
+
+## Who's Using Schemathesis?
+
+Schemathesis is used by a number of projects and companies, including direct usage or integration into other tools:
+
+- Abstract Machines ([Magistrala](https://github.com/absmach/magistrala))
+- Bundesstelle für Open Data ([smard-api](https://github.com/bundesAPI/smard-api))
+- [CheckMK](https://github.com/Checkmk/checkmk)
+- Chronosphere.io ([Calyptia](https://github.com/chronosphereio/calyptia-api))
+- HXSecurity ([DongTai](https://github.com/HXSecurity/DongTai))
+- Netflix ([Dispatch](https://github.com/Netflix/dispatch))
+- [Pixie](https://github.com/pixie-io/pixie)
+- [Qdrant](https://github.com/qdrant/qdrant)
+- Spotify ([Backstage](https://github.com/backstage/backstage))
+- [Weechat](https://github.com/weechat/weechat)
+- WordPress ([OpenVerse](https://github.com/WordPress/openverse))
+
+## Testimonials
+
+"_The world needs modern, spec-based API tests, so we can deliver APIs as-designed. Schemathesis is the right tool for that job._"
+
+<div>Emmanuel Paraskakis - <strong>Level 250</strong></div>
+
+---
+
+"_Schemathesis is the only sane way to thoroughly test an API._"
+
+<div>Zdenek Nemec - <strong>superface.ai</strong></div>
+
+---
+
+"_The tool is absolutely amazing as it can do the negative scenario testing instead of me and much faster! Before I was doing the same tests in Postman client. But it's much slower and brings maintenance burden._"
+
+<div>Luděk Nový - <strong>JetBrains</strong></div>
+
+---
+
+"_Schemathesis is the best tool for fuzz testing of REST API on the market. We are at Red Hat use it for examining our applications in functional and integrations testing levels._"
+
+<div>Dmitry Misharov - <strong>RedHat</strong></div>
+
+---
+
+"_There are different levels of usability and documentation quality among these tools which have been reported, where Schemathesis clearly stands out among the most user-friendly and industry-strength tools._"
+
+<div>Testing RESTful APIs: A Survey - <strong>a research paper by Golmohammadi, at al</strong></div>
+
+---
+
+## Contributing
+
+We welcome contributions in code and are especially interested in learning about your use cases. Your input is essential for improving Schemathesis and directly influences future updates.
+
+### How to Contribute
+
+1. Discuss ideas and questions through [GitHub issues](https://github.com/schemathesis/schemathesis/issues) or on our [Discord channel](https://discord.gg/R9ASRAmHnA).
+2. For code contributions, see our [contributing guidelines](https://github.com/schemathesis/schemathesis/blob/master/CONTRIBUTING.rst).
+3. Share your experience and thoughts using [this feedback form](https://forms.gle/kJ4hSxc1Yp6Ga96t5).
+
+### Why Your Input Matters
+
+- Enables us to develop useful features and fix bugs faster
+- Improves our test suite and documentation
+
+Thank you for contributing to making Schemathesis better! 👍
+
+## Get in Touch
+
+If you need assistance with integrating Schemathesis into your workflows or have specific questions, feel free to reach out at <a href="mailto:support@schemathesis.io">support@schemathesis.io</a>.
+
+## Acknowledgements
+
+Schemathesis is built on top of <a href="https://hypothesis.works/" target="_blank">Hypothesis</a>, a powerful property-based testing library for Python.
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).