Files
Sebastiaan van Stijn 12123eb592 client: merge ExecInspectResult with ExecInspect
The `ExecInspectResult` type was embedding `ExecInspect`, which is also
defined by the client, so there's no need to abstract it.

While updating, also;

- Rename `ExecID` to `ID`, to match the field-name returned by the API.
- Rename `Pid` to `PID`, to be in the right casing.
- Remove `json` labels, as option-types are not (un)marshaled to JSON.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2025-10-24 15:05:36 +02:00

97 lines
2.5 KiB
Go

package container
import (
"bytes"
"context"
"testing"
"github.com/moby/moby/client"
)
// ExecResult represents a result returned from Exec()
type ExecResult struct {
ExitCode int
outBuffer *bytes.Buffer
errBuffer *bytes.Buffer
}
// Stdout returns stdout output of a command run by Exec()
func (res ExecResult) Stdout() string {
return res.outBuffer.String()
}
// Stderr returns stderr output of a command run by Exec()
func (res ExecResult) Stderr() string {
return res.errBuffer.String()
}
// Combined returns combined stdout and stderr output of a command run by Exec()
func (res ExecResult) Combined() string {
return res.outBuffer.String() + res.errBuffer.String()
}
// AssertSuccess fails the test and stops execution if the command exited with a
// nonzero status code.
func (res ExecResult) AssertSuccess(t testing.TB) {
t.Helper()
if res.ExitCode != 0 {
t.Logf("expected exit code 0, got %d", res.ExitCode)
t.Logf("stdout: %s", res.Stdout())
t.Logf("stderr: %s", res.Stderr())
t.FailNow()
}
}
// Exec executes a command inside a container, returning the result
// containing stdout, stderr, and exit code. Note:
// - this is a synchronous operation;
// - cmd stdin is closed.
func Exec(ctx context.Context, apiClient client.APIClient, id string, cmd []string, ops ...func(*client.ExecCreateOptions)) (ExecResult, error) {
// prepare exec
execOptions := client.ExecCreateOptions{
AttachStdout: true,
AttachStderr: true,
Cmd: cmd,
}
for _, op := range ops {
op(&execOptions)
}
res, err := apiClient.ExecCreate(ctx, id, execOptions)
if err != nil {
return ExecResult{}, err
}
execID := res.ID
// run it, with stdout/stderr attached
aresp, err := apiClient.ExecAttach(ctx, execID, client.ExecAttachOptions{})
if err != nil {
return ExecResult{}, err
}
// read the output
s, err := demultiplexStreams(ctx, aresp.HijackedResponse)
if err != nil {
return ExecResult{}, err
}
// get the exit code
inspect, err := apiClient.ExecInspect(ctx, execID, client.ExecInspectOptions{})
if err != nil {
return ExecResult{}, err
}
return ExecResult{ExitCode: inspect.ExitCode, outBuffer: &s.stdout, errBuffer: &s.stderr}, nil
}
// ExecT calls Exec() and aborts the test if an error occurs.
func ExecT(ctx context.Context, t testing.TB, apiClient client.APIClient, id string, cmd []string, ops ...func(*client.ExecCreateOptions)) ExecResult {
t.Helper()
res, err := Exec(ctx, apiClient, id, cmd, ops...)
if err != nil {
t.Fatal(err)
}
return res
}