-
Notifications
You must be signed in to change notification settings - Fork 85
/
DockerService.cs
241 lines (220 loc) · 9.07 KB
/
DockerService.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
using System;
using System.Collections.Generic;
using System.Composition;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Docker.DotNet;
using Docker.DotNet.Models;
using Microsoft.ComponentDetection.Common.Telemetry.Records;
using Microsoft.ComponentDetection.Contracts;
using Microsoft.ComponentDetection.Contracts.BcdeModels;
using Newtonsoft.Json;
namespace Microsoft.ComponentDetection.Common
{
[Export(typeof(IDockerService))]
public class DockerService : IDockerService
{
// Base image annotations from ADO dockerTask
private const string BaseImageRefAnnotation = "image.base.ref.name";
private const string BaseImageDigestAnnotation = "image.base.digest";
private static readonly DockerClient Client = new DockerClientConfiguration().CreateClient();
private static int incrementingContainerId;
[Import]
public ILogger Logger { get; set; }
public async Task<bool> CanPingDockerAsync(CancellationToken cancellationToken = default)
{
try
{
await Client.System.PingAsync(cancellationToken);
return true;
}
catch (Exception e)
{
this.Logger.LogException(e, false);
return false;
}
}
public async Task<bool> CanRunLinuxContainersAsync(CancellationToken cancellationToken = default)
{
using var record = new DockerServiceSystemInfoTelemetryRecord();
if (!await this.CanPingDockerAsync(cancellationToken))
{
return false;
}
try
{
var systemInfoResponse = await Client.System.GetSystemInfoAsync(cancellationToken);
record.SystemInfo = JsonConvert.SerializeObject(systemInfoResponse);
return string.Equals(systemInfoResponse.OSType, "linux", StringComparison.OrdinalIgnoreCase);
}
catch (Exception e)
{
record.ExceptionMessage = e.Message;
}
return false;
}
public async Task<bool> ImageExistsLocallyAsync(string image, CancellationToken cancellationToken = default)
{
using var record = new DockerServiceImageExistsLocallyTelemetryRecord
{
Image = image,
};
try
{
var imageInspectResponse = await Client.Images.InspectImageAsync(image, cancellationToken);
record.ImageInspectResponse = JsonConvert.SerializeObject(imageInspectResponse);
return true;
}
catch (Exception e)
{
record.ExceptionMessage = e.Message;
return false;
}
}
public async Task<bool> TryPullImageAsync(string image, CancellationToken cancellationToken = default)
{
using var record = new DockerServiceTryPullImageTelemetryRecord
{
Image = image,
};
var parameters = new ImagesCreateParameters
{
FromImage = image,
};
try
{
var createImageProgress = new List<string>();
var progress = new Progress<JSONMessage>(message =>
{
createImageProgress.Add(JsonConvert.SerializeObject(message));
});
await Client.Images.CreateImageAsync(parameters, null, progress, cancellationToken);
record.CreateImageProgress = JsonConvert.SerializeObject(createImageProgress);
return true;
}
catch (Exception e)
{
record.ExceptionMessage = e.Message;
return false;
}
}
public async Task<ContainerDetails> InspectImageAsync(string image, CancellationToken cancellationToken = default)
{
using var record = new DockerServiceInspectImageTelemetryRecord
{
Image = image,
};
try
{
var imageInspectResponse = await Client.Images.InspectImageAsync(image, cancellationToken);
record.ImageInspectResponse = JsonConvert.SerializeObject(imageInspectResponse);
var baseImageRef = string.Empty;
var baseImageDigest = string.Empty;
imageInspectResponse.Config.Labels?.TryGetValue(BaseImageRefAnnotation, out baseImageRef);
imageInspectResponse.Config.Labels?.TryGetValue(BaseImageDigestAnnotation, out baseImageDigest);
record.BaseImageRef = baseImageRef;
record.BaseImageDigest = baseImageDigest;
var layers = imageInspectResponse.RootFS?.Layers
.Select((diffId, index) =>
new DockerLayer
{
DiffId = diffId,
LayerIndex = index,
});
return new ContainerDetails
{
Id = GetContainerId(),
ImageId = imageInspectResponse.ID,
Digests = imageInspectResponse.RepoDigests,
Tags = imageInspectResponse.RepoTags,
CreatedAt = imageInspectResponse.Created,
BaseImageDigest = baseImageDigest,
BaseImageRef = baseImageRef,
Layers = layers ?? Enumerable.Empty<DockerLayer>(),
};
}
catch (Exception e)
{
record.ExceptionMessage = e.Message;
return null;
}
}
public async Task<(string Stdout, string Stderr)> CreateAndRunContainerAsync(string image, IList<string> command, CancellationToken cancellationToken = default)
{
using var record = new DockerServiceTelemetryRecord
{
Image = image,
Command = JsonConvert.SerializeObject(command),
};
await this.TryPullImageAsync(image, cancellationToken);
var container = await CreateContainerAsync(image, command, cancellationToken);
record.Container = JsonConvert.SerializeObject(container);
var stream = await AttachContainerAsync(container.ID, cancellationToken);
await StartContainerAsync(container.ID, cancellationToken);
var (stdout, stderr) = await stream.ReadOutputToEndAsync(cancellationToken);
record.Stdout = stdout;
record.Stderr = stderr;
await RemoveContainerAsync(container.ID, cancellationToken);
return (stdout, stderr);
}
private static async Task<CreateContainerResponse> CreateContainerAsync(
string image,
IList<string> command,
CancellationToken cancellationToken = default)
{
var parameters = new CreateContainerParameters
{
Image = image,
Cmd = command,
NetworkDisabled = true,
HostConfig = new HostConfig
{
CapDrop = new List<string>
{
"all",
},
SecurityOpt = new List<string>
{
"no-new-privileges",
},
Binds = new List<string>
{
$"{Path.GetTempPath()}:/tmp",
"/var/run/docker.sock:/var/run/docker.sock",
},
},
};
return await Client.Containers.CreateContainerAsync(parameters, cancellationToken);
}
private static async Task<MultiplexedStream> AttachContainerAsync(string containerId, CancellationToken cancellationToken = default)
{
var parameters = new ContainerAttachParameters
{
Stdout = true,
Stderr = true,
Stream = true,
};
return await Client.Containers.AttachContainerAsync(containerId, false, parameters, cancellationToken);
}
private static async Task StartContainerAsync(string containerId, CancellationToken cancellationToken = default)
{
var parameters = new ContainerStartParameters();
await Client.Containers.StartContainerAsync(containerId, parameters, cancellationToken);
}
private static async Task RemoveContainerAsync(string containerId, CancellationToken cancellationToken = default)
{
var parameters = new ContainerRemoveParameters
{
Force = true,
RemoveVolumes = true,
};
await Client.Containers.RemoveContainerAsync(containerId, parameters, cancellationToken);
}
private static int GetContainerId()
{
return Interlocked.Increment(ref incrementingContainerId);
}
}
}