/
client.go
247 lines (220 loc) · 5.87 KB
/
client.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
// Copyright 2022 D2iQ, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package docker
import (
"archive/tar"
"bytes"
"context"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"sync"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/container"
"github.com/docker/docker/client"
)
var (
clientFromEnv *client.Client
clientFromEnvOnce sync.Once
errClientFromEnv error
)
func ClientFromEnv() (*client.Client, error) {
clientFromEnvOnce.Do(func() {
var err error
clientFromEnv, err = client.NewClientWithOpts(
client.FromEnv,
client.WithAPIVersionNegotiation(),
)
if err != nil {
errClientFromEnv = fmt.Errorf(
"failed to create Docker client from environment: %w",
err,
)
}
})
return clientFromEnv, errClientFromEnv
}
//nolint:revive // Complex but only used in tests.
func RunContainerInBackground(
ctx context.Context,
containerName string,
containerCfg *container.Config,
hostCfg *container.HostConfig,
pullUsername, pullPassword string,
) (types.ContainerJSON, error) {
dClient, err := ClientFromEnv()
if err != nil {
return types.ContainerJSON{}, fmt.Errorf("failed to create Docker client: %w", err)
}
if hostCfg.NetworkMode.IsUserDefined() {
_, err = dClient.NetworkInspect(
ctx,
hostCfg.NetworkMode.NetworkName(),
types.NetworkInspectOptions{},
)
if client.IsErrNotFound(err) {
_, err = dClient.NetworkCreate(
ctx,
hostCfg.NetworkMode.NetworkName(),
types.NetworkCreate{
Driver: "bridge",
Options: map[string]string{
"com.docker.network.bridge.enable_ip_masquerade": "true",
"com.docker.network.driver.mtu": "1500",
},
},
)
}
if err != nil {
return types.ContainerJSON{}, fmt.Errorf("failed to create Docker network: %w", err)
}
}
out, err := dClient.ImagePull(ctx, containerCfg.Image, types.ImagePullOptions{})
defer func() { _ = out.Close() }()
if err != nil {
_, _ = io.Copy(os.Stderr, out)
return types.ContainerJSON{}, fmt.Errorf("failed to pull Docker image: %w", err)
}
_, _ = io.Copy(io.Discard, out)
created, err := dClient.ContainerCreate(ctx, containerCfg, hostCfg, nil, nil, containerName)
if err != nil {
return types.ContainerJSON{}, fmt.Errorf("failed to create container: %w", err)
}
containerID := created.ID
if err := dClient.ContainerStart(ctx, containerID, types.ContainerStartOptions{}); err != nil {
//nolint:contextcheck // Best effort background deletion.
if deleteErr := ForceDeleteContainer(context.Background(), containerID); deleteErr != nil {
err = errors.Join(err, deleteErr)
}
return types.ContainerJSON{}, fmt.Errorf("failed to start Docker container: %w", err)
}
containerInspect, err := dClient.ContainerInspect(ctx, containerID)
if err != nil {
//nolint:contextcheck // Best effort background deletion.
if deleteErr := ForceDeleteContainer(context.Background(), containerID); deleteErr != nil {
err = errors.Join(err, deleteErr)
}
return types.ContainerJSON{}, fmt.Errorf(
"failed to inspect started Docker container: %w",
err,
)
}
return containerInspect, nil
}
func ForceDeleteContainer(ctx context.Context, containerID string) error {
dClient, err := ClientFromEnv()
if err != nil {
return err
}
err = dClient.ContainerRemove(
ctx,
containerID,
types.ContainerRemoveOptions{
RemoveVolumes: true,
Force: true,
},
)
if err != nil {
return fmt.Errorf("failed to delete container: %w", err)
}
return nil
}
func RetagAndPushImage( //nolint:revive // Lots of args is fine in these tests.
ctx context.Context,
srcImage, destImage string,
pullUsername, pullPassword string,
pushUsername, pushPassword string,
) error {
dClient, err := ClientFromEnv()
if err != nil {
return err
}
_, _, err = dClient.ImageInspectWithRaw(
ctx,
srcImage,
)
if err != nil {
if !client.IsErrNotFound(err) {
return fmt.Errorf("failed to check if image is already present locally: %w", err)
}
out, err := dClient.ImagePull(
ctx,
srcImage,
types.ImagePullOptions{RegistryAuth: authString(pullUsername, pullPassword)},
)
defer func() {
if out != nil {
_ = out.Close()
}
}()
if err != nil {
if out != nil {
_, _ = io.Copy(os.Stderr, out)
}
return fmt.Errorf(
"failed to pull image %q: %w",
srcImage,
err,
)
}
_, _ = io.Copy(io.Discard, out)
}
if err := dClient.ImageTag(ctx, srcImage, destImage); err != nil {
return fmt.Errorf("failed to retag image: %w", err)
}
defer func() { _, _ = dClient.ImageRemove(ctx, destImage, types.ImageRemoveOptions{}) }()
out, err := dClient.ImagePush(
ctx,
destImage,
types.ImagePushOptions{RegistryAuth: authString(pushUsername, pushPassword)},
)
defer func() {
if out != nil {
_ = out.Close()
}
}()
if err != nil {
if out != nil {
_, _ = io.Copy(os.Stderr, out)
}
return fmt.Errorf("failed to push retagged image: %w", err)
}
_, _ = io.Copy(io.Discard, out)
return nil
}
func authString(username, password string) string {
authConfig := types.AuthConfig{
Username: username,
Password: password,
}
encodedJSON, _ := json.Marshal(authConfig)
return base64.URLEncoding.EncodeToString(encodedJSON)
}
func ReadFileFromContainer(ctx context.Context, containerID, fPath string) (string, error) {
dClient, err := ClientFromEnv()
if err != nil {
return "", err
}
r, _, err := dClient.CopyFromContainer(ctx, containerID, fPath)
if err != nil {
return "", fmt.Errorf("failed to copy file from container: %w", err)
}
defer r.Close()
tr := tar.NewReader(r)
_, err = tr.Next()
if err == io.EOF {
return "", nil
}
if err != nil {
return "", fmt.Errorf("failed to copy file from container: %w", err)
}
var b bytes.Buffer
_, err = io.Copy(&b, tr) //nolint:gosec // Do not worry about DoS in e2e test.
if err != nil {
return "", fmt.Errorf("failed to copy file from container: %w", err)
}
return b.String(), nil
}