5 // Marek Sieradzki (marek.sieradzki@gmail.com)
6 // Andres G. Aragoneses (knocte@gmail.com)
8 // (C) 2006 Marek Sieradzki
9 // (C) 2012 Andres G. Aragoneses
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 using System.Collections;
32 using Microsoft.Build.BuildEngine;
33 using Microsoft.Build.Framework;
34 using Microsoft.Build.Utilities;
35 using NUnit.Framework;
38 namespace MonoTests.Microsoft.Build.BuildEngine {
40 public class TargetTest {
46 public void TestFromXml1 ()
48 string documentString = @"
49 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
50 <Target Name='Target'>
55 engine = new Engine (Consts.BinPath);
57 project = engine.CreateNewProject ();
58 project.LoadXml (documentString);
60 Target[] t = new Target [1];
61 project.Targets.CopyTo (t, 0);
63 Assert.AreEqual (String.Empty, t [0].Condition, "A1");
64 Assert.AreEqual (String.Empty, t [0].DependsOnTargets, "A2");
65 Assert.IsFalse (t [0].IsImported, "A3");
66 Assert.AreEqual ("Target", t [0].Name, "A4");
70 public void TestFromXml2 ()
72 string documentString = @"
73 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
74 <Target Name='Target' Condition='false' DependsOnTargets='X' >
79 engine = new Engine (Consts.BinPath);
81 project = engine.CreateNewProject ();
82 project.LoadXml (documentString);
84 Target[] t = new Target [1];
85 project.Targets.CopyTo (t, 0);
87 Assert.AreEqual ("false", t [0].Condition, "A1");
88 Assert.AreEqual ("X", t [0].DependsOnTargets, "A2");
90 t [0].Condition = "true";
91 t [0].DependsOnTargets = "A;B";
93 Assert.AreEqual ("true", t [0].Condition, "A3");
94 Assert.AreEqual ("A;B", t [0].DependsOnTargets, "A4");
98 public void TestAddNewTask1 ()
100 string documentString = @"
101 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
102 <Target Name='Target' >
107 engine = new Engine (Consts.BinPath);
109 project = engine.CreateNewProject ();
110 project.LoadXml (documentString);
112 Target[] t = new Target [1];
113 project.Targets.CopyTo (t, 0);
115 BuildTask bt = t [0].AddNewTask ("Message");
117 Assert.AreEqual ("Message", bt.Name, "A1");
121 [ExpectedException (typeof (ArgumentNullException))]
122 public void TestAddNewTask2 ()
124 string documentString = @"
125 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
126 <Target Name='Target' >
131 engine = new Engine (Consts.BinPath);
133 project = engine.CreateNewProject ();
134 project.LoadXml (documentString);
136 Target[] t = new Target [1];
137 project.Targets.CopyTo (t, 0);
139 t [0].AddNewTask (null);
143 public void TestGetEnumerator ()
145 string documentString = @"
146 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
147 <Target Name='Target' >
148 <Message Text='text' />
149 <Warning Text='text' />
154 engine = new Engine (Consts.BinPath);
156 project = engine.CreateNewProject ();
157 project.LoadXml (documentString);
159 Target[] t = new Target [1];
160 project.Targets.CopyTo (t, 0);
162 IEnumerator e = t [0].GetEnumerator ();
164 Assert.AreEqual ("Message", ((BuildTask) e.Current).Name, "A1");
166 Assert.AreEqual ("Warning", ((BuildTask) e.Current).Name, "A2");
167 Assert.IsFalse (e.MoveNext (), "A3");
171 public void TestOutOfRangeElementsOfTheEnumerator()
173 string documentString =
175 <Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>
177 <Message Text='text' />
181 engine = new Engine (Consts.BinPath);
183 project = engine.CreateNewProject ();
184 project.LoadXml (documentString);
186 Assert.IsFalse (project.Targets == null, "A1");
187 Assert.AreEqual (1, project.Targets.Count, "A2");
189 Target target = project.Targets ["A"];
190 Assert.IsFalse (target == null, "A3");
192 IEnumerator e = target.GetEnumerator ();
196 var name = ((BuildTask)e.Current).Name;
197 } catch (InvalidOperationException) { // "Enumeration has not started. Call MoveNext"
201 Assert.Fail ("A4: Should have thrown IOE");
204 Assert.AreEqual (true, e.MoveNext (), "A5");
205 Assert.AreEqual ("Message", ((BuildTask)e.Current).Name, "A6");
206 Assert.AreEqual (false, e.MoveNext (), "A7");
208 var name = ((BuildTask) e.Current).Name;
209 } catch (InvalidOperationException) { //"Enumeration already finished."
212 Assert.Fail ("A8: Should have thrown IOE, because there's only one buidTask");
216 [ExpectedException (typeof (InvalidProjectFileException))]
217 public void TestOnError1 ()
222 string documentString = @"
223 <Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>
225 <OnError ExecuteTargets='B' />
226 <Error Text='text' />
231 engine = new Engine (Consts.BinPath);
232 project = engine.CreateNewProject ();
233 project.LoadXml (documentString);
237 public void TestRemoveTask1 ()
239 string documentString = @"
240 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
241 <Target Name='Target' >
242 <Message Text='text' />
243 <Warning Text='text' />
248 engine = new Engine (Consts.BinPath);
250 project = engine.CreateNewProject ();
251 project.LoadXml (documentString);
253 Target[] t = new Target [1];
254 project.Targets.CopyTo (t, 0);
256 IEnumerator e = t [0].GetEnumerator ();
258 t [0].RemoveTask ((BuildTask) e.Current);
259 e = t [0].GetEnumerator ();
261 Assert.AreEqual ("Warning", ((BuildTask) e.Current).Name, "A1");
262 Assert.IsFalse (e.MoveNext (), "A2");
266 [ExpectedException (typeof (ArgumentNullException))]
267 public void TestRemoveTask2 ()
269 string documentString = @"
270 <Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
271 <Target Name='Target' >
276 engine = new Engine (Consts.BinPath);
278 project = engine.CreateNewProject ();
279 project.LoadXml (documentString);
281 Target[] t = new Target [1];
282 project.Targets.CopyTo (t, 0);
283 t [0].RemoveTask (null);
287 public void TestTargetOutputs1 ()
292 string documentString = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
294 <fruit Include=""apple""/>
295 <fruit Include=""rhubarb""/>
296 <fruit Include=""apricot""/>
299 <Target Name=""Main"">
300 <CallTarget Targets=""foo"">
301 <Output TaskParameter=""TargetOutputs"" ItemName=""AllOut""/>
304 <CallTarget Targets=""foo"">
305 <Output TaskParameter=""TargetOutputs"" ItemName=""AllOut""/>
307 <Message Text=""AllOut: @(AllOut)""/>
310 <Target Name=""foo"" Outputs=""@(FooItem)"">
311 <Message Text=""foo called""/>
312 <CreateItem Include=""%(fruit.Identity)"">
313 <Output TaskParameter=""Include"" ItemName=""FooItem""/>
315 <Message Text=""FooItem: @(FooItem)""/>
319 engine = new Engine (Consts.BinPath);
320 project = engine.CreateNewProject ();
321 project.LoadXml (documentString);
323 MonoTests.Microsoft.Build.Tasks.TestMessageLogger logger =
324 new MonoTests.Microsoft.Build.Tasks.TestMessageLogger ();
325 engine.RegisterLogger (logger);
327 bool result = project.Build ("Main");
329 logger.DumpMessages ();
330 Assert.Fail ("Build failed");
334 Assert.AreEqual (3, logger.NormalMessageCount, "Expected number of messages");
335 logger.CheckLoggedMessageHead ("foo called", "A1");
336 logger.CheckLoggedMessageHead ("FooItem: apple;rhubarb;apricot", "A2");
337 logger.CheckLoggedMessageHead ("AllOut: apple;rhubarb;apricot;apple;rhubarb;apricot", "A3");
338 Assert.AreEqual (0, logger.NormalMessageCount, "Extra messages found");
340 Assert.AreEqual (2, logger.TargetStarted, "TargetStarted count");
341 Assert.AreEqual (2, logger.TargetFinished, "TargetFinished count");
342 Assert.AreEqual (8, logger.TaskStarted, "TaskStarted count");
343 Assert.AreEqual (8, logger.TaskFinished, "TaskFinished count");
345 } catch (AssertionException) {
346 logger.DumpMessages ();
353 public void BuildProjectWithItemGroupInsideTarget()
355 ItemGroupInsideATarget ();
358 private MonoTests.Microsoft.Build.Tasks.TestMessageLogger ItemGroupInsideATarget() {
359 var engine = new Engine(Consts.BinPath);
360 var project = engine.CreateNewProject();
361 var projectXml = GetProjectXmlWithItemGroupInsideATarget ();
362 project.LoadXml(projectXml);
364 MonoTests.Microsoft.Build.Tasks.TestMessageLogger logger =
365 new MonoTests.Microsoft.Build.Tasks.TestMessageLogger ();
366 engine.RegisterLogger (logger);
368 bool result = project.Build("Main");
371 logger.DumpMessages ();
372 Assert.Fail("Build failed");
378 private string GetProjectXmlWithItemGroupInsideATarget ()
381 @"<Project ToolsVersion=""4.0"" xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
383 <fruit Include=""apple""/>
384 <fruit Include=""apricot""/>
387 <Target Name=""Main"">
389 <fruit Include=""raspberry"" />
391 <Message Text=""%(fruit.Identity)""/>
397 [Category ("NotWorking")] //https://bugzilla.xamarin.com/show_bug.cgi?id=1862
398 public void BuildProjectOutputWithItemGroupInsideTarget()
400 var logger = ItemGroupInsideATarget ();
404 Assert.AreEqual(3, logger.NormalMessageCount, "Expected number of messages");
405 logger.CheckLoggedMessageHead("apple", "A1");
406 logger.CheckLoggedMessageHead("apricot", "A2");
407 logger.CheckLoggedMessageHead("raspberry", "A3");
408 Assert.AreEqual(0, logger.NormalMessageCount, "Extra messages found");
410 Assert.AreEqual(1, logger.TargetStarted, "TargetStarted count");
411 Assert.AreEqual(1, logger.TargetFinished, "TargetFinished count");
412 Assert.AreEqual(3, logger.TaskStarted, "TaskStarted count");
413 Assert.AreEqual(3, logger.TaskFinished, "TaskFinished count");
416 catch (AssertionException)
418 logger.DumpMessages();
425 public void TestTargetOutputsIncludingMetadata ()
430 string documentString = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
432 <fruit Include=""apple""><md>a</md></fruit>
433 <fruit Include=""rhubarb""><md>b</md></fruit>
434 <fruit Include=""apricot""><md>c</md></fruit>
437 <Target Name=""Main"">
438 <CallTarget Targets=""foo"">
439 <Output TaskParameter=""TargetOutputs"" ItemName=""AllOut""/>
442 <CallTarget Targets=""foo"">
443 <Output TaskParameter=""TargetOutputs"" ItemName=""AllOut""/>
445 <Message Text=""AllOut: @(AllOut) metadata: %(AllOut.md)""/>
448 <Target Name=""foo"" Outputs=""@(FooItem)"">
449 <Message Text=""foo called""/>
450 <CreateItem Include=""@(fruit)"">
451 <Output TaskParameter=""Include"" ItemName=""FooItem""/>
453 <Message Text=""FooItem: @(FooItem) metadata: %(FooItem.md)""/>
457 engine = new Engine (Consts.BinPath);
458 project = engine.CreateNewProject ();
459 project.LoadXml (documentString);
461 MonoTests.Microsoft.Build.Tasks.TestMessageLogger logger =
462 new MonoTests.Microsoft.Build.Tasks.TestMessageLogger ();
463 engine.RegisterLogger (logger);
465 bool result = project.Build ("Main");
467 logger.DumpMessages ();
468 Assert.Fail ("Build failed");
472 logger.CheckLoggedMessageHead ("foo called", "A1");
473 logger.CheckLoggedMessageHead ("FooItem: apple metadata: a", "A2");
474 logger.CheckLoggedMessageHead ("FooItem: rhubarb metadata: b", "A3");
475 logger.CheckLoggedMessageHead ("FooItem: apricot metadata: c", "A4");
477 logger.CheckLoggedMessageHead ("AllOut: apple;apple metadata: a", "A5");
478 logger.CheckLoggedMessageHead ("AllOut: rhubarb;rhubarb metadata: b", "A6");
479 logger.CheckLoggedMessageHead ("AllOut: apricot;apricot metadata: c", "A7");
481 Assert.AreEqual (0, logger.NormalMessageCount, "Extra messages found");
483 Assert.AreEqual (2, logger.TargetStarted, "TargetStarted count");
484 Assert.AreEqual (2, logger.TargetFinished, "TargetFinished count");
485 Assert.AreEqual (10, logger.TaskStarted, "TaskStarted count");
486 Assert.AreEqual (10, logger.TaskFinished, "TaskFinished count");
488 } catch (AssertionException) {
489 logger.DumpMessages ();
495 public void TestOverridingTargets ()
500 string second = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
501 <Target Name='BeforeBuild'/>
502 <Target Name='AfterBuild'/>
503 <Target Name='Build' DependsOnTargets='BeforeBuild'>
504 <Message Text='Build executing'/>
505 <CallTarget Targets='AfterBuild'/>
508 using (StreamWriter sw = new StreamWriter (Path.Combine ("Test", Path.Combine ("resources", "second.proj")))) {
512 string documentString = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
513 <Target Name='AfterBuild'>
514 <Message Text='Overriding AfterBuild'/>
517 <Import Project='Test/resources/second.proj'/>
518 <Target Name='BeforeBuild'>
519 <Message Text='Overriding BeforeBuild'/>
523 engine = new Engine (Consts.BinPath);
524 project = engine.CreateNewProject ();
525 project.LoadXml (documentString);
527 MonoTests.Microsoft.Build.Tasks.TestMessageLogger logger =
528 new MonoTests.Microsoft.Build.Tasks.TestMessageLogger ();
529 engine.RegisterLogger (logger);
531 bool result = project.Build ("Build");
533 logger.DumpMessages ();
534 Assert.Fail ("Build failed");
537 logger.CheckLoggedMessageHead ("Overriding BeforeBuild", "A1");
538 logger.CheckLoggedMessageHead ("Build executing", "A1");
540 Assert.AreEqual (0, logger.NormalMessageCount, "Unexpected extra messages found");
545 public void TestBeforeAndAfterTargets ()
550 string projectString = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"" ToolsVersion=""4.0"">
551 <Target Name=""DefaultBeforeTarget1"" BeforeTargets=""Default"">
552 <Message Text=""Hello from DefaultBeforeTarget1""/>
555 <Target Name=""DefaultBeforeTarget2"" BeforeTargets=""Default;Default;NonExistant"">
556 <Message Text=""Hello from DefaultBeforeTarget2""/>
560 <Target Name=""DefaultAfterTarget"" AfterTargets=""Default ; Foo"">
561 <Message Text=""Hello from DefaultAfterTarget""/>
564 <Target Name=""Default"" DependsOnTargets=""DefaultDependsOn"">
565 <Message Text=""Hello from Default""/>
568 <Target Name=""DefaultDependsOn"">
569 <Message Text=""Hello from DefaultDependsOn""/>
573 engine = new Engine ();
574 project = engine.CreateNewProject ();
575 project.LoadXml (projectString);
577 MonoTests.Microsoft.Build.Tasks.TestMessageLogger logger =
578 new MonoTests.Microsoft.Build.Tasks.TestMessageLogger ();
579 engine.RegisterLogger (logger);
581 if (!project.Build ("Default")) {
582 logger.DumpMessages ();
583 Assert.Fail ("Build failed");
586 logger.CheckLoggedMessageHead ("Hello from DefaultDependsOn", "A1");
587 logger.CheckLoggedMessageHead ("Hello from DefaultBeforeTarget1", "A1");
588 logger.CheckLoggedMessageHead ("Hello from DefaultBeforeTarget2", "A1");
589 logger.CheckLoggedMessageHead ("Hello from Default", "A1");
590 logger.CheckLoggedMessageHead ("Hello from DefaultAfterTarget", "A1");
592 Assert.AreEqual (0, logger.NormalMessageCount, "Unexpected messages found");
594 //warnings for referencing unknown targets: NonExistant and Foo
595 Assert.AreEqual (2, logger.WarningsCount, "Expected warnings not raised");