InTheForest/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-01-11 02:31:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

client: ContainerWaitResult: use singular for channels

Browse Source 
These channels should ever only return a single result, so rename
them to match that expectation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
2025-10-29 11:37:09 +01:00
parent 51a0584088
commit 29ad05b130
7 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
client/container_wait.go
View File

@@ -20,8 +20,8 @@ type ContainerWaitOptions struct {
// ContainerWaitResult defines the result from the [Client.ContainerWait] method.
type ContainerWaitResult struct {
Results <-chan container.WaitResponse
Errors <-chan error
Result <-chan container.WaitResponse
Error <-chan error
}
// ContainerWait waits until the specified container is in a certain state
@@ -45,7 +45,7 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
containerID, err := trimID("container", containerID)
if err != nil {
errC <- err
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}
query := url.Values{}
@@ -57,7 +57,7 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
if err != nil {
defer ensureReaderClosed(resp)
errC <- err
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}
go func() {
@@ -88,5 +88,5 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
resultC <- res
}()
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}

38
client/container_wait_test.go
View File

@@ -21,11 +21,11 @@ import (
func TestContainerWaitError(t *testing.T) {
client, err := NewClientWithOpts(WithMockClient(errorMock(http.StatusInternalServerError, "Server error")))
assert.NilError(t, err)
wait := client.ContainerWait(context.Background(), "nothing", ContainerWaitOptions{})
wait := client.ContainerWait(t.Context(), "nothing", ContainerWaitOptions{})
select {
case result := <-wait.Results:
case result := <-wait.Result:
t.Fatalf("expected to not get a wait result, got %d", result.StatusCode)
case err := <-wait.Errors:
case err := <-wait.Error:
assert.Check(t, is.ErrorType(err, cerrdefs.IsInternal))
}
}
@@ -38,11 +38,11 @@ func TestContainerWaitConnectionError(t *testing.T) {
client, err := NewClientWithOpts(WithAPIVersionNegotiation(), WithHost("tcp://no-such-host.invalid"))
assert.NilError(t, err)
wait := client.ContainerWait(context.Background(), "nothing", ContainerWaitOptions{})
wait := client.ContainerWait(t.Context(), "nothing", ContainerWaitOptions{})
select {
case result := <-wait.Results:
case result := <-wait.Result:
t.Fatalf("expected to not get a wait result, got %d", result.StatusCode)
case err := <-wait.Errors:
case err := <-wait.Error:
assert.Check(t, is.ErrorType(err, IsErrConnectionFailed))
}
}
@@ -59,11 +59,11 @@ func TestContainerWait(t *testing.T) {
}))
assert.NilError(t, err)
wait := client.ContainerWait(context.Background(), "container_id", ContainerWaitOptions{})
wait := client.ContainerWait(t.Context(), "container_id", ContainerWaitOptions{})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.NilError(t, err)
case result := <-wait.Results:
case result := <-wait.Result:
assert.Check(t, is.Equal(result.StatusCode, int64(15)))
}
}
@@ -82,11 +82,11 @@ func TestContainerWaitProxyInterrupt(t *testing.T) {
}))
assert.NilError(t, err)
wait := client.ContainerWait(context.Background(), "container_id", ContainerWaitOptions{})
wait := client.ContainerWait(t.Context(), "container_id", ContainerWaitOptions{})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.Check(t, is.ErrorContains(err, expErr))
case result := <-wait.Results:
case result := <-wait.Result:
t.Fatalf("Unexpected result: %v", result)
}
}
@@ -102,12 +102,12 @@ func TestContainerWaitProxyInterruptLong(t *testing.T) {
}))
assert.NilError(t, err)
wait := client.ContainerWait(context.Background(), "container_id", ContainerWaitOptions{})
wait := client.ContainerWait(t.Context(), "container_id", ContainerWaitOptions{})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
// LimitReader limiting isn't exact, because of how the Readers do chunking.
assert.Check(t, len(err.Error()) <= containerWaitErrorMsgLimit*2, "Expected error to be limited around %d, actual length: %d", containerWaitErrorMsgLimit, len(err.Error()))
case result := <-wait.Results:
case result := <-wait.Result:
t.Fatalf("Unexpected result: %v", result)
}
}
@@ -124,7 +124,7 @@ func TestContainerWaitErrorHandling(t *testing.T) {
{name: "connection reset", rdr: iotest.ErrReader(syscall.ECONNRESET), exp: syscall.ECONNRESET},
} {
t.Run(test.name, func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
ctx, cancel := context.WithCancel(t.Context())
defer cancel()
client, err := NewClientWithOpts(WithMockClient(func(req *http.Request) (*http.Response, error) {
@@ -136,10 +136,10 @@ func TestContainerWaitErrorHandling(t *testing.T) {
assert.NilError(t, err)
wait := client.ContainerWait(ctx, "container_id", ContainerWaitOptions{})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.Check(t, is.Equal(err.Error(), test.exp.Error()))
return
case result := <-wait.Results:
case result := <-wait.Result:
t.Fatalf("expected to not get a wait result, got %d", result.StatusCode)
return
}
@@ -154,7 +154,7 @@ func ExampleClient_ContainerWait_withTimeout() {
client, _ := NewClientWithOpts(FromEnv)
wait := client.ContainerWait(ctx, "container_id", ContainerWaitOptions{})
if err := <-wait.Errors; err != nil {
if err := <-wait.Error; err != nil {
log.Fatal(err)
}
}

4
integration-cli/docker_api_containers_test.go
View File

@@ -823,9 +823,9 @@ func (s *DockerAPISuite) TestContainerAPIWait(c *testing.T) {
wait := apiClient.ContainerWait(testutil.GetContext(c), name, client.ContainerWaitOptions{})
select {
case err = <-wait.Errors:
case err = <-wait.Error:
assert.NilError(c, err)
case waitRes := <-wait.Results:
case waitRes := <-wait.Result:
assert.Equal(c, waitRes.StatusCode, int64(0))
}
}

4
integration/container/create_test.go
View File

@@ -508,13 +508,13 @@ func TestCreateTmpfsOverrideAnonymousVolume(t *testing.T) {
select {
case <-timeout.C:
t.Fatal("timeout waiting for container to exit")
case status := <-wait.Results:
case status := <-wait.Result:
var errMsg string
if status.Error != nil {
errMsg = status.Error.Message
}
assert.Equal(t, int(status.StatusCode), 0, errMsg)
case err := <-wait.Errors:
case err := <-wait.Error:
assert.NilError(t, err)
}
}

4
integration/container/daemon_linux_test.go
View File

@@ -218,8 +218,8 @@ func TestRestartDaemonWithRestartingContainer(t *testing.T) {
defer cancel()
wait := apiClient.ContainerWait(ctxTimeout, id, client.ContainerWaitOptions{Condition: containertypes.WaitConditionNextExit})
select {
case <-wait.Results:
case err := <-wait.Errors:
case <-wait.Result:
case err := <-wait.Error:
assert.NilError(t, err)
}
}

20
integration/container/wait_test.go
View File

@@ -47,9 +47,9 @@ func TestWaitNonBlocked(t *testing.T) {
wait := cli.ContainerWait(ctx, containerID, client.ContainerWaitOptions{})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.NilError(t, err)
case waitRes := <-wait.Results:
case waitRes := <-wait.Result:
assert.Check(t, is.Equal(tc.expectedCode, waitRes.StatusCode))
}
})
@@ -91,9 +91,9 @@ func TestWaitBlocked(t *testing.T) {
assert.NilError(t, err)
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.NilError(t, err)
case waitRes := <-wait.Results:
case waitRes := <-wait.Result:
assert.Check(t, is.Equal(tc.expectedCode, waitRes.StatusCode))
case <-time.After(2 * time.Second):
t.Fatal("timeout waiting for `docker wait`")
@@ -152,9 +152,9 @@ func TestWaitConditions(t *testing.T) {
assert.NilError(t, err)
wait := cli.ContainerWait(ctx, containerID, client.ContainerWaitOptions{Condition: tc.waitCond})
select {
case err := <-wait.Errors:
case err := <-wait.Error:
t.Fatalf("ContainerWait() err = %v", err)
case res := <-wait.Results:
case res := <-wait.Result:
t.Fatalf("ContainerWait() sent exit code (%v) before ContainerStart()", res)
default:
}
@@ -166,9 +166,9 @@ func TestWaitConditions(t *testing.T) {
assert.NilError(t, err)
select {
case err := <-wait.Errors:
case err := <-wait.Error:
assert.NilError(t, err)
case waitRes := <-wait.Results:
case waitRes := <-wait.Result:
assert.Check(t, is.Equal(int64(99), waitRes.StatusCode))
case <-time.After(StopContainerWindowsPollTimeout):
ctr, _ := cli.ContainerInspect(ctx, containerID, client.ContainerInspectOptions{})
@@ -229,11 +229,11 @@ func TestWaitRestartedContainer(t *testing.T) {
assert.NilError(t, err)
select {
case err := <-wait.Errors:
case err := <-wait.Error:
t.Fatalf("Unexpected error: %v", err)
case <-time.After(time.Second * 3):
t.Fatalf("Wait should end after restart")
case waitRes := <-wait.Results:
case waitRes := <-wait.Result:
expectedCode := int64(5)
if !isWindowDaemon {

10
vendor/github.com/moby/moby/client/container_wait.go generated vendored
View File

@@ -20,8 +20,8 @@ type ContainerWaitOptions struct {
// ContainerWaitResult defines the result from the [Client.ContainerWait] method.
type ContainerWaitResult struct {
Results <-chan container.WaitResponse
Errors <-chan error
Result <-chan container.WaitResponse
Error <-chan error
}
// ContainerWait waits until the specified container is in a certain state
@@ -45,7 +45,7 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
containerID, err := trimID("container", containerID)
if err != nil {
errC <- err
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}
query := url.Values{}
@@ -57,7 +57,7 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
if err != nil {
defer ensureReaderClosed(resp)
errC <- err
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}
go func() {
@@ -88,5 +88,5 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, option
resultC <- res
}()
return ContainerWaitResult{Results: resultC, Errors: errC}
return ContainerWaitResult{Result: resultC, Error: errC}
}