:bug: Client go version metrics endpoint test by bentito · Pull Request #1821 · operator-framework/operator-controller

bentito · 2025-02-27T19:10:45Z

Description

This PR rewrites the metrics endpoint e2e test using client-go. It maintains the recent change to the kubectl exec version by still "force" deleting the Pod (0 time grace period). Seems to pass a local 10 of 10 in a row e2e test.

Added an optional TEST_FILTER env var to the e2e run in the Makefile. Not really related but sure is better when you're iterating on one e2e test change.

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

netlify · 2025-02-27T19:11:03Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`600fb09`
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/67c89a75fb9fcd00089a5ff7
😎 Deploy Preview	https://deploy-preview-1821--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

bentito · 2025-02-27T19:33:04Z

Hmm, I pulled test/utils.go because I thought it had no used methods once I moved FindK8sClient to the test file and made it local. There was another seemingly unused, but now I'm realizing possibly externally used function there. Should I just put utils.go back as-was to alleviate the go-apidiff check fail, or...?

codecov · 2025-02-27T19:35:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.45%. Comparing base (7fc18c6) to head (600fb09).
Report is 1 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1821 +/- ##
==========================================
+ Coverage 68.39% 68.45% +0.05% 
==========================================
Files 63 63 Lines 5136 5136 ==========================================
+ Hits 3513 3516 +3 + Misses 1392 1390 -2 + Partials 231 230 -1

