[AndroidToolTask] Log tool output as error (#229)

Context: #208
Updates AndroidToolTask to capture all standard output from the tool and
log it as an error if the task fails.

Author: pjcollins

src/Microsoft.Android.Build.BaseTasks/AndroidToolTask.cs

@@ -2,6 +2,8 @@
 
 usingSystem;
 usingSystem.IO;
+usingSystem.Text;
+usingMicrosoft.Build.Framework;
 usingMicrosoft.Build.Utilities;
 
 namespaceMicrosoft.Android.Build.Tasks
@@ -12,6 +14,8 @@ public abstract class AndroidToolTask : ToolTask
 
 protectedstringWorkingDirectory{get;privateset;}
 
+StringBuildertoolOutput=newStringBuilder();
+
 publicAndroidToolTask()
 {
 WorkingDirectory=Directory.GetCurrentDirectory();
@@ -20,13 +24,24 @@ public AndroidToolTask ()
 publicoverrideboolExecute()
 {
 try{
-returnRunTask();
+booltaskResult=RunTask();
+if(!taskResult&&!string.IsNullOrEmpty(toolOutput.ToString())){
+Log.LogUnhandledToolError(TaskPrefix,toolOutput.ToString().Trim());
+}
+toolOutput.Clear();
+returntaskResult;
 }catch(Exceptionex){
 Log.LogUnhandledException(TaskPrefix,ex);
 returnfalse;
 }
 }
 
+protectedoverridevoidLogEventsFromTextOutput(stringsingleLine,MessageImportancemessageImportance)
+{
+base.LogEventsFromTextOutput(singleLine,messageImportance);
+toolOutput.AppendLine(singleLine);
+}
+
 // Most ToolTask's do not override Execute and
 // just expect the base to be called
 publicvirtualboolRunTask()=>base.Execute();

src/Microsoft.Android.Build.BaseTasks/UnhandledExceptionLogger.cs

@@ -85,5 +85,10 @@ static void LogUnhandledException (Action<string,string> logCodedError, string p
 else
 logCodedError(prefix+"7000",ex.ToString());
 }
+
+publicstaticvoidLogUnhandledToolError(thisTaskLoggingHelperlog,stringprefix,stringtoolOutput)
+{
+log.LogCodedError($"XA{prefix}0000",toolOutput);
+}
 }
 }

tests/Microsoft.Android.Build.BaseTasks-Tests/AndroidToolTaskTests.cs

@@ -1,18 +1,24 @@
 usingSystem.IO;
 usingSystem.Collections.Generic;
-usingSystem.Threading.Tasks;
 usingMicrosoft.Android.Build.BaseTasks.Tests.Utilities;
 usingMicrosoft.Android.Build.Tasks;
 usingNUnit.Framework;
 usingMicrosoft.Build.Framework;
-usingXamarin.Build;
+usingNUnit.Framework.Internal;
+usingSystem.Linq;
 
 namespaceMicrosoft.Android.Build.BaseTasks.Tests
 {
 [TestFixture]
 publicclassAndroidToolTaskTests
 {
-publicclassMyAndroidTask:AndroidTask{
+List<BuildErrorEventArgs>errors;
+List<BuildWarningEventArgs>warnings;
+List<BuildMessageEventArgs>messages;
+MockBuildEngineengine;
+
+publicclassMyAndroidTask:AndroidTask
+{
 publicoverridestringTaskPrefix{get;}="MAT";
 publicstringKey{get;set;}
 publicstringValue{get;set;}
@@ -25,7 +31,8 @@ public override bool RunTask ()
 }
 }
 
-publicclassMyOtherAndroidTask:AndroidTask{
+publicclassMyOtherAndroidTask:AndroidTask
+{
 publicoverridestringTaskPrefix{get;}="MOAT";
 publicstringKey{get;set;}
 publicboolProjectSpecific{get;set;}=false;
@@ -40,15 +47,31 @@ public override bool RunTask ()
 }
 }
 
+publicclassDotnetToolOutputTestTask:AndroidToolTask
+{
+publicoverridestringTaskPrefix{get;}="DTOT";
+protectedoverridestringToolName=>"dotnet";
+protectedoverridestringGenerateFullPathToTool()=>ToolExe;
+publicstringCommandLineArgs{get;set;}="--info";
+protectedoverridestringGenerateCommandLineCommands()=>CommandLineArgs;
+}
+
+[SetUp]
+publicvoidTestSetup()
+{
+errors=newList<BuildErrorEventArgs>();
+warnings=newList<BuildWarningEventArgs>();
+messages=newList<BuildMessageEventArgs>();
+engine=newMockBuildEngine(TestContext.Out,errors,warnings,messages);
+}
+
 [Test]
 [TestCase(true,true,true)]
 [TestCase(false,false,true)]
 [TestCase(true,false,false)]
 [TestCase(false,true,false)]
 publicvoidTestRegisterTaskObjectCanRetrieveCorrectItem(boolprojectSpecificA,boolprojectSpecificB,boolexpectedResult)
 {
-varengine=newMockBuildEngine(TestContext.Out){
-};
 vartask=newMyAndroidTask(){
 BuildEngine=engine,
 Key="Foo",
@@ -72,8 +95,6 @@ public void TestRegisterTaskObjectCanRetrieveCorrectItem (bool projectSpecificA,
 [TestCase(false,true,false)]
 publicvoidTestRegisterTaskObjectFailsWhenDirectoryChanges(boolprojectSpecificA,boolprojectSpecificB,boolexpectedResult)
 {
-varengine=newMockBuildEngine(TestContext.Out){
-};
 MyAndroidTasktask;
 varcurrentDir=Directory.GetCurrentDirectory();
 Directory.SetCurrentDirectory(Path.Combine(currentDir,".."));
@@ -96,5 +117,30 @@ public void TestRegisterTaskObjectFailsWhenDirectoryChanges (bool projectSpecifi
 task2.Execute();
 Assert.AreEqual(expectedResult,string.Compare(task2.Value,task.Value,ignoreCase:true)==0);
 }
+
+[Test]
+[TestCase("invalidcommand",false,"You intended to execute a .NET program, but dotnet-invalidcommand does not exist.")]
+[TestCase("--info",true,"")]
+publicvoidFailedAndroidToolTaskShouldLogOutputAsError(stringargs,boolexpectedResult,stringexpectedErrorText)
+{
+vartask=newDotnetToolOutputTestTask(){
+BuildEngine=engine,
+CommandLineArgs=args,
+};
+vartaskSucceeded=task.Execute();
+Assert.AreEqual(expectedResult,taskSucceeded,"Task execution did not return expected value.");
+
+if(taskSucceeded){
+Assert.IsEmpty(errors,"Successful task should not have any errors.");
+}else{
+Assert.IsNotEmpty(errors,"Task expected to fail should have errors.");
+Assert.AreEqual("MSB6006",errors[0].Code,
+$"Expected error code MSB6006 but got {errors[0].Code}");
+Assert.AreEqual("XADTOT0000",errors[1].Code,
+$"Expected error code XADTOT0000 but got {errors[1].Code}");
+Assert.IsTrue(errors.Any(e =>e.Message.Contains(expectedErrorText)),
+"Task expected to fail should contain expected error text.");
+}
+}
 }
 }

tests/Microsoft.Android.Build.BaseTasks-Tests/Microsoft.Android.Build.BaseTasks-Tests.csproj

@@ -9,6 +9,7 @@
  <IsPackable>false</IsPackable>
  <OutputPath>$(TestOutputFullPath)</OutputPath>
  <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+ <RollForward>Major</RollForward>
  </PropertyGroup>
 
  <ImportProject="..\..\src\Microsoft.Android.Build.BaseTasks\MSBuildReferences.projitems" />