pytest-jsonschema 1.0.0a1__tar.gz

pytest-jsonschema-1.0.0a1/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2024 Érico Andrei
+
+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.

pytest-jsonschema-1.0.0a1/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: pytest-jsonschema
+Version: 1.0.0a1
+Summary: A pytest plugin to perform JSONSchema validations
+Author-email: Érico Andrei <ericof@plone.org>
+Maintainer-email: Érico Andrei <ericof@plone.org>
+License: 
+        The MIT License (MIT)
+        
+        Copyright (c) 2024 Érico Andrei
+        
+        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.
+        
+Project-URL: Repository, https://github.com/collective/pytest-jsonschema
+Keywords: pytest,testing
+Classifier: Framework :: Pytest
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+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 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: release
+Provides-Extra: test
+License-File: LICENSE
+
+<h1 align="center">pytest-jsonschema</h1>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Wheel](https://img.shields.io/pypi/wheel/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - License](https://img.shields.io/pypi/l/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Status](https://img.shields.io/pypi/status/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+
+[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+[![Tests](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml)
+[![Linters](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml)
+![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
+
+[![GitHub contributors](https://img.shields.io/github/contributors/collective/pytest-jsonschema)](https://github.com/collective/pytest-jsonschema)
+[![GitHub Repo stars](https://img.shields.io/github/stars/collective/pytest-jsonschema?style=social)](https://github.com/collective/pytest-jsonschema)
+</div>
+
+**pytest-jsonschema** is a [pytest](https://docs.pytest.org) plugin providing fixtures to perform JSONSchema validations.
+
+Features
+--------
+
+* TODO
+
+
+Requirements
+------------
+
+* TODO
+
+
+Installation
+------------
+
+You can install "pytest-jsonschema" via `pip`_ from `PyPI`_::
+
+    $ pip install pytest-jsonschema
+
+
+Usage
+-----
+
+* TODO
+
+Contributing
+------------
+Contributions are very welcome. Tests can be run with `tox`_, please ensure
+the coverage at least stays the same before you submit a pull request.
+
+License
+-------
+
+Distributed under the terms of the `MIT`_ license, "pytest-jsonschema" is free and open source software

pytest-jsonschema-1.0.0a1/README.md

@@ -0,0 +1,57 @@
+<h1 align="center">pytest-jsonschema</h1>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Wheel](https://img.shields.io/pypi/wheel/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - License](https://img.shields.io/pypi/l/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Status](https://img.shields.io/pypi/status/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+
+[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+[![Tests](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml)
+[![Linters](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml)
+![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
+
+[![GitHub contributors](https://img.shields.io/github/contributors/collective/pytest-jsonschema)](https://github.com/collective/pytest-jsonschema)
+[![GitHub Repo stars](https://img.shields.io/github/stars/collective/pytest-jsonschema?style=social)](https://github.com/collective/pytest-jsonschema)
+</div>
+
+**pytest-jsonschema** is a [pytest](https://docs.pytest.org) plugin providing fixtures to perform JSONSchema validations.
+
+Features
+--------
+
+* TODO
+
+
+Requirements
+------------
+
+* TODO
+
+
+Installation
+------------
+
+You can install "pytest-jsonschema" via `pip`_ from `PyPI`_::
+
+    $ pip install pytest-jsonschema
+
+
+Usage
+-----
+
+* TODO
+
+Contributing
+------------
+Contributions are very welcome. Tests can be run with `tox`_, please ensure
+the coverage at least stays the same before you submit a pull request.
+
+License
+-------
+
+Distributed under the terms of the `MIT`_ license, "pytest-jsonschema" is free and open source software

pytest-jsonschema-1.0.0a1/pyproject.toml

@@ -0,0 +1,106 @@
+[build-system]
+requires = [
+  "setuptools>=61.0.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-jsonschema"
+description = "A pytest plugin to perform JSONSchema validations"
+version = "1.0.0a1"
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Érico Andrei", email = "ericof@plone.org" },
+]
+maintainers = [
+    { name = "Érico Andrei", email = "ericof@plone.org" },
+]
+keywords = [
+    "pytest",
+    "testing",
+]
+license = {file = "LICENSE"}
+classifiers = [
+    "Framework :: Pytest",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "pytest>=6.2.0",
+    "ruamel.yaml",
+    "jsonschema",
+    "tomli==2.0.1 ; python_version<='3.11'",
+]
+
+[project.optional-dependencies]
+release = [
+    "zest.releaser[recommended]",
+    "zestreleaser.towncrier",
+]
+test = [
+    "pytest-cov",
+    "pre-commit",
+    "tox",
+]
+
+[project.urls]
+Repository = "https://github.com/collective/pytest-jsonschema"
+[project.entry-points.pytest11]
+jsonschema = "pytest_jsonschema.fixtures"
+
+[tool.isort]
+profile = "plone"
+
+[tool.black]
+target-version = ["py38"]
+
+[tool.codespell]
+ignore-words-list = "discreet,vew"
+skip = "*.po,*.min.js,*.json"
+
+[tool.towncrier]
+filename = "CHANGELOG.md"
+directory = "news/"
+title_format = "## {version} ({project_date})"
+underlines = ["", "", ""]
+template = "./docs/towncrier_template.jinja"
+start_string = "<!-- towncrier release notes start -->\n"
+issue_format = "[#{issue}](https://github.com/collective/pytest-jsonschema/issue/{issue})"
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Breaking"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Feature"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bugfix"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "internal"
+name = "Internal"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "documentation"
+name = "Documentation"
+showcontent = true

pytest-jsonschema-1.0.0a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema/fixtures.py

@@ -0,0 +1,44 @@
+from . import loaders
+from . import schemas
+from . import types
+from . import validator
+
+import pytest
+
+
+@pytest.fixture
+def schema_validate_file() -> types.FileValidator:
+    """Validate a file againstt a known JSON Schema."""
+
+    def func(path: types.StrPath, schema_name: str, file_type: str = "") -> bool:
+        """Validate a file against a known JSON Schema."""
+        data = loaders.data_from_file(path, file_type=file_type)
+        schema = schemas.load(schema_name)
+        return validator.validate(data, schema)
+
+    return func
+
+
+@pytest.fixture
+def schema_validate_string() -> types.StrValidator:
+    """Validate a string againstt a known JSON Schema."""
+
+    def func(data: str, schema_name: str, file_type: str = "") -> bool:
+        """Validate a string against a known JSON Schema."""
+        data = loaders.data_from_string(data, file_type=file_type)
+        schema = schemas.load(schema_name)
+        return validator.validate(data, schema)
+
+    return func
+
+
+@pytest.fixture
+def schema_validate() -> types.Validator:
+    """Validate a string againstt a known JSON Schema."""
+
+    def func(data: types.DataStructure, schema_name: str) -> bool:
+        """Validate a file against a known JSON Schema."""
+        schema = schemas.load(schema_name)
+        return validator.validate(data, schema)
+
+    return func

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema/loaders.py

@@ -0,0 +1,47 @@
+from pathlib import Path
+from ruamel.yaml import YAML
+from typing import Union
+
+import json
+
+
+try:
+    import tomllib  # Python 3.12
+except ImportError:
+    import tomli as tomllib
+
+yaml = YAML()
+
+_FILETYPES = {
+    ".json": "json",
+    ".toml": "toml",
+    ".yaml": "yaml",
+    ".yml": "yaml",
+}
+
+_LOADERS = {
+    "json": json.loads,
+    "toml": tomllib.loads,
+    "yaml": yaml.load,
+}
+
+
+def _guess_format(path: Path) -> str:
+    """Given a path, try to guess the correct filetype."""
+    extension = path.suffix
+    return _FILETYPES.get(extension, "")
+
+
+def data_from_file(path: Path, file_type: str = "") -> Union[dict, list]:
+    """Load data from file."""
+    path = Path(path)
+    if file_type not in _LOADERS:
+        file_type = _guess_format(path)
+    data = path.read_text()
+    return data_from_string(data, file_type)
+
+
+def data_from_string(data: str, file_type: str) -> Union[dict, list]:
+    """Load data from string."""
+    loader = _LOADERS.get(file_type)
+    return loader(data)

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema/schemas/__init__.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+
+import json
+
+
+def load(schema_name: str) -> dict:
+    """Load data from string."""
+    base_path = Path(__file__).parent / f"{schema_name}.json"
+    return json.loads(base_path.read_text())

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema/types.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+from typing import Protocol
+from typing import Union
+
+
+StrPath = Union[str, Path]
+DataStructure = Union[dict, list]
+
+
+class FileValidator(Protocol):
+    def __call__(self, path: StrPath, schema_name: str, file_type: str = "") -> bool:
+        ...
+
+
+class StrValidator(Protocol):
+    def __call__(self, data: str, schema_name: str, file_type: str = "") -> bool:
+        ...
+
+
+class Validator(Protocol):
+    def __call__(self, data: DataStructure, schema_name: str) -> bool:
+        ...

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema/validator.py

@@ -0,0 +1,19 @@
+from .types import DataStructure
+
+import jsonschema
+import logging
+
+
+logger = logging.getLogger("pytest-jsonschema")
+
+
+def validate(data: DataStructure, schema: dict) -> bool:
+    """Validate a data structure against a JSON Schema."""
+    try:
+        jsonschema.validate(data, schema)
+    except jsonschema.ValidationError as exc:
+        logger.error(f"Validation failed: {exc}")
+        validation = False
+    else:
+        validation = True
+    return validation

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: pytest-jsonschema
+Version: 1.0.0a1
+Summary: A pytest plugin to perform JSONSchema validations
+Author-email: Érico Andrei <ericof@plone.org>
+Maintainer-email: Érico Andrei <ericof@plone.org>
+License: 
+        The MIT License (MIT)
+        
+        Copyright (c) 2024 Érico Andrei
+        
+        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.
+        
+Project-URL: Repository, https://github.com/collective/pytest-jsonschema
+Keywords: pytest,testing
+Classifier: Framework :: Pytest
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+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 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: release
+Provides-Extra: test
+License-File: LICENSE
+
+<h1 align="center">pytest-jsonschema</h1>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Wheel](https://img.shields.io/pypi/wheel/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - License](https://img.shields.io/pypi/l/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![PyPI - Status](https://img.shields.io/pypi/status/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+
+[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+
+[![Tests](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/code.yml)
+[![Linters](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/lint.yml)
+![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
+
+[![GitHub contributors](https://img.shields.io/github/contributors/collective/pytest-jsonschema)](https://github.com/collective/pytest-jsonschema)
+[![GitHub Repo stars](https://img.shields.io/github/stars/collective/pytest-jsonschema?style=social)](https://github.com/collective/pytest-jsonschema)
+</div>
+
+**pytest-jsonschema** is a [pytest](https://docs.pytest.org) plugin providing fixtures to perform JSONSchema validations.
+
+Features
+--------
+
+* TODO
+
+
+Requirements
+------------
+
+* TODO
+
+
+Installation
+------------
+
+You can install "pytest-jsonschema" via `pip`_ from `PyPI`_::
+
+    $ pip install pytest-jsonschema
+
+
+Usage
+-----
+
+* TODO
+
+Contributing
+------------
+Contributions are very welcome. Tests can be run with `tox`_, please ensure
+the coverage at least stays the same before you submit a pull request.
+
+License
+-------
+
+Distributed under the terms of the `MIT`_ license, "pytest-jsonschema" is free and open source software

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+src/pytest_jsonschema/__init__.py
+src/pytest_jsonschema/fixtures.py
+src/pytest_jsonschema/loaders.py
+src/pytest_jsonschema/types.py
+src/pytest_jsonschema/validator.py
+src/pytest_jsonschema.egg-info/PKG-INFO
+src/pytest_jsonschema.egg-info/SOURCES.txt
+src/pytest_jsonschema.egg-info/dependency_links.txt
+src/pytest_jsonschema.egg-info/entry_points.txt
+src/pytest_jsonschema.egg-info/requires.txt
+src/pytest_jsonschema.egg-info/top_level.txt
+src/pytest_jsonschema/schemas/__init__.py

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+jsonschema = pytest_jsonschema.fixtures

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/requires.txt

@@ -0,0 +1,15 @@
+pytest>=6.2.0
+ruamel.yaml
+jsonschema
+
+[:python_version <= "3.11"]
+tomli==2.0.1
+
+[release]
+zest.releaser[recommended]
+zestreleaser.towncrier
+
+[test]
+pytest-cov
+pre-commit
+tox

pytest-jsonschema-1.0.0a1/src/pytest_jsonschema.egg-info/top_level.txt

@@ -0,0 +1 @@
+pytest_jsonschema