Return nil health when inspecting containers without healthchecks #21388

ashley-cui · 2024-01-26T19:21:08Z

When inspecting a container that does not define any health check, the health field should return nil. This matches docker behavior.

Does this PR introduce a user-facing change?

The `podman inspect` command now returns nil health when inspecting containers without healthchecks.

openshift-ci · 2024-01-26T19:21:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ashley-cui

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ashley-cui]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ashley-cui · 2024-01-26T19:21:29Z

Fixes: #18792

packit-as-a-service · 2024-01-26T19:58:54Z

Cockpit tests failed for commit 14e979d. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-26T20:45:46Z

Cockpit tests failed for commit 2a936bc. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-26T21:44:49Z

Cockpit tests failed for commit 29e4694. @martinpitt, @jelly, @mvollmer please check.

TomSweeneyRedHat · 2024-01-26T22:05:49Z

@ashley-cui looks like you might have upset other tests.

packit-as-a-service · 2024-01-27T02:58:43Z

Cockpit tests failed for commit 5ab50ce. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:00:12Z

Cockpit tests failed for commit 9390d56. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:01:59Z

Cockpit tests failed for commit 5ab50ce. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:03:54Z

Cockpit tests failed for commit 8e8f3fc. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:04:06Z

Cockpit tests failed for commit 9390d56. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:04:30Z

Cockpit tests failed for commit 8e8f3fc. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:04:38Z

Cockpit tests failed for commit 5ab50ce. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:12:29Z

Cockpit tests failed for commit 9390d56. @martinpitt, @jelly, @mvollmer please check.

packit-as-a-service · 2024-01-27T03:17:57Z

Cockpit tests failed for commit 8e8f3fc. @martinpitt, @jelly, @mvollmer please check.

rhatdan · 2024-01-27T10:45:54Z

libpod/container_inspect.go

+			if reflect.DeepEqual(healthCheckState, define.HealthCheckResults{}) {
+				data.State.Health = &healthCheckState
+			}
+			data.State.Health = nil


This looks wrong, you set it and then unset it. Should this be in a else statement?

packit-as-a-service · 2024-01-28T00:55:25Z

Cockpit tests failed for commit 1546f27. @martinpitt, @jelly, @mvollmer please check.

containers/podman#21388 drops the `State.Health` field for containers without health checks. This causes an `undefined` crash in the container sort function.

martinpitt · 2024-01-28T08:52:51Z

Thanks, the latest round looks much greener. This still causes a crash in cockpit-podman due to the API change. I sent cockpit-project/cockpit-podman#1540 to adjust for this, it should land by tomorrow European morning. It would be nice if you could wait with landing this PR until then, so that we can re-run the test here and make sure everything is ok.

FTR: This is exactly how I wanted the process to work -- we collaborate early and instantly know what/where things changed, before landing regressions in releases and distros 👍 ⭐ Thanks at this point!

containers/podman#21388 drops the `State.Health` field for containers without health checks. This causes an `undefined` crash in the container sort function.

rhatdan · 2024-01-28T12:35:39Z

LGTM

rhatdan · 2024-01-28T12:36:03Z

@containers/podman-maintainers PTAL

baude · 2024-01-28T14:56:24Z

pkg/api/handlers/compat/containers.go

