MSBuild:Как узнать количество вынесенных предупреждений?
-
02-07-2019 - |
Вопрос
Существует сценарий MSBuild, который включает количество проектов Delphi и C#, модульных тестов и т. д.
Проблема в:как отметить неудачную сборку, если были выданы предупреждения (в целях тестирования, а не для выпускных сборок)?Использование LogError вместо LogWarning в пользовательских задачах кажется не очень хорошим вариантом, поскольку сборка должна тестировать столько, сколько возможно (до реальной ошибки), чтобы сообщать как можно больше предупреждений за раз (проект сборки используется в CruiseControl.NET). ).
Возможно, решение состоит в том, чтобы создать свой собственный регистратор, который будет хранить внутри себя флаг предупреждений, но я не могу найти способ прочитать этот флаг в конце сборки?
P.S.Нет никаких проблем, чтобы завершить сборку сразу же после получения предупреждения (выходные данные компилятора Delphi обрабатываются специальной задачей, а для C# можно использовать /warnaserror), но желательное поведение — «построить все;собрать все предупреждения;сбой сборки», чтобы сообщать обо всех предупреждениях, а не только о первом.
П.П.С.Поскольку мне действительно нужно не количество предупреждений, а просто флаг их наличия, я решил упростить механизм сигнализации и вместо разделяемой памяти использовать банальный Mutex.Код ниже:
using System;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using System.Threading;
namespace Intrahealth.Build.WarningLogger
{
public sealed class WarningLoggerCheck : Task
{
public override bool Execute()
{
Log.LogMessage("WarningLoggerCheck:" + mutexName + "...");
result = false;
Mutex m = null;
try
{
m = Mutex.OpenExisting(mutexName);
}
catch (WaitHandleCannotBeOpenedException)
{
result = true;
}
catch (Exception)
{
}
if (result)
Log.LogMessage("WarningLoggerCheck PASSED");
else
Log.LogError("Build log contains warnings. Build is FAILED");
return result;
}
private bool result = true;
[Output]
public bool Result
{
get { return result; }
}
private string mutexName = "WarningLoggerMutex";
public string MutexName
{
get { return mutexName; }
set { mutexName = value ?? "WarningLoggerMutex"; }
}
}
public class WarningLogger : Logger
{
internal static int warningsCount = 0;
private string mutexName = String.Empty;
private Mutex mutex = null;
public override void Initialize(IEventSource eventSource)
{
eventSource.WarningRaised += new BuildWarningEventHandler(eventSource_WarningRaised);
}
private void SetMutex()
{
if (mutexName == String.Empty)
{
mutexName = "WarningLoggerMutex";
if (this.Parameters != null && this.Parameters != String.Empty)
{
mutexName = this.Parameters;
}
}
mutex = new Mutex(false, mutexName);
}
void eventSource_WarningRaised(object sender, BuildWarningEventArgs e)
{
if (e.Message != null && e.Message.Contains("MSB3146"))
return;
if (e.Code != null && e.Code.Equals("MSB3146"))
return;
if (warningsCount == 0)
SetMutex();
warningsCount++;
}
}
}
Решение
AFAIK MSBuild не имеет встроенной поддержки для получения количества предупреждений в заданной точке сценария сборки.Однако вы можете выполнить следующие шаги для достижения этой цели:
- Создайте собственный регистратор, который прослушивает события предупреждения и подсчитывает количество предупреждений.
- Создайте пользовательскую задачу, предоставляющую свойство [Output] WarningCount.
- Пользовательская задача каким-то образом получает значение счетчика предупреждений из пользовательского журнала.
Самый сложный шаг – это шаг 3.Для этого есть несколько вариантов, и вы можете свободно искать их в разделе IPC — Inter Process Communication.Далее следует рабочий пример того, как этого можно добиться.Каждый предмет отличается Библиотека классов.
Общая память
http://weblogs.asp.net/rosherove/archive/2003/05/01/6295.aspx
Я создал обертку для названной общей памяти, которая была частью более крупного проекта.Это в основном позволяет хранить сериализованные типы и графики объектов и извлекать из общей памяти (в том числе, как и следовало ожидать перекрестного процесса).Будет ли когда-либо завершен более крупный проект-это еще один вопрос ;-).
Сэмпллогер
Реализует специальный регистратор, который отслеживает количество предупреждений.
namespace SampleLogger
{
using System;
using Microsoft.Build.Utilities;
using Microsoft.Build.Framework;
using DM.SharedMemory;
public class MySimpleLogger : Logger
{
private Segment s;
private int warningCount;
public override void Initialize(IEventSource eventSource)
{
eventSource.WarningRaised += new BuildWarningEventHandler(eventSource_WarningRaised);
this.s = new Segment("MSBuildMetadata", SharedMemoryCreationFlag.Create, 65535);
this.s.SetData(this.warningCount.ToString());
}
void eventSource_WarningRaised(object sender, BuildWarningEventArgs e)
{
this.warningCount++;
this.s.SetData(this.warningCount.ToString());
}
public override void Shutdown()
{
this.s.Dispose();
base.Shutdown();
}
}
}
Примеры задач
Реализует пользовательскую задачу, считывающую количество предупреждений, выданных в проекте MSbuild.Пользовательская задача считывает данные из общей памяти, записанной пользовательским регистратором, реализованным в библиотеке классов. Сэмпллогер.
namespace SampleTasks
{
using System;
using Microsoft.Build.Utilities;
using Microsoft.Build.Framework;
using DM.SharedMemory;
public class BuildMetadata : Task
{
public int warningCount;
[Output]
public int WarningCount
{
get
{
Segment s = new Segment("MSBuildMetadata", SharedMemoryCreationFlag.Attach, 0);
int warningCount = Int32.Parse(s.GetData() as string);
return warningCount;
}
}
public override bool Execute()
{
return true;
}
}
}
Собираюсь покататься.
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003" DefaultTargets="Main">
<UsingTask TaskName="BuildMetadata" AssemblyFile="F:\temp\SampleLogger\bin\debug\SampleTasks.dll" />
<Target Name="Main">
<Warning Text="Sample warning #1" />
<Warning Text="Sample warning #2" />
<BuildMetadata>
<Output
TaskParameter="WarningCount"
PropertyName="WarningCount" />
</BuildMetadata>
<Error Text="A total of $(WarningCount) warning(s) were raised." Condition="$(WarningCount) > 0" />
</Target>
</Project>
Если вы запустите следующую команду:
c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\MSBuild test.xml /logger:SampleLogger.dll
Это будет результат:
Microsoft (R) Build Engine Version 2.0.50727.3053
[Microsoft .NET Framework, Version 2.0.50727.3053]
Copyright (C) Microsoft Corporation 2005. All rights reserved.
Build started 30-09-2008 13:04:39.
__________________________________________________
Project "F:\temp\SampleLogger\bin\debug\test.xml" (default targets):
Target Main:
F:\temp\SampleLogger\bin\debug\test.xml : warning : Sample warning #1
F:\temp\SampleLogger\bin\debug\test.xml : warning : Sample warning #2
F:\temp\SampleLogger\bin\debug\test.xml(15,3): error : A total of 2 warning(s) were raised.
Done building target "Main" in project "test.xml" -- FAILED.
Done building project "test.xml" -- FAILED.
Build FAILED.
F:\temp\SampleLogger\bin\debug\test.xml : warning : Sample warning #1
F:\temp\SampleLogger\bin\debug\test.xml : warning : Sample warning #2
F:\temp\SampleLogger\bin\debug\test.xml(15,3): error : A total of 2 warning(s) were raised.
2 Warning(s)
1 Error(s)
Time Elapsed 00:00:00.01
Другие советы
Компилятор C# (csc.exe) имеет переключатель /warnaserror, который будет рассматривать предупреждения как ошибки и завершать сборку не будет.Это также доступно в качестве параметра в файле .csproj.Я предполагаю, что у Delphi есть аналогичная способность.
msbuild.exe %~nx1 /t:Rebuild /p:Configuration=Release >> %MrB-BUILDLOG%
findstr /r /c:"[1-9][0-9]* Error(s)" >> %MrB-BUILDLOG%
if not errorlevel 1 (
echo ERROR: sending notification email for build errors in '%~nx1'. >> %MrB-BUILDLOG%
) else (
findstr /r /c:"[1-9][0-9]* Warning(s)" >> %MrB-BUILDLOG%
if not errorlevel 1 (
echo ERROR: sending notification email for build warnings in '%~nx1'. >>
%Mrb-buildlog%) иначе (Echo успешное строительство «%~ nx1».>> % mrb-buildlog %))