public void Configuration()
{
var conf = new Configuration(
$@"TestResources\{ParameterLoader.ParameterConfigurationFileName}",
Common.AnalyzerLanguage.CSharp);
conf.IgnoreHeaderComments.Should().BeTrue();
conf.Files.Should().BeEquivalentTo("TestResources\\TestInput.cs");
string[] expectedAnalyzerIds =
{
"S1121",
"S2306",
"S1227",
"S104",
"S1541",
"S103",
"S1479",
"S1067",
"S107",
"S101",
"S100",
"S1134",
"S1135"
};
conf.AnalyzerIds.Should().BeEquivalentTo(expectedAnalyzerIds);
var analyzers = conf.GetAnalyzers();
Assert.AreEqual(expectedAnalyzerIds.Length, analyzers.Count());
}
public IEnumerable <Diagnostic> GetDiagnostics(Compilation compilation)
{
var diagnosticAnalyzers = configuration.GetAnalyzers();
if (diagnosticAnalyzers.IsDefaultOrEmpty)
{
return(new Diagnostic[0]);
}
var compilationOptions = compilation.Language == LanguageNames.CSharp
? (CompilationOptions) new CS.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)
: new VB.VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary);
compilationOptions = compilationOptions.WithSpecificDiagnosticOptions(
diagnosticAnalyzers.SelectMany(analyzer => analyzer.SupportedDiagnostics)
.Select(diagnostic =>
new KeyValuePair <string, ReportDiagnostic>(diagnostic.Id, ReportDiagnostic.Warn)));
var modifiedCompilation = compilation.WithOptions(compilationOptions);
using (var tokenSource = new CancellationTokenSource())
{
var compilationWithAnalyzer = modifiedCompilation.WithAnalyzers(
diagnosticAnalyzers,
new AnalyzerOptions(ImmutableArray.Create <AdditionalText>(new AnalyzerAdditionalFile(configuration.Path))),
tokenSource.Token);
return(compilationWithAnalyzer.GetAnalyzerDiagnosticsAsync().Result);
}
}
public void Configuration()
{
var conf = new Configuration(XDocument.Load("TestResources\\ConfigurationTest.xml"), Common.AnalyzerLanguage.CSharp);
conf.IgnoreHeaderComments.Should().BeTrue();
conf.Files.Should().BeEquivalentTo("TestResources\\TestInput.cs");
conf.AnalyzerIds.Should().BeEquivalentTo(
"S1121",
"S2306",
"S1227",
"S104",
"S1541",
"S103",
"S1479",
"S1067",
"S107",
"S101",
"S100",
"S124");
var analyzers = conf.GetAnalyzers();
analyzers.OfType<FileLines>().Single().Maximum.ShouldBeEquivalentTo(1000);
analyzers.OfType<LineLength>().Single().Maximum.ShouldBeEquivalentTo(200);
analyzers.OfType<TooManyLabelsInSwitch>().Single().Maximum.ShouldBeEquivalentTo(30);
analyzers.OfType<TooManyParameters>().Single().Maximum.ShouldBeEquivalentTo(7);
analyzers.OfType<ExpressionComplexity>().Single().Maximum.ShouldBeEquivalentTo(3);
analyzers.OfType<FunctionComplexity>().Single().Maximum.ShouldBeEquivalentTo(10);
analyzers.OfType<ClassName>().Single().Convention.ShouldBeEquivalentTo("^(?:[A-HJ-Z][a-zA-Z0-9]+|I[a-z0-9][a-zA-Z0-9]*)$");
analyzers.OfType<MethodName>().Single().Convention.ShouldBeEquivalentTo("^[A-Z][a-zA-Z0-9]+$");
var commentAnalyzer = analyzers.OfType<CommentRegularExpression>().Single();
var ruleInstances = commentAnalyzer.RuleInstances.ToList();
ruleInstances.Should().HaveCount(2);
ruleInstances[0].Descriptor.Id.ShouldBeEquivalentTo("TODO");
ruleInstances[0].Descriptor.MessageFormat.ToString().ShouldBeEquivalentTo("Fix this TODO");
ruleInstances[0].RegularExpression.ShouldBeEquivalentTo(".*TODO.*");
ruleInstances[1].Descriptor.Id.ShouldBeEquivalentTo("FIXME");
ruleInstances[1].Descriptor.MessageFormat.ToString().ShouldBeEquivalentTo("Fix this FIXME");
ruleInstances[1].RegularExpression.ShouldBeEquivalentTo(".*FIXME.*");
}
public static int Main(string[] args)
{
var language = AnalyzerLanguage.Parse(args[2]);
Write($"SonarLint for Visual Studio version {typeof (Program).Assembly.GetName().Version}");
var configuration = new Configuration(XDocument.Load(args[0]), language);
var diagnosticsRunner = new DiagnosticsRunner(configuration.GetAnalyzers());
var xmlOutSettings = new XmlWriterSettings
{
Encoding = Encoding.UTF8,
Indent = true,
IndentChars = " "
};
using (var xmlOut = XmlWriter.Create(args[1], xmlOutSettings))
{
xmlOut.WriteComment("This XML format is not an API");
xmlOut.WriteStartElement("AnalysisOutput");
xmlOut.WriteStartElement("Files");
var n = 0;
foreach (var file in configuration.Files)
{
xmlOut.Flush();
Write(n + "/" + configuration.Files.Count() + " files analyzed, starting to analyze: " + file);
n++;
try
{
var solution = CompilationHelper.GetSolutionFromFiles(file, language);
var compilation = solution.Projects.First().GetCompilationAsync().Result;
var syntaxTree = compilation.SyntaxTrees.First();
var metrics = language == AnalyzerLanguage.CSharp
? (MetricsBase)new Common.CSharp.Metrics(syntaxTree)
: new Common.VisualBasic.Metrics(syntaxTree);
xmlOut.WriteStartElement("File");
xmlOut.WriteElementString("Path", file);
xmlOut.WriteStartElement("Metrics");
xmlOut.WriteElementString("Lines", metrics.GetLineCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Classes", metrics.GetClassCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Accessors", metrics.GetAccessorCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Statements", metrics.GetStatementCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Functions", metrics.GetFunctionCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("PublicApi", metrics.GetPublicApiCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("PublicUndocumentedApi", metrics.GetPublicUndocumentedApiCount().ToString(CultureInfo.InvariantCulture));
var complexity = metrics.GetComplexity();
xmlOut.WriteElementString("Complexity", complexity.ToString(CultureInfo.InvariantCulture));
// TODO This is a bit ridiculous, but is how SonarQube works
var fileComplexityDistribution = new Distribution(0, 5, 10, 20, 30, 60, 90);
fileComplexityDistribution.Add(complexity);
xmlOut.WriteElementString("FileComplexityDistribution", fileComplexityDistribution.ToString());
xmlOut.WriteElementString("FunctionComplexityDistribution", metrics.GetFunctionComplexityDistribution().ToString());
var comments = metrics.GetComments(configuration.IgnoreHeaderComments);
xmlOut.WriteStartElement("Comments");
xmlOut.WriteStartElement("NoSonar");
foreach (var line in comments.NoSonar)
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("NonBlank");
foreach (var line in comments.NonBlank)
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("LinesOfCode");
foreach (var line in metrics.GetLinesOfCode())
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("Issues");
foreach (var diagnostic in diagnosticsRunner.GetDiagnostics(compilation))
{
xmlOut.WriteStartElement("Issue");
xmlOut.WriteElementString("Id", diagnostic.Id);
if (diagnostic.Location != Location.None)
{
xmlOut.WriteElementString("Line", (diagnostic.GetLineNumberToReport()).ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteElementString("Message", diagnostic.GetMessage());
xmlOut.WriteEndElement();
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
}
catch (Exception e)
{
Console.Error.WriteLine("Failed to analyze the file: " + file);
Console.Error.WriteLine(e);
return 1;
}
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteEndDocument();
xmlOut.Flush();
return 0;
}
}
public static int Main(string[] args)
{
var language = AnalyzerLanguage.Parse(args[2]);
Write($"SonarLint for Visual Studio version {typeof (Program).Assembly.GetName().Version}");
var configuration = new Configuration(XDocument.Load(args[0]), language);
var diagnosticsRunner = new DiagnosticsRunner(configuration.GetAnalyzers());
var xmlOutSettings = new XmlWriterSettings
{
Encoding = Encoding.UTF8,
Indent = true,
IndentChars = " "
};
using (var xmlOut = XmlWriter.Create(args[1], xmlOutSettings))
{
xmlOut.WriteComment("This XML format is not an API");
xmlOut.WriteStartElement("AnalysisOutput");
xmlOut.WriteStartElement("Files");
var n = 0;
foreach (var file in configuration.Files)
{
xmlOut.Flush();
Write(n + "/" + configuration.Files.Count() + " files analyzed, starting to analyze: " + file);
n++;
try
{
var solution = CompilationHelper.GetSolutionFromFiles(file, language);
var compilation = solution.Projects.First().GetCompilationAsync().Result;
var syntaxTree = compilation.SyntaxTrees.First();
var metrics = language == AnalyzerLanguage.CSharp
? (MetricsBase) new Common.CSharp.Metrics(syntaxTree)
: new Common.VisualBasic.Metrics(syntaxTree);
xmlOut.WriteStartElement("File");
xmlOut.WriteElementString("Path", file);
xmlOut.WriteStartElement("Metrics");
xmlOut.WriteElementString("Lines", metrics.GetLineCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Classes", metrics.GetClassCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Accessors", metrics.GetAccessorCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Statements", metrics.GetStatementCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("Functions", metrics.GetFunctionCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("PublicApi", metrics.GetPublicApiCount().ToString(CultureInfo.InvariantCulture));
xmlOut.WriteElementString("PublicUndocumentedApi", metrics.GetPublicUndocumentedApiCount().ToString(CultureInfo.InvariantCulture));
var complexity = metrics.GetComplexity();
xmlOut.WriteElementString("Complexity", complexity.ToString(CultureInfo.InvariantCulture));
// TODO This is a bit ridiculous, but is how SonarQube works
var fileComplexityDistribution = new Distribution(0, 5, 10, 20, 30, 60, 90);
fileComplexityDistribution.Add(complexity);
xmlOut.WriteElementString("FileComplexityDistribution", fileComplexityDistribution.ToString());
xmlOut.WriteElementString("FunctionComplexityDistribution", metrics.GetFunctionComplexityDistribution().ToString());
var comments = metrics.GetComments(configuration.IgnoreHeaderComments);
xmlOut.WriteStartElement("Comments");
xmlOut.WriteStartElement("NoSonar");
foreach (var line in comments.NoSonar)
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("NonBlank");
foreach (var line in comments.NonBlank)
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("LinesOfCode");
foreach (var line in metrics.GetLinesOfCode())
{
xmlOut.WriteElementString("Line", line.ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteStartElement("Issues");
foreach (var diagnostic in diagnosticsRunner.GetDiagnostics(compilation))
{
xmlOut.WriteStartElement("Issue");
xmlOut.WriteElementString("Id", diagnostic.Id);
if (diagnostic.Location != Location.None)
{
xmlOut.WriteElementString("Line", (diagnostic.GetLineNumberToReport()).ToString(CultureInfo.InvariantCulture));
}
xmlOut.WriteElementString("Message", diagnostic.GetMessage());
xmlOut.WriteEndElement();
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
}
catch (Exception e)
{
Console.Error.WriteLine("Failed to analyze the file: " + file);
Console.Error.WriteLine(e);
return(1);
}
}
xmlOut.WriteEndElement();
xmlOut.WriteEndElement();
xmlOut.WriteEndDocument();
xmlOut.Flush();
return(0);
}
}
