{"id":17932903,"url":"https://github.com/leidenheit/itarazzo-library","last_synced_at":"2025-08-15T15:33:41.697Z","repository":{"id":259702034,"uuid":"879240344","full_name":"leidenheit/itarazzo-library","owner":"leidenheit","description":"Library to parse, validate and execute an Arazzo specification.","archived":false,"fork":false,"pushed_at":"2024-11-17T12:41:06.000Z","size":109,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-08-11T05:44:41.095Z","etag":null,"topics":["api-rest","arazzo","arazzo-specification","openapi","openapi-specification","testing"],"latest_commit_sha":null,"homepage":"https://github.com/leidenheit/itarazzo-client","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leidenheit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T11:44:13.000Z","updated_at":"2025-07-12T10:43:15.000Z","dependencies_parsed_at":"2024-10-27T13:13:52.723Z","dependency_job_id":"60c7046c-f260-4273-8075-a9252f16952e","html_url":"https://github.com/leidenheit/itarazzo-library","commit_stats":null,"previous_names":["leidenheit/itarazzo-library"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/leidenheit/itarazzo-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leidenheit%2Fitarazzo-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leidenheit%2Fitarazzo-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leidenheit%2Fitarazzo-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leidenheit%2Fitarazzo-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leidenheit","download_url":"https://codeload.github.com/leidenheit/itarazzo-library/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leidenheit%2Fitarazzo-library/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270587089,"owners_count":24611467,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","arazzo","arazzo-specification","openapi","openapi-specification","testing"],"created_at":"2024-10-28T21:34:09.986Z","updated_at":"2025-08-15T15:33:41.401Z","avatar_url":"https://github.com/leidenheit.png","language":"Java","funding_links":[],"categories":["Java"],"sub_categories":[],"readme":"# Itarazzo Library\r\nEnables seamless execution of OpenAPI Initiative (OAI) [Arazzo Specifications](https://spec.openapis.org/arazzo/latest.html) in an integration testing \r\ncontext. Designed for developers who need automated and test-driven verification of API workflows, *Itarazzo Library* \r\nextends integration testing capabilities using a range of powerful technologies.\r\n\r\n---\r\n\r\n**Note**: This project is developed in my free time alongside family and full-time work. Any feedback or contributions are greatly appreciated as I strive to make this tool as helpful as possible for other developers.\r\n\r\n---\r\n\r\n## Key Features\r\n- **Arazzo Specification Integration**: Executes Arazzo Specifications within integration tests, allowing automated e2e-testing \r\n  of complex workflows with detailed logging.\r\n---\r\n\r\n## Technologies Used\r\nItarazzo Library leverages a robust stack of technologies to provide extensive API testing support:\r\n- **JUnit 5**: For structuring and running integration tests.\r\n- **Jackson**: For efficient JSON parsing and serialization.\r\n- **Everit JSON Path**: Enables flexible, path-based JSON validation.\r\n- **XPath**: Supports XML handling, useful for APIs returning XML responses.\r\n- **RestAssured**: Simplifies HTTP requests and validations for RESTful APIs.\r\n- **Swagger**: Parses OpenAPI specifications, enabling standardized API testing against specifications.\r\n---\r\n\r\n## Getting Started\r\n### Prerequisites\r\nEnsure you have the following dependencies in your project’s pom.xml:\r\n\r\n```xml\r\n\u003cdependencies\u003e\r\n  \u003cdependency\u003e\r\n    \u003cgroupId\u003eio.github.leidenheit\u003c/groupId\u003e\r\n    \u003cartifactId\u003eitarazzo\u003c/artifactId\u003e\r\n    \u003cversion\u003e0.1.0\u003c/version\u003e\r\n  \u003c/dependency\u003e\r\n  \r\n  \u003c!-- a logging implementation e.g. Logback --\u003e\r\n  \u003cdependency\u003e\r\n      \u003cgroupId\u003ech.qos.logback\u003c/groupId\u003e\r\n      \u003cartifactId\u003elogback-classic\u003c/artifactId\u003e\r\n      \u003cversion\u003e1.5.6\u003c/version\u003e\r\n  \u003c/dependency\u003e\r\n  \u003cdependency\u003e\r\n      \u003cgroupId\u003ech.qos.logback\u003c/groupId\u003e\r\n      \u003cartifactId\u003elogback-core\u003c/artifactId\u003e\r\n      \u003cversion\u003e1.5.6\u003c/version\u003e\r\n  \u003c/dependency\u003e\r\n\u003c/dependencies\u003e\r\n```\r\n\r\n### Basic Usage\r\nTo use Itarazzo Library in your integration tests, start by creating a test class that extends the capabilities of the \r\nlibrary with the JUnit 5 `ItarazzoExtension`.\r\n\r\n```java\r\n@ExtendWith(ItarazzoExtension.class)\r\nclass ExampleArazzoIT {\r\n\r\n    @TestFactory\r\n    @DisplayName(\"Workflow\")\r\n    Stream\u003cDynamicTest\u003e executeWorkflow(final ArazzoSpecification arazzoSpec, final String inputsFilePath) {\r\n        var inputs = InputsReader.readInputs(inputsFilePath);\r\n        ItarazzoDynamicTest dynamicTest = new ItarazzoDynamicTest();\r\n        return dynamicTest.generateWorkflowTests(arazzoSpec, inputs);\r\n    }\r\n}\r\n```\r\n\r\n### Configuration Options\r\n#### Environment Variables\r\nTo define specific Arazzo files and inputs:\r\n\r\n- `ARAZZO_FILE`: Specifies the path to the Arazzo YAML specification file. \r\n- `ARAZZO_INPUTS_FILE`: Path to a valid JSON file containing test inputs.\r\n\r\nThese can be set directly in the test environment or passed as system properties in Maven.\r\n\r\n---\r\n## Custom Extension Points (coming soon)\r\nThe Itarazzo Library features extensibility, allowing you to configure and customize API interactions precisely to \r\nmatch your testing requirements. Below are some common extension points.\r\n\r\n### Custom Server Selection\r\nTo designate a server specifically for the integration test, use the `x-itarazzo-designated-server` extension. \r\nIf no server is designated, the library considers the first server from the referenced source description.\r\n\r\nExample in an OpenAPI file:\r\n```yaml\r\nservers:\r\n- url: https://api.example.com/v1\r\n  x-itarazzo-designated-server: true\r\n```\r\nThis configuration ensures that the Itarazzo Library targets the specified server during test execution.\r\n\r\n---\r\n## Running Tests\r\nTo execute the tests, run the following Maven command:\r\n\r\n```bash\r\nmvn verify -Darazzo.file=\"/path/to/arazzo.yaml\" -Darazzo.inputs.file=\"/path/to/inputs.json\"\r\n```\r\nThis command triggers the workflow specified in your Arazzo YAML and applies test inputs from the JSON file.\r\n\r\n---\r\n### Contributions\r\nContributions are welcome! If you encounter any issues or have suggestions, please submit them as issues or pull requests.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleidenheit%2Fitarazzo-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleidenheit%2Fitarazzo-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleidenheit%2Fitarazzo-library/lists"}