SONARPY-2084: S1451 : Improve issue message (#2048)

Seppli11 · web-flow · commit f5c8971947e7 · 2024-10-08T12:22:07.000+02:00
diff --git a/python-checks/src/main/java/org/sonar/python/checks/FileHeaderCopyrightCheck.java b/python-checks/src/main/java/org/sonar/python/checks/FileHeaderCopyrightCheck.java
@@ -19,8 +19,10 @@
  */
 package org.sonar.python.checks;
 
+import java.util.Objects;
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
+import javax.annotation.Nullable;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
@@ -33,7 +35,8 @@
 public class FileHeaderCopyrightCheck extends PythonSubscriptionCheck {
 
   private static final String DEFAULT_HEADER_FORMAT = "";
-  private static final String MESSAGE = "Add or update the header of this file.";
+  private static final String ADD_HEADER_MESSAGE = "Add a header to this file.";
+  private static final String UPDATE_HEADER_MESSAGE = "Update the header of this file to match the expected one.";
 
   @RuleProperty(
     key = "headerFormat",
@@ -61,38 +64,48 @@ public void initialize(Context context) {
         }
       }
 
-      var header = getHeaderText(ctx);
-      var headerWithoutShebang = shebangPattern.matcher(header).replaceFirst("");
+      if(headerFormat.isEmpty()) {
+        return;
+      }
 
-      if (isRegularExpression) {
-        checkRegularExpression(ctx, header, headerWithoutShebang);
-      } else if (!headerFormat.isEmpty()) {
-        var matches = Stream.of(header, headerWithoutShebang)
-          .anyMatch(h -> h.startsWith(headerFormat));
+      String header = getHeaderText(ctx);
+      String fileContent = ctx.pythonFile().content();
+      var fileContentWithoutShebang = shebangPattern.matcher(fileContent).replaceFirst("");
 
-        if (!matches) {
-          ctx.addFileIssue(MESSAGE);
-        }
+      if (header == null && !fileContentWithoutShebang.startsWith("#")) {
+        ctx.addFileIssue(ADD_HEADER_MESSAGE);
+      } else if (!isStartingWithCopyrightHeader(header, fileContentWithoutShebang)) {
+        ctx.addFileIssue(UPDATE_HEADER_MESSAGE);
       }
     });
   }
 
