Kong/kubernetes-ingress-controller

Integration tests not idempotent because of faulty cleanup

Open

#2,652 opened on Jul 6, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (619 forks)auto 404
area/debtarea/testsbuggood first issuenice-to-haveonboardingpriority/low

Repository metrics

Stars
 (2,404 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

When integration tests are executed, a lot of cleaning functions are deferred to the end of the test. The problem is that we use the exitOnErr function to assert that no error must occur. Whenever such a function fails, the program exits, and all the deferred functions are not executed anymore. This leads to having orphaned resources.

Expected Behavior

We should use the new mechanism introduced in KTF to clean resources, instead of the deferred functions. See https://github.com/Kong/kubernetes-ingress-controller/issues/2618 as a similar issue in KTF.

Contributor guide

Research direction
Use the new mechanism in KTF instead of deferred functions to ensure cleanup runs even after errors.
Tech stack
go
Domain
backendtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoKTF
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65