-
-
Notifications
You must be signed in to change notification settings - Fork 270
/
TestcontainersClient.cs
331 lines (273 loc) · 10.9 KB
/
TestcontainersClient.cs
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
namespace DotNet.Testcontainers.Clients
{
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Docker.DotNet;
using Docker.DotNet.Models;
using DotNet.Testcontainers.Builders;
using DotNet.Testcontainers.Configurations;
using DotNet.Testcontainers.Containers;
using ICSharpCode.SharpZipLib.Tar;
using Microsoft.Extensions.Logging;
/// <inheritdoc cref="ITestcontainersClient" />
internal sealed class TestcontainersClient : ITestcontainersClient
{
public const string TestcontainersLabel = "org.testcontainers";
public const string TestcontainersLangLabel = TestcontainersLabel + ".lang";
public const string TestcontainersVersionLabel = TestcontainersLabel + ".version";
public const string TestcontainersSessionIdLabel = TestcontainersLabel + ".session-id";
private readonly string _osRootDirectory = Path.GetPathRoot(Directory.GetCurrentDirectory());
private readonly IDockerContainerOperations _containers;
private readonly IDockerImageOperations _images;
private readonly IDockerNetworkOperations _network;
private readonly IDockerSystemOperations _system;
private readonly DockerRegistryAuthenticationProvider _registryAuthenticationProvider;
/// <summary>
/// Initializes a new instance of the <see cref="TestcontainersClient" /> class.
/// </summary>
public TestcontainersClient()
: this(
Guid.Empty,
TestcontainersSettings.OS.DockerEndpointAuthConfig,
TestcontainersSettings.Logger)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="TestcontainersClient" /> class.
/// </summary>
/// <param name="sessionId">The session id.</param>
/// <param name="dockerEndpointAuthConfig">The Docker endpoint authentication configuration.</param>
/// <param name="logger">The logger.</param>
public TestcontainersClient(Guid sessionId, IDockerEndpointAuthenticationConfiguration dockerEndpointAuthConfig, ILogger logger)
: this(
new DockerContainerOperations(sessionId, dockerEndpointAuthConfig, logger),
new DockerImageOperations(sessionId, dockerEndpointAuthConfig, logger),
new DockerNetworkOperations(sessionId, dockerEndpointAuthConfig, logger),
new DockerSystemOperations(sessionId, dockerEndpointAuthConfig, logger),
new DockerRegistryAuthenticationProvider(logger))
{
}
private TestcontainersClient(
IDockerContainerOperations containerOperations,
IDockerImageOperations imageOperations,
IDockerNetworkOperations networkOperations,
IDockerSystemOperations systemOperations,
DockerRegistryAuthenticationProvider registryAuthenticationProvider)
{
_containers = containerOperations;
_images = imageOperations;
_network = networkOperations;
_system = systemOperations;
_registryAuthenticationProvider = registryAuthenticationProvider;
}
/// <inheritdoc />
public bool IsRunningInsideDocker
{
get
{
return File.Exists(Path.Combine(_osRootDirectory, ".dockerenv"));
}
}
/// <inheritdoc />
public Task<long> GetContainerExitCodeAsync(string id, CancellationToken ct = default)
{
return _containers.GetExitCodeAsync(id, ct);
}
/// <inheritdoc />
public Task<(string Stdout, string Stderr)> GetContainerLogsAsync(string id, DateTime since = default, DateTime until = default, bool timestampsEnabled = true, CancellationToken ct = default)
{
var unixEpoch = new DateTime(1970, 1, 1);
if (default(DateTime).Equals(since))
{
since = DateTime.MinValue;
}
if (default(DateTime).Equals(until))
{
until = DateTime.MaxValue;
}
return _containers.GetLogsAsync(id, since.ToUniversalTime().Subtract(unixEpoch), until.ToUniversalTime().Subtract(unixEpoch), timestampsEnabled, ct);
}
/// <inheritdoc />
public Task<ContainerInspectResponse> InspectContainerAsync(string id, CancellationToken ct = default)
{
return _containers.InspectAsync(id, ct);
}
/// <inheritdoc />
public async Task StartAsync(string id, CancellationToken ct = default)
{
if (await _containers.ExistsWithIdAsync(id, ct)
.ConfigureAwait(false))
{
await _containers.StartAsync(id, ct)
.ConfigureAwait(false);
}
}
/// <inheritdoc />
public async Task StopAsync(string id, CancellationToken ct = default)
{
if (await _containers.ExistsWithIdAsync(id, ct)
.ConfigureAwait(false))
{
await _containers.StopAsync(id, ct)
.ConfigureAwait(false);
}
}
/// <inheritdoc />
public async Task RemoveAsync(string id, CancellationToken ct = default)
{
if (await _containers.ExistsWithIdAsync(id, ct)
.ConfigureAwait(false))
{
try
{
await _containers.RemoveAsync(id, ct)
.ConfigureAwait(false);
}
catch (DockerApiException e)
{
// The Docker daemon may already start the progress to removes the container (AutoRemove):
// https://docs.docker.com/engine/api/v1.41/#operation/ContainerCreate.
if (!e.Message.Contains($"removal of container {id} is already in progress"))
{
throw;
}
}
}
}
/// <inheritdoc />
public Task<ExecResult> ExecAsync(string id, IList<string> command, CancellationToken ct = default)
{
return _containers.ExecAsync(id, command, ct);
}
/// <inheritdoc />
public async Task CopyFileAsync(string id, string filePath, byte[] fileContent, int accessMode, int userId, int groupId, CancellationToken ct = default)
{
IOperatingSystem os = new Unix(dockerEndpointAuthConfig: null);
var containerPath = os.NormalizePath(filePath);
using (var tarOutputMemStream = new MemoryStream())
{
using (var tarOutputStream = new TarOutputStream(tarOutputMemStream, Encoding.Default))
{
tarOutputStream.IsStreamOwner = false;
var header = new TarHeader();
header.Name = containerPath;
header.UserId = userId;
header.GroupId = groupId;
header.Mode = accessMode;
header.Size = fileContent.Length;
var entry = new TarEntry(header);
await tarOutputStream.PutNextEntryAsync(entry, ct)
.ConfigureAwait(false);
#if NETSTANDARD2_1_OR_GREATER
await tarOutputStream.WriteAsync(fileContent, ct)
.ConfigureAwait(false);
#else
await tarOutputStream.WriteAsync(fileContent, 0, fileContent.Length, ct)
.ConfigureAwait(false);
#endif
await tarOutputStream.CloseEntryAsync(ct)
.ConfigureAwait(false);
}
tarOutputMemStream.Seek(0, SeekOrigin.Begin);
await _containers.ExtractArchiveToContainerAsync(id, Path.AltDirectorySeparatorChar.ToString(), tarOutputMemStream, ct)
.ConfigureAwait(false);
}
}
/// <inheritdoc />
public async Task<byte[]> ReadFileAsync(string id, string filePath, CancellationToken ct = default)
{
Stream tarStream;
IOperatingSystem os = new Unix(dockerEndpointAuthConfig: null);
var containerPath = os.NormalizePath(filePath);
try
{
tarStream = await _containers.GetArchiveFromContainerAsync(id, containerPath, ct)
.ConfigureAwait(false);
}
catch (DockerContainerNotFoundException e)
{
throw new FileNotFoundException(null, Path.GetFileName(containerPath), e);
}
using (var tarInputStream = new TarInputStream(tarStream, Encoding.Default))
{
tarInputStream.IsStreamOwner = true;
var entry = await tarInputStream.GetNextEntryAsync(ct)
.ConfigureAwait(false);
if (entry.IsDirectory)
{
throw new InvalidOperationException("Cannot read from a directory. Use a file instead.");
}
var readBytes = new byte[entry.Size];
#if NETSTANDARD2_1_OR_GREATER
_ = await tarInputStream.ReadAsync(new Memory<byte>(readBytes), ct)
.ConfigureAwait(false);
#else
_ = await tarInputStream.ReadAsync(readBytes, 0, readBytes.Length, ct)
.ConfigureAwait(false);
#endif
return readBytes;
}
}
/// <inheritdoc />
public async Task<string> RunAsync(IContainerConfiguration configuration, CancellationToken ct = default)
{
async Task CopyResourceMappingAsync(string containerId, IResourceMapping resourceMapping)
{
var resourceMappingContent = await resourceMapping.GetAllBytesAsync(ct)
.ConfigureAwait(false);
await CopyFileAsync(containerId, resourceMapping.Target, resourceMappingContent, 420, 0, 0, ct)
.ConfigureAwait(false);
}
if (TestcontainersSettings.ResourceReaperEnabled && ResourceReaper.DefaultSessionId.Equals(configuration.SessionId))
{
_ = await ResourceReaper.GetAndStartDefaultAsync(configuration.DockerEndpointAuthConfig, ct)
.ConfigureAwait(false);
}
var cachedImage = await _images.ByNameAsync(configuration.Image.FullName, ct)
.ConfigureAwait(false);
if (configuration.ImagePullPolicy(cachedImage))
{
var dockerRegistryServerAddress = configuration.Image.GetHostname();
if (dockerRegistryServerAddress == null)
{
var info = await _system.GetInfoAsync(ct)
.ConfigureAwait(false);
dockerRegistryServerAddress = info.IndexServerAddress;
}
var authConfig = _registryAuthenticationProvider.GetAuthConfig(dockerRegistryServerAddress);
await _images.CreateAsync(configuration.Image, authConfig, ct)
.ConfigureAwait(false);
}
var id = await _containers.RunAsync(configuration, ct)
.ConfigureAwait(false);
if (configuration.Networks.Any() && PortForwardingContainer.Instance != null && TestcontainersStates.Running.Equals(PortForwardingContainer.Instance.State))
{
await _network.ConnectAsync("bridge", id, ct)
.ConfigureAwait(false);
}
if (configuration.ResourceMappings.Any())
{
await Task.WhenAll(configuration.ResourceMappings.Values.Select(resourceMapping => CopyResourceMappingAsync(id, resourceMapping)))
.ConfigureAwait(false);
}
return id;
}
/// <inheritdoc />
public async Task<string> BuildAsync(IImageFromDockerfileConfiguration configuration, CancellationToken ct = default)
{
var cachedImage = await _images.ByNameAsync(configuration.Image.FullName, ct)
.ConfigureAwait(false);
if (configuration.ImageBuildPolicy(cachedImage))
{
_ = await _images.BuildAsync(configuration, ct)
.ConfigureAwait(false);
}
return configuration.Image.FullName;
}
}
}