Flag	Coverage Δ
e2e	`51.60% <ø> (+0.07%)`	⬆️
unit	`55.99% <ø> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

camilamacedo86 · 2025-02-28T07:02:51Z

-	require.Contains(c.t, string(output), "200 OK", "Metrics endpoint did not return 200 OK")
+	// Combine stdout + stderr
+	combined := stdout.String() + stderr.String()
+	require.Contains(c.t, combined, "200 OK", "Metrics endpoint did not return 200 OK")


Is it not much more complex than before?
I think before it was very clear what it does, we could easily copy and paste to validate the things.
But anyone, maybe it is a matter of preference. So, OK with ANY

yeah Idk, it was certainly harder to implement, kubectl exec was doing several things for us. I think this PR mostly just answers @joelanford concern that that help from kubectl also opened more avenues for things to go subtly wrong. And @azych desire that this test should use go-client like the other e2e.

I could see wrapping this in a more general purpose execInPod kind of utility function that could be re-used. But mostly a nit since there's not another place that we need this at the moment.

azych

LGTM, just added a few nits

Signed-off-by: Brett Tofel <btofel@redhat.com>

test/utils.go deleted because no used funcs Signed-off-by: Brett Tofel <btofel@redhat.com>

Signed-off-by: Brett Tofel <btofel@redhat.com>

Have to have package filter too, to not run all the unit tests due to UNIT_TEST_DIRS Signed-off-by: Brett Tofel <btofel@redhat.com>

Signed-off-by: Brett Tofel <btofel@redhat.com>

This reverts commit fed0ad5.

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 27, 2025

bentito requested a review from a team as a code owner February 27, 2025 19:10

bentito force-pushed the client-go-version-metrics-endpoint-test branch from ecfef0f to dce13b3Compare February 27, 2025 19:26

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 27, 2025

camilamacedo86 reviewed Feb 27, 2025
View reviewed changes

Comment threadMakefile

camilamacedo86 reviewed Feb 28, 2025
View reviewed changes

Comment threadtest/e2e/metrics_test.go Outdated

camilamacedo86 reviewed Feb 28, 2025
View reviewed changes

azych reviewed Feb 28, 2025
View reviewed changes

Comment threadtest/e2e/metrics_test.go
Comment threadtest/e2e/metrics_test.go Outdated
Comment threadtest/e2e/metrics_test.go Outdated
Comment threadtest/e2e/metrics_test.go Outdated
Comment threadtest/e2e/metrics_test.go

azych approved these changes Feb 28, 2025
View reviewed changes

joelanford reviewed Mar 3, 2025
View reviewed changes

Comment threadtest/e2e/metrics_test.go

joelanford reviewed Mar 3, 2025
View reviewed changes

Comment threadMakefile Outdated

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 3, 2025

bentito force-pushed the client-go-version-metrics-endpoint-test branch from 8f5b7eb to 15a1c2aCompare March 3, 2025 21:53

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 3, 2025

bentito added 8 commits March 5, 2025 08:36

Adds TEST_FILTER env var to e2e run
cf9f0bb
Signed-off-by: Brett Tofel <btofel@redhat.com>

Rewrite metrics endpoint test to use client-go
27c86c2
test/utils.go deleted because no used funcs Signed-off-by: Brett Tofel <btofel@redhat.com>

Rm pointer helpers, use k8s ones.
dd0154e
Signed-off-by: Brett Tofel <btofel@redhat.com>

Rename main test client to globalClient (de-shadow "c")
37d7a2a
Signed-off-by: Brett Tofel <btofel@redhat.com>

Use apierrors, move deferred cleanup, less nesting
562cba6
Signed-off-by: Brett Tofel <btofel@redhat.com>

Rename main test cfg->globalConfig de-shadow "cfg"
c426735
Signed-off-by: Brett Tofel <btofel@redhat.com>

Allow test-unit filter on package and test
d09f74d
Have to have package filter too, to not run all the unit tests due to UNIT_TEST_DIRS Signed-off-by: Brett Tofel <btofel@redhat.com>

Drop UNIT_TEST_DIRS for TEST_PKGS + TEST_FILTER
e82ebca
Signed-off-by: Brett Tofel <btofel@redhat.com>

bentito force-pushed the client-go-version-metrics-endpoint-test branch from 15a1c2a to e82ebcaCompare March 5, 2025 13:39

camilamacedo86 reviewed Mar 5, 2025
View reviewed changes

Comment threadMakefile Outdated

Remove ENVTEST_VERSION dupe in Makefile
600fb09
Signed-off-by: Brett Tofel <btofel@redhat.com>

joelanford enabled auto-merge March 5, 2025 20:22

joelanford approved these changes Mar 5, 2025
View reviewed changes

joelanford added this pull request to the merge queue Mar 5, 2025

Merged via the queue into operator-framework:main with commit fed0ad5Mar 5, 2025

camilamacedo86 added a commit that referenced this pull request Mar 18, 2025
Revert ":bug: Client go version metrics endpoint test (#1821)"
b42b25c
This reverts commit fed0ad5.

camilamacedo86 mentioned this pull request Mar 18, 2025
🐛 Revert "🐛 Client go version metrics endpoint test" #1871
Merged

github-merge-queueBot pushed a commit that referenced this pull request Mar 18, 2025
Revert ":bug: Client go version metrics endpoint test (#1821)" (#1871)
ef348ee
This reverts commit fed0ad5.

Navigation Menu

Uh oh!

🐛 Client go version metrics endpoint test - #1821

🐛 Client go version metrics endpoint test#1821
joelanford merged 9 commits into
operator-framework:mainfrom
bentito:client-go-version-metrics-endpoint-test

bentito commented Feb 27, 2025

Uh oh!

netlifyBot commented Feb 27, 2025•
edited
Loading

Uh oh!

bentito commented Feb 27, 2025

Uh oh!

codecovBot commented Feb 27, 2025•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

camilamacedo86Feb 28, 2025•
edited
Loading

Uh oh!

bentitoMar 3, 2025

Uh oh!

joelanfordMar 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azych left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

bentito commented Feb 27, 2025

Description

Reviewer Checklist

Uh oh!

netlifyBot commented Feb 27, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

bentito commented Feb 27, 2025

Uh oh!

codecovBot commented Feb 27, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

camilamacedo86Feb 28, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bentitoMar 3, 2025

Choose a reason for hiding this comment

Uh oh!

joelanfordMar 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azych left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

netlifyBot commented Feb 27, 2025•
edited
Loading

codecovBot commented Feb 27, 2025•
edited
Loading

camilamacedo86Feb 28, 2025•
edited
Loading