Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leidenheit/itarazzo-client
Client which utilizes Itarazzo library in order to execute an arazzo specification easily
https://github.com/leidenheit/itarazzo-client
api-rest arazzo arazzo-specification openapi openapi-specification testing
Last synced: 6 days ago
JSON representation
Client which utilizes Itarazzo library in order to execute an arazzo specification easily
- Host: GitHub
- URL: https://github.com/leidenheit/itarazzo-client
- Owner: leidenheit
- License: apache-2.0
- Created: 2024-10-27T12:14:19.000Z (20 days ago)
- Default Branch: develop
- Last Pushed: 2024-11-08T16:26:21.000Z (8 days ago)
- Last Synced: 2024-11-08T17:28:51.317Z (8 days ago)
- Topics: api-rest, arazzo, arazzo-specification, openapi, openapi-specification, testing
- Language: Dockerfile
- Homepage: https://github.com/leidenheit/itarazzo-library
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Itarazzo Client
The *Itarazzo Client* allows for the execution and integration of workflow tests based on the [Arazzo Specification](https://spec.openapis.org/arazzo/latest.html). This client is encapsulated in a Docker container and uses an integration test that leverages the Itarazzo library to run tests.
---
>**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.
---
## Contents
- [Integration Test](#integration-test)
- [Parameters](#parameters)
- [Docker Configuration](#docker-configuration)
- [Building and Running the Docker Image](#building-and-running-docker-image)
- [Using Docker Compose](#using-docker-compose)
- [Execution Notes](#execution-notes)
- [Security](#security-warning)
---
## Integration Test
The `ArazzoIT` integration test uses the [Itarazzo Library](https://github.com/leidenheit/itarazzo-library) and is executed with the JUnit 5 extension `ItarazzoExtension`. This test dynamically generates workflow tests based on the provided Arazzo specification and a JSON input file.
```java
@ExtendWith(ItarazzoExtension.class)
class ArazzoIT {
@TestFactory
@DisplayName("Workflow")
Stream testMyArazzo(final ArazzoSpecification arazzo, final String inputsFilePath) {
var inputs = InputsReader.readInputs(inputsFilePath);
ItarazzoDynamicTest dynamicTest = new ItarazzoDynamicTest();
return Assertions.assertDoesNotThrow(() -> dynamicTest.generateWorkflowTests(arazzo, inputs));
}
}
```
This test is initialized by the `ItarazzoExtension` and dynamically generates tests based on the Arazzo specification (`arazzo`) and the input file (`inputsFilePath`).
---
## Parameters
To configure the workflow, two environment variables need to be specified:
- `ARAZZO_FILE`: Path or URI to the Arazzo specification (e.g., `/itarazzo/specs/pet-store.arazzo.yaml`)
- `ARAZZO_INPUTS_FILE`: Path to a valid JSON file that contains input values for the workflow test (e.g., `/itarazzo/specs/arazzo-inputs.json`)
---
## Docker Configuration
The Itarazzo client runs within a Docker container as a non-root user (`itarazzobot`) in the working directory `/itarazzo`.
---
## Building and Running Docker Image
Use the following commands to build and run the Docker image:
```bash
# Build the Docker image
docker build -t itarazzo-client .
# Run the container
docker run --rm \
-e ARAZZO_FILE=/itarazzo/specs/pet-store.arazzo.yaml \
-e ARAZZO_INPUTS_FILE=/itarazzo/specs/arazzo-inputs.json \
-v /path/to/specsDir:/itarazzo/specs \
-v /path/to/reportsDir:/itarazzo/target/reports \
-v ~/.m2:/home/itarazzobot/.m2 \
itarazzo-client
```
---
### Explanation of this command:
- Sets the environment variables ARAZZO_FILE and ARAZZO_INPUTS_FILE.
- Mounts the local directory `path/to/specsDir` to `/itarazzo/specs`, allowing access to specifications in the container.
- Mounts `path/to/reportsDir` to `/itarazzo/target/reports` so that test reports are available on the host machine.
- Optional: Uses the local Maven repository (`~/.m2`) in order to access the *not-yet* published `itarazzo-library` dependency.
---
## Using docker-compose
There is also a `docker-compose.yaml` which simplifies starting the container:
```yaml
services:
itarazzo:
build:
context: .
environment:
- ARAZZO_FILE=/itarazzo/specs/pet-store.arazzo.yaml
- ARAZZO_INPUTS_FILE=/itarazzo/specs/arazzo-inputs.json
volumes:
- ./src/test/resources:/itarazzo/specs
- ./target/reports:/itarazzo/target/reports
- ~/.m2:/home/itarazzobot/.m2
stop_grace_period: 30s
```
---
### Start the container using docker-compose:
```bash
docker-compose up --build
```
This command builds and starts the container, runs the tests, and exits automatically when done.
---
## Execution Notes
The container will automatically exit after completing the tests.
---
## Security Warning
>Itarazzo Client makes real API requests. Please take care to avoid unintentionally interacting with production systems.