-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
inspect.go
270 lines (218 loc) · 6.11 KB
/
inspect.go
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
package docker
import (
"encoding/json"
"fmt"
"strconv"
"strings"
"testing"
"time"
"github.com/gruntwork-io/terratest/modules/logger"
"github.com/gruntwork-io/terratest/modules/shell"
"github.com/stretchr/testify/require"
)
// ContainerInspect defines the output of the Inspect method, with the options returned by 'docker inspect'
// converted into a more friendly and testable interface
type ContainerInspect struct {
// ID of the inspected container
ID string
// Name of the inspected container
Name string
// time.Time that the container was created
Created time.Time
// String representing the container's status
Status string
// Whether the container is currently running or not
Running bool
// Container's exit code
ExitCode uint8
// String with the container's error message, if there is any
Error string
// Ports exposed by the container
Ports []Port
// Volume bindings made to the container
Binds []VolumeBind
// Health check
Health HealthCheck
}
// Port represents a single port mapping exported by the container
type Port struct {
HostPort uint16
ContainerPort uint16
Protocol string
}
// VolumeBind represents a single volume binding made to the container
type VolumeBind struct {
Source string
Destination string
}
// HealthCheck represents the current health history of the container
type HealthCheck struct {
// Health check status
Status string
// Current count of failing health checks
FailingStreak uint8
// Log of failures
Log []HealthLog
}
// HealthLog represents the output of a single Health check of the container
type HealthLog struct {
// Start time of health check
Start string
// End time of health check
End string
// Exit code of health check
ExitCode uint8
// Output of health check
Output string
}
// inspectOutput defines options that will be returned by 'docker inspect', in JSON format.
// Not all options are included here, only the ones that we might need
type inspectOutput struct {
Id string
Created string
Name string
State struct {
Health HealthCheck
Status string
Running bool
ExitCode uint8
Error string
}
NetworkSettings struct {
Ports map[string][]struct {
HostIp string
HostPort string
}
}
HostConfig struct {
Binds []string
}
}
// Inspect runs the 'docker inspect {container id}' command and returns a ContainerInspect
// struct, converted from the output JSON, along with any errors
func Inspect(t *testing.T, id string) *ContainerInspect {
out, err := InspectE(t, id)
require.NoError(t, err)
return out
}
// InspectE runs the 'docker inspect {container id}' command and returns a ContainerInspect
// struct, converted from the output JSON, along with any errors
func InspectE(t *testing.T, id string) (*ContainerInspect, error) {
cmd := shell.Command{
Command: "docker",
Args: []string{"container", "inspect", id},
// inspect is a short-running command, don't print the output.
Logger: logger.Discard,
}
out, err := shell.RunCommandAndGetStdOutE(t, cmd)
if err != nil {
return nil, err
}
var containers []inspectOutput
err = json.Unmarshal([]byte(out), &containers)
if err != nil {
return nil, err
}
if len(containers) == 0 {
return nil, fmt.Errorf("no container found with ID %s", id)
}
container := containers[0]
return transformContainer(t, container)
}
// transformContainerPorts converts 'docker inspect' output JSON into a more friendly and testable format
func transformContainer(t *testing.T, container inspectOutput) (*ContainerInspect, error) {
name := strings.TrimLeft(container.Name, "/")
ports, err := transformContainerPorts(container)
if err != nil {
return nil, err
}
volumes := transformContainerVolumes(container)
created, err := time.Parse(time.RFC3339Nano, container.Created)
if err != nil {
return nil, err
}
inspect := ContainerInspect{
ID: container.Id,
Name: name,
Created: created,
Status: container.State.Status,
Running: container.State.Running,
ExitCode: container.State.ExitCode,
Error: container.State.Error,
Ports: ports,
Binds: volumes,
Health: HealthCheck{
Status: container.State.Health.Status,
FailingStreak: container.State.Health.FailingStreak,
Log: container.State.Health.Log,
},
}
return &inspect, nil
}
// transformContainerPorts converts Docker's ports from the following json into a more testable format
//
// {
// "80/tcp": [
// {
// "HostIp": ""
// "HostPort": "8080"
// }
// ]
// }
func transformContainerPorts(container inspectOutput) ([]Port, error) {
var ports []Port
cPorts := container.NetworkSettings.Ports
for key, portBinding := range cPorts {
split := strings.Split(key, "/")
containerPort, err := strconv.ParseUint(split[0], 10, 16)
if err != nil {
return nil, err
}
var protocol string
if len(split) > 1 {
protocol = split[1]
}
for _, port := range portBinding {
hostPort, err := strconv.ParseUint(port.HostPort, 10, 16)
if err != nil {
return nil, err
}
ports = append(ports, Port{
HostPort: uint16(hostPort),
ContainerPort: uint16(containerPort),
Protocol: protocol,
})
}
}
return ports, nil
}
// GetExposedHostPort returns an exposed host port according to requested container port. Returns 0 if the requested port is not exposed.
func (inspectOutput ContainerInspect) GetExposedHostPort(containerPort uint16) uint16 {
for _, port := range inspectOutput.Ports {
if port.ContainerPort == containerPort {
return port.HostPort
}
}
return uint16(0)
}
// transformContainerVolumes converts Docker's volume bindings from the
// format "/foo/bar:/foo/baz" into a more testable one
func transformContainerVolumes(container inspectOutput) []VolumeBind {
binds := container.HostConfig.Binds
volumes := make([]VolumeBind, 0, len(binds))
for _, bind := range binds {
var source, dest string
split := strings.Split(bind, ":")
// Considering it as an unbound volume
dest = split[0]
if len(split) == 2 {
source = split[0]
dest = split[1]
}
volumes = append(volumes, VolumeBind{
Source: source,
Destination: dest,
})
}
return volumes
}