SONARJAVA-4951 Replace sonar-java specific verifier with analyzer-commons library (#4786)

Use the CheckVerifier provided by the sonar-analyzer-commons testing module instead of the sonar-java-specific implementation to improve testing and allow for better maintanance and updates of the verifier logic.

Author: irina-batinic-sonarsource

docs/CUSTOM_RULES_101.md

@@ -682,14 +682,25 @@ See: [pom.xml#L137-L197](./java-custom-rules-example/pom_SQ_9_9_LTS.xml#L137-L19
 You can raise an issue on a given line, but you can also raise it at a specific Token. 
 Because of that, you may want to specify, in your sample code used by your Unit Tests, the exact location, i.e. in between which 2 specific Columns, where you are expecting the issue to be raised.
 
-This can be achieved using the special keywords `sc` (start-column) and `ec` (end-column) in the `// Noncompliant` comment. 
-In the following example, we are expecting to have the issue being raised between the columns 27 and 32 (i.e. exactly on the "Order" variable type):
-
+> **Deprecated**
+> 
+>This can be achieved using the special keywords `sc` (start-column) and `ec` (end-column) in the `// Noncompliant` comment. 
+>In the following example, we are expecting to have the issue being raised between the columns 27 and 32 (i.e. exactly on the "Order" variable type):
+> ```java
+> public String updateOrder(Order order){ // Noncompliant [[sc=27;ec=32]] {{Don't use Order here because it's an @Entity}}
+>  // ...
+> }
+> ```
+
+Assert precise primary location of an issue with the comment on a line below containing required number of `^`.
 ```java
-public String updateOrder(Order order){ // Noncompliant [[sc=27;ec=32]] {{Don't use Order here because it's an @Entity}}
+public String updateOrder(Order order){ // Noncompliant {{Don't use Order here because it's an @Entity}}
+//                        ^^^^^
   // ...
 }
 ```
+More information on how to test precise issue location can be found in: [SonarSource Analyzer Test Commons](https://github.com/SonarSource/sonar-analyzer-commons/tree/master/test-commons) library.
+
 
 ### How to test the Source Version in a rule
 

docs/java-custom-rules-example/src/test/files/NoIfStatementInTestsRule.java

@@ -9,7 +9,8 @@ public class ATest {
 
   @Test
   public void myTest() {
-    if (someCondition) { // Noncompliant [[sc=5;ec=7]] {{Remove this 'if' statement from this test.}}
+    if (someCondition) { // Noncompliant {{Remove this 'if' statement from this test.}}
+//  ^^
       // verify something
     }
   }

docs/java-custom-rules-example/src/test/files/SecurityAnnotationMandatoryRule.java

@@ -12,10 +12,12 @@ class BusinessClassDelegate implements MySecurityInterface, SecondInterface {
   public void aMethod() { }
 
   @org.foo.MyOtherSecurityAnnotation
-  public void anotherMethod() { } // Noncompliant [[sc=15;ec=28]]  {{Mandatory Annotation not set @MySecurityAnnotation}}
+  public void anotherMethod() { } // Noncompliant {{Mandatory Annotation not set @MySecurityAnnotation}}
+//            ^^^^^^^^^^^^^
 
   @VariousAnnotation
-  public void differentMethod() { } // Noncompliant [[startColumn=15;endColumn=30]] {{Mandatory Annotation not set @MySecurityAnnotation}}
+  public void differentMethod() { } // Noncompliant {{Mandatory Annotation not set @MySecurityAnnotation}}
+//            ^^^^^^^^^^^^^^^
 }
 
 class OtherClass implements FirstInterface, SecondInterface {

docs/java-custom-rules-example/src/test/files/SpringControllerRequestMappingEntityRule.java

@@ -6,7 +6,8 @@
 public class HelloController {
 
   @RequestMapping("/updateOrder")
-  public String updateOrder(Order order, Client client) { // Noncompliant [[sc=29;ec=34]] {{Don't use Order here because it's an @Entity}}
+  public String updateOrder(Order order, Client client) { // Noncompliant {{Don't use Order here because it's an @Entity}}
+//                          ^^^^^
     return null;
   }
 

its/autoscan/src/test/resources/autoscan/diffs/diff_S1128.json

@@ -1,6 +1,6 @@
 {
   "ruleKey": "S1128",
   "hasTruePositives": true,
-  "falseNegatives": 34,
+  "falseNegatives": 33,
   "falsePositives": 0
-}
+}

its/autoscan/src/test/resources/autoscan/diffs/diff_S2699.json

@@ -1,6 +1,6 @@
 {
   "ruleKey": "S2699",
   "hasTruePositives": true,
-  "falseNegatives": 151,
+  "falseNegatives": 150,
   "falsePositives": 1
-}
+}

its/autoscan/src/test/resources/autoscan/diffs/diff_S5786.json

@@ -1,6 +1,6 @@
 {
   "ruleKey": "S5786",
   "hasTruePositives": true,
-  "falseNegatives": 63,
+  "falseNegatives": 62,
   "falsePositives": 0
 }

java-checks-test-sources/aws/src/main/files/non-compiling/checks/aws/AwsConsumerBuilderUsageCheckSample.java

@@ -7,7 +7,8 @@ public class AwsConsumerBuilderUsageCheckSample {
 
   public void test() {
     AwsConsumerBuilderUsageCheckSample.builder()
-      .validDestination(Destination.builder() // Noncompliant [[sc=8;ec=24]] {{Consider using the Consumer Builder method instead of creating this nested builder.}}
+      .validDestination(Destination.builder() // Noncompliant {{Consider using the Consumer Builder method instead of creating this nested builder.}}
+//     ^^^^^^^^^^^^^^^^
         .toAddresses("to-email@domain.com")
         .bccAddresses("bcc-email@domain.com")
         .build())

java-checks-test-sources/aws/src/main/java/checks/aws/AwsConsumerBuilderUsageCheckSample.java

@@ -18,7 +18,8 @@ public class AwsConsumerBuilderUsageCheckSample {
   void test_destination(Destination destination1) {
 
     software.amazon.awssdk.services.sesv2.model.SendEmailRequest.builder()
-      .destination(Destination.builder() // Noncompliant [[sc=8;ec=19]] {{Consider using the Consumer Builder method instead of creating this nested builder.}}
+      .destination(Destination.builder() // Noncompliant {{Consider using the Consumer Builder method instead of creating this nested builder.}}
+//     ^^^^^^^^^^^
         .toAddresses("to-email@domain.com")
         .bccAddresses("bcc-email@domain.com")
         .build())

java-checks-test-sources/aws/src/main/java/checks/aws/AwsCredentialsShouldBeSetExplicitlyCheckSample.java

@@ -12,22 +12,28 @@ public class AwsCredentialsShouldBeSetExplicitlyCheckSample {
   public static final AwsClientBuilder BUILDER = S3Client.builder(); // Compliant FN - Could be configured closer to build call
 
   void nonCompliant() {
-    S3Client.builder().build(); // Noncompliant [[sc=5;ec=31]] {{Set the credentials provider explicitly on this builder.}}
-    S3Client client = S3Client.builder().build(); // Noncompliant [[sc=23;ec=49]] {{Set the credentials provider explicitly on this builder.}}
-    S3Client otherClient = S3Client.builder() // Noncompliant [[sl=+0;sc=28;el=+2;ec=15]] {{Set the credentials provider explicitly on this builder.}}
+    S3Client.builder().build(); // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+//  ^^^^^^^^^^^^^^^^^^^^^^^^^^
+    S3Client client = S3Client.builder().build(); // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+//                    ^^^^^^^^^^^^^^^^^^^^^^^^^^
+    S3Client otherClient = S3Client.builder() // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+  //^[sc=28;ec=14;el=+3]
       .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable())))
       .build();
   }
 
   void nonCompliantBuilderAsVariable() {
-    S3ClientBuilder builder = S3Client.builder(); // Noncompliant [[sc=5;ec=50]] {{Set the credentials provider explicitly on this builder.}}
+    S3ClientBuilder builder = S3Client.builder(); // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+//  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     builder.build();
 
-    S3ClientBuilder secondBuilder = S3Client.builder(); // Noncompliant [[sc=5;ec=56]] {{Set the credentials provider explicitly on this builder.}}
+    S3ClientBuilder secondBuilder = S3Client.builder(); // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+//  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     secondBuilder.region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable())));
     secondBuilder.build();
 
-    S3ClientBuilder thirdBuilder = S3Client.builder() // Noncompliant [[sl=+0;sc=5;el=+1;ec=92]] {{Set the credentials provider explicitly on this builder.}}
+    S3ClientBuilder thirdBuilder = S3Client.builder() // Noncompliant {{Set the credentials provider explicitly on this builder.}}
+  //^[sc=5;ec=91;el=+2]
       .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable())));
     thirdBuilder.build();
   }