Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide for developers: how to test KIC #4107

Closed
1 of 3 tasks
mflendrich opened this issue May 31, 2023 · 2 comments · Fixed by #4111
Closed
1 of 3 tasks

Guide for developers: how to test KIC #4107

mflendrich opened this issue May 31, 2023 · 2 comments · Fixed by #4111

Comments

@mflendrich
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Problem Statement

Broken out of #4099

As a developer I would like to know what level/method of testing (unit, integration, e2e) is appropriate for the behavior change/functionality I'm implementing.

It is tempting to write an integration/e2e test where a unit/env test would suffice (and be faster, easier to comprehend and maintain).

Proposed Solution

  • Provide definitions of existing testing levels (unit, envtest, integration, e2e) and their characteristics/performance
  • Idea (@czeslavo):Provide a flowchart / decision tree to help decide on the testing level

Additional information

For the flowchart, example by @randmonkey:

Does it need Kong gateway?
Yes -> integration test
No -> unit test

Acceptance Criteria

  • Developer documentation defines all existing testing levels
  • Developer documentation helps make a decision about the testing method most suitable to fix the problem
@pmalek
Copy link
Member

pmalek commented Jun 1, 2023

Some info about testing has been put into https://github.com/Kong/kubernetes-ingress-controller/blob/5d8abcae128ce355afb74d261baba5672a4e40c0/TESTING.md

@rainest
Copy link
Contributor

rainest commented Oct 4, 2023

For whatever reason merging the linked PR did not close this issue despite Github saying it would. Closing manually.

@rainest rainest closed this as completed Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants