Enhance API-Testing-Guidelines.md

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs

Apache License 2.0

9 stars 24 forks source link

Enhance API-Testing-Guidelines.md #203

Closed jlurien closed 2 weeks ago

jlurien commented 1 month ago

What type of PR is this?

documentation

What this PR does / why we need it:

Enhances API testing guidelines with much more details and explanations. Initial version was too basic to assure consistent and coherent testing plans.

Which issue(s) this PR fixes:

Fixes #158

Special notes for reviewers:

This is a first draft following proposal and initial feedback in #158.

Changelog input

* Enhancement of API-Testing-Guidelines

jlurien commented 1 month ago

In the latter commit:

Proposal updated with comments and feedback after dedicated session on May 16th.

Tests coverage section moved to to the top, merging legacy section "Test Cases contribution for APIs".
Added distinction between basic and enhanced test plan, to be aligned with Release Management proposal. There is no proper definition of what is basic or enhanced, so I suggested some initial text.
Added explicitly that environment variables may be kept in a separated file. We should enhance this part with more details and a suggested template.

Please review these changes.

jlurien commented 3 weeks ago

I think I have incorporated all suggestions and feedback, please double check

mdomale commented 3 weeks ago

@jlurien Except above 1 comment PR looks fine to us .

jlurien commented 3 weeks ago

Final comments addressed. Thanks for the feedback and corrections.

mdomale commented 3 weeks ago

@jlurien Thanks for accommodating comments .LGTM now cc @akoshunyadi @shilpa-padgaonkar