kubernetes-sigs/cluster-api

Detect unexpected errors via logs in envtest and e2e tests

Open

#11,402 opened on Nov 11, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (1,532 forks)auto 404
area/testinghelp wantedkind/featurepriority/backlogtriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

It would be great if we find a way to surface unexpected conditions via logs and then check in envtest and e2e tests that they never occur.

Of course this requires us to have an easy way to identify such logs (e.g. they could contain a specific keyword).

Recently we implemented something similar for panics. After envtest and e2e tests are completed we check controller-runtime metrics to ensure no panics occured

Contributor guide

Research direction
Examine how panics are detected via metrics in envtest and e2e tests. Then propose a similar approach for logs by identifying a keyword or pattern for unexpected errors. Consider how to collect logs programmatically and assert their absence.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55