doc: Add test guide to DEVELOPMENT.md #1747
Conversation
DEVELOPMENT.md
Outdated
| 1. Traditional unit tests | ||
| 2. Golden unit tests | ||
| 3. Showcase integration tests | ||
| 4. Golden integration tests(We should stop adding new ones, and rely on golden unit tests and showcase tests) |
There was a problem hiding this comment.
nit: I think this makes it sound like there is a possibility/ use case to add in the occasional golden integration tests.
Is there ever a use case/ need to add in new goldens? If not, I think we should just change it from We should to Do not add new ones ... and specify that we want to focus on adding new showcase tests while making the current goldens work.
Or if there is, maybe it would help to list some examples for when we should add goldens.
There was a problem hiding this comment.
Is there ever a use case/ need to add in new goldens? If not, I think we should just change it from We should to Do not add new ones ... and specify that we want to focus on adding new showcase tests while making the current goldens work.
Great question and I don't have a definite answer, we need to audit the current golden integration tests and see if there is any cases that cannot be covered by unit or showcase tests. I cannot think a good exception for golden integration tests but I also don't want to say we don't need it at all without auditing. So I prefer to keep it as should but maybe we can add more details to clarify.
DEVELOPMENT.md
Outdated
| 2. Golden unit tests | ||
| 3. Showcase integration tests |
There was a problem hiding this comment.
Could be helpful to have a quick blurb specify that:
Golden unit tests -> Generate an output file for the specific composer
Showcase integration -> Test the generated library's behavior against a mock server (and then link to the showcase module's README/ DEVELOPMENT.md)
Especially helpful for a first-time contributor
There was a problem hiding this comment.
Thanks, will do! I was planning to add more detailed explanation but wanted to get some initial feedback first, glad to see someone else also found it useful.
Co-authored-by: Emily Wang <emmwang@google.com>
|
[gapic-generator-java-root] Kudos, SonarCloud Quality Gate passed!
|
|
[java_showcase_integration_tests] Kudos, SonarCloud Quality Gate passed!
|
|
[java_showcase_unit_tests] Kudos, SonarCloud Quality Gate passed!
|
3 participants
No description provided.