/// <summary>
/// Make path relative to repository root.
/// </summary>
/// <param name="filePath">Full file path.</param>
/// <param name="repositorySettings">Repository settings.</param>
/// <returns>File path relative to the repository root.</returns>
protected string MakeFilePathRelativeToRepositoryRoot(string filePath, RepositorySettings repositorySettings)
{
filePath.NotNullOrWhiteSpace(nameof(filePath));
repositorySettings.NotNull(nameof(repositorySettings));
return(filePath.Substring(repositorySettings.RepositoryRoot.FullPath.Length));
}
/// <inheritdoc />
public override IEnumerable <IIssue> ReadIssues(
MarkdownlintIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MarkdownlintIssuesSettings markdownlintIssuesSettings)
{
issueProvider.NotNull(nameof(issueProvider));
repositorySettings.NotNull(nameof(repositorySettings));
markdownlintIssuesSettings.NotNull(nameof(markdownlintIssuesSettings));
var regex = new Regex(@"(.*): (\d*): (MD\d*)/((?:\w*-*/*)*) (.*)");
foreach (var line in markdownlintIssuesSettings.LogFileContent.ToStringUsingEncoding().Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None).ToList().Where(s => !string.IsNullOrEmpty(s)))
{
var groups = regex.Match(line).Groups;
// Read affected file from the line.
if (!this.TryGetFile(groups, repositorySettings, out string fileName))
{
continue;
}
var lineNumber = int.Parse(groups[2].Value);
var rule = groups[3].Value;
var ruleDescription = groups[5].Value;
yield return
(IssueBuilder
.NewIssue(ruleDescription, issueProvider)
.InFile(fileName, lineNumber)
.WithPriority(IssuePriority.Warning)
.OfRule(rule, MarkdownlintRuleUrlResolver.Instance.ResolveRuleUrl(rule))
.Create());
}
}
/// <inheritdoc/>
public override IEnumerable <IIssue> ReadIssues(
MsBuildIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MsBuildIssuesSettings issueProviderSettings)
{
#pragma warning disable SA1123 // Do not place regions within elements
#region DupFinder Exclusion
#pragma warning restore SA1123 // Do not place regions within elements
issueProvider.NotNull(nameof(issueProvider));
repositorySettings.NotNull(nameof(repositorySettings));
issueProviderSettings.NotNull(nameof(issueProviderSettings));
#endregion
var result = new List <IIssue>();
var binLogReader = new BinLogReader();
foreach (var record in binLogReader.ReadRecords(issueProviderSettings.LogFileContent))
{
var buildEventArgs = record.Args;
if (buildEventArgs is BuildWarningEventArgs buildWarning)
{
var projectFileRelativePath = this.GetProject(buildWarning, repositorySettings);
// Read affected file from the warning.
if (!this.TryGetFile(buildWarning, repositorySettings, out string fileName))
{
continue;
}
var line = GetLine(buildWarning);
var rule = buildWarning.Code;
// Determine rule URL.
Uri ruleUrl = null;
if (!string.IsNullOrWhiteSpace(rule))
{
ruleUrl = MsBuildRuleUrlResolver.Instance.ResolveRuleUrl(rule);
}
// Build issue.
result.Add(
IssueBuilder
.NewIssue(buildWarning.Message, issueProvider)
.WithPriority(IssuePriority.Warning)
.InProject(projectFileRelativePath, System.IO.Path.GetFileNameWithoutExtension(projectFileRelativePath))
.InFile(fileName, line)
.OfRule(rule, ruleUrl)
.Create());
}
}
return(result);
}
/// <summary>
/// Checks if a file is part of the repository.
/// </summary>
/// <param name="filePath">Full file path.</param>
/// <param name="repositorySettings">Repository settings.</param>
/// <returns>True if file is in repository, false otherwise.</returns>
protected bool CheckIfFileIsInRepository(string filePath, RepositorySettings repositorySettings)
{
filePath.NotNullOrWhiteSpace(nameof(filePath));
repositorySettings.NotNull(nameof(repositorySettings));
if (!filePath.IsSubpathOf(repositorySettings.RepositoryRoot.FullPath))
{
this.Log.Warning(
"Ignored issue for file '{0}' since it is outside the repository folder at {1}.",
filePath,
repositorySettings.RepositoryRoot);
return(false);
}
return(true);
}
/// <inheritdoc/>
public override IEnumerable <IIssue> ReadIssues(
RepositorySettings repositorySettings,
MsBuildIssuesSettings msBuildIssuesSettings)
{
repositorySettings.NotNull(nameof(repositorySettings));
msBuildIssuesSettings.NotNull(nameof(msBuildIssuesSettings));
var result = new List <IIssue>();
var logDocument = XDocument.Parse(msBuildIssuesSettings.LogFileContent);
// Loop through all warning tags.
foreach (var warning in logDocument.Descendants("warning"))
{
// Read affected file from the warning.
if (!this.TryGetFile(warning, repositorySettings, out string fileName))
{
continue;
}
// Read affected line from the warning.
if (!TryGetLine(warning, out var line))
{
continue;
}
// Read rule code from the warning.
if (!TryGetRule(warning, out string rule))
{
continue;
}
result.Add(new Issue <MsBuildIssuesProvider>(
fileName,
line,
warning.Value,
0,
rule,
MsBuildRuleUrlResolver.Instance.ResolveRuleUrl(rule)));
}
return(result);
}
/// <summary>
/// Validates a file path.
/// </summary>
/// <param name="filePath">Full file path.</param>
/// <param name="repositorySettings">Repository settings.</param>
/// <returns>Tuple containing a value if validation was successful, and file path relative to repository root.</returns>
protected (bool Valid, string FilePath) ValidateFilePath(string filePath, RepositorySettings repositorySettings)
{
filePath.NotNullOrWhiteSpace(nameof(filePath));
repositorySettings.NotNull(nameof(repositorySettings));
// Ignore files from outside the repository.
if (!this.CheckIfFileIsInRepository(filePath, repositorySettings))
{
return(false, string.Empty);
}
// Make path relative to repository root.
filePath = this.MakeFilePathRelativeToRepositoryRoot(filePath, repositorySettings);
// Remove leading directory separator.
filePath = this.RemoveLeadingDirectorySeparator(filePath);
return(true, filePath);
}
/// <inheritdoc />
public override IEnumerable <IIssue> ReadIssues(
MarkdownlintIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MarkdownlintIssuesSettings markdownlintIssuesSettings)
{
issueProvider.NotNull(nameof(issueProvider));
repositorySettings.NotNull(nameof(repositorySettings));
markdownlintIssuesSettings.NotNull(nameof(markdownlintIssuesSettings));
Dictionary <string, IEnumerable <Issue> > logFileEntries;
using (var ms = new MemoryStream(markdownlintIssuesSettings.LogFileContent.RemovePreamble()))
{
var jsonSerializer = new DataContractJsonSerializer(
typeof(Dictionary <string, IEnumerable <Issue> >),
settings: new DataContractJsonSerializerSettings {
UseSimpleDictionaryFormat = true
});
logFileEntries = jsonSerializer.ReadObject(ms) as Dictionary <string, IEnumerable <Issue> >;
}
return
(from file in logFileEntries
from entry in file.Value
let
rule = entry.ruleName
select
IssueBuilder
.NewIssue(entry.ruleDescription, issueProvider)
.InFile(file.Key, entry.lineNumber)
.WithPriority(IssuePriority.Warning)
.OfRule(rule, MarkdownlintRuleUrlResolver.Instance.ResolveRuleUrl(rule))
.Create());
}
/// <inheritdoc/>
public override IEnumerable <IIssue> ReadIssues(
MsBuildIssuesProvider issueProvider,
IssueCommentFormat format,
RepositorySettings repositorySettings,
MsBuildIssuesSettings issueProviderSettings)
{
#pragma warning disable SA1123 // Do not place regions within elements
#region DupFinder Exclusion
#pragma warning restore SA1123 // Do not place regions within elements
issueProvider.NotNull(nameof(issueProvider));
repositorySettings.NotNull(nameof(repositorySettings));
issueProviderSettings.NotNull(nameof(issueProviderSettings));
#endregion
var result = new List <IIssue>();
// Read log file.
var logDocument = XDocument.Parse(issueProviderSettings.LogFileContent.ToStringUsingEncoding(true));
// Loop through all warning tags.
foreach (var warning in logDocument.Descendants("warning"))
{
// Read affected project from the warning.
if (!this.TryGetProject(warning, repositorySettings, out string projectFileRelativePath))
{
continue;
}
// Read affected file from the warning.
if (!this.TryGetFile(warning, repositorySettings, out string fileName))
{
continue;
}
// Read affected line from the warning.
if (!TryGetLine(warning, out var line))
{
continue;
}
// Read rule code from the warning.
if (!TryGetRule(warning, out string rule))
{
continue;
}
// Determine rule URL.
Uri ruleUrl = null;
if (!string.IsNullOrWhiteSpace(rule))
{
ruleUrl = MsBuildRuleUrlResolver.Instance.ResolveRuleUrl(rule);
}
// Build issue.
result.Add(
IssueBuilder
.NewIssue(warning.Value, issueProvider)
.WithPriority(IssuePriority.Warning)
.InProject(projectFileRelativePath, System.IO.Path.GetFileNameWithoutExtension(projectFileRelativePath))
.InFile(fileName, line)
.OfRule(rule, ruleUrl)
.Create());
}
return(result);
}