Allow to skip automated test with OpenAPI/AsyncAPI

[Snorkell]

Reason/Context

Hello, while testing api with microcks I had some issue with some endpoints not returning a body therefore the test fails because there is no mapping between the request and the response as presented in this issue #944

I know changing the way the test works by allowing empty response can take some time, and a easy temporary workaround would be to skip the test while such a feature is not there yet, and may be other feature that are not supported yet can make a skippable test a nice thing

Description

Make a test skippable by adding some kind of property in the spec definition

This way test that are using Api feature that are not already handled by Microcks can pass without breaking any CD/CI pipeline that should assert that the tests are passing

I already did a POC and a PR should be pushed soon (I won't forget to sign off my commit this time I hope 😅)

I also wanted to thank you for the fast feedback for the other issue/PR, agains thanks for all this work

Implementation ideas

A nice thing could be to add a property in the openapi/asyncapi spec like

x-microcks-skip-test: true

that would just skip the iteration of the test in the test runner while setting the success flag to true, and adding a new boolean flag like "skipped"
and then display them as skipped in the frontend

[lbroudoux]

Have you checked that you can select the operations to include when launching a test? Users in the community seem to find this selection pretty convenient... Couldn't it be applied to your situation?

[Snorkell]

Hey, to be honest I didn't see the filters on the operation, but in my case I do the test using a test container. I saw that using the testContainer we can provide filteredOperations for the TestRequest builder so yeah my feature might be useless in this case.

However with the filteredOperations() I have to fill every operation I want to test, this can be a tedious task for a huge api spec if I only want to skip one.

I feel like my feature is not that usefull but also can come handy for huge api specs with lots of endpoints

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. Microcks is a Cloud Native Computing Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️