[25.0 backport] client: fix connection-errors being shadowed by API version errors

[neersighted]

• Backport of client: fix connection-errors being shadowed by API version errors #47440
• fixes / addresses Misleading error message for docker secret ls docker/cli#4890
• relates to client: negotiate api version before handling version-specific code #46463
• relates to Docker CLI: docker image prune --all --force is failing in Version 25.0.1 docker/cli#4852

client: fix TestPingWithError

This test was added in 27ef09a (#33827), which changed
the Ping handling to ignore internal server errors. That case is tested in
TestPingFail, which verifies that we accept the Ping response if a 500
status code was received.

The TestPingWithError test was added to verify behavior if a protocol
(connection) error occurred; however the mock-client returned both a
response, and an error; the error returned would only happen if a connection
error occurred, which means that the server would not provide a reply.

Running the test also shows that returning a response is unexpected, and
ignored:

=== RUN   TestPingWithError
2024/02/23 14:16:49 RoundTripper returned a response & error; ignoring response
2024/02/23 14:16:49 RoundTripper returned a response & error; ignoring response
--- PASS: TestPingWithError (0.00s)
PASS

This patch updates the test to remove the response.

client: NegotiateAPIVersion: do not ignore (connection) errors from Ping

NegotiateAPIVersion was ignoring errors returned by Ping. The intent here
was to handle API responses from a daemon that may be in an unhealthy state,
however this case is already handled by Ping itself.

Ping only returns an error when either failing to connect to the API (daemon
not running or permissions errors), or when failing to parse the API response.

Neither of those should be ignored in this code, or considered a successful
"ping", so update the code to return

client: doRequest: make sure we return a connection-error

This function has various errors that are returned when failing to make a
connection (due to permission issues, TLS mis-configuration, or failing to
resolve the TCP address).

The errConnectionFailed error is currently used as a special case when
processing Ping responses. The current code did not consistently treat
connection errors, and because of that could either absorb the error,
or process the empty response.

client: fix connection-errors being shadowed by API version mismatch errors

Commit e690724 (#46463) applied a fix for situations
where the client was configured with API-version negotiation, but did not yet
negotiate a version.

However, the checkVersion() function that was implemented copied the semantics
of cli.NegotiateAPIVersion, which ignored connection failures with the
assumption that connection errors would still surface further down.

However, when using the result of a failed negotiation for NewVersionError,
an API version mismatch error would be produced, masking the actual connection
error.

This patch changes the signature of checkVersion to return unexpected errors,
including failures to connect to the API.

Before this patch:

docker -H unix:///no/such/socket.sock secret ls
"secret list" requires API version 1.25, but the Docker daemon API version is 1.24

With this patch applied:

docker -H unix:///no/such/socket.sock secret ls
Cannot connect to the Docker daemon at unix:///no/such/socket.sock. Is the docker daemon running?

- Description for the changelog

- Fix a regression that caused API socket connection failures to report an API version negotiation failure instead.

- A picture of a cute animal (not mandatory but encouraged)

[neersighted]

Note that #47139 caused (trivial) conflicts; I have elected not to include it in the backport as the type movement introduced new deprecations, and pulling those deprecations into a patch release would constitute a breaking change.

[thaJeztah]

Looks like you probably missed one;

client/build_cancel.go:1: : # github.com/docker/docker/client [github.com/docker/docker/client.test]
client/image_list_test.go:39:56: undefined: image.ListOptions (typecheck)
package client // import "github.com/docker/docker/client"

[neersighted]

Drat, it cherry-picks cleanly but doesn't compile. Will take a look in a bit.

[thaJeztah]

Yeah; looks also related to #47139, so should be an easy fix

[thaJeztah]

LGTM

[vvoland]

We really need to get #47471 in 😅

Run teststat -markdown $(find /tmp/reports -type f -name '*.json' -print0 | xargs -0) >> $GITHUB_STEP_SUMMARY
2024/02/29 14:33:39 json: cannot unmarshal string into Go value of type main.Line
2024/02/29 14:33:39 invalid character 'p' looking for beginning of value
...