swaggerforge 0.1.0

Automatic pytest test generation from OpenAPI (Swagger) specifications

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

pip install swaggerforge

Usage

Generate tests from a specification, pointing at the base URL of the API under test:

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:

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 $refs 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 file.