+
+			for _, item := range log {
+				res := &types.HealthcheckResult{}
+				s, _ := time.Parse(time.RFC3339Nano, item.Start)


if you are comfy with ignoring this error, i would appreciate a comment here ... also ignored on the next line

Fixed, the error is now handled. Thanks!

baude · 2024-01-28T14:57:06Z

one nit, lets wait for @martinpitt before merging ... else, LGTM

martinpitt · 2024-01-28T19:37:18Z

The cockpit PR landed, can you please retry (or force-push)? Thanks!

Luap99 · 2024-01-29T12:13:32Z

libpod/container_inspect.go

@@ -196,7 +197,11 @@ func (c *Container) getContainerInspectData(size bool, driverData *define.Driver
 			// An error here is not considered fatal; no health state will be displayed
 			logrus.Error(err)
 		} else {
-			data.State.Health = healthCheckState
+			if reflect.DeepEqual(healthCheckState, define.HealthCheckResults{}) {


why are we using DeepEqual here? first it slow but second we already are checking if there is healthcheck with
c.config.HealthCheckConfig != nil so we should just assign the struct here.
The health key should only be missing if there is no healthcheck but not when the log is just empty (like it is doing here)

Nice catch, thanks!

Luap99

LGTM

mheon · 2024-01-29T15:51:14Z

LGTM

mheon · 2024-01-29T15:51:20Z

/lgtm
/hold

mheon · 2024-01-29T19:29:07Z

Tests are angry

TomSweeneyRedHat · 2024-01-30T21:52:39Z

On the surface, the changes LGTM, but tests are angry and this looks like it might be a real test issue:

[+1967s] Summarizing 1 Failure:
[+1967s]   [FAIL] Podman healthcheck run [It] podman disable healthcheck with --no-healthcheck must not show starting on status
[+1967s]   /var/tmp/go/src/github.com/containers/podman/test/e2e/healthcheck_run_test.go:40
[+1967s]

When inspecting a container that does not define any health check, the health field should return nil. This matches docker behavior. Signed-off-by: Ashley Cui <acui@redhat.com>

packit-as-a-service · 2024-01-31T05:14:04Z

Cockpit tests failed for commit a1c47f0. @martinpitt, @jelly, @mvollmer please check.

martinpitt · 2024-01-31T07:23:42Z

Wrt. the rawhide failure, the test instaled the wrong cockpit-podman version again (from rawhide, instead of from our main-builds COPR). I'll investigate today, please disregard this ATM.

I filed cockpit-project/cockpit-podman#1543 to fix this.

martinpitt · 2024-01-31T09:08:28Z

@ashley-cui the rawhide cockpit-revdeps should go green now, I landed a fix/hack. I can't retry it myself, but you should be able to on https://github.com/containers/podman/pull/21388/checks?check_run_id=21048234276

mheon · 2024-01-31T13:11:09Z

/lgtm
/hold cancel

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note labels Jan 26, 2024

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 26, 2024

ashley-cui marked this pull request as ready for review January 26, 2024 19:21

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 26, 2024

ashley-cui force-pushed the healthcheck branch from 14e979d to 2a936bc Compare January 26, 2024 20:08

ashley-cui force-pushed the healthcheck branch from 2a936bc to 29e4694 Compare January 26, 2024 21:05

ashley-cui force-pushed the healthcheck branch from 29e4694 to 5ab50ce Compare January 27, 2024 02:19

github-actions bot added the kind/api-change Change to remote API; merits scrutiny label Jan 27, 2024

ashley-cui force-pushed the healthcheck branch 2 times, most recently from 9390d56 to 8e8f3fc Compare January 27, 2024 02:27

rhatdan reviewed Jan 27, 2024

View reviewed changes

ashley-cui force-pushed the healthcheck branch from 8e8f3fc to 1546f27 Compare January 28, 2024 00:18

baude reviewed Jan 28, 2024

View reviewed changes

Luap99 reviewed Jan 29, 2024

View reviewed changes

ashley-cui force-pushed the healthcheck branch 2 times, most recently from 14d5626 to 4ce2a10 Compare January 29, 2024 15:02

Luap99 reviewed Jan 29, 2024

View reviewed changes

Return nil health when inspecting containers without healthchecks

a1c47f0

When inspecting a container that does not define any health check, the health field should return nil. This matches docker behavior. Signed-off-by: Ashley Cui <acui@redhat.com>

ashley-cui force-pushed the healthcheck branch from 4ce2a10 to a1c47f0 Compare January 31, 2024 04:12

ashley-cui added the 5.0 label Jan 31, 2024

martinpitt mentioned this pull request Jan 31, 2024

fmf: Fix installation of our main-builds COPR cockpit-project/cockpit-podman#1543

Merged

openshift-ci bot assigned mheon Jan 31, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 31, 2024

openshift-merge-bot bot merged commit 1698fa0 into containers:main Jan 31, 2024
90 of 92 checks passed

cevich mentioned this pull request Jan 31, 2024

[skip-ci] Make leak-detection readable by humans #21459

Merged

ashley-cui mentioned this pull request Feb 6, 2024

Running containers without defined or disabled health checks should not return "Health": {} #18792

Closed

stale-locking-app bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Apr 30, 2024

stale-locking-app bot locked as resolved and limited conversation to collaborators Apr 30, 2024

Return nil health when inspecting containers without healthchecks #21388

Return nil health when inspecting containers without healthchecks #21388

Conversation

ashley-cui commented Jan 26, 2024

Does this PR introduce a user-facing change?

openshift-ci bot commented Jan 26, 2024

ashley-cui commented Jan 26, 2024

packit-as-a-service bot commented Jan 26, 2024

packit-as-a-service bot commented Jan 26, 2024

packit-as-a-service bot commented Jan 26, 2024

TomSweeneyRedHat commented Jan 26, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

packit-as-a-service bot commented Jan 27, 2024

rhatdan Jan 27, 2024

Choose a reason for hiding this comment

packit-as-a-service bot commented Jan 28, 2024

martinpitt commented Jan 28, 2024

rhatdan commented Jan 28, 2024

rhatdan commented Jan 28, 2024

baude Jan 28, 2024

Choose a reason for hiding this comment

ashley-cui Jan 29, 2024

Choose a reason for hiding this comment

baude commented Jan 28, 2024

martinpitt commented Jan 28, 2024 via email

Luap99 Jan 29, 2024

Choose a reason for hiding this comment

ashley-cui Jan 29, 2024

Choose a reason for hiding this comment

Luap99 left a comment

Choose a reason for hiding this comment

mheon commented Jan 29, 2024

mheon commented Jan 29, 2024

mheon commented Jan 29, 2024

TomSweeneyRedHat commented Jan 30, 2024

packit-as-a-service bot commented Jan 31, 2024

martinpitt commented Jan 31, 2024 • edited

martinpitt commented Jan 31, 2024

mheon commented Jan 31, 2024

martinpitt commented Jan 31, 2024 •

edited