Fix S1104 FP: Should be ignored on classes and structs marked as [Ser…

…ializable] (#8521)
SonarSource · Jan 5, 2024 · 53626ac · 53626ac
1 parent 2a9584d
commit 53626ac
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 44 deletions.
diff --git a/analyzers/its/expected/akka.net/Akka.Persistence--netstandard2.0-S1104.json b/analyzers/its/expected/akka.net/Akka.Persistence--netstandard2.0-S1104.json
@@ -12,19 +12,6 @@
 "endColumn":  73
 }
 }
-},
-{
-"id":  "S1104",
-"message":  "Make this field 'private' and encapsulate it in a 'public' property.",
-"location":  {
-"uri":  "https://github.com/SonarSource/sonar-dotnet/blob/master/analyzers/its/sources/akka.net/src/core/Akka.Persistence/SnapshotProtocol.cs#L62",
-"region":  {
-"startLine":  62,
-"startColumn":  32,
-"endLine":  62,
-"endColumn":  73
-}
-}
 }
 ]
 }
diff --git a/analyzers/its/expected/akka.net/Akka.Persistence.Sql.Common--netstandard2.0-S1104.json b/analyzers/its/expected/akka.net/Akka.Persistence.Sql.Common--netstandard2.0-S1104.json
diff --git a/analyzers/src/SonarAnalyzer.CSharp/Rules/FieldsShouldBeEncapsulatedInProperties.cs b/analyzers/src/SonarAnalyzer.CSharp/Rules/FieldsShouldBeEncapsulatedInProperties.cs
@@ -50,7 +50,8 @@ protected override void Initialize(SonarAnalysisContext context) =>
                     }
 
                     var parentSymbol = c.SemanticModel.GetDeclaredSymbol(fieldDeclaration.Parent);
-                    if (parentSymbol.HasAttribute(KnownType.System_Runtime_InteropServices_StructLayoutAttribute))
+                    if (parentSymbol.HasAttribute(KnownType.System_Runtime_InteropServices_StructLayoutAttribute)
+                        || parentSymbol.HasAttribute(KnownType.System_SerializableAttribute))
                     {
                         return;
                     }

diff --git a/analyzers/tests/SonarAnalyzer.UnitTest/TestCases/FieldsShouldBeEncapsulatedInProperties.cs b/analyzers/tests/SonarAnalyzer.UnitTest/TestCases/FieldsShouldBeEncapsulatedInProperties.cs
@@ -84,4 +84,12 @@ public class InteropClass
         public string value; // Compliant - for interop code
     }
 
+    // https://github.com/SonarSource/sonar-dotnet/issues/8504
+    [Serializable]
+    public class Repro_8504
+    {
+        public string type;     // Compliant
+        public string key;      // Compliant
+        public string value;    // Compliant
+    }
 }