fix: Skip non .cs files IO-1156 (#240)

* test: Add test for Directory.Build.props false positives * fix: Skip non `.cs` files * fix: Codacy issue
codacy · Jul 31, 2024 · 433fafa · 433fafa
1 parent 418bb42
commit 433fafa
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 1 deletion.
diff --git a/docs/multiple-tests/skip-non-cs-files/patterns.xml b/docs/multiple-tests/skip-non-cs-files/patterns.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<module name="root">
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="SonarLint\.xml"/>
+    </module>
+</module>
diff --git a/docs/multiple-tests/skip-non-cs-files/results.xml b/docs/multiple-tests/skip-non-cs-files/results.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<checkstyle version="4.3">
+</checkstyle>
diff --git a/docs/multiple-tests/skip-non-cs-files/src/Directory.Build.props b/docs/multiple-tests/skip-non-cs-files/src/Directory.Build.props
@@ -0,0 +1,7 @@
+<Project>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="All" />
+  </ItemGroup>
+</Project>
+
+
diff --git a/docs/multiple-tests/skip-non-cs-files/src/SonarLint.xml b/docs/multiple-tests/skip-non-cs-files/src/SonarLint.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<AnalysisInput>
+  <Rules>
+    <Rule>
+      <Key>S103</Key>
+      <Parameters>
+        <Parameter>
+          <Key>maximumLineLength</Key>  
+          <Value>24</Value>  
+        </Parameter>
+      </Parameters>
+    </Rule>
+  </Rules>
+</AnalysisInput>
diff --git a/src/Analyzer/CodeAnalyzer.cs b/src/Analyzer/CodeAnalyzer.cs
@@ -114,7 +114,19 @@ protected virtual void Dispose(bool disposing)
 
         protected override async Task Analyze(CancellationToken cancellationToken)
         {
-            foreach (var file in Config.Files) await Analyze(file, cancellationToken).ConfigureAwait(false);
+            foreach (var file in Config.Files) {
+                // skip all files that don't have the main language extension
+                // To allow Semgrep to run on C# configuration files
+                // We are analyzing `Directory.Packages.props` as if it was a C# file
+                // This is to avoid that.
+                // More info here: https://codacy.zendesk.com/agent/tickets/44462
+                if (!file.EndsWith(".cs"))
+                {
+                    continue;
+                }
+
+                await Analyze(file, cancellationToken).ConfigureAwait(false);
+            }
         }
 
         public async Task Analyze(string file, CancellationToken cancellationToken)