SCAN4NET-171 Read new properties for downloading plugins #2294
+428
−39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hashicorp-vault-sonar-prod
bot
changed the title
alex-meseldzija-sonarsource
force-pushed
the
alex/SCAN4NET-171
branch
2 times, most recently
from
0e8ecff to
fdc4cef
Compare
pavel-mikula-sonarsource
requested changes
Jan 24, 2025
src/SonarScanner.MSBuild.PreProcessor/Interfaces/IAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
src/SonarScanner.MSBuild.PreProcessor/Roslyn/RoslynAnalyzerProvider.cs
Outdated
Show resolved
Hide resolved
alex-meseldzija-sonarsource
force-pushed
the
alex/SCAN4NET-171
branch
2 times, most recently
from
51fadff to
ad8f09f
Compare
alex-meseldzija-sonarsource
changed the base branch from
master
to
alex/refactor-fetch-analyzer-plugin
alex-meseldzija-sonarsource
force-pushed
the
alex/refactor-fetch-analyzer-plugin
branch
2 times, most recently
from
5fb0eda to
1e11364
Compare
alex-meseldzija-sonarsource
force-pushed
the
alex/SCAN4NET-171
branch
from
ad8f09f to
ac9dd05
Compare
alex-meseldzija-sonarsource
force-pushed
the
alex/refactor-fetch-analyzer-plugin
branch
from
1e11364 to
f4efaca
Compare
alex-meseldzija-sonarsource
force-pushed
the
alex/SCAN4NET-171
branch
2 times, most recently
from
98affdf to
f089335
Compare
Base automatically changed from
alex/refactor-fetch-analyzer-plugin
to
master
January 31, 2025 15:20
alex-meseldzija-sonarsource
force-pushed
the
alex/SCAN4NET-171
branch
from
f089335 to
80132ec
Compare
|
pavel-mikula-sonarsource
requested changes
Feb 3, 2025
| { | ||
| SuppliedPlugins.Should().NotBeEmpty("No plugins have been requested"); | ||
| var found = SuppliedPlugins.Any(x => string.Equals(key, x.Key, System.StringComparison.Ordinal)); | ||
| found.Should().BeTrue("Expected plugin was not requested. Id: {0}", key); | ||
| var suppliedPlugin = SuppliedPlugins.FirstOrDefault(x => string.Equals(plugin.Key, x.Key, System.StringComparison.Ordinal)); |
There was a problem hiding this comment.
To throw in case the expectation of having single with that key is broken
Suggested change
| var suppliedPlugin = SuppliedPlugins.FirstOrDefault(x => string.Equals(plugin.Key, x.Key, System.StringComparison.Ordinal)); | |
| var suppliedPlugin = SuppliedPlugins.SingleOrDefault(x => string.Equals(plugin.Key, x.Key, System.StringComparison.Ordinal)); |
| { | ||
| SuppliedPlugins.Should().NotBeEmpty("No plugins have been requested"); | ||
| var found = SuppliedPlugins.Any(x => string.Equals(key, x.Key, System.StringComparison.Ordinal)); | ||
| found.Should().BeTrue("Expected plugin was not requested. Id: {0}", key); | ||
| var suppliedPlugin = SuppliedPlugins.FirstOrDefault(x => string.Equals(plugin.Key, x.Key, System.StringComparison.Ordinal)); |
There was a problem hiding this comment.
What the Java?
Suggested change
| var suppliedPlugin = SuppliedPlugins.FirstOrDefault(x => string.Equals(plugin.Key, x.Key, System.StringComparison.Ordinal)); | |
| var suppliedPlugin = SuppliedPlugins.FirstOrDefault(x => plugin.Key = x.Key); |
| @@ -18,11 +18,6 @@ | |||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | |||
| */ | |||
|
|
|||
| using System; | |||
There was a problem hiding this comment.
Do you see why it's worth taking care of the project structure in general? :)
| private const string RoslynRepoPrefix = "roslyn."; | ||
| private const string ServerPropertyFormat = "sonar.{0}.analyzer"; | ||
| private const string RoslynRepoPrefix = "roslyn."; // Used for plugins generated by SonarQube Roslyn SDK, and legacy Sonar Security C# Frontend | ||
| private const string LegacySecurityFrontEndPropertyPrefix = "sonaranalyzer.security.cs"; // Should not be used and exists for backward compatibility with version <= 9.2 |
There was a problem hiding this comment.
The comment doesn't sound right on the Security front end. It's only used for deduplication, and it's not really needed for backward compatibility.
As this constant was not here before, I'd hardcode the value below where it's used.
| private const string ServerPropertyFormat = "sonar.{0}.analyzer"; | ||
| private const string RoslynRepoPrefix = "roslyn."; // Used for plugins generated by SonarQube Roslyn SDK, and legacy Sonar Security C# Frontend | ||
| private const string LegacySecurityFrontEndPropertyPrefix = "sonaranalyzer.security.cs"; // Should not be used and exists for backward compatibility with version <= 9.2 | ||
| private const string LegacyServerPropertyPrefix = "sonaranalyzer-"; // Should not be used and exists for backward compatibility with version <= 9.2. |
There was a problem hiding this comment.
What is version 9.2? Plugin? SonarQube? Scanner?
Plugin was < 10.4
SQ was < 10.8
Scanner is irrelevant
Suggested change
| private const string LegacyServerPropertyPrefix = "sonaranalyzer-"; // Should not be used and exists for backward compatibility with version <= 9.2. | |
| private const string LegacyServerPropertyPrefix = "sonaranalyzer-"; // Backward compatibility with ??? version <= 9.2. |
| } | ||
|
|
||
| [TestMethod] | ||
| public void RoslynConfig_ValidProfile_Security_Frontend() |
There was a problem hiding this comment.
I would not write 3 dedicated UT for security. Add the scaffolding to the existing UTs above
| } | ||
|
|
||
| [TestMethod] | ||
| public void RoslynConfig_IncompletePluginDoesNotPopulate() |
There was a problem hiding this comment.
Suggested change
| public void RoslynConfig_IncompletePluginDoesNotPopulate() | |
| public void RoslynConfig_IncompletePluginIgnored() |
| {"sonar.cs.analyzer.dotnet.staticResourceName", "SonarAnalyzer.zip"}, | ||
| }); | ||
| var context = new Context(TestContext, sonarProperties, [[@"c:\assembly1.dll"], [@"d:\foo\assembly2.dll"]]); | ||
| var expectedSonarLintXml = """ |
There was a problem hiding this comment.
What's the point of asserting this file in this UT? It seems immutable to the scaffolding
| {"sonar.cs.analyzer.security.pluginVersion", "1.13.0"}, | ||
| {"sonar.cs.analyzer.security.staticResourceName", "SecurityAnalyzer.zip"}, | ||
| {"sonaranalyzer.security.cs.analyzerId", "SonarAnalyzer.Security"}, | ||
| {"sonaranalyzer.security.cs.ruleNamespace", "SonarAnalyzer.Security"}, |
There was a problem hiding this comment.
ruleNamespace should not exist as part of the new properties
Comment on lines
+464
to
+467
| {"wintellect.pluginKey", "wintellect"}, | ||
| {"sonar.cs.analyzer.dotnet.analyzerId", "SonarAnalyzer.CSharp"}, | ||
| {"sonar.cs.analyzer.dotnet.ruleNamespace", "SonarAnalyzer.CSharp"}, | ||
| {"sonar.cs.analyzer.dotnet.staticResourceName", "SonarAnalyzer.zip"}, |
There was a problem hiding this comment.
What is this trying to say? That any missing property will be no-op? It's bit hard to see. We should make that more explicit. Something like this:
{"sonar.cs.analyzer.security.missing-pluginKey", "securitycsharpfrontend"},
{"sonar.cs.analyzer.security.pluginVersion", "1.13.0"},
{"sonar.cs.analyzer.security.staticResourceName", "SecurityAnalyzer.zip"},
The question is how to make it visible for all 3 of them. Parametrized test with analyzerIdName, versionName, staticResourceName?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SCAN4NET-171