ISSUE-195 # Generation of Scenarios from OpenAPI specifications (POC)

[javiertuya]

Generation of Scenarios from OpenAPI specifications (POC)

Fixes Issue

• Which issue or ticket was(will be) fixed by this PR? Close Support OpenAPI Specification #195

PR Branch
https://github.com/javiertuya/zerocode/tree/195-zerocode-openapi-poc

Motivation and Context

This is a proof of concept of a generator of Zerocode scenarios from OpenAPI specifications.

• Currently implemented in a separate module: zerocode-openapi
• Provides a single entry point generateAll that takes two arguments:
  • File name or url where the OpenAPI specification is located.
  • A folder where the generated scenarios will be placed (name of scenarios match the name of the path in the specification).
• Integration tests generate scenarios from the POC demonstrator: Swagger Petstore specification.
• End to End tests (manual execution) run the generated scenarios agains the real petstore backend.
• Additional performance test (manual) generates scenarios from the OpenAPI specification of the GitHub REST API.
• Provisional documentation with more details in the module README.md file

Checklist:

• New Unit tests were added

  • Covered in existing Unit tests

• Integration tests were added

  • Covered in existing Integration tests

• Test names are meaningful

• Feature manually tested and outcome is successful

• PR doesn't break any of the earlier features for end users

  • WARNING! This might break one or more earlier earlier features, hence left a comment tagging all reviewrs

• Branch build passed in CI

• No 'package.*' in the imports

• Relevant DOcumentation page added or updated with clear instructions and examples for the end user

  • Not applicable. This was only a code refactor change, no functional or behaviourial changes were introduced

• Http test added to http-testing module(if applicable) ?

  • Not applicable. The changes did not affect HTTP automation flow

• Kafka test added to kafka-testing module(if applicable) ?

  • Not applicable. The changes did not affect Kafka automation flow

[authorjapps]

Thanks @javiertuya , will have a look. This might take bit of time to fully review it as there are a lot of things for the context.

Also, added @a1shadows @omkar-shitole as the reviewer. Can you guys have a look please?