1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
// Copyright 2020 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dockerutil
import (
"bytes"
"context"
"fmt"
"time"
"github.com/docker/docker/api/types"
"github.com/docker/docker/pkg/stdcopy"
)
// ExecOpts holds arguments for Exec calls.
type ExecOpts struct {
// Env are additional environment variables.
Env []string
// Privileged enables privileged mode.
Privileged bool
// User is the user to use.
User string
// Enables Tty and stdin for the created process.
UseTTY bool
// WorkDir is the working directory of the process.
WorkDir string
}
// Exec creates a process inside the container.
func (c *Container) Exec(ctx context.Context, opts ExecOpts, args ...string) (string, error) {
p, err := c.doExec(ctx, opts, args)
if err != nil {
return "", err
}
if exitStatus, err := p.WaitExitStatus(ctx); err != nil {
return "", err
} else if exitStatus != 0 {
out, _ := p.Logs()
return out, fmt.Errorf("process terminated with status: %d", exitStatus)
}
return p.Logs()
}
// ExecProcess creates a process inside the container and returns a process struct
// for the caller to use.
func (c *Container) ExecProcess(ctx context.Context, opts ExecOpts, args ...string) (Process, error) {
return c.doExec(ctx, opts, args)
}
func (c *Container) doExec(ctx context.Context, r ExecOpts, args []string) (Process, error) {
config := c.execConfig(r, args)
resp, err := c.client.ContainerExecCreate(ctx, c.id, config)
if err != nil {
return Process{}, fmt.Errorf("exec create failed with err: %v", err)
}
hijack, err := c.client.ContainerExecAttach(ctx, resp.ID, types.ExecStartCheck{})
if err != nil {
return Process{}, fmt.Errorf("exec attach failed with err: %v", err)
}
return Process{
container: c,
execid: resp.ID,
conn: hijack,
}, nil
}
func (c *Container) execConfig(r ExecOpts, cmd []string) types.ExecConfig {
env := append(r.Env, fmt.Sprintf("RUNSC_TEST_NAME=%s", c.Name))
return types.ExecConfig{
AttachStdin: r.UseTTY,
AttachStderr: true,
AttachStdout: true,
Cmd: cmd,
Privileged: r.Privileged,
WorkingDir: r.WorkDir,
Env: env,
Tty: r.UseTTY,
User: r.User,
}
}
// Process represents a containerized process.
type Process struct {
container *Container
execid string
conn types.HijackedResponse
}
// Write writes buf to the process's stdin.
func (p *Process) Write(timeout time.Duration, buf []byte) (int, error) {
p.conn.Conn.SetDeadline(time.Now().Add(timeout))
return p.conn.Conn.Write(buf)
}
// Read returns process's stdout and stderr.
func (p *Process) Read() (string, string, error) {
var stdout, stderr bytes.Buffer
if err := p.read(&stdout, &stderr); err != nil {
return "", "", err
}
return stdout.String(), stderr.String(), nil
}
// Logs returns combined stdout/stderr from the process.
func (p *Process) Logs() (string, error) {
var out bytes.Buffer
if err := p.read(&out, &out); err != nil {
return "", err
}
return out.String(), nil
}
func (p *Process) read(stdout, stderr *bytes.Buffer) error {
_, err := stdcopy.StdCopy(stdout, stderr, p.conn.Reader)
return err
}
// ExitCode returns the process's exit code.
func (p *Process) ExitCode(ctx context.Context) (int, error) {
_, exitCode, err := p.runningExitCode(ctx)
return exitCode, err
}
// IsRunning checks if the process is running.
func (p *Process) IsRunning(ctx context.Context) (bool, error) {
running, _, err := p.runningExitCode(ctx)
return running, err
}
// WaitExitStatus until process completes and returns exit status.
func (p *Process) WaitExitStatus(ctx context.Context) (int, error) {
waitChan := make(chan (int))
errChan := make(chan (error))
go func() {
for {
running, exitcode, err := p.runningExitCode(ctx)
if err != nil {
errChan <- fmt.Errorf("error waiting process %s: container %v", p.execid, p.container.Name)
}
if !running {
waitChan <- exitcode
}
time.Sleep(time.Millisecond * 500)
}
}()
select {
case ws := <-waitChan:
return ws, nil
case err := <-errChan:
return -1, err
}
}
// runningExitCode collects if the process is running and the exit code.
// The exit code is only valid if the process has exited.
func (p *Process) runningExitCode(ctx context.Context) (bool, int, error) {
// If execid is not empty, this is a execed process.
if p.execid != "" {
status, err := p.container.client.ContainerExecInspect(ctx, p.execid)
return status.Running, status.ExitCode, err
}
// else this is the root process.
status, err := p.container.Status(ctx)
return status.Running, status.ExitCode, err
}
|
