forked from dotnet/msbuild
/
WriteCodeFragment_Tests.cs
1115 lines (957 loc) · 42.4 KB
/
WriteCodeFragment_Tests.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
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.IO;
using Microsoft.Build.Tasks;
using Microsoft.Build.Utilities;
using Microsoft.Build.Shared;
using Xunit;
using System.Linq;
using System.Runtime.InteropServices;
using Shouldly;
namespace Microsoft.Build.UnitTests
{
/// <summary>
/// Tests for write code fragment task
/// </summary>
public class WriteCodeFragment_Tests
{
/// <summary>
/// Need an available language
/// </summary>
[Fact]
[Trait("Category", "mono-osx-failing")]
public void InvalidLanguage()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "xx";
task.OutputFile = new TaskItem("foo");
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3712");
}
/// <summary>
/// Need a language
/// </summary>
[Fact]
public void NoLanguage()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.OutputFile = new TaskItem("foo");
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3098");
}
/// <summary>
/// Need a location
/// </summary>
[Fact]
public void NoFileOrDirectory()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3711");
}
/// <summary>
/// Combine file and directory
/// </summary>
[Fact]
public void CombineFileDirectory()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = new TaskItem[] { new TaskItem("aa") };
task.OutputFile = new TaskItem("CombineFileDirectory.tmp");
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string file = Path.Combine(Path.GetTempPath(), "CombineFileDirectory.tmp");
Assert.Equal(file, task.OutputFile.ItemSpec);
Assert.True(File.Exists(file));
}
/// <summary>
/// Ignore directory if file is rooted
/// </summary>
[Fact]
public void DirectoryAndRootedFile()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = new TaskItem[] { new TaskItem("aa") };
string folder = Path.Combine(Path.GetTempPath(), "foo" + Path.DirectorySeparatorChar);
string file = Path.Combine(folder, "CombineFileDirectory.tmp");
Directory.CreateDirectory(folder);
task.OutputFile = new TaskItem(file);
task.OutputDirectory = new TaskItem("c:\\");
bool result = task.Execute();
Assert.True(result);
Assert.Equal(file, task.OutputFile.ItemSpec);
Assert.True(File.Exists(file));
FileUtilities.DeleteWithoutTrailingBackslash(folder, true);
}
/// <summary>
/// Given nothing to write, should succeed but
/// produce no output file
/// </summary>
[Fact]
public void NoAttributesShouldEmitNoFile()
{
string file = Path.Combine(Path.GetTempPath(), "NoAttributesShouldEmitNoFile.tmp");
if (File.Exists(file))
{
File.Delete(file);
}
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = new TaskItem[] { }; // MSBuild sets an empty array
task.OutputFile = new TaskItem(file);
bool result = task.Execute();
Assert.True(result);
Assert.False(File.Exists(file));
Assert.Null(task.OutputFile);
}
/// <summary>
/// Given nothing to write, should succeed but
/// produce no output file
/// </summary>
[Fact]
public void NoAttributesShouldEmitNoFile2()
{
string file = Path.Combine(Path.GetTempPath(), "NoAttributesShouldEmitNoFile.tmp");
if (File.Exists(file))
{
File.Delete(file);
}
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = null; // null this time
task.OutputFile = new TaskItem(file);
bool result = task.Execute();
Assert.True(result);
Assert.False(File.Exists(file));
Assert.Null(task.OutputFile);
}
/// <summary>
/// Bad file path
/// </summary>
[Fact]
public void InvalidFilePath()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = new TaskItem[] { new TaskItem("aa") };
task.OutputFile = new TaskItem("||//invalid||");
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3713");
}
/// <summary>
/// Bad directory path
/// </summary>
[Fact]
[PlatformSpecific(TestPlatforms.Windows)] // "No invalid characters on Unix"
public void InvalidDirectoryPath()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
task.Language = "c#";
task.AssemblyAttributes = new TaskItem[] { new TaskItem("aa") };
task.OutputDirectory = new TaskItem("||invalid||");
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3713");
}
/// <summary>
/// Parameterless attribute
/// </summary>
[Fact]
public void OneAttributeNoParams()
{
string file = Path.Combine(Path.GetTempPath(), "OneAttribute.tmp");
try
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("System.AssemblyTrademarkAttribute");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputFile = new TaskItem(file);
bool result = task.Execute();
Assert.True(result);
Assert.True(File.Exists(file));
string content = File.ReadAllText(file);
Console.WriteLine(content);
CheckContentCSharp(content, "[assembly: System.AssemblyTrademarkAttribute()]");
}
finally
{
File.Delete(file);
}
}
/// <summary>
/// Test with the VB language
/// </summary>
[Fact]
[Trait("Category", "mono-osx-failing")]
public void OneAttributeNoParamsVb()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("System.AssemblyTrademarkAttribute");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "visualbasic";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
CheckContentVB(content, "<Assembly: System.AssemblyTrademarkAttribute()>");
}
/// <summary>
/// More than one attribute
/// </summary>
[Fact]
public void TwoAttributes()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute1 = new TaskItem("AssemblyTrademarkAttribute");
attribute1.SetMetadata("Name", "Microsoft");
TaskItem attribute2 = new TaskItem("System.AssemblyCultureAttribute");
attribute2.SetMetadata("Culture", "en-US");
task.AssemblyAttributes = new TaskItem[] { attribute1, attribute2 };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
CheckContentCSharp(
content,
@"[assembly: AssemblyTrademarkAttribute(Name=""Microsoft"")]",
@"[assembly: System.AssemblyCultureAttribute(Culture=""en-US"")]");
}
/// <summary>
/// Specify directory instead
/// </summary>
[Fact]
public void ToDirectory()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("System.AssemblyTrademarkAttribute");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
Assert.True(File.Exists(task.OutputFile.ItemSpec));
Assert.Equal(Path.GetTempPath(), task.OutputFile.ItemSpec.Substring(0, Path.GetTempPath().Length));
Assert.Equal(".cs", task.OutputFile.ItemSpec.Substring(task.OutputFile.ItemSpec.Length - 3));
File.Delete(task.OutputFile.ItemSpec);
}
/// <summary>
/// Regular case
/// </summary>
[Fact]
public void OneAttributeTwoParams()
{
string file = Path.Combine(Path.GetTempPath(), "OneAttribute.tmp");
try
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("Company", "Microsoft");
attribute.SetMetadata("Year", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputFile = new TaskItem(file);
bool result = task.Execute();
Assert.True(result);
Assert.True(File.Exists(file));
string content = File.ReadAllText(file);
Console.WriteLine(content);
CheckContentCSharp(content, @"[assembly: AssemblyTrademarkAttribute(Company=""Microsoft"", Year=""2009"")]");
}
finally
{
File.Delete(file);
}
}
/// <summary>
/// This produces invalid code, but the task works
/// </summary>
[Fact]
public void OneAttributeTwoParamsSameName()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("Company", "Microsoft");
attribute.SetMetadata("Company", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
File.Delete(task.OutputFile.ItemSpec);
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// </summary>
[Fact]
public void OneAttributePositionalParamInvalidSuffix()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_ParameterXXXXXXXXXX", "Microsoft");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3098");
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// </summary>
[Fact]
public void OneAttributeTwoPositionalParams()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_Parameter1", "Microsoft");
attribute.SetMetadata("_Parameter2", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
CheckContentCSharp(content, @"[assembly: AssemblyTrademarkAttribute(""Microsoft"", ""2009"")]");
File.Delete(task.OutputFile.ItemSpec);
}
[Fact]
public void OneAttributeTwoPositionalParamsWithSameValue()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyMetadataAttribute");
attribute.SetMetadata("_Parameter1", "TestValue");
attribute.SetMetadata("_Parameter2", "TestValue");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
CheckContentCSharp(content, @"[assembly: AssemblyMetadataAttribute(""TestValue"", ""TestValue"")]");
File.Delete(task.OutputFile.ItemSpec);
}
public static string EscapedLineSeparator => NativeMethodsShared.IsWindows ? "\\r\\n" : "\\n";
/// <summary>
/// Multi line argument values should cause a verbatim string to be used
/// </summary>
[Fact]
public void MultilineAttributeCSharp()
{
var lines = new[] { "line 1", "line 2", "line 3" };
var multilineString = String.Join(Environment.NewLine, lines);
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("System.Reflection.AssemblyDescriptionAttribute");
attribute.SetMetadata("_Parameter1", multilineString);
attribute.SetMetadata("Description", multilineString);
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
var csMultilineString = lines.Aggregate((l1, l2) => l1 + EscapedLineSeparator + l2);
CheckContentCSharp(content, $"[assembly: System.Reflection.AssemblyDescriptionAttribute(\"{csMultilineString}\", Description=\"{csMultilineString}\")]");
File.Delete(task.OutputFile.ItemSpec);
}
private static readonly string VBCarriageReturn = "Global.Microsoft.VisualBasic.ChrW(13)";
private static readonly string VBLineFeed = "Global.Microsoft.VisualBasic.ChrW(10)";
public static readonly string VBLineSeparator = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? $"{VBCarriageReturn}&{VBLineFeed}" : VBLineFeed;
/// <summary>
/// Multi line argument values should cause a verbatim string to be used
/// </summary>
[Fact]
[Trait("Category", "mono-osx-failing")]
public void MultilineAttributeVB()
{
var lines = new []{ "line 1", "line 2", "line 3" };
var multilineString = String.Join(Environment.NewLine, lines);
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("System.Reflection.AssemblyDescriptionAttribute");
attribute.SetMetadata("_Parameter1", multilineString);
attribute.SetMetadata("Description", multilineString);
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "visualbasic";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
var vbMultilineString = lines
.Select(l => $"\"{l}\"")
.Aggregate((l1, l2) => $"{l1}&{VBLineSeparator}&{l2}");
CheckContentVB(content, $"<Assembly: System.Reflection.AssemblyDescriptionAttribute({vbMultilineString}, Description:={vbMultilineString})>");
File.Delete(task.OutputFile.ItemSpec);
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// If a parameter is skipped, it's an error.
/// </summary>
[Fact]
public void OneAttributeSkippedPositionalParams()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_Parameter2", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3714");
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// This test is for "_ParameterX"
/// </summary>
[Fact]
public void InvalidNumber()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_ParameterX", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3098");
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// This test is for "_Parameter"
/// </summary>
[Fact]
public void NoNumber()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_Parameter", "2009");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.False(result);
engine.AssertLogContains("MSB3098");
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// These can also be combined with named params.
/// </summary>
[Fact]
public void OneAttributePositionalAndNamedParams()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_Parameter1", "Microsoft");
attribute.SetMetadata("Date", "2009");
attribute.SetMetadata("Copyright", "(C)");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "c#";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
// NOTE: order here is defined by dictionary traversal order and may change
// based on implementation details there, but named parameters can have different
// orders so that's ok.
CheckContentCSharp(content, @"[assembly: AssemblyTrademarkAttribute(""Microsoft"", Copyright=""(C)"", Date=""2009"")]");
File.Delete(task.OutputFile.ItemSpec);
}
/// <summary>
/// Some attributes only allow positional constructor arguments.
/// To set those, use metadata names like "_Parameter1", "_Parameter2" etc.
/// These can also be combined with named params.
/// </summary>
[Fact]
[Trait("Category", "mono-osx-failing")]
public void OneAttributePositionalAndNamedParamsVisualBasic()
{
WriteCodeFragment task = new WriteCodeFragment();
MockEngine engine = new MockEngine(true);
task.BuildEngine = engine;
TaskItem attribute = new TaskItem("AssemblyTrademarkAttribute");
attribute.SetMetadata("_Parameter1", "Microsoft");
attribute.SetMetadata("_Parameter2", "2009");
attribute.SetMetadata("Copyright", "(C)");
task.AssemblyAttributes = new TaskItem[] { attribute };
task.Language = "visualbasic";
task.OutputDirectory = new TaskItem(Path.GetTempPath());
bool result = task.Execute();
Assert.True(result);
string content = File.ReadAllText(task.OutputFile.ItemSpec);
Console.WriteLine(content);
CheckContentVB(content, @"<Assembly: AssemblyTrademarkAttribute(""Microsoft"", ""2009"", Copyright:=""(C)"")>");
File.Delete(task.OutputFile.ItemSpec);
}
/// <summary>
/// A type can be declared for a positional arguments using the metadata
/// "_Parameter1_TypeName" where the value is the full type name.
/// </summary>
[Fact]
public void DeclaredTypeForPositionalParameter()
{
TaskItem attribute = new("CLSCompliantAttribute");
attribute.SetMetadata("_Parameter1", "True");
attribute.SetMetadata("_Parameter1_TypeName", "System.Boolean");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: CLSCompliantAttribute(true)]"
);
}
/// <summary>
/// A type can be declared for a positional arguments using the metadata
/// "Foo_TypeName" where the value is the full type name.
/// </summary>
[Fact]
public void DeclaredTypeForNamedParameter()
{
TaskItem attribute = new TaskItem("TestAttribute");
attribute.SetMetadata("BoolArgument", "False");
attribute.SetMetadata("BoolArgument_TypeName", "System.Boolean");
attribute.SetMetadata("Int32Argument", "42");
attribute.SetMetadata("Int32Argument_TypeName", "System.Int32");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(Int32Argument=42, BoolArgument=false)]"
);
}
/// <summary>
/// Metadata that looks like a declared type, but doesn't have corresponding named parameter
/// metadata should be treated as another named parameter for backward-compatibility.
/// </summary>
[Fact]
public void DeclaredTypedWithoutCorrespondingNamedParameter()
{
TaskItem attribute = new TaskItem("TestAttribute");
attribute.SetMetadata("BoolArgument", "False");
attribute.SetMetadata("BoolArgument_TypeName", "System.Boolean");
attribute.SetMetadata("Int32Argument_TypeName", "System.Int32");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(Int32Argument_TypeName=""System.Int32"", BoolArgument=false)]"
);
}
/// <summary>
/// An unknown type name for a parameter should cause a failure.
/// </summary>
[Fact]
public void DeclaredTypeIsUnknown()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("TestParameter", "99");
attribute.SetMetadata("TestParameter_TypeName", "Foo.Bar");
ExecuteAndVerifyFailure(
CreateTask("c#", attribute),
"MSB3715"
);
}
/// <summary>
/// A parameter value that cannot be converted to the declared type should cause a failure.
/// </summary>
[Fact]
public void DeclaredTypeCausesConversionFailure()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("TestParameter", "99");
attribute.SetMetadata("TestParameter_TypeName", "System.Boolean");
ExecuteAndVerifyFailure(
CreateTask("c#", attribute),
"MSB3716"
);
}
/// <summary>
/// Parameter value that is too large for the declared data type should cause a failure.
/// </summary>
[Fact]
public void DeclaredTypeCausesOverflow()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("TestParameter", "1000");
attribute.SetMetadata("TestParameter_TypeName", "System.Byte");
ExecuteAndVerifyFailure(
CreateTask("c#", attribute),
"MSB3716"
);
}
/// <summary>
/// The metadata value should convert successfully to an enum.
/// </summary>
[Fact]
public void DeclaredTypeIsEnum()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("_Parameter1", "Local");
attribute.SetMetadata("_Parameter1_TypeName", "System.DateTimeKind");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(System.DateTimeKind.Local)]"
);
}
/// <summary>
/// The metadata value should convert successfully to a type name in C#.
/// </summary>
[Fact]
public void DeclaredTypeIsTypeInCSharp()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("_Parameter1", "System.Console");
attribute.SetMetadata("_Parameter1_TypeName", "System.Type");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(typeof(System.Console))]"
);
}
/// <summary>
/// The metadata value should convert successfully to a type name in VB.NET.
/// </summary>
[Fact]
public void DeclaredTypeIsTypeInVB()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("_Parameter1", "System.Console");
attribute.SetMetadata("_Parameter1_TypeName", "System.Type");
ExecuteAndVerifySuccess(
CreateTask("visualbasic", attribute),
@"<Assembly: TestAttribute(GetType(System.Console))>"
);
}
/// <summary>
/// Arrays are not supported for declared types. Literal arguments need to be used instead.
/// This test confirms that it fails instead of falling back to being treated as a string.
/// </summary>
[Fact]
public void DeclaredTypeOfArrayIsNotSupported()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("_Parameter1", "1,2,3");
attribute.SetMetadata("_Parameter1_TypeName", "System.Int32[]");
ExecuteAndVerifyFailure(
CreateTask("c#", attribute),
"MSB3716"
);
}
/// <summary>
/// The exact code for a positional argument can be specified using
/// the metadata "_Parameter1_IsLiteral" with a value of "true".
/// </summary>
[Fact]
public void LiteralPositionalParameter()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("_Parameter1", "42 /* A comment */");
attribute.SetMetadata("_Parameter1_IsLiteral", "true");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(42 /* A comment */)]"
);
}
/// <summary>
/// The exact code for a named argument can be specified using
/// the metadata "Foo_IsLiteral" with a value of "true".
/// </summary>
[Fact]
public void LiteralNamedParameter()
{
TaskItem attribute = new("TestAttribute");
attribute.SetMetadata("TestParameter", "42 /* A comment */");
attribute.SetMetadata("TestParameter_IsLiteral", "true");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: TestAttribute(TestParameter=42 /* A comment */)]"
);
}
/// <summary>
/// The type of a positional argument can be inferred
/// if the type of the attribute is in mscorlib.
/// </summary>
[Fact]
public void InferredTypeForPositionalParameter()
{
TaskItem attribute = new("CLSCompliantAttribute");
attribute.SetMetadata("_Parameter1", "True");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: CLSCompliantAttribute(true)]"
);
}
/// <summary>
/// The type of a named argument can be inferred
/// if the type of the attribute is in mscorlib.
/// </summary>
[Fact]
public void InferredTypeForNamedParameter()
{
TaskItem attribute = new("System.Runtime.CompilerServices.InternalsVisibleToAttribute");
attribute.SetMetadata("_Parameter1", "MyAssembly");
attribute.SetMetadata("AllInternalsVisible", "True");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.Runtime.CompilerServices.InternalsVisibleToAttribute(""MyAssembly"", AllInternalsVisible=true)]"
);
}
/// <summary>
/// For backward-compatibility, if multiple constructors are found with the same number
/// of position arguments that was specified in the metadata, then the constructor that
/// has strings for every parameter should be used.
/// </summary>
[Fact]
public void InferredTypePrefersStringWhenMultipleConstructorsAreFound()
{
TaskItem attribute = new("System.Diagnostics.Contracts.ContractOptionAttribute");
attribute.SetMetadata("_Parameter1", "a");
attribute.SetMetadata("_Parameter2", "b");
attribute.SetMetadata("_Parameter3", "false");
// There are two constructors with three parameters:
// * ContractOptionAttribute(string, string, bool)
// * ContractOptionAttribute(string, string, string)
//
// The first overload would come first when comparing the type names
// ("System.Boolean" comes before "System.String"), but because we
// need to remain backward-compatible, the constructor that takes
// all strings should be preferred over all other constructors.
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.Diagnostics.Contracts.ContractOptionAttribute(""a"", ""b"", ""false"")]"
);
}
/// <summary>
/// When multiple constructors are found with the same number of
/// position arguments that was specified in the metadata, and none
/// of them have parameters of all strings, then the constructors
/// should be sorted by the names of the parameter types.
/// The first constructor is then selected.
/// </summary>
[Fact]
public void InferredTypeWithMultipleAttributeConstructorsIsDeterministic()
{
TaskItem attribute = new("System.Reflection.AssemblyFlagsAttribute");
attribute.SetMetadata("_Parameter1", "2");
// There are three constructors with a single parameter:
// * AssemblyFlagsAttribute(int)
// * AssemblyFlagsAttribute(uint)
// * AssemblyFlagsAttribute(System.Reflection.AssemblyNameFlags)
//
// The int overload should be used, because "System.Int32"
// is alphabetically before any of the other types.
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.Reflection.AssemblyFlagsAttribute(2)]"
);
// To prove that it's treating the argument as an int,
// we can specify an enum value which should fail type
// conversion and fall back to being used as a string.
attribute.SetMetadata("_Parameter1", "PublicKey");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.Reflection.AssemblyFlagsAttribute(""PublicKey"")]"
);
}
/// <summary>
/// If the attribute type is not in mscorlib, then the
/// parameter should be treated as a string when the parameter
/// is not given a declared type or is not marked as a literal.
/// </summary>
[Fact]
public void InferredTypeFallsBackToStringWhenTypeCannotBeInferred()
{
// Use an attribute that is not in mscorlib. TypeConverterAttribute is in the "System" assembly.
TaskItem attribute = new("System.ComponentModel.TypeConverterAttribute");
attribute.SetMetadata("_Parameter1", "false");
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.ComponentModel.TypeConverterAttribute(""false"")]"
);
}
/// <summary>
/// If the parameter type cannot be converted to the inferred type,
/// then the parameter should be treated as a string.
/// </summary>
[Fact]
public void InferredTypeFallsBackToStringWhenTypeConversionFails()
{
TaskItem attribute = new("System.Diagnostics.DebuggableAttribute");
attribute.SetMetadata("_Parameter1", "True"); // Should be a boolean. Will be converted.
attribute.SetMetadata("_Parameter2", "42"); // Should be a boolean. Will fail type conversion.
ExecuteAndVerifySuccess(
CreateTask("c#", attribute),
@"[assembly: System.Diagnostics.DebuggableAttribute(true, ""42"")]"
);
}
/// <summary>
/// Individual parameters can be typed differently.
/// </summary>
[Fact]
public void UsingInferredDeclaredTypesAndLiteralsInSameAttribute()
{
TaskItem attribute = new("System.Diagnostics.Contracts.ContractOptionAttribute");
attribute.SetMetadata("_Parameter1", "foo"); // Inferred as string.
attribute.SetMetadata("_Parameter2", @"""bar"" /* setting */"); // Literal string.
attribute.SetMetadata("_Parameter2_IsLiteral", "true");
attribute.SetMetadata("_Parameter3", "False"); // Typed as boolean.
attribute.SetMetadata("_Parameter3_TypeName", "System.Boolean");