SONARPY-3129 Use text blocks instead of string concatenation (#339)

GitOrigin-RevId: 2f6907c148cb4b7ffacb63565afa4e0ed9226723

Author: ghislainpiot

its/commons/src/test/java/com/sonar/python/it/TestsUtils.java

@@ -65,8 +65,7 @@ public static ConcurrentOrchestratorExtension.ConcurrentOrchestratorExtensionBui
 
       // Custom rules plugin
       .addPlugin(FileLocation.byWildcardMavenFilename(new File("../python-custom-rules-plugin/target"), "python-custom-rules-plugin-*.jar"))
-      .addPlugin(FileLocation.byWildcardMavenFilename(new File("../../../docs/python-custom-rules-example/target"), "python-custom-rules" +
-        "-example-*.jar"))
+      .addPlugin(FileLocation.byWildcardMavenFilename(new File("../../../docs/python-custom-rules-example/target"), "python-custom-rules-example-*.jar"))
       .restoreProfileAtStartup(FileLocation.of("profiles/profile-python-custom-rules-example.xml"))
       .restoreProfileAtStartup(FileLocation.of("profiles/profile-python-custom-rules.xml"))
       .restoreProfileAtStartup(FileLocation.of("profiles/profile-python-test-rules.xml"))

its/plugin/it-python-plugin-test/src/test/java/com/sonar/python/it/plugin/SonarLintTest.java

@@ -102,9 +102,11 @@ static void stop() {
   @Test
   void should_raise_issues() throws IOException, InterruptedException, ExecutionException {
     ClientInputFile inputFile = prepareInputFile("foo.py",
-      "def fooBar():\n"
-        + "  `1` \n"
-        + "  `1` #NOSONAR\n",
+      """
+      def fooBar():
+        `1`
+        `1` #NOSONAR
+      """,
       false);
 
     List<Issue> issues = new ArrayList<>();

its/plugin/it-python-plugin-test/src/test/java/com/sonar/python/it/plugin/TestReportTest.java

@@ -116,9 +116,9 @@ void invalid_test_report() {
     final String projectKey = "nosetests_invalid";
     BuildResult result = ORCHESTRATOR.executeBuildQuietly(createBuild(projectKey, "invalid_report.xml"));
     assertThat(result.isSuccess()).isTrue();
-    assertThat(result.getLogs()).contains("Cannot read report 'invalid_report.xml', the following exception occurred:" +
-      " Unexpected character 't' (code 116) in prolog; expected '<'\n" +
-      " at [row,col {unknown-source}]: [1,1]");
+    assertThat(result.getLogs()).contains("""
+      Cannot read report 'invalid_report.xml', the following exception occurred: Unexpected character 't' (code 116) in prolog; expected '<'
+      """);
   }
 
   private static Map<String, Integer> nullMeasures() {

python-checks-testkit/src/main/java/org/sonar/python/checks/quickfix/PythonQuickFixVerifier.java

@@ -95,8 +95,12 @@ public static void verify(Function<String, PythonVisitorContext> createVisitorCo
       .toList();
 
     assertThat(appliedQuickFix)
-      .as("The code with the quickfix applied is not the expected result.\n" +
-        "Applied QuickFixes are:\n%s\nExpected result:\n%s", appliedQuickFix, Arrays.asList(codesFixed))
+      .as("""
+        The code with the quickfix applied is not the expected result.
+        Applied QuickFixes are:
+        %s
+        Expected result:
+        %s""", appliedQuickFix, Arrays.asList(codesFixed))
       .isEqualTo(Arrays.asList(codesFixed));
   }
 

python-checks-testkit/src/test/java/org/sonar/python/checks/quickfix/PythonQuickFixVerifierTest.java

@@ -82,9 +82,10 @@ void test_verify() {
 
   @Test
   void test_verify_invalid_after() {
-    var expectedMsg = "[Correction of quick fixes] The code expected to be generated by the quickfix is not valid (I)Python code.\n" +
-      "Results is :\n" +
-      "[a!!=10]";
+    var expectedMsg = """
+      [Correction of quick fixes] The code expected to be generated by the quickfix is not valid (I)Python code.
+      Results is :
+      [a!!=10]""";
     var check = new SimpleCheck();
     assertThatThrownBy(() -> PythonQuickFixVerifier.verify(check, "a=10", "a!!=10"))
       .isInstanceOf(AssertionError.class)

python-checks/src/main/java/org/sonar/python/checks/FunctionUsingLoopVariableCheck.java

@@ -90,13 +90,15 @@ private static void reportIssue(SubscriptionContext ctx, FunctionLike functionLi
     if (!problematicUsages.isEmpty() && !bindingUsages.isEmpty()) {
       PreciseIssue issue;
       if (functionLike.is(Tree.Kind.FUNCDEF)) {
-        issue = ctx.addIssue(problematicUsages.get(0), String.format("Add a parameter to function \"%s\" and use variable \"%s\" as its default value;" +
-          "The value of \"%s\" might change at the next loop iteration.", ((FunctionDef) functionLike).name().name(), symbolName, symbolName))
+        issue = ctx.addIssue(problematicUsages.get(0), String.format("""
+          Add a parameter to function "%s" and use variable "%s" as its default value;\
+          The value of "%s" might change at the next loop iteration.""", ((FunctionDef) functionLike).name().name(), symbolName, symbolName))
           .secondary(((FunctionDef) functionLike).name(), "Function capturing the variable");
       } else {
         issue = ctx.addIssue(problematicUsages.get(0),
-          String.format("Add a parameter to the parent lambda function and use variable \"%s\" as its default value; " +
-            "The value of \"%s\" might change at the next loop iteration.", symbolName, symbolName))
+          String.format("""
+            Add a parameter to the parent lambda function and use variable "%s" as its default value; \
+            The value of "%s" might change at the next loop iteration.""", symbolName, symbolName))
           .secondary(((LambdaExpression) functionLike).lambdaKeyword(), "Lambda capturing the variable");
       }
       for (Tree bindingUsage : bindingUsages) {

python-checks/src/main/java/org/sonar/python/checks/StringFormat.java

@@ -40,8 +40,14 @@ public class StringFormat {
 
   // See https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting
   private static final Pattern PRINTF_PARAMETER_PATTERN = Pattern.compile(
-    "%" + "(?<field>(?:\\((?<mapkey>.*?)\\))?" + "(?<flags>[#\\-+0 ]*)?" + "(?<width>[0-9]*|\\*)?" +
-      "(?:\\.(?<precision>[0-9]*|\\*))?" + "(?:[lLH])?" + "(?<type>[diueEfFgGoxXrsac]|%))?");
+    """
+    %\
+    (?<field>(?:\\((?<mapkey>.*?)\\))?\
+    (?<flags>[#\\-+0 ]*)?\
+    (?<width>[0-9]*|\\*)?\
+    (?:\\.(?<precision>[0-9]*|\\*))?\
+    (?:[lLH])?\
+    (?<type>[diueEfFgGoxXrsac]|%))?""");
 
   private static final Pattern FORMAT_FIELD_PATTERN = Pattern.compile("^(?<name>[^.\\[!:{}]+)?(?:(?:\\.[a-zA-Z0-9_]+)|(?:\\[[^]]+]))*");
   private static final Pattern FORMAT_NUMBER_PATTERN = Pattern.compile("^\\d+$");

python-checks/src/main/java/org/sonar/python/checks/TooManyLinesInFunctionCheck.java

@@ -34,8 +34,9 @@
 @Rule(key = "S138")
 public class TooManyLinesInFunctionCheck extends PythonSubscriptionCheck {
 
-  private static final String MESSAGE = "This %1$s \"%2$s\" has %3$d lines of code, " +
-    "which is greater than the %4$d authorized. Split it into smaller %1$ss.";
+  private static final String MESSAGE = """
+    This %1$s "%2$s" has %3$d lines of code, \
+    which is greater than the %4$d authorized. Split it into smaller %1$ss.""";
 
   private static final int DEFAULT = 100;
 

python-checks/src/main/java/org/sonar/python/checks/cdk/DisabledESDomainEncryptionCheck.java

@@ -37,8 +37,9 @@
 
 @Rule(key = "S6308")
 public class DisabledESDomainEncryptionCheck extends AbstractCdkResourceCheck {
-  private static final String OMITTING_MESSAGE = "Omitting %s causes encryption of data at rest to be disabled for this %s domain." +
-    " Make sure it is safe here.";
+  private static final String OMITTING_MESSAGE = """
+    Omitting %s causes encryption of data at rest to be disabled for this %s domain.\
+     Make sure it is safe here.""";
   private static final String UNENCRYPTED_MESSAGE = "Make sure that using unencrypted %s domains is safe here.";
   private static final String ENABLED = "enabled";
   private static final String OPENSEARCH = "OpenSearch";

python-checks/src/main/java/org/sonar/python/checks/cdk/IamPrivilegeEscalationCheck.java

@@ -32,8 +32,9 @@
 @Rule(key = "S6317")
 public class IamPrivilegeEscalationCheck extends AbstractIamPolicyStatementCheck {
 
-  private static final String ISSUE_MESSAGE_FORMAT = "This policy is vulnerable to the \"%s\" privilege escalation vector. " +
-    "Remove permissions or restrict the set of resources they apply to.";
+  private static final String ISSUE_MESSAGE_FORMAT = """
+    This policy is vulnerable to the "%s" privilege escalation vector. \
+    Remove permissions or restrict the set of resources they apply to.""";
   private static final String SECONDARY_MESSAGE = "Permissions are granted on all resources.";
   private static final Pattern SENSITIVE_RESOURCE_PATTERN = Pattern.compile("(^\\*$)|(arn:.*:(role|user|group)/\\*)");