Kong/kubernetes-ingress-controller

Get rid of `tcpMutex`, `tlsMutex` and `ingressClassMutex` from integration tests

Open

#5,757 opened on Mar 27, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Go (619 forks)auto 404
area/debtarea/testsgood first issue

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

Problem Statement

Some integration tests require

https://github.com/Kong/kubernetes-ingress-controller/blob/09f1e556e68442b87345879e18867e9b0226e3a7/test/integration/tcpingress_test.go#L33-L36

those tests should be migrated to isolated tests. UDP-related tests have been already migrated as a byproduct of fighting with flakes.

Similar situation is for ingressClassMutex.

Also, it's a great opportunity for improvement and cleanups, e.g. usage of assertion helpers from test/integration/isolated/assertion_helpers.go. See UDP corresponding tests for inspiration.

Proposed Solution

  • tests are migrated to isolated
  • tcpMutex, tlsMutex and ingressClassMutex are no longer needed

Acceptance Criteria

  • tests are migrated to isolated
  • tcpMutex, tlsMutex and ingressClassMutex are removed

Contributor guide

Research direction
Examine the existing TCP, TLS, and IngressClass integration tests that use mutexes. Review the isolated test pattern in TESTING.md and the migrated UDP tests. Create new isolated test files and move the logic, replacing mutexes with test fixtures. Remove the mutex variables after all tests are migrated.
Tech stack
go
Domain
backend
Issue type
Refactor
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
GoKubernetesintegration tests
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75