-
-
Notifications
You must be signed in to change notification settings - Fork 166
/
AssemblyVersionInfo.cs
826 lines (689 loc) · 33.8 KB
/
AssemblyVersionInfo.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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
namespace Nerdbank.GitVersioning.Tasks
{
using System;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using Validation;
public class AssemblyVersionInfo : Task
{
/// <summary>
/// The #if expression that surrounds a <see cref="GeneratedCodeAttribute"/> to avoid a compilation failure when targeting the nano framework.
/// </summary>
/// <remarks>
/// See https://github.com/dotnet/Nerdbank.GitVersioning/issues/346
/// </remarks>
private const string CompilerDefinesAroundGeneratedCodeAttribute = "NETSTANDARD || NETFRAMEWORK || NETCOREAPP";
private const string CompilerDefinesAroundExcludeFromCodeCoverageAttribute = "NETFRAMEWORK || NETCOREAPP || NETSTANDARD2_0 || NETSTANDARD2_1";
public static readonly string GeneratorName = ThisAssembly.AssemblyName;
public static readonly string GeneratorVersion = ThisAssembly.AssemblyVersion;
#if NET461
private static readonly CodeGeneratorOptions codeGeneratorOptions = new CodeGeneratorOptions
{
BlankLinesBetweenMembers = false,
IndentString = " ",
};
private CodeCompileUnit generatedFile;
#endif
private const string FileHeaderComment = @"------------------------------------------------------------------------------
<auto-generated>
This code was generated by a tool.
Runtime Version:4.0.30319.42000
Changes to this file may cause incorrect behavior and will be lost if
the code is regenerated.
</auto-generated>
------------------------------------------------------------------------------
";
private CodeGenerator generator;
[Required]
public string CodeLanguage { get; set; }
[Required]
public string OutputFile { get; set; }
public bool EmitNonVersionCustomAttributes { get; set; }
public string AssemblyName { get; set; }
public string AssemblyVersion { get; set; }
public string AssemblyFileVersion { get; set; }
public string AssemblyInformationalVersion { get; set; }
public string RootNamespace { get; set; }
public string AssemblyOriginatorKeyFile { get; set; }
public string AssemblyKeyContainerName { get; set; }
public string AssemblyTitle { get; set; }
public string AssemblyProduct { get; set; }
public string AssemblyCopyright { get; set; }
public string AssemblyCompany { get; set; }
public string AssemblyConfiguration { get; set; }
public bool PublicRelease { get; set; }
public string PrereleaseVersion { get; set; }
public string GitCommitId { get; set; }
public string GitCommitDateTicks { get; set; }
public bool EmitThisAssemblyClass { get; set; } = true;
/// <summary>
/// Specify additional fields to be added to the <c>ThisAssembly</c> class.
/// </summary>
/// <remarks>
/// Field name is given by %(Identity). Provide the field value by specifying exactly one metadata value that is %(String), %(Boolean) or %(Ticks) (for UTC DateTime).
/// If specifying %(String), you can also specify %(EmitIfEmpty) to determine if a class member is added even if the value is an empty string (default is false).
/// </remarks>
/// <example>
/// <![CDATA[
/// <ItemGroup>
/// <AdditionalThisAssemblyFields Include = "CustomString1" String="Hello, World!"/>
/// <AdditionalThisAssemblyFields Include = "CustomString2" String="$(SomeProperty)" EmitIfEmpty="true"/>
/// <AdditionalThisAssemblyFields Include = "CustomBool1" Boolean="true"/>
/// <AdditionalThisAssemblyFields Include = "CustomDateTime1" Ticks="637505461230000000"/>
/// </ItemGroup>
/// ]]>
/// </example>
public ITaskItem[] AdditionalThisAssemblyFields { get; set; }
#if NET461
public override bool Execute()
{
// attempt to use local codegen
string fileContent = this.BuildCode();
if (fileContent is object)
{
Directory.CreateDirectory(Path.GetDirectoryName(this.OutputFile));
Utilities.FileOperationWithRetry(() => File.WriteAllText(this.OutputFile, fileContent));
}
else if (CodeDomProvider.IsDefinedLanguage(this.CodeLanguage))
{
using (var codeDomProvider = CodeDomProvider.CreateProvider(this.CodeLanguage))
{
this.generatedFile = new CodeCompileUnit();
this.generatedFile.AssemblyCustomAttributes.AddRange(this.CreateAssemblyAttributes().ToArray());
var ns = new CodeNamespace();
this.generatedFile.Namespaces.Add(ns);
if (this.EmitThisAssemblyClass)
{
ns.Types.Add(this.CreateThisAssemblyClass());
}
Directory.CreateDirectory(Path.GetDirectoryName(this.OutputFile));
FileStream file = null;
Utilities.FileOperationWithRetry(() => file = File.OpenWrite(this.OutputFile));
using (file)
{
using (var fileWriter = new StreamWriter(file, new UTF8Encoding(true), 4096, leaveOpen: true))
{
codeDomProvider.GenerateCodeFromCompileUnit(this.generatedFile, fileWriter, codeGeneratorOptions);
}
// truncate to new size.
file.SetLength(file.Position);
}
}
}
else
{
this.Log.LogError("CodeDomProvider not available for language: {0}. No version info will be embedded into assembly.", this.CodeLanguage);
}
return !this.Log.HasLoggedErrors;
}
private CodeTypeDeclaration CreateThisAssemblyClass()
{
var thisAssembly = new CodeTypeDeclaration("ThisAssembly")
{
IsClass = true,
IsPartial = true,
TypeAttributes = TypeAttributes.NotPublic | TypeAttributes.Sealed,
};
var codeAttributeDeclarationCollection = new CodeAttributeDeclarationCollection();
codeAttributeDeclarationCollection.Add(new CodeAttributeDeclaration("System.CodeDom.Compiler.GeneratedCode",
new CodeAttributeArgument(new CodePrimitiveExpression(GeneratorName)),
new CodeAttributeArgument(new CodePrimitiveExpression(GeneratorVersion))));
thisAssembly.CustomAttributes = codeAttributeDeclarationCollection;
// CodeDOM doesn't support static classes, so hide the constructor instead.
thisAssembly.Members.Add(new CodeConstructor { Attributes = MemberAttributes.Private });
var fields = this.GetFieldsForThisAssembly();
foreach (var pair in fields)
{
switch (pair.Value.Value)
{
case null:
if (pair.Value.EmitIfEmpty)
{
thisAssembly.Members.Add(CreateField(pair.Key, (string)null));
}
break;
case string stringValue:
if (pair.Value.EmitIfEmpty || !string.IsNullOrEmpty(stringValue))
{
thisAssembly.Members.Add(CreateField(pair.Key, stringValue));
}
break;
case bool boolValue:
thisAssembly.Members.Add(CreateField(pair.Key, boolValue));
break;
case DateTime dateValue:
thisAssembly.Members.AddRange(CreateDateTimeField(pair.Key, dateValue).ToArray());
break;
default:
throw new NotSupportedException($"Value type {pair.Value.Value.GetType().Name} as found for the \"{pair.Key}\" property is not supported.");
}
}
return thisAssembly;
}
private IEnumerable<CodeAttributeDeclaration> CreateAssemblyAttributes()
{
yield return DeclareAttribute(typeof(AssemblyVersionAttribute), this.AssemblyVersion);
yield return DeclareAttribute(typeof(AssemblyFileVersionAttribute), this.AssemblyFileVersion);
yield return DeclareAttribute(typeof(AssemblyInformationalVersionAttribute), this.AssemblyInformationalVersion);
if (this.EmitNonVersionCustomAttributes)
{
if (!string.IsNullOrEmpty(this.AssemblyTitle))
{
yield return DeclareAttribute(typeof(AssemblyTitleAttribute), this.AssemblyTitle);
}
if (!string.IsNullOrEmpty(this.AssemblyProduct))
{
yield return DeclareAttribute(typeof(AssemblyProductAttribute), this.AssemblyProduct);
}
if (!string.IsNullOrEmpty(this.AssemblyCompany))
{
yield return DeclareAttribute(typeof(AssemblyCompanyAttribute), this.AssemblyCompany);
}
if (!string.IsNullOrEmpty(this.AssemblyCopyright))
{
yield return DeclareAttribute(typeof(AssemblyCopyrightAttribute), this.AssemblyCopyright);
}
}
}
private static CodeMemberField CreateField<T>(string name, T value)
{
return new CodeMemberField(typeof(T), name)
{
Attributes = MemberAttributes.Const | MemberAttributes.Assembly,
InitExpression = new CodePrimitiveExpression(value),
};
}
private static IEnumerable<CodeTypeMember> CreateDateTimeField(string name, DateTime value)
{
Requires.NotNullOrEmpty(name, nameof(name));
// internal static System.DateTime GitCommitDate => new System.DateTime({ticks}, System.DateTimeKind.Utc);");
var property = new CodeMemberProperty()
{
Attributes = MemberAttributes.Assembly | MemberAttributes.Static | MemberAttributes.Final,
Type = new CodeTypeReference(typeof(DateTime)),
Name = name,
HasGet = true,
HasSet = false,
};
property.GetStatements.Add(
new CodeMethodReturnStatement(
new CodeObjectCreateExpression(
typeof(DateTime),
new CodePrimitiveExpression(value.Ticks),
new CodePropertyReferenceExpression(
new CodeTypeReferenceExpression(typeof(DateTimeKind)),
nameof(DateTimeKind.Utc)))));
yield return property;
}
private static CodeAttributeDeclaration DeclareAttribute(Type attributeType, params CodeAttributeArgument[] arguments)
{
var assemblyTypeReference = new CodeTypeReference(attributeType);
return new CodeAttributeDeclaration(assemblyTypeReference, arguments);
}
private static CodeAttributeDeclaration DeclareAttribute(Type attributeType, params string[] arguments)
{
return DeclareAttribute(
attributeType,
arguments.Select(a => new CodeAttributeArgument(new CodePrimitiveExpression(a))).ToArray());
}
#else
public override bool Execute()
{
string fileContent = this.BuildCode();
if (fileContent is object)
{
Directory.CreateDirectory(Path.GetDirectoryName(this.OutputFile));
Utilities.FileOperationWithRetry(() => File.WriteAllText(this.OutputFile, fileContent));
}
else
{
this.Log.LogError("CodeDomProvider not available for language: {0}. No version info will be embedded into assembly.", this.CodeLanguage);
}
return !this.Log.HasLoggedErrors;
}
#endif
public string BuildCode()
{
this.generator = this.CreateGenerator();
if (this.generator is object)
{
this.generator.AddComment(FileHeaderComment);
this.generator.AddBlankLine();
this.generator.AddAnalysisSuppressions();
this.generator.AddBlankLine();
this.generator.EmitNamespaceIfRequired(this.RootNamespace ?? "AssemblyInfo");
this.GenerateAssemblyAttributes();
if (this.EmitThisAssemblyClass)
{
this.GenerateThisAssemblyClass();
}
return this.generator.GetCode();
}
return null;
}
private void GenerateAssemblyAttributes()
{
this.generator.DeclareAttribute(typeof(AssemblyVersionAttribute), this.AssemblyVersion);
this.generator.DeclareAttribute(typeof(AssemblyFileVersionAttribute), this.AssemblyFileVersion);
this.generator.DeclareAttribute(typeof(AssemblyInformationalVersionAttribute), this.AssemblyInformationalVersion);
if (this.EmitNonVersionCustomAttributes)
{
if (!string.IsNullOrEmpty(this.AssemblyTitle))
{
this.generator.DeclareAttribute(typeof(AssemblyTitleAttribute), this.AssemblyTitle);
}
if (!string.IsNullOrEmpty(this.AssemblyProduct))
{
this.generator.DeclareAttribute(typeof(AssemblyProductAttribute), this.AssemblyProduct);
}
if (!string.IsNullOrEmpty(this.AssemblyCompany))
{
this.generator.DeclareAttribute(typeof(AssemblyCompanyAttribute), this.AssemblyCompany);
}
if (!string.IsNullOrEmpty(this.AssemblyCopyright))
{
this.generator.DeclareAttribute(typeof(AssemblyCopyrightAttribute), this.AssemblyCopyright);
}
}
}
private List<KeyValuePair<string, (object Value, bool EmitIfEmpty /* Only applies to string values */)>> GetFieldsForThisAssembly()
{
// Determine information about the public key used in the assembly name.
string publicKey, publicKeyToken;
bool hasKeyInfo = this.TryReadKeyInfo(out publicKey, out publicKeyToken);
// Define the constants.
var fields = new Dictionary<string, (object Value, bool EmitIfEmpty /* Only applies to string values */)>
{
{ "AssemblyVersion", (this.AssemblyVersion, false) },
{ "AssemblyFileVersion", (this.AssemblyFileVersion, false) },
{ "AssemblyInformationalVersion", (this.AssemblyInformationalVersion, false) },
{ "AssemblyName", (this.AssemblyName, false) },
{ "AssemblyTitle", (this.AssemblyTitle, false) },
{ "AssemblyProduct", (this.AssemblyProduct, false) },
{ "AssemblyCopyright", (this.AssemblyCopyright, false) },
{ "AssemblyCompany", (this.AssemblyCompany, false) },
{ "AssemblyConfiguration", (this.AssemblyConfiguration, false) },
{ "GitCommitId", (this.GitCommitId, false) },
// These properties should be defined even if they are empty strings:
{ "RootNamespace", (this.RootNamespace, true) },
// These non-string properties are always emitted:
{ "IsPublicRelease", (this.PublicRelease, true) },
{ "IsPrerelease", (!string.IsNullOrEmpty(this.PrereleaseVersion), true) },
};
if (hasKeyInfo)
{
fields.Add("PublicKey", (publicKey, false));
fields.Add("PublicKeyToken", (publicKeyToken, false));
}
if (long.TryParse(this.GitCommitDateTicks, out long gitCommitDateTicks))
{
fields.Add("GitCommitDate", (new DateTime(gitCommitDateTicks, DateTimeKind.Utc), true));
}
if (this.AdditionalThisAssemblyFields is object)
{
foreach (var item in this.AdditionalThisAssemblyFields)
{
var name = item.ItemSpec.Trim();
var meta = new Dictionary<string, string>(item.MetadataCount, StringComparer.OrdinalIgnoreCase);
foreach (string metadataName in item.MetadataNames)
{
meta.Add(metadataName, item.GetMetadata(metadataName));
}
object value = null;
bool emitIfEmpty = false;
if (meta.TryGetValue("String", out string stringValue))
{
value = stringValue;
if (meta.TryGetValue("EmitIfEmpty", out string emitIfEmptyString))
{
if (!bool.TryParse(emitIfEmptyString, out emitIfEmpty))
{
this.Log.LogError($"The value '{emitIfEmptyString}' for EmitIfEmpty metadata for item '{name}' in {nameof(this.AdditionalThisAssemblyFields)} is not valid.");
continue;
}
}
}
if (meta.TryGetValue("Boolean", out string boolText))
{
if (value is object)
{
this.Log.LogError($"The metadata for item '{name}' in {nameof(this.AdditionalThisAssemblyFields)} specifies more than one kind of value.");
continue;
}
if (bool.TryParse(boolText, out bool boolValue))
{
value = boolValue;
}
else
{
this.Log.LogError($"The Boolean value '{boolText}' for item '{name}' in AdditionalThisAssemblyFields is not valid.");
continue;
}
}
if (meta.TryGetValue("Ticks", out string ticksText))
{
if (value is object)
{
this.Log.LogError($"The metadata for item '{name}' in {nameof(this.AdditionalThisAssemblyFields)} specifies more than one kind of value.");
continue;
}
if (long.TryParse(ticksText, out long ticksValue))
{
value = new DateTime(ticksValue, DateTimeKind.Utc);
}
else
{
this.Log.LogError($"The Ticks value '{ticksText}' for item '{name}' in {nameof(this.AdditionalThisAssemblyFields)} is not valid.");
continue;
}
}
if (value is null)
{
this.Log.LogWarning($"Field '{name}' in {nameof(this.AdditionalThisAssemblyFields)} has no value and will be ignored.");
continue;
}
if (fields.ContainsKey(name))
{
this.Log.LogError($"Field name '{name}' in {nameof(this.AdditionalThisAssemblyFields)} is defined multiple times.");
continue;
}
fields.Add(name, (value, emitIfEmpty));
}
}
return fields.OrderBy(f => f.Key).ToList();
}
private void GenerateThisAssemblyClass()
{
this.generator.StartThisAssemblyClass();
var fields = this.GetFieldsForThisAssembly();
foreach (var pair in fields)
{
switch (pair.Value.Value)
{
case null:
if (pair.Value.EmitIfEmpty)
{
this.generator.AddThisAssemblyMember(pair.Key, string.Empty);
}
break;
case string stringValue:
if (pair.Value.EmitIfEmpty || !string.IsNullOrEmpty(stringValue))
{
this.generator.AddThisAssemblyMember(pair.Key, stringValue);
}
break;
case bool boolValue:
this.generator.AddThisAssemblyMember(pair.Key, boolValue);
break;
case DateTime datetimeValue:
this.generator.AddThisAssemblyMember(pair.Key, datetimeValue);
break;
default:
throw new NotSupportedException($"Value type {pair.Value.Value.GetType().Name} as found for the \"{pair.Key}\" property is not supported.");
}
}
this.generator.EndThisAssemblyClass();
}
private CodeGenerator CreateGenerator()
{
switch (this.CodeLanguage.ToLowerInvariant())
{
case "c#":
return new CSharpCodeGenerator();
case "visual basic":
case "visualbasic":
case "vb":
return new VisualBasicCodeGenerator();
case "f#":
return new FSharpCodeGenerator();
default:
return null;
}
}
private abstract class CodeGenerator
{
protected readonly StringBuilder codeBuilder;
internal CodeGenerator()
{
this.codeBuilder = new StringBuilder();
}
protected virtual IEnumerable<string> WarningCodesToSuppress { get; } = new string[]
{
"CA2243", // Attribute string literals should parse correctly
};
internal abstract void AddAnalysisSuppressions();
internal abstract void AddComment(string comment);
internal abstract void DeclareAttribute(Type type, string arg);
internal abstract void StartThisAssemblyClass();
internal abstract void AddThisAssemblyMember(string name, string value);
internal abstract void AddThisAssemblyMember(string name, bool value);
internal abstract void AddThisAssemblyMember(string name, DateTime value);
internal abstract void EndThisAssemblyClass();
/// <summary>
/// Gives languages that *require* a namespace a chance to emit such.
/// </summary>
/// <param name="ns">The RootNamespace of the project.</param>
internal virtual void EmitNamespaceIfRequired(string ns) { }
internal string GetCode() => this.codeBuilder.ToString();
internal void AddBlankLine()
{
this.codeBuilder.AppendLine();
}
protected void AddCodeComment(string comment, string token)
{
var sr = new StringReader(comment);
string line;
while ((line = sr.ReadLine()) is object)
{
this.codeBuilder.Append(token);
this.codeBuilder.AppendLine(line);
}
}
}
private class FSharpCodeGenerator : CodeGenerator
{
internal override void AddAnalysisSuppressions()
{
this.codeBuilder.AppendLine($"#nowarn {string.Join(" ", this.WarningCodesToSuppress.Select(c => $"\"{c}\""))}");
}
internal override void AddComment(string comment)
{
this.AddCodeComment(comment, "//");
}
internal override void AddThisAssemblyMember(string name, string value)
{
this.codeBuilder.AppendLine($" static member internal {name} = \"{value}\"");
}
internal override void AddThisAssemblyMember(string name, bool value)
{
this.codeBuilder.AppendLine($" static member internal {name} = {(value ? "true" : "false")}");
}
internal override void AddThisAssemblyMember(string name, DateTime value)
{
this.codeBuilder.AppendLine($" static member internal {name} = new System.DateTime({value.Ticks}L, System.DateTimeKind.Utc)");
}
internal override void EmitNamespaceIfRequired(string ns)
{
this.codeBuilder.AppendLine($"namespace {ns}");
}
internal override void DeclareAttribute(Type type, string arg)
{
this.codeBuilder.AppendLine($"[<assembly: {type.FullName}(\"{arg}\")>]");
}
internal override void EndThisAssemblyClass()
{
this.codeBuilder.AppendLine("do()");
}
internal override void StartThisAssemblyClass()
{
this.codeBuilder.AppendLine("do()");
this.codeBuilder.AppendLine($"#if {CompilerDefinesAroundGeneratedCodeAttribute}");
this.codeBuilder.AppendLine($"[<System.CodeDom.Compiler.GeneratedCode(\"{GeneratorName}\",\"{GeneratorVersion}\")>]");
this.codeBuilder.AppendLine("#endif");
this.codeBuilder.AppendLine($"#if {CompilerDefinesAroundExcludeFromCodeCoverageAttribute}");
this.codeBuilder.AppendLine("[<System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage>]");
this.codeBuilder.AppendLine("#endif");
this.codeBuilder.AppendLine("type internal ThisAssembly() =");
}
}
private class CSharpCodeGenerator : CodeGenerator
{
internal override void AddAnalysisSuppressions()
{
this.codeBuilder.AppendLine($"#pragma warning disable {string.Join(", ", this.WarningCodesToSuppress)}");
}
internal override void AddComment(string comment)
{
this.AddCodeComment(comment, "//");
}
internal override void DeclareAttribute(Type type, string arg)
{
this.codeBuilder.AppendLine($"[assembly: {type.FullName}(\"{arg}\")]");
}
internal override void StartThisAssemblyClass()
{
this.codeBuilder.AppendLine($"#if {CompilerDefinesAroundGeneratedCodeAttribute}");
this.codeBuilder.AppendLine($"[System.CodeDom.Compiler.GeneratedCode(\"{GeneratorName}\",\"{GeneratorVersion}\")]");
this.codeBuilder.AppendLine("#endif");
this.codeBuilder.AppendLine($"#if {CompilerDefinesAroundExcludeFromCodeCoverageAttribute}");
this.codeBuilder.AppendLine("[System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]");
this.codeBuilder.AppendLine("#endif");
this.codeBuilder.AppendLine("internal static partial class ThisAssembly {");
}
internal override void AddThisAssemblyMember(string name, string value)
{
this.codeBuilder.AppendLine($" internal const string {name} = \"{value}\";");
}
internal override void AddThisAssemblyMember(string name, bool value)
{
this.codeBuilder.AppendLine($" internal const bool {name} = {(value ? "true" : "false")};");
}
internal override void AddThisAssemblyMember(string name, DateTime value)
{
this.codeBuilder.AppendLine($" internal static readonly System.DateTime {name} = new System.DateTime({value.Ticks}L, System.DateTimeKind.Utc);");
}
internal override void EndThisAssemblyClass()
{
this.codeBuilder.AppendLine("}");
}
}
private class VisualBasicCodeGenerator : CodeGenerator
{
internal override void AddAnalysisSuppressions()
{
this.codeBuilder.AppendLine($"#Disable Warning {string.Join(", ", this.WarningCodesToSuppress)}");
}
internal override void AddComment(string comment)
{
this.AddCodeComment(comment, "'");
}
internal override void DeclareAttribute(Type type, string arg)
{
this.codeBuilder.AppendLine($"<Assembly: {type.FullName}(\"{arg}\")>");
}
internal override void StartThisAssemblyClass()
{
this.codeBuilder.AppendLine($"#If {CompilerDefinesAroundExcludeFromCodeCoverageAttribute.Replace("||", " Or ")} Then");
this.codeBuilder.AppendLine($"<System.CodeDom.Compiler.GeneratedCode(\"{GeneratorName}\",\"{GeneratorVersion}\")>");
this.codeBuilder.AppendLine("<System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage>");
this.codeBuilder.AppendLine("Partial Friend NotInheritable Class ThisAssembly");
this.codeBuilder.AppendLine($"#ElseIf {CompilerDefinesAroundGeneratedCodeAttribute.Replace("||", " Or ")} Then");
this.codeBuilder.AppendLine($"<System.CodeDom.Compiler.GeneratedCode(\"{GeneratorName}\",\"{GeneratorVersion}\")>");
this.codeBuilder.AppendLine("Partial Friend NotInheritable Class ThisAssembly");
this.codeBuilder.AppendLine("#Else");
this.codeBuilder.AppendLine("Partial Friend NotInheritable Class ThisAssembly");
this.codeBuilder.AppendLine("#End If");
}
internal override void AddThisAssemblyMember(string name, string value)
{
this.codeBuilder.AppendLine($" Friend Const {name} As String = \"{value}\"");
}
internal override void AddThisAssemblyMember(string name, bool value)
{
this.codeBuilder.AppendLine($" Friend Const {name} As Boolean = {(value ? "True" : "False")}");
}
internal override void AddThisAssemblyMember(string name, DateTime value)
{
this.codeBuilder.AppendLine($" Friend Shared ReadOnly {name} As System.DateTime = New System.DateTime({value.Ticks}L, System.DateTimeKind.Utc)");
}
internal override void EndThisAssemblyClass()
{
this.codeBuilder.AppendLine("End Class");
}
}
private static string ToHex(byte[] data)
{
return BitConverter.ToString(data).Replace("-", "").ToLowerInvariant();
}
/// <summary>
/// Gets the public key from a key container.
/// </summary>
/// <param name="containerName">The name of the container.</param>
/// <returns>The public key.</returns>
private static byte[] GetPublicKeyFromKeyContainer(string containerName)
{
throw new NotImplementedException();
}
private static byte[] GetPublicKeyFromKeyPair(byte[] keyPair)
{
byte[] publicKey;
if (CryptoBlobParser.TryGetPublicKeyFromPrivateKeyBlob(keyPair, out publicKey))
{
return publicKey;
}
else
{
throw new ArgumentException("Invalid keypair");
}
}
private bool TryReadKeyInfo(out string publicKey, out string publicKeyToken)
{
try
{
byte[] publicKeyBytes = null;
if (!string.IsNullOrEmpty(this.AssemblyOriginatorKeyFile) && File.Exists(this.AssemblyOriginatorKeyFile))
{
if (Path.GetExtension(this.AssemblyOriginatorKeyFile).Equals(".snk", StringComparison.OrdinalIgnoreCase))
{
byte[] keyBytes = File.ReadAllBytes(this.AssemblyOriginatorKeyFile);
bool publicKeyOnly = keyBytes[0] != 0x07;
publicKeyBytes = publicKeyOnly ? keyBytes : GetPublicKeyFromKeyPair(keyBytes);
}
}
else if (!string.IsNullOrEmpty(this.AssemblyKeyContainerName))
{
publicKeyBytes = GetPublicKeyFromKeyContainer(this.AssemblyKeyContainerName);
}
if (publicKeyBytes is object && publicKeyBytes.Length > 0) // If .NET 2.0 isn't installed, we get byte[0] back.
{
publicKey = ToHex(publicKeyBytes);
publicKeyToken = ToHex(CryptoBlobParser.GetStrongNameTokenFromPublicKey(publicKeyBytes));
}
else
{
if (publicKeyBytes is object)
{
this.Log.LogWarning("Unable to emit public key fields in ThisAssembly class because .NET 2.0 isn't installed.");
}
publicKey = null;
publicKeyToken = null;
return false;
}
return true;
}
catch (NotImplementedException)
{
publicKey = null;
publicKeyToken = null;
return false;
}
}
}
}