-
Notifications
You must be signed in to change notification settings - Fork 0
/
Docker.cs
376 lines (348 loc) · 17.5 KB
/
Docker.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices;
using System.Threading.Tasks;
using Fux.Config.DockerHelper.Attribute;
namespace Fux.Config
{
/// <summary>
/// This class maintains the configuration for Docker
/// </summary>
public class Docker
{
/// <summary>
/// This property contains the dictionary of secrets from Docker
/// </summary>
private static readonly Dictionary<string, string> _secrets = new Dictionary<string, string>();
/// <summary>
/// This property contains the path to the Docker secrets
/// </summary>
private static string _secretsDirectory =
(RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ?
$"{Path.DirectorySeparatorChar}ProgramData{Path.DirectorySeparatorChar}Docker{Path.DirectorySeparatorChar}secrets"
: $"{Path.DirectorySeparatorChar}run{Path.DirectorySeparatorChar}secrets");
/// <summary>
/// This method normalizes a secret's name
/// </summary>
/// <param name="secretName"></param>
/// <returns></returns>
private static string NormalizeSecretName(string secretName) =>
secretName.ToLower().Replace(_secretsDirectory.ToLower(), "").TrimStart(Path.DirectorySeparatorChar);
/// <summary>
/// This method reads the secrets from the file system
/// </summary>
private static void ReadSecrets()
{
// Check the secrets in memory and populate them
if (_secrets.Count == 0)
foreach (string s in Directory.GetFiles(_secretsDirectory))
_secrets[NormalizeSecretName(s)] = File.ReadAllText(s).Trim();
}
/// <summary>
/// This method asynchronously reads the secrets from the file system
/// </summary>
/// <returns></returns>
private static async Task ReadSecretsAsync()
{
// Check the secrets in memory and populate them
if (_secrets.Count == 0)
foreach (string s in Directory.GetFiles(_secretsDirectory))
_secrets[NormalizeSecretName(s)] = (await File.ReadAllTextAsync(s)).Trim();
}
/// <summary>
/// This method sets a secret into the instance and
/// tries to write the secret to the filesystem
/// </summary>
/// <param name="secretName"></param>
/// <param name="secretValue"></param>
private static void WriteSecret(string secretName, string secretValue)
{
// Try to write the secret to the filesystem
try
{
// Write the secret to the filesystem
File.WriteAllText($"{_secretsDirectory}{Path.DirectorySeparatorChar}{secretName.ToLower()}", secretValue);
}
catch (Exception) { /* Fail Gracefully */ }
// Reset the secret into the instance
_secrets[NormalizeSecretName(secretName)] = secretValue;
}
/// <summary>
/// This method sets a secret into the instance and asynchronously
/// tries to write the secret to the filesystem
/// </summary>
/// <param name="secretName"></param>
/// <param name="secretValue"></param>
/// <returns></returns>
private static async Task WriteSecretAsync(string secretName, string secretValue)
{
// Try to write the secret to the filesystem
try
{
// Write the secret to the filesystem
await File.WriteAllTextAsync($"{_secretsDirectory}{Path.DirectorySeparatorChar}{secretName.ToLower()}", secretValue);
}
catch (Exception) { /* Fail Gracefully */ }
// Reset the secret into the instance
_secrets[NormalizeSecretName(secretName)] = secretValue;
}
/// <summary>
/// This method resets the secrets directory path into memory
/// </summary>
/// <param name="directoryPath"></param>
public static void SetSecretsDirectory(string directoryPath) =>
_secretsDirectory = Path.GetFullPath(directoryPath);
/// <summary>
/// This method loads a POCO from a Docker Secret stored as a JSON string using a
/// <code>DockerSecretName</code> attribute at the class level
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static TValue Get<TValue>()
{
// Load the value's type
Type type = typeof(TValue);
// Localize the key attribute
DockerSecretNameAttribute keyAttribute =
(type.GetCustomAttributes(typeof(DockerSecretNameAttribute), true).FirstOrDefault() as DockerSecretNameAttribute);
// Make sure we have a key attribute
if (keyAttribute == null) throw new Exception($"{typeof(TValue).Name} Does Not Contain a DockerSecretName Attribute");
// Load the value from the Docker Secrets
TValue value = Get<TValue>(keyAttribute.Name, keyAttribute.AllowEmpty);
// We're done, return the value
return value;
}
/// <summary>
/// This method returns the string value of a Docker secret named <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <returns></returns>
public static string Get(string secretName, bool allowEmpty = true)
{
// Ensure the secrets are in memory
ReadSecrets();
// Localise the value
string value = _secrets[NormalizeSecretName(secretName)] ?? null;
// Check the value and empty flag
if (!allowEmpty && (string.IsNullOrEmpty(value) || string.IsNullOrWhiteSpace(value)))
throw new Exception($"Docker Secret Cannot Be Empty [{secretName}]");
// Check the value and return null
if (string.IsNullOrEmpty(value) || string.IsNullOrWhiteSpace(value))
return null;
// Return the secret
return value;
}
/// <summary>
/// This method loads a Docker Secret, statically typed to <paramref name="type"/>
/// from the current context via <paramref name="secretName"/> with the option to throw
/// an exception if <paramref name="allowEmpty"/> is <code>false</code>
/// </summary>
/// <param name="type"></param>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <returns></returns>
public static dynamic Get(Type type, string secretName, bool allowEmpty = true) =>
Core.Convert.FromString(type, Get(secretName, allowEmpty));
/// <summary>
/// This method returns the typed value of a Docker secret name <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static TValue Get<TValue>(string secretName, bool allowEmpty = true) =>
Core.Convert.FromString<TValue>(Get(secretName, allowEmpty));
/// <summary>
/// This method asynchronously loads a POCO from a Docker Secret stored as a JSON string using a
/// <code>DockerSecretName</code> attribute at the class level
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static async Task<TValue> GetAsync<TValue>()
{
// Load the value's type
Type type = typeof(TValue);
// Localize the key attribute
DockerSecretNameAttribute keyAttribute =
(type.GetCustomAttributes(typeof(DockerSecretNameAttribute), true).FirstOrDefault() as DockerSecretNameAttribute);
// Make sure we have a key attribute
if (keyAttribute == null) throw new Exception($"{typeof(TValue).Name} Does Not Contain a DockerSecretName Attribute");
// Load the value from the Docker Secret
TValue value = await GetAsync<TValue>(keyAttribute.Name, keyAttribute.AllowEmpty);
// We're done, return the value
return value;
}
/// <summary>
/// This method asynchronously returns the string value of a Docker secret name <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <returns></returns>
public static async Task<string> GetAsync(string secretName, bool allowEmpty = true)
{
// Ensure the secrets are in memory
await ReadSecretsAsync();
// Localise the value
string value = _secrets[NormalizeSecretName(secretName)] ?? null;
// Check the value and empty flag
if (!allowEmpty && (string.IsNullOrEmpty(value) || string.IsNullOrWhiteSpace(value)))
throw new Exception($"Docker Secret Cannot Be Empty [{secretName}]");
// Check the value and return null
if (string.IsNullOrEmpty(value) || string.IsNullOrWhiteSpace(value))
return null;
// Return the secret
return value;
}
/// <summary>
/// This method asynchronously returns the typed value of a Docker secret named <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static async Task<TValue> GetAsync<TValue>(string secretName, bool allowEmpty = true) =>
Core.Convert.FromString<TValue>(await GetAsync(secretName, allowEmpty));
/// <summary>
/// This method asynchronously loads a Docker Secret, statically typed to <paramref name="type"/>
/// from the current context via <paramref name="secretName"/> with the option to throw
/// an exception if <paramref name="allowEmpty"/> is <code>false</code>
/// </summary>
/// <param name="type"></param>
/// <param name="secretName"></param>
/// <param name="allowEmpty"></param>
/// <returns></returns>
public static async Task<dynamic> GetAsync(Type type, string secretName, bool allowEmpty = true) =>
Core.Convert.FromString(type, await GetAsync(secretName, allowEmpty));
/// <summary>
/// This method loads and populates an object from Docker using the <code>DockerSecretNameAttribute</code>
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static TValue GetObject<TValue>() where TValue : class, new() =>
Core.Convert.MapWithValueGetter<TValue, DockerSecretNameAttribute>((attribute, type, currentValue) =>
Get(type, attribute.Name, attribute.AllowEmpty));
/// <summary>
/// This method asynchronously loads and populates an object from Docker using the <code>DockerSecretNameAttribute</code>
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static Task<TValue> GetObjectAsync<TValue>() where TValue : class, new() =>
Core.Convert.MapWithValueGetterAsync<TValue, DockerSecretNameAttribute>(async (attribute, type, currentValue) =>
await GetAsync(type, attribute.Name, attribute.AllowEmpty));
/// <summary>
/// This method saves a POCO to a Docker Secret stored as a JSON string using a
/// <code>DockerSecretName</code> attribute at the class level
/// </summary>
/// <param name="value"></param>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static void Set<TValue>(TValue value)
{
// Localize our type
Type type = typeof(TValue);
// Localize the key attribute
DockerSecretNameAttribute keyAttribute =
(type.GetCustomAttributes(typeof(DockerSecretNameAttribute), true).FirstOrDefault() as DockerSecretNameAttribute);
// Make sure we have a key attribute
if (keyAttribute == null) throw new System.Exception($"{typeof(TValue).Name} Does Not Contain a RedisKey Attribute");
// Set the value into Docker
Set<TValue>(keyAttribute.Name, value);
}
/// <summary>
/// This method sets <paramref name="value"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static void Set(string secretName, string value) =>
WriteSecret(secretName, value);
/// <summary>
/// This method sets <paramref name="value"/> of <paramref name="type"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <param name="type"></param>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static void Set(Type type, string secretName, dynamic value) =>
Set(secretName, Core.Convert.ToString(type, value));
/// <summary>
/// This method sets <paramref name="value"/> of <typeparamref name="TValue"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static void Set<TValue>(string secretName, TValue value) =>
Set(secretName, Core.Convert.ToString<TValue>(value));
/// <summary>
/// This method populates an object in a Docker Secret using the <code>DockerSecretNameAttribute</code>
/// </summary>
/// <typeparam name="TType"></typeparam>
/// <returns></returns>
public static void SetObject<TType>() where TType : class, new() =>
// Generate the instance
Core.Convert.MapWithValueGetter<TType, DockerSecretNameAttribute>((attribute, type, value) =>
{
// Set the value into the instance
Set(type, attribute.Name, value);
// We're done, just return the current value
return value;
}, false);
/// <summary>
/// This method asynchronously saves a POCO to a Docker Secret stored as a JSON string using a
/// <code>DockerSecretName</code> attribute at the class level
/// </summary>
/// <param name="value"></param>
/// <typeparam name="TValue"></typeparam>
/// <returns></returns>
public static Task SetAsync<TValue>(TValue value)
{
// Localize our type
Type type = typeof(TValue);
// Localize the key attribute
DockerSecretNameAttribute keyAttribute =
(type.GetCustomAttributes(typeof(DockerSecretNameAttribute), true).FirstOrDefault() as DockerSecretNameAttribute);
// Make sure we have a key attribute
if (keyAttribute == null) throw new System.Exception($"{typeof(TValue).Name} Does Not Contain a DockerSecretName Attribute");
// Set the value into Docker
return SetAsync<TValue>(keyAttribute.Name, value);
}
/// <summary>
/// This method asynchronously sets <paramref name="value"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static Task SetAsync(string secretName, string value) =>
WriteSecretAsync(secretName, value);
/// <summary>
/// This method asynchronously sets <paramref name="value"/> of <paramref name="type"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <param name="type"></param>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static Task SetAsync(Type type, string secretName, dynamic value) =>
SetAsync(secretName, Core.Convert.ToString(type, value));
/// <summary>
/// This method asynchronously sets <paramref name="value"/> of <typeparamref name="TValue"/> into the instance and filesystem as <paramref name="secretName"/>
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <param name="secretName"></param>
/// <param name="value"></param>
public static Task SetAsync<TValue>(string secretName, TValue value) =>
SetAsync(secretName, Core.Convert.ToString<TValue>(value));
/// <summary>
/// This method asynchronously populates an object in a Docker Secret using the <code>DockerSecretNameAttribute</code>
/// </summary>
/// <typeparam name="TType"></typeparam>
/// <returns></returns>
public static Task SetObjectAsync<TType>() where TType : class, new() =>
// Generate the instance
Core.Convert.MapWithValueGetterAsync<TType, DockerSecretNameAttribute>(async (attribute, type, value) =>
{
// Set the value into the instance
await SetAsync(type, attribute.Name, value);
// We're done, just return the current value
return value;
}, false);
}
}