/// <summary>
/// Executes the task.
/// </summary>
/// <returns>true if successful</returns>
public override bool Execute()
{
string errorCode = null;
LogMessageLevel errorLevel = FailOnError ? LogMessageLevel.Error : LogMessageLevel.Warning;
AssemblyInfoData asmInfo = default;
string assemblyInfoPath = null;
AssemblyVersion = MessageCodes.ErrorString;
if (this.BuildEngine != null)
{
Logger = new LogWrapper(Log, GetType().Name);
}
else
{
Logger = new MockTaskLogger(GetType().Name);
}
try
{
string assemblyFileMsg = "";
if (string.IsNullOrWhiteSpace(AssemblyInfoPath))
{
assemblyInfoPath = Path.Combine("Properties", "AssemblyInfo.cs");
}
else
{
assemblyInfoPath = AssemblyInfoPath;
}
try
{
asmInfo = ParseAssembly(assemblyInfoPath, FailOnError);
AssemblyVersion = asmInfo.AssemblyVersion;
}
catch (FileNotFoundException ex)
{
if (FailOnError)
{
errorCode = MessageCodes.GetAssemblyInfo.AssemblyInfoNotFound;
throw;
}
else
{
Logger.LogError(ex.Message);
}
}
assemblyFileMsg = " in " + assemblyInfoPath;
if (AssemblyVersion == null || AssemblyVersion == ErrorString || AssemblyVersion.Length == 0)
{
Logger.LogError("AssemblyVersion could not be determined.");
return(false);
}
return(true);
}
catch (ParsingException ex)
{
if (string.IsNullOrEmpty(errorCode))
{
errorCode = MessageCodes.GetAssemblyInfo.GeneralFailure;
}
if (BuildEngine != null)
{
int line = BuildEngine.LineNumberOfTaskNode;
int column = BuildEngine.ColumnNumberOfTaskNode;
Logger.LogError(null, errorCode, null, BuildEngine.ProjectFileOfTaskNode, line, column, line, column, ex.Message);
}
else
{
Logger.LogError(null, errorCode, null, null, ex.LineNumber, ex.ColumnNumber, ex.EndLineNumber, ex.EndColumnNumber, ex.Message);
}
return(false);
}
catch (Exception ex)
{
if (string.IsNullOrEmpty(errorCode))
{
errorCode = MessageCodes.GetAssemblyInfo.GeneralFailure;
}
if (BuildEngine != null)
{
int line = BuildEngine.LineNumberOfTaskNode;
int column = BuildEngine.ColumnNumberOfTaskNode;
Logger.LogError(null, errorCode, null, BuildEngine.ProjectFileOfTaskNode, line, column, line, column, ex.Message);
}
else
{
Logger.LogError(null, errorCode, null, null, 0, 0, 0, 0, $"{ex.Message}");
}
return(false);
}
}
/// <summary>
/// Executes the task.
/// </summary>
/// <returns>true if successful</returns>
public override bool Execute()
{
string errorCode = null;
LogMessageLevel errorLevel = ErrorOnMismatch ? LogMessageLevel.Error : LogMessageLevel.Warning;
AssemblyInfoData asmInfo = default;
string assemblyInfoPath = null;
if (this.BuildEngine != null)
{
Logger = new LogWrapper(Log, GetType().Name);
}
else
{
Logger = new MockTaskLogger(GetType().Name);
}
try
{
if (!Util.MatchVersions(AssemblyVersion, PluginVersion))
{
Logger.Log(null, MessageCodes.CompareVersions.VersionMismatch, "",
assemblyInfoPath, asmInfo.AssemblyVersionPosition, errorLevel,
"PluginVersion {0} does not match AssemblyVersion {1}.", PluginVersion,
AssemblyVersion);
if (ErrorOnMismatch)
{
return(false);
}
}
return(true);
}
catch (VersionMatchException ex)
{
if (BuildEngine != null)
{
int line = BuildEngine.LineNumberOfTaskNode;
int column = BuildEngine.ColumnNumberOfTaskNode;
Logger.LogError(null, MessageCodes.CompareVersions.InvalidVersion, null, BuildEngine.ProjectFileOfTaskNode, line, column, line, column, ex.Message);
}
else
{
Logger.LogError(null, MessageCodes.CompareVersions.InvalidVersion, null, null, 0, 0, 0, 0, ex.Message);
}
return(false);
}
catch (ParsingException ex)
{
if (string.IsNullOrEmpty(errorCode))
{
errorCode = MessageCodes.CompareVersions.GeneralFailure;
}
if (BuildEngine != null)
{
int line = BuildEngine.LineNumberOfTaskNode;
int column = BuildEngine.ColumnNumberOfTaskNode;
Logger.LogError(null, errorCode, null, BuildEngine.ProjectFileOfTaskNode, line, column, line, column, ex.Message);
}
else
{
Logger.LogError(null, errorCode, null, null, ex.LineNumber, ex.ColumnNumber, ex.EndLineNumber, ex.EndColumnNumber, ex.Message);
}
return(false);
}
catch (Exception ex)
{
if (string.IsNullOrEmpty(errorCode))
{
errorCode = MessageCodes.CompareVersions.GeneralFailure;
}
if (BuildEngine != null)
{
int line = BuildEngine.LineNumberOfTaskNode;
int column = BuildEngine.ColumnNumberOfTaskNode;
Logger.LogError(null, errorCode, null, BuildEngine.ProjectFileOfTaskNode, line, column, line, column, $"Error in {GetType().Name}: {ex.Message}");
}
else
{
Logger.LogError(null, errorCode, null, null, 0, 0, 0, 0, $"Error in {GetType().Name}: {ex.Message}");
}
return(false);
}
}
/// <summary>
/// Parses the assembly version from the given file.
/// </summary>
/// <param name="assemblyFile"></param>
/// <param name="errorOnMismatch"></param>
/// <returns></returns>
public AssemblyInfoData ParseAssembly(string assemblyFile, bool errorOnMismatch)
{
string assemblyVersionStart = "[assembly: AssemblyVersion";
string assemblyFileVersionStart = "[assembly: AssemblyFileVersion";
string assemblyVersionString = null;
string assemblyFileVersionString = null;
int asmVerLineNum = 0;
int asmFileVerLineNum = 0;
int asmVerStartColumn;
int asmVerEndColumn;
int asmFileVerStartColumn;
int asmFileVerEndColumn;
FilePosition asmVerPosition = default;
FilePosition asmFileVerPosition = default;
string line;
int currentLine = 1;
string assemblyVersion = null;
string assemblyFileVersion = null;
if (!File.Exists(assemblyFile))
{
throw new FileNotFoundException("Could not find AssemblyInfo: " + assemblyFile);
}
using (StreamReader assemblyStream = new StreamReader(assemblyFile))
{
while ((line = assemblyStream.ReadLine()) != null)
{
if (line.Trim().StartsWith(assemblyVersionStart))
{
assemblyVersionString = line;
asmVerLineNum = currentLine;
}
if (line.Trim().StartsWith(assemblyFileVersionStart))
{
assemblyFileVersionString = line;
asmFileVerLineNum = currentLine;
}
currentLine++;
}
}
if (!string.IsNullOrEmpty(assemblyVersionString))
{
asmVerStartColumn = assemblyVersionString.IndexOf('"') + 1;
asmVerEndColumn = assemblyVersionString.LastIndexOf('"');
asmVerPosition = new FilePosition(asmVerLineNum, asmVerStartColumn + 1, asmVerEndColumn + 1);
if (asmVerStartColumn > 0 && asmVerEndColumn > 0)
{
assemblyVersion = assemblyVersionString.Substring(asmVerStartColumn, asmVerEndColumn - asmVerStartColumn);
}
}
else
{
if (FailOnError)
{
throw new ParsingException(null, MessageCodes.GetAssemblyInfo.AssemblyFileVersionParseFail,
"", assemblyFile, 0, 0, 0, 0, "Unable to parse the AssemblyVersion from {0}", assemblyFile);
}
Logger.LogWarning(null, MessageCodes.GetAssemblyInfo.AssemblyFileVersionParseFail,
"", assemblyFile, 0, 0, 0, 0, "Unable to parse the AssemblyVersion from {0}", assemblyFile);
return(AssemblyInfoData.AssemblyVersionError());
}
if (!string.IsNullOrEmpty(assemblyFileVersionString))
{
asmFileVerStartColumn = assemblyFileVersionString.IndexOf('"') + 1;
asmFileVerEndColumn = assemblyFileVersionString.LastIndexOf('"');
int lenth = asmFileVerEndColumn - asmFileVerStartColumn;
if (asmFileVerStartColumn > 0 && asmFileVerEndColumn > 0 && lenth > 0)
{
assemblyFileVersion = assemblyFileVersionString.Substring(asmFileVerStartColumn, asmFileVerEndColumn - asmFileVerStartColumn);
if (assemblyVersion != assemblyFileVersion)
{
string message = "AssemblyVersion {0} does not match AssemblyFileVersion {1} in {2}";
if (errorOnMismatch)
{
throw new ParsingException(null, MessageCodes.GetAssemblyInfo.AssemblyVersionMismatch,
"", assemblyFile, asmFileVerLineNum, asmFileVerStartColumn + 1, asmFileVerLineNum,
asmFileVerEndColumn + 1, message, assemblyVersion, assemblyFileVersion, assemblyFile);
}
Logger.LogWarning(null, MessageCodes.GetAssemblyInfo.AssemblyVersionMismatch,
"", assemblyFile, asmFileVerLineNum, asmFileVerStartColumn + 1, asmFileVerLineNum,
asmFileVerEndColumn + 1, message, assemblyVersion, assemblyFileVersion, assemblyFile);
}
}
else
{
asmFileVerStartColumn = Math.Max(0, asmFileVerStartColumn);
asmFileVerEndColumn = asmFileVerStartColumn;
string message = "Unable to parse the AssemblyFileVersion from {0}";
if (errorOnMismatch)
{
throw new ParsingException(null, MessageCodes.GetAssemblyInfo.AssemblyFileVersionParseFail,
"", assemblyFile, asmFileVerLineNum, asmFileVerStartColumn,
asmFileVerLineNum, asmFileVerEndColumn, message, assemblyFile);
}
Logger.LogWarning(null, MessageCodes.GetAssemblyInfo.AssemblyFileVersionParseFail,
"", assemblyFile, asmFileVerLineNum, asmFileVerStartColumn, asmFileVerLineNum,
asmFileVerEndColumn, message, assemblyFile);
}
asmFileVerPosition = new FilePosition(asmFileVerLineNum, asmFileVerStartColumn, asmFileVerEndColumn);
}
return(new AssemblyInfoData(assemblyVersion, assemblyFileVersion, asmVerPosition, asmFileVerPosition));
}