-  private static String getHeaderText(SubscriptionContext ctx) {
+  private static @Nullable String getHeaderText(SubscriptionContext ctx) {
     StringLiteral tokenDoc = ((FileInput) ctx.syntaxNode()).docstring();
     if (tokenDoc != null && tokenDoc.firstToken().line() == 1) {
       return tokenDoc.firstToken().value();
     }
-    return ctx.pythonFile().content();
+    return null;
+  }
+
+  private boolean isStartingWithCopyrightHeader(@Nullable String header, String fileContentWithoutShebang) {
+    if (isRegularExpression) {
+      return isStartingWithRegexSearchPattern(header, fileContentWithoutShebang);
+    } else {
+      return isStartingWithNormalSearchPattern(header, fileContentWithoutShebang);
+    }
   }
 
-  private void checkRegularExpression(SubscriptionContext ctx, String... fileContent) {
-    var matches = Stream.of(fileContent)
+  private boolean isStartingWithRegexSearchPattern(String... fileContent) {
+    return Stream.of(fileContent)
+      .filter(Objects::nonNull)
       .map(searchPattern::matcher)
       .anyMatch(matcher -> matcher.find() && matcher.start() == 0);
-
-    if (!matches) {
-      ctx.addFileIssue(MESSAGE);
-    }
   }
 
+  private boolean isStartingWithNormalSearchPattern(String... fileContent) {
+    return Stream.of(fileContent)
+      .filter(Objects::nonNull)
+      .anyMatch(content -> content.startsWith(headerFormat));
+  }
 }
diff --git a/python-checks/src/test/java/org/sonar/python/checks/FileHeaderCopyrightCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/FileHeaderCopyrightCheckTest.java
@@ -22,15 +22,19 @@
 import java.io.File;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.List;
 import org.assertj.core.api.Assertions;
 import org.junit.Assert;
 import org.junit.jupiter.api.Test;
+import org.sonar.plugins.python.api.PythonCheck;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
 import org.sonar.plugins.python.api.PythonVisitorContext;
 import org.sonar.python.SubscriptionVisitor;
 import org.sonar.python.TestPythonVisitorRunner;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
 class FileHeaderCopyrightCheckTest {
 
   @Test
@@ -55,57 +59,63 @@ void test_noncompliant() {
   void test_NoCopyright() {
     PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/fileHeaderCopyright/headerNoCopyright.py", new FileHeaderCopyrightCheck());
     PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/fileHeaderCopyright/emptyFileNoCopyright.py", new FileHeaderCopyrightCheck());
+    PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/fileHeaderCopyright/emptyFileWithLineBreakNoCopyright.py", new FileHeaderCopyrightCheck());
   }
 
 
   @Test
   void test_copyright_docstring() {
     FileHeaderCopyrightCheck fileHeaderCopyrightCheck = new FileHeaderCopyrightCheck();
-    fileHeaderCopyrightCheck.headerFormat = "\"\"\"\n" +
-      " SonarQube, open source software quality management tool.\n" +
-      " Copyright (C) 2008-2018 SonarSource\n" +
-      " mailto:contact AT sonarsource DOT com\n" +
-      "\n" +
-      " SonarQube is free software; you can redistribute it and/or\n" +
-      " modify it under the terms of the GNU Lesser General Public\n" +
-      " License as published by the Free Software Foundation; either\n" +
-      " version 3 of the License, or (at your option) any later version.\n" +
-      "\n" +
-      " SonarQube is distributed in the hope that it will be useful,\n" +
-      " but WITHOUT ANY WARRANTY; without even the implied warranty of\n" +
-      " MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n" +
-      " Lesser General Public License for more details.\n" +
-      "\n" +
-      " You should have received a copy of the GNU Lesser General Public License\n" +
-      " along with this program; if not, write to the Free Software Foundation,\n" +
-      " Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\n" +
-      "\"\"\"";
+    fileHeaderCopyrightCheck.headerFormat = """
+      ""\"
+       SonarQube, open source software quality management tool.
+       Copyright (C) 2008-2018 SonarSource
+       mailto:contact AT sonarsource DOT com
+      
+       SonarQube is free software; you can redistribute it and/or
+       modify it under the terms of the GNU Lesser General Public
+       License as published by the Free Software Foundation; either
+       version 3 of the License, or (at your option) any later version.
+      
+       SonarQube is distributed in the hope that it will be useful,
+       but WITHOUT ANY WARRANTY; without even the implied warranty of
+       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+       Lesser General Public License for more details.
+      
+       You should have received a copy of the GNU Lesser General Public License
+       along with this program; if not, write to the Free Software Foundation,
+       Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+      ""\"""";
     PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/fileHeaderCopyright/docstring.py", fileHeaderCopyrightCheck);
   }
 
   @Test
   void test_copyright_docstring_noncompliant() {
     FileHeaderCopyrightCheck fileHeaderCopyrightCheck = new FileHeaderCopyrightCheck();
-    fileHeaderCopyrightCheck.headerFormat = "\"\"\"\n" +
-      " SonarQube, open source software quality management tool.\n" +
-      " Copyright (C) 2008-2018 SonarSource\n" +
-      " mailto:contact AT sonarsource DOT com\n" +
-      "\n" +
-      " SonarQube is free software; you can redistribute it and/or\n" +
-      " modify it under the terms of the GNU Lesser General Public\n" +
-      " License as published by the Free Software Foundation; either\n" +
-      " version 3 of the License, or (at your option) any later version.\n" +
-      "\n" +
-      " SonarQube is distributed in the hope that it will be useful,\n" +
-      " but WITHOUT ANY WARRANTY; without even the implied warranty of\n" +
-      " MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n" +
-      " Lesser General Public License for more details.\n" +
-      "\n" +
-      " You should have received a copy of the GNU Lesser General Public License\n" +
-      " along with this program; if not, write to the Free Software Foundation,\n" +
-      " Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\n" +
-      "\"\"\"";
+    fileHeaderCopyrightCheck.headerFormat = """
+      ""\"
+       SonarQube, open source software quality management tool.
+       Copyright (C) 2008-2018 SonarSource
+       mailto:contact AT sonarsource DOT com
+      
+       SonarQube is free software; you can redistribute it and/or
+       modify it under the terms of the GNU Lesser General Public
+       License as published by the Free Software Foundation; either
+       version 3 of the License, or (at your option) any later version.
+      
+       SonarQube is distributed in the hope that it will be useful,
+       but WITHOUT ANY WARRANTY; without even the implied warranty of
+       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+       Lesser General Public License for more details.
+      
+       You should have received a copy of the GNU Lesser General Public License
+       along with this program; if not, write to the Free Software Foundation,
+       Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+      ""\"""";
     PythonCheckVerifier.verify("src/test/resources/checks/fileHeaderCopyright/docstringNonCompliant.py", fileHeaderCopyrightCheck);
+
+    List<PythonCheck.PreciseIssue> issues = PythonCheckVerifier.issues("src/test/resources/checks/fileHeaderCopyright/emptyFileNoCopyright.py", fileHeaderCopyrightCheck);
+    assertEquals(1, issues.size());
   }
 
   @Test
@@ -116,8 +126,10 @@ void test_searchPattern() {
     PythonCheckVerifier.verify("src/test/resources/checks/fileHeaderCopyright/copyrightNonCompliant.py", fileHeaderCopyrightCheck);
     PythonCheckVerifier.verify("src/test/resources/checks/fileHeaderCopyright/searchPatternNonCompliant.py", fileHeaderCopyrightCheck);
     PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/fileHeaderCopyright/searchPattern.py", fileHeaderCopyrightCheck);
-    fileHeaderCopyrightCheck.headerFormat = "";
-    PythonCheckVerifier.verify("src/test/resources/checks/fileHeaderCopyright/searchPatternNonCompliant.py", fileHeaderCopyrightCheck);
+
+    List<PythonCheck.PreciseIssue> issues = PythonCheckVerifier.issues("src/test/resources/checks/fileHeaderCopyright/emptyFileNoCopyright.py",
+      fileHeaderCopyrightCheck);
+    assertEquals(1, issues.size());
   }
 
   @Test
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/copyrightNonCompliant.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/copyrightNonCompliant.py
@@ -1,6 +1,6 @@
 # Copyright BAR
 
-# Noncompliant@-3
+# Noncompliant@-3 {{Update the header of this file to match the expected one.}}
 def fun():
   if expression:
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/docstringNonCompliant.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/docstringNonCompliant.py
@@ -18,7 +18,7 @@
  along with this program; if not, write to the Free Software Foundation,
  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 """
-# Noncompliant@-21
+# Noncompliant@-21 {{Update the header of this file to match the expected one.}}
 def fun():
   if expression:
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/emptyFileButCopyright.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/emptyFileButCopyright.py
@@ -1 +1,2 @@
-#Noncompliant@-1
+
+#Noncompliant@-2 {{Add a header to this file.}}
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/emptyFileWithLineBreakNoCopyright.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/emptyFileWithLineBreakNoCopyright.py
@@ -0,0 +1 @@
+
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/noHeaderNonCompliant.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/noHeaderNonCompliant.py
@@ -1,4 +1,4 @@
-# Noncompliant@-1
+# Noncompliant@-1 {{Update the header of this file to match the expected one.}}
 def fun():
   if expression:
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternMisplacedCopyright.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternMisplacedCopyright.py
@@ -1,6 +1,6 @@
 # License 101
 # Copyright 2020
 # All rights reserved.
-# Noncompliant@-4
+# Noncompliant@-4 {{Update the header of this file to match the expected one.}}
 def foo():
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternNonCompliant.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternNonCompliant.py
@@ -1,6 +1,6 @@
 # Copyright 2020
 # Another comment
 # All rights reserved.
-# Noncompliant@-4
+# Noncompliant@-4 {{Update the header of this file to match the expected one.}}
 def foo():
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternShebangCopyrightNonCompliant.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternShebangCopyrightNonCompliant.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # Copyright_2020
 # All rights reserved.
-# Noncompliant@-4
+# Noncompliant@-4 {{Update the header of this file to match the expected one.}}
 def foo():
     pass
diff --git a/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternThrowsError.py b/python-checks/src/test/resources/checks/fileHeaderCopyright/searchPatternThrowsError.py
@@ -1,6 +1,6 @@
 # Copyright 2020
 # Another comment
 # All rights reserved.
-# Noncompliant@-4
+# This file is used to check that the search pattern is correctly used to find the header of the file.
 def foo():
     pass

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-#Noncompliant@-1`
	`1`	`+`
	`2`	`+#Noncompliant@-2 {{Add a header to this file.}}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Noncompliant@-1`
	`1`	`+# Noncompliant@-1 {{Update the header of this file to match the expected one.}}`
`2`	`2`	`def fun():`
`3`	`3`	`if expression:`
`4`	`4`	`pass`