swaggerforge 0.1.0__tar.gz

swaggerforge-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Viktor Pylypenko
+
+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.

swaggerforge-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: swaggerforge
+Version: 0.1.0
+Summary: Automatic pytest test generation from OpenAPI (Swagger) specifications
+Author: Viktor Pylypenko
+License-Expression: MIT
+Keywords: openapi,swagger,pytest,test generation,api testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: prance>=23.6.21.0
+Requires-Dist: openapi-core>=0.18
+Requires-Dist: openapi-spec-validator>=0.7
+Requires-Dist: jinja2>=3.0
+Requires-Dist: requests>=2.28
+Requires-Dist: jsonschema>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0; extra == "dev"
+Requires-Dist: flake8>=7.0; extra == "dev"
+Dynamic: license-file
+
+# SwaggerForge
+
+Automatic pytest test generation from OpenAPI (Swagger) specifications.
+
+SwaggerForge is a Python library and command-line tool that reads an OpenAPI
+specification and generates ready-to-run pytest test files - one per resource
+covering positive, negative, boundary, and boolean scenarios grounded in
+established test-design techniques.
+
+## Features
+
+- Reads OpenAPI 3.x specifications in JSON or YAML
+- Resolves `$ref` references automatically
+- Generates one pytest file per resource tag
+- Produces six scenario types per endpoint where applicable:
+  - **Positive** >>> valid request, expects a 2xx response and validates the
+    response schema
+  - **Missing required field** >>> omits a required field, expects 400
+  - **Wrong data type** >>> sends a mistyped field, expects 400/422
+  - **Nonexistent resource** >>> requests an unlikely identifier, expects 404
+  - **Boundary values** >>> tests values at and just beyond declared
+    numeric/length limits (Boundary Value Analysis)
+  - **Boolean coverage** >>> exercises both `true` and `false` for boolean fields
+- Deterministic output: the same specification always produces identical tests
+- Generated files use session-scoped pytest fixtures and run with no manual edits
+
+## Requirements
+
+- Python 3.10 or newer
+
+## Installation
+
+```bash
+pip install swaggerforge
+```
+
+## Usage
+
+Generate tests from a specification, pointing at the base URL of the API
+under test:
+
+```bash
+swaggerforge generate --spec swagger.json --url http://localhost:8080
+```
+
+This reads `swagger.json`, writes one `test_<resource>.py` file per resource
+tag into the output directory (default: `tests_generated/`), and the files can
+be run immediately:
+
+```bash
+pytest tests_generated
+```
+
+### Options
+
+| Option     | Description                                        | Default            |
+|------------|----------------------------------------------------|--------------------|
+| `--spec`   | Path to the OpenAPI specification (JSON or YAML)   | *(required)*       |
+| `--url`    | Base URL of the API under test                     | *(required)*       |
+| `--output` | Directory for the generated test files             | `tests_generated`  |
+
+## How it works
+
+SwaggerForge runs a six-stage pipeline: the specification is validated, parsed
+into an internal model (with `$ref`s resolved), turned into test scenarios
+based on test-design techniques, rendered into pytest code via templates, and
+written to per-resource files.
+
+## Limitations
+
+- Targets OpenAPI 3.x with JSON request bodies
+- Authentication is not yet handled (planned)
+- Boundary tests require the specification to declare numeric/length constraints
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file.

swaggerforge-0.1.0/README.md

@@ -0,0 +1,77 @@
+# SwaggerForge
+
+Automatic pytest test generation from OpenAPI (Swagger) specifications.
+
+SwaggerForge is a Python library and command-line tool that reads an OpenAPI
+specification and generates ready-to-run pytest test files - one per resource
+covering positive, negative, boundary, and boolean scenarios grounded in
+established test-design techniques.
+
+## Features
+
+- Reads OpenAPI 3.x specifications in JSON or YAML
+- Resolves `$ref` references automatically
+- Generates one pytest file per resource tag
+- Produces six scenario types per endpoint where applicable:
+  - **Positive** >>> valid request, expects a 2xx response and validates the
+    response schema
+  - **Missing required field** >>> omits a required field, expects 400
+  - **Wrong data type** >>> sends a mistyped field, expects 400/422
+  - **Nonexistent resource** >>> requests an unlikely identifier, expects 404
+  - **Boundary values** >>> tests values at and just beyond declared
+    numeric/length limits (Boundary Value Analysis)
+  - **Boolean coverage** >>> exercises both `true` and `false` for boolean fields
+- Deterministic output: the same specification always produces identical tests
+- Generated files use session-scoped pytest fixtures and run with no manual edits
+
+## Requirements
+
+- Python 3.10 or newer
+
+## Installation
+
+```bash
+pip install swaggerforge
+```
+
+## Usage
+
+Generate tests from a specification, pointing at the base URL of the API
+under test:
+
+```bash
+swaggerforge generate --spec swagger.json --url http://localhost:8080
+```
+
+This reads `swagger.json`, writes one `test_<resource>.py` file per resource
+tag into the output directory (default: `tests_generated/`), and the files can
+be run immediately:
+
+```bash
+pytest tests_generated
+```
+
+### Options
+
+| Option     | Description                                        | Default            |
+|------------|----------------------------------------------------|--------------------|
+| `--spec`   | Path to the OpenAPI specification (JSON or YAML)   | *(required)*       |
+| `--url`    | Base URL of the API under test                     | *(required)*       |
+| `--output` | Directory for the generated test files             | `tests_generated`  |
+
+## How it works
+
+SwaggerForge runs a six-stage pipeline: the specification is validated, parsed
+into an internal model (with `$ref`s resolved), turned into test scenarios
+based on test-design techniques, rendered into pytest code via templates, and
+written to per-resource files.
+
+## Limitations
+
+- Targets OpenAPI 3.x with JSON request bodies
+- Authentication is not yet handled (planned)
+- Boundary tests require the specification to declare numeric/length constraints
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file.

swaggerforge-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "swaggerforge"
+version = "0.1.0"
+description = "Automatic pytest test generation from OpenAPI (Swagger) specifications"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Viktor Pylypenko" }
+]
+keywords = ["openapi", "swagger", "pytest", "test generation", "api testing"]
+dependencies = [
+    "click>=8.0",
+    "prance>=23.6.21.0",
+    "openapi-core>=0.18",
+    "openapi-spec-validator>=0.7",
+    "jinja2>=3.0",
+    "requests>=2.28",
+    "jsonschema>=4.0",
+]
+
+[project.scripts]
+swaggerforge = "swaggerforge.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+swaggerforge = ["templates/*"]
+
+[tool.pytest.ini_options]
+minversion = "9.0"
+addopts = "--import-mode=importlib"
+testpaths = ["tests"]
+
+[project.optional-dependencies]
+dev = ["pytest>=9.0", "flake8>=7.0"]

swaggerforge-0.1.0/setup.cfg

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

swaggerforge-0.1.0/src/swaggerforge/cli.py

@@ -0,0 +1,67 @@
+"""Command-line interface for SwaggerForge."""
+
+import click
+from swaggerforge.validator import load_and_validate, SpecValidationError
+from swaggerforge.parser import parse_spec, SpecParseError
+from swaggerforge.generator import generate_scenarios
+from swaggerforge.output import write_test_files
+
+
+@click.group()
+@click.version_option()
+def main():
+    """SwaggerForge generate pytest tests from OpenAPI specifications."""
+    pass
+
+
+@main.command()
+@click.option(
+    "--spec",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the OpenAPI specification file (JSON or YAML).",
+)
+@click.option(
+    "--url",
+    required=True,
+    help="Base URL of the API to be tested.",
+)
+@click.option(
+    "--output",
+    default="tests_generated",
+    type=click.Path(),
+    help="Directory where generated test files will be written.",
+)
+def generate(spec, url, output):
+    """Generate pytest test files from an OpenAPI specification."""
+    click.echo(f"Reading specification: {spec}")
+
+    try:
+        spec_dict = load_and_validate(spec)
+    except SpecValidationError as error:
+        raise click.ClickException(str(error))
+
+    click.echo("Specification is valid.")
+    click.echo(f"API title: {spec_dict['info']['title']}")
+
+    try:
+        endpoints = parse_spec(spec)
+    except SpecParseError as error:
+        raise click.ClickException(str(error))
+
+    tags = sorted({endpoint.tag for endpoint in endpoints})
+    click.echo(f"Found {len(endpoints)} endpoints across {len(tags)} resources: {', '.join(tags)}")
+
+    scenarios = generate_scenarios(endpoints)
+    click.echo(f"Generated {len(scenarios)} test scenarios.")
+
+    try:
+        written = write_test_files(scenarios, url, output)
+    except OSError as error:
+        raise click.ClickException(
+            f"Could not write test files to '{output}': {error}"
+        )
+
+    click.echo(f"Wrote {len(written)} test file(s) to '{output}':")
+    for path in written:
+        click.echo(f"  - {path}")