Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Do not merge] Enable razor in nuget and Sonarlint #8660

Closed
wants to merge 6 commits into from
Closed

[Do not merge] Enable razor in nuget and Sonarlint #8660

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f8fe4c3
Enable razor in nuget and Sonarlint
andrei-epure-sonarsource Jan 31, 2024
33ca85d
add test
andrei-epure-sonarsource Jan 31, 2024
80deb0f
Enable razor analysis in SonarReportingContextBase
andrei-epure-sonarsource Feb 7, 2024
28dde55
Update regular expression
andrei-epure-sonarsource Feb 7, 2024
6b545d2
Debug and don't map locations
andrei-epure-sonarsource Feb 7, 2024
67fc1da
disable debugger, add whitelsit
andrei-epure-sonarsource Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ public void RegisterNodeAction<TSyntaxKind>(GeneratedCodeRecognizer generatedCod
public void RegisterNodeActionInAllFiles<TSyntaxKind>(Action<SonarSyntaxNodeReportingContext> action, params TSyntaxKind[] syntaxKinds) where TSyntaxKind : struct =>
analysisContext.RegisterSyntaxNodeAction(c => action(new(this, c)), syntaxKinds);

// This function will always return true for non-Razor files.
// Otherwise, it returns true if the rule is not noisy on Razor files and not a test-only rule.
internal bool ShouldAnalyzeRazorFile(SyntaxTree sourceTree) =>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name is quite counter intuitive

!GeneratedCodeRecognizer.IsRazorGeneratedFile(sourceTree)
|| !SupportedDiagnostics.Any(x => (x.CustomTags.Count() == 1 && x.CustomTags.Contains(DiagnosticDescriptorFactory.TestSourceScopeTag))
Expand Down
3 changes: 1 addition & 2 deletions analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ public SonarLintXmlReader SonarLintXml()
}

public bool IsRazorAnalysisEnabled() =>
ProjectConfiguration().ProjectType != ProjectType.Unknown
&& SonarLintXml().AnalyzeRazorCode(Compilation.Language);
SonarLintXml().AnalyzeRazorCode(Compilation.Language);

public bool IsTestProject()
{
Expand Down
18 changes: 12 additions & 6 deletions analyzers/src/SonarAnalyzer.Common/Helpers/GeneratedCodeRecognizer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
*/

using System.IO;
using System.Text.RegularExpressions;

namespace SonarAnalyzer.Helpers
{
Expand Down Expand Up @@ -61,15 +62,20 @@ public abstract class GeneratedCodeRecognizer
public static bool IsRazorGeneratedFile(SyntaxTree tree) =>
tree is not null && (IsRazor(tree) || IsCshtml(tree));

// match also ViewContact.razor.hyYZFFeGwGnGotaj.ide.g.cs
// but it can also be just ViewContact.razor.ide.g.cs
static Regex regex = new Regex(".*razor(\\.[a-zA-Z0-9]*)?(\\.ide)?\\.g\\.cs$", RegexOptions.Compiled | RegexOptions.IgnoreCase);

public static bool IsRazor(SyntaxTree tree) =>
// razor.ide.g.cs is the extension for razor-generated files in the context of design-time builds.
// However, it is not considered here because of https://github.com/dotnet/razor/issues/9108
tree.FilePath.EndsWith("razor.g.cs", StringComparison.OrdinalIgnoreCase);
regex.IsMatch(tree.FilePath);
// tree.FilePath.EndsWith("razor.g.cs", StringComparison.OrdinalIgnoreCase)
// || tree.FilePath.EndsWith("razor.ide.g.cs", StringComparison.OrdinalIgnoreCase);

// FIXME how can I test if the new behavior for CSHTML is the same with Razor
// ViewContact.cshtml.hyYZFFeGwGnGotaj.ide.g.cs
public static bool IsCshtml(SyntaxTree tree) =>
// cshtml.ide.g.cs is the extension for razor-generated files in the context of design-time builds.
// However, it is not considered here because of https://github.com/dotnet/razor/issues/9108
tree.FilePath.EndsWith("cshtml.g.cs", StringComparison.OrdinalIgnoreCase);
tree.FilePath.EndsWith("cshtml.g.cs", StringComparison.OrdinalIgnoreCase)
|| tree.FilePath.EndsWith("cshtml.ide.g.cs", StringComparison.OrdinalIgnoreCase);

private bool HasGeneratedCommentOrAttribute(SyntaxTree tree)
{
Expand Down
4 changes: 2 additions & 2 deletions analyzers/tests/SonarAnalyzer.Test/Helpers/GeneratedCodeRecognizerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ public void IsGenerated_NonGeneratedPath_ReturnsTrue()
[DataRow("C:\\SonarSource\\SomeFile_razor.g.cs")]
[DataRow("C:\\SonarSource\\SomeFile_cshtml.g.cs")]
[DataRow("C:\\SonarSource\\SomeFile_RAZOR.g.cS")]
[DataRow("C:\\SonarSource\\SomeFile_razor.ide.g.cs")]
[DataRow("C:\\SonarSource\\SomeFile_cshtml.ide.g.cs")]
public void IsRazorGeneratedFile_RazorGeneratedFiles_ReturnsTrue(string path)
{
// GetRoot() cannot be mocked - not virtual, so we use Loose behaviour to return null Root
Expand All @@ -77,8 +79,6 @@ public void IsRazorGeneratedFile_RazorGeneratedFiles_ReturnsTrue(string path)
[DataRow("C:\\SonarSource\\SomeFile_razor.g.cs.randomEnding")]
[DataRow("C:\\SonarSource\\SomeFile_cshtml.g.cs.randomEnding")]
[DataRow("C:\\SonarSource\\SomeFile_razor.g.ß")]
[DataRow("C:\\SonarSource\\SomeFile_razor.ide.g.cs")] // Not considered razor file because of https://github.com/dotnet/razor/issues/9108
[DataRow("C:\\SonarSource\\SomeFile_cshtml.ide.g.cs")] // Not considered razor file because of https://github.com/dotnet/razor/issues/9108
public void IsRazorGeneratedFile_NonRazorGeneratedFiles_ReturnsFalse(string path)
{
var syntaxTree = new Mock<SyntaxTree>(MockBehavior.Loose);
Expand Down
4 changes: 2 additions & 2 deletions analyzers/tests/SonarAnalyzer.TestFramework.Test/Verification/VerifierTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,11 +182,11 @@ public class Sample
[DataTestMethod]
[DataRow("Dummy.razor")]
[DataRow("Dummy.cshtml")]
public void Verify_RazorAnalysisInSLAndNugetContext_DoesNotRaise(string path) =>
public void Verify_RazorAnalysisInSLAndNugetContext(string path) =>
DummyWithLocation
.AddPaths(path)
.WithAdditionalFilePath(AnalysisScaffolding.CreateSonarProjectConfig(TestContext, ProjectType.Unknown))
.VerifyNoIssueReported();
.Verify();

[DataTestMethod]
[DataRow("net6.0")]
Expand Down