return 0;
}
+ public int CheckFullLog (string text)
+ {
+ for (int i = 0; i < all_messages.Count; i ++) {
+ BuildEventArgs arg = all_messages [i];
+ if (text == arg.Message) {
+ all_messages.RemoveAt (i);
+ return 0;
+ }
+ }
+
+ return 1;
+ }
+
public void DumpMessages ()
{
foreach (BuildEventArgs arg in all_messages)
/r:System.Xml.dll \
/r:$(XBUILD_FRAMEWORK)
-TEST_MCS_FLAGS = /r:$(XBUILD_ENGINE) /r:$(XBUILD_FRAMEWORK) -r:System.dll -r:System.Core.dll
+TEST_RESX_RESOURCES = Test/Microsoft.Build.Utilities/Strings.resources
+
+TEST_MCS_FLAGS = /r:$(XBUILD_ENGINE) /r:$(XBUILD_FRAMEWORK) -r:System.dll -r:System.Core.dll $(TEST_RESX_RESOURCES:%=-resource:%)
include $(XBUILD_DIR)/xbuild_test.make
include ../../build/library.make
+
+EXTRA_DISTFILES = $(TEST_RESX_RESOURCES:.resources=.resx)
+
+CLEAN_FILES += $(TEST_RESX_RESOURCES)
+
+$(TEST_RESX_RESOURCES): %.resources: %.resx
+ $(RESGEN) $< || cp $@.prebuilt $@
+
+$(test_lib): $(TEST_RESX_RESOURCES)
string helpKeywordPrefix;
ITaskHost hostObject;
TaskLoggingHelper log;
- ResourceManager taskResources;
protected Task()
: this (null, null)
protected Task(ResourceManager taskResources,
string helpKeywordPrefix)
{
- this.taskResources = taskResources;
+ log = new TaskLoggingHelper (this);
+ log.TaskResources = taskResources;
this.helpKeywordPrefix = helpKeywordPrefix;
}
}
set {
buildEngine = value;
- log = new TaskLoggingHelper (this);
}
}
protected ResourceManager TaskResources {
get {
- return taskResources;
+ return log.TaskResources;
}
set {
- taskResources = value;
+ log.TaskResources = value;
}
}
}
string helpKeywordPrefix;
string taskName;
ResourceManager taskResources;
+ ITask taskInstance;
public TaskLoggingHelper (ITask taskInstance)
{
- if (taskInstance != null)
- this.buildEngine = taskInstance.BuildEngine;
+ if (taskInstance == null)
+ throw new ArgumentNullException ("taskInstance");
+
+ this.taskInstance = taskInstance;
taskName = null;
}
{
if (resourceName == null)
throw new ArgumentNullException ("resourceName");
-
- return null;
+
+ if (taskResources == null)
+ throw new InvalidOperationException ("Task did not register any task resources");
+
+ string resourceString = taskResources.GetString (resourceName);
+ if (resourceString == null)
+ throw new ArgumentException ($"No resource string found for resource named {resourceName}");
+
+ return FormatString (resourceString, args);
}
[MonoTODO]
{
if (message == null)
throw new ArgumentNullException ("message");
+
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
BuildErrorEventArgs beea = new BuildErrorEventArgs (
- null, null, buildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, FormatString (message, messageArgs),
+ null, null, BuildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, FormatString (message, messageArgs),
helpKeywordPrefix, null);
- buildEngine.LogErrorEvent (beea);
+ BuildEngine.LogErrorEvent (beea);
hasLoggedErrors = true;
}
if (message == null)
throw new ArgumentNullException ("message");
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
BuildErrorEventArgs beea = new BuildErrorEventArgs (
subcategory, errorCode, file, lineNumber,
columnNumber, endLineNumber, endColumnNumber,
FormatString (message, messageArgs), helpKeyword /*it's helpKeyword*/,
null /*it's senderName*/);
- buildEngine.LogErrorEvent (beea);
+ BuildEngine.LogErrorEvent (beea);
hasLoggedErrors = true;
}
if (exception == null)
throw new ArgumentNullException ("exception");
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
StringBuilder sb = new StringBuilder ();
sb.Append (exception.Message);
if (showStackTrace == true)
sb.Append (exception.StackTrace);
BuildErrorEventArgs beea = new BuildErrorEventArgs (
- null, null, buildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, sb.ToString (),
+ null, null, BuildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, sb.ToString (),
exception.HelpLink, exception.Source);
- buildEngine.LogErrorEvent (beea);
+ BuildEngine.LogErrorEvent (beea);
hasLoggedErrors = true;
}
params object[] messageArgs)
{
LogErrorFromResources (null, null, null, null, 0, 0, 0,
- 0, messageResourceName, null);
+ 0, messageResourceName, messageArgs);
}
public void LogErrorFromResources (string subcategoryResourceName,
string messageResourceName,
params object[] messageArgs)
{
+ if (messageResourceName == null)
+ throw new ArgumentNullException ("messageResourceName");
+
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
+ string subcategory = null;
+ if (!String.IsNullOrEmpty (subcategoryResourceName))
+ subcategory = taskResources.GetString (subcategoryResourceName);
+
BuildErrorEventArgs beea = new BuildErrorEventArgs (
- taskResources.GetString (subcategoryResourceName),
+ subcategory,
errorCode, file, lineNumber, columnNumber,
endLineNumber, endColumnNumber,
- taskResources.GetString (messageResourceName),
+ FormatResourceString (messageResourceName, messageArgs),
helpKeyword, null );
- buildEngine.LogErrorEvent (beea);
+ BuildEngine.LogErrorEvent (beea);
hasLoggedErrors = true;
}
public void LogMessageFromResources (string messageResourceName,
params object[] messageArgs)
{
- LogMessage (taskResources.GetString (messageResourceName),
- messageArgs);
+ LogMessageFromResources (MessageImportance.Normal, messageResourceName, messageArgs);
}
public void LogMessageFromResources (MessageImportance importance,
string messageResourceName,
params object[] messageArgs)
{
- LogMessage (importance, taskResources.GetString (
- messageResourceName), messageArgs);
+ if (messageResourceName == null)
+ throw new ArgumentNullException ("messageResourceName");
+
+ LogMessage (importance, FormatResourceString (messageResourceName, messageArgs));
}
public bool LogMessagesFromFile (string fileName)
if (lineOfText == null)
throw new ArgumentNullException ("lineOfText");
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
BuildMessageEventArgs bmea = new BuildMessageEventArgs (
lineOfText, helpKeywordPrefix,
null, messageImportance);
- buildEngine.LogMessageEvent (bmea);
+ BuildEngine.LogMessageEvent (bmea);
return true;
}
public void LogWarning (string message,
params object[] messageArgs)
{
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
// FIXME: what about all the parameters?
BuildWarningEventArgs bwea = new BuildWarningEventArgs (
- null, null, buildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, FormatString (message, messageArgs),
+ null, null, BuildEngine.ProjectFileOfTaskNode, 0, 0, 0, 0, FormatString (message, messageArgs),
helpKeywordPrefix, null);
- buildEngine.LogWarningEvent (bwea);
+ BuildEngine.LogWarningEvent (bwea);
}
public void LogWarning (string subcategory, string warningCode,
string message,
params object[] messageArgs)
{
+ ThrowInvalidOperationIf (BuildEngine == null, "Task is attempting to log before it was initialized");
+
BuildWarningEventArgs bwea = new BuildWarningEventArgs (
subcategory, warningCode, file, lineNumber,
columnNumber, endLineNumber, endColumnNumber,
FormatString (message, messageArgs), helpKeyword, null);
- buildEngine.LogWarningEvent (bwea);
+ BuildEngine.LogWarningEvent (bwea);
}
public void LogWarningFromException (Exception exception)
public void LogWarningFromResources (string messageResourceName,
params object[] messageArgs)
{
- LogWarning (taskResources.GetString (messageResourceName),
- messageArgs);
+ if (messageResourceName == null)
+ throw new ArgumentNullException ("messageResourceName");
+
+ LogWarningFromResources (null, null, null, null, 0, 0, 0, 0, messageResourceName, messageArgs);
}
public void LogWarningFromResources (string subcategoryResourceName,
string messageResourceName,
params object[] messageArgs)
{
- LogWarning (taskResources.GetString (subcategoryResourceName),
+ if (messageResourceName == null)
+ throw new ArgumentNullException ("messageResourceName");
+
+ string subcategory = null;
+ if (!String.IsNullOrEmpty (subcategoryResourceName))
+ subcategory = taskResources.GetString (subcategoryResourceName);
+
+ LogWarning (subcategory,
warningCode, helpKeyword, file, lineNumber,
columnNumber, endLineNumber, endColumnNumber,
- taskResources.GetString (messageResourceName),
- messageArgs);
+ FormatResourceString (messageResourceName, messageArgs));
}
public void LogWarningWithCodeFromResources (string messageResourceName,
{
}
+ void ThrowInvalidOperationIf (bool condition, string message)
+ {
+ if (condition)
+ throw new InvalidOperationException (message);
+ }
+
protected IBuildEngine BuildEngine {
get {
- return buildEngine;
+ return taskInstance?.BuildEngine;
}
}
Microsoft.Build.Utilities/TaskLoggingHelperTest.cs
Microsoft.Build.Utilities/ToolLocationHelperTest.cs
Microsoft.Build.Utilities/ToolTaskTest.cs
+../../Microsoft.Build.Tasks/Test/Microsoft.Build.Tasks/TestMessageLogger.cs
+../../Microsoft.Build.Engine/Test/Microsoft.Build.BuildEngine/Consts.cs
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+ <!--
+ Microsoft ResX Schema
+
+ Version 1.3
+
+ The primary goals of this format is to allow a simple XML format
+ that is mostly human readable. The generation and parsing of the
+ various data types are done through the TypeConverter classes
+ associated with the data types.
+
+ Example:
+
+ ... ado.net/XML headers & schema ...
+ <resheader name="resmimetype">text/microsoft-resx</resheader>
+ <resheader name="version">1.3</resheader>
+ <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+ <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+ <data name="Name1">this is my long string</data>
+ <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+ <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+ [base64 mime encoded serialized .NET Framework object]
+ </data>
+ <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+ [base64 mime encoded string representing a byte array form of the .NET Framework object]
+ </data>
+
+ There are any number of "resheader" rows that contain simple
+ name/value pairs.
+
+ Each data row contains a name, and value. The row also contains a
+ type or mimetype. Type corresponds to a .NET class that support
+ text/value conversion through the TypeConverter architecture.
+ Classes that don't support this are serialized and stored with the
+ mimetype set.
+
+ The mimetype is used forserialized objects, and tells the
+ ResXResourceReader how to depersist the object. This is currently not
+ extensible. For a given mimetype the value must be set accordingly:
+
+ Note - application/x-microsoft.net.object.binary.base64 is the format
+ that the ResXResourceWriter will generate, however the reader can
+ read any of the formats listed below.
+
+ mimetype: application/x-microsoft.net.object.binary.base64
+ value : The object must be serialized with
+ : System.Serialization.Formatters.Binary.BinaryFormatter
+ : and then encoded with base64 encoding.
+
+ mimetype: application/x-microsoft.net.object.soap.base64
+ value : The object must be serialized with
+ : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+ : and then encoded with base64 encoding.
+
+ mimetype: application/x-microsoft.net.object.bytearray.base64
+ value : The object must be serialized into a byte array
+ : using a System.ComponentModel.TypeConverter
+ : and then encoded with base64 encoding.
+ -->
+ <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+ <xsd:element name="root" msdata:IsDataSet="true">
+ <xsd:complexType>
+ <xsd:choice maxOccurs="unbounded">
+ <xsd:element name="data">
+ <xsd:complexType>
+ <xsd:sequence>
+ <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+ <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+ </xsd:sequence>
+ <xsd:attribute name="name" type="xsd:string" msdata:Ordinal="1" />
+ <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+ <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+ </xsd:complexType>
+ </xsd:element>
+ <xsd:element name="resheader">
+ <xsd:complexType>
+ <xsd:sequence>
+ <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+ </xsd:sequence>
+ <xsd:attribute name="name" type="xsd:string" use="required" />
+ </xsd:complexType>
+ </xsd:element>
+ </xsd:choice>
+ </xsd:complexType>
+ </xsd:element>
+ </xsd:schema>
+ <resheader name="resmimetype">
+ <value>text/microsoft-resx</value>
+ </resheader>
+ <resheader name="version">
+ <value>1.3</value>
+ </resheader>
+ <resheader name="reader">
+ <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+ </resheader>
+ <resheader name="writer">
+ <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+ </resheader>
+ <data name="MessageResource1">
+ <value>Message from resources with arg '{0}'</value>
+ </data>
+</root>
//
// Author:
// Marek Sieradzki (marek.sieradzki@gmail.com)
+// Ankit Jain (ankit.jain@xamarin.com)
//
// (C) 2005 Marek Sieradzki
+// (C) 2016 Xamarin, Inc. (http://www.xamarin.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
using System;
using System.Collections;
+using System.Reflection;
+using System.Resources;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
+using Microsoft.Build.BuildEngine;
using NUnit.Framework;
+using MonoTests.Microsoft.Build.Tasks;
namespace MonoTests.Microsoft.Build.Utilities {
class TestTask : Task {
+ public static Action<TaskLoggingHelper> action = null;
+
+ public TestTask ()
+ : base (new ResourceManager("Strings", typeof(TestTask).GetTypeInfo().Assembly))
+ {
+ }
+
public override bool Execute ()
{
+ action (Log);
return true;
}
}
TaskLoggingHelper tlh;
TestTask task;
+
+ public TaskLoggingHelperTest ()
+ {
+ task = new TestTask ();
+ }
[Test]
public void TestAssignment ()
string output;
tlh.ExtractMessageCode (null, out output);
}
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogErrorFromResourcesNullMessage ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogErrorFromResources (null);
+ }
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogErrorFromResourcesNullMessage2 ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogErrorFromResources (null, null, null, null, 0, 0, 0, 0, null);
+ }
+
+ [Test]
+ public void TestLogErrorFromResources1 ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogErrorFromResources ("MessageResource1", "foo"),
+ (l) => Assert.IsTrue (l.CheckFullLog ("Message from resources with arg 'foo'") == 0, "Message not found")
+ );
+ }
+
+ [Test]
+ public void TestLogErrorFromResourcesNonExistantResourceName ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogErrorFromResources ("NonExistantResourceName", "foo"),
+ null,
+ (p, l) => {
+ Assert.IsFalse (p.Build (), "Build should have failed");
+ Assert.IsTrue (l.CheckFullLog (
+ "Error executing task TestTask: No resource string found for resource named NonExistantResourceName") == 0,
+ "Error not found in the log");
+ }
+ );
+ }
+
+
+ [Test]
+ public void TestLogErrorFromResourcesNullSubcategoryResourceName ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogErrorFromResources (null, null, null, null, 0, 0, 0, 0, "MessageResource1", "foo"),
+ (l) => Assert.IsTrue (l.CheckFullLog ("Message from resources with arg 'foo'") == 0, "Message not found")
+ );
+ }
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogWarningFromResourcesNullMessage ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogWarningFromResources (null);
+ }
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogWarningFromResourcesNullMessage2 ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogWarningFromResources (null, null, null, null, 0, 0, 0, 0, null);
+ }
+
+ [Test]
+ public void TestLogWarningFromResourcesNullSubcategoryResourceName ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogWarningFromResources (null, null, null, null, 0, 0, 0, 0, "MessageResource1", "foo"),
+ (l) => Assert.IsTrue (l.CheckFullLog ("Message from resources with arg 'foo'") == 0, "Message not found")
+ );
+ }
+
+ [Test]
+ public void TestLogWarningFromResources1 ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogWarningFromResources ("MessageResource1", "foo"),
+ (l) => Assert.IsTrue (l.CheckFullLog ("Message from resources with arg 'foo'") == 0, "Message not found")
+ );
+ }
+
+ [Test]
+ public void TestLogWarningFromResourcesNonExistantResourceName ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogWarningFromResources ("NonExistantResourceName", "foo"),
+ null,
+ (p, l) => {
+ if (p.Build ()) { l.DumpMessages (); Assert.Fail ("Build should have failed"); }
+ Assert.IsTrue (l.CheckFullLog (
+ "Error executing task TestTask: No resource string found for resource named NonExistantResourceName") == 0,
+ "Error not found in the log");
+ }
+ );
+ }
+
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogMessageFromResourcesNullMessage ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogMessageFromResources (null);
+ }
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestLogMessageFromResourcesNullMessage2 ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.LogMessageFromResources (MessageImportance.Low, null);
+ }
+
+ [Test]
+ public void TestLogMessageFromResources1 ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogMessageFromResources ("MessageResource1", "foo"),
+ (l) => Assert.IsTrue (l.CheckFullLog ("Message from resources with arg 'foo'") == 0, "Message not found")
+ );
+ }
+
+ [Test]
+ public void TestLogMessageFromResourcesNonExistantResourceName ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.LogMessageFromResources ("NonExistantResourceName", "foo"),
+ null,
+ (p, l) => {
+ if (p.Build ()) { l.DumpMessages (); Assert.Fail ("Build should have failed"); }
+ l.DumpMessages ();
+ Assert.IsTrue (l.CheckFullLog (
+ "Error executing task TestTask: No resource string found for resource named NonExistantResourceName") == 0,
+ "Error not found in the log");
+ }
+ );
+ }
+
+ [Test]
+ [ExpectedException (typeof (ArgumentNullException))]
+ public void TestFormatResourceString1 ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.FormatResourceString (null);
+ }
+
+ [Test]
+ [ExpectedException (typeof (InvalidOperationException))]
+ public void TestFormatResourceString2 ()
+ {
+ tlh = new TaskLoggingHelper (task);
+ tlh.FormatResourceString ("MessageResource1");
+ }
+
+ [Test]
+ public void TestFormatResourceString3 ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => tlh.FormatResourceString ("NonExistantResourceName"),
+ null,
+ (p, l) => {
+ if (p.Build ()) { l.DumpMessages (); Assert.Fail ("Build should have failed"); }
+ l.DumpMessages ();
+ Assert.IsTrue (l.CheckFullLog (
+ "Error executing task TestTask: No resource string found for resource named NonExistantResourceName") == 0,
+ "Error not found in the log");
+ }
+ );
+ }
+
+ [Test]
+ public void TestFormatResourceString4 ()
+ {
+ RunAndCheckTaskLoggingHelper (
+ (tlh) => Assert.AreEqual (
+ tlh.FormatResourceString ("MessageResource1", "foo"),
+ "Message from resources with arg 'foo'"),
+ null
+ );
+ }
+ void RunAndCheckTaskLoggingHelper (Action<TaskLoggingHelper> taskAction, Action<TestMessageLogger> loggerAction, Action<Project, TestMessageLogger> projectBuildAction = null)
+ {
+ string asmLocation = typeof (TaskLoggingHelperTest).Assembly.Location;
+ string project_xml = @"<Project xmlns=""http://schemas.microsoft.com/developer/msbuild/2003"">
+ <UsingTask TaskName='MonoTests.Microsoft.Build.Utilities.TestTask' AssemblyFile='" + asmLocation + @"' />
+ <Target Name=""1"">
+ <TestTask />
+ </Target>
+ </Project>";
+
+ Engine engine = new Engine (Consts.BinPath);
+ Project proj = engine.CreateNewProject ();
+ proj.LoadXml (project_xml);
+ TestMessageLogger logger = new TestMessageLogger ();
+ engine.RegisterLogger (logger);
+
+ TestTask.action = taskAction;
+
+ if (projectBuildAction == null) {
+ if (!proj.Build ("1")) {
+ logger.DumpMessages ();
+ Assert.Fail ("Build failed");
+ }
+ } else
+ projectBuildAction (proj, logger);
+
+ if (loggerAction != null)
+ loggerAction (logger);
+ }
}
-
}
projects / mono.git / commitdiff