SONARJAVA-3679 Report issue with AnalyzerMessage (#3447)

quentin-jaquier-sonarsource · web-flow · commit 5e70f93b9233 · 2021-02-18T20:39:04.000+01:00
* SONARJAVA-3679 Report issue with AnalyzerMessage * SONARJAVA-3679 Make sure JavaCheckVerifier fails when DefaultJavaFileScannerContext does
diff --git a/java-checks/src/main/java/org/sonar/java/checks/security/ExcessiveContentRequestCheck.java b/java-checks/src/main/java/org/sonar/java/checks/security/ExcessiveContentRequestCheck.java
@@ -126,21 +126,22 @@ public List<Tree.Kind> nodesToVisit() {
 
   @Override
   public void visitNode(Tree tree) {
+    DefaultJavaFileScannerContext defaultContext = (DefaultJavaFileScannerContext) context;
     if (tree.is(Tree.Kind.NEW_CLASS)) {
       NewClassTree newClassTree = (NewClassTree) tree;
       if (MULTIPART_CONSTRUCTOR.matches(newClassTree)) {
         // Create an issue that we will report only at the end of the analysis if the maximum size was never set.
-        DefaultJavaFileScannerContext defaultContext = (DefaultJavaFileScannerContext) context;
         AnalyzerMessage analyzerMessage = defaultContext.createAnalyzerMessage(this, newClassTree, MESSAGE_SIZE_NOT_SET);
         multipartConstructorIssues.add(analyzerMessage);
       }
     } else {
       MethodInvocationTree mit = (MethodInvocationTree) tree;
       if (METHODS_SETTING_MAX_SIZE.matches(mit)) {
         sizeSetSomewhere = true;
-        getIfExceedSize(mit.arguments().get(0)).ifPresent(bytesExceeding ->
-          reportIssue(mit, String.format(MESSAGE_EXCEED_SIZE, bytesExceeding, fileUploadSizeLimit))
-        );
+        getIfExceedSize(mit.arguments().get(0))
+          .map(bytesExceeding ->
+            defaultContext.createAnalyzerMessage(this, mit, String.format(MESSAGE_EXCEED_SIZE, bytesExceeding, fileUploadSizeLimit)))
+          .ifPresent(defaultContext::reportIssue);
       }
     }
   }
diff --git a/java-frontend/src/main/java/org/sonar/java/model/DefaultJavaFileScannerContext.java b/java-frontend/src/main/java/org/sonar/java/model/DefaultJavaFileScannerContext.java
@@ -258,7 +258,7 @@ public List<Tree> getComplexityNodes(Tree tree) {
     return complexityVisitor.getNodes(tree);
   }
 
-  private static void throwIfEndOfAnalysisCheck(JavaCheck javaCheck) {
+  protected static void throwIfEndOfAnalysisCheck(JavaCheck javaCheck) {
     if (javaCheck instanceof EndOfAnalysisCheck) {
       throw new UnsupportedOperationException("EndOfAnalysisCheck must only call reportIssue with AnalyzerMessage and must never pass a Tree reference.");
     }
diff --git a/java-frontend/src/main/java/org/sonar/java/model/VisitorsBridgeForTests.java b/java-frontend/src/main/java/org/sonar/java/model/VisitorsBridgeForTests.java
@@ -96,22 +96,26 @@ public void addIssue(int line, JavaCheck javaCheck, String message, @Nullable In
 
     @Override
     public void reportIssue(JavaCheck javaCheck, Tree syntaxNode, String message, List<Location> secondary, @Nullable Integer cost) {
+      throwIfEndOfAnalysisCheck(javaCheck);
       List<List<Location>> flows = secondary.stream().map(Collections::singletonList).collect(Collectors.toList());
       issues.add(createAnalyzerMessage(getInputFile(), javaCheck, syntaxNode, null, message, flows, cost));
     }
 
     @Override
     public void reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message) {
+      throwIfEndOfAnalysisCheck(javaCheck);
       issues.add(createAnalyzerMessage(javaCheck, startTree, endTree, message, Collections.emptyList(), null));
     }
 
     @Override
     public void reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message, List<Location> secondary, @Nullable Integer cost) {
+      throwIfEndOfAnalysisCheck(javaCheck);
       issues.add(createAnalyzerMessage(javaCheck, startTree, endTree, message, secondary, cost));
     }
 
     @Override
     public void reportIssueWithFlow(JavaCheck javaCheck, Tree syntaxNode, String message, Iterable<List<Location>> flows, @Nullable Integer cost) {
+      throwIfEndOfAnalysisCheck(javaCheck);
       issues.add(createAnalyzerMessage(getInputFile(), javaCheck, syntaxNode, null, message, flows, cost));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ public List<Tree> getComplexityNodes(Tree tree) {`
`258`	`258`	`return complexityVisitor.getNodes(tree);`
`259`	`259`	`}`
`260`	`260`
`261`		`- private static void throwIfEndOfAnalysisCheck(JavaCheck javaCheck) {`
	`261`	`+ protected static void throwIfEndOfAnalysisCheck(JavaCheck javaCheck) {`
`262`	`262`	`if (javaCheck instanceof EndOfAnalysisCheck) {`
`263`	`263`	`throw new UnsupportedOperationException("EndOfAnalysisCheck must only call reportIssue with AnalyzerMessage and must never pass a Tree reference.");`
`264`	`264`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,22 +96,26 @@ public void addIssue(int line, JavaCheck javaCheck, String message, @Nullable In`
`96`	`96`
`97`	`97`	`@Override`
`98`	`98`	`public void reportIssue(JavaCheck javaCheck, Tree syntaxNode, String message, List<Location> secondary, @Nullable Integer cost) {`
	`99`	`+ throwIfEndOfAnalysisCheck(javaCheck);`
`99`	`100`	`List<List<Location>> flows = secondary.stream().map(Collections::singletonList).collect(Collectors.toList());`
`100`	`101`	`issues.add(createAnalyzerMessage(getInputFile(), javaCheck, syntaxNode, null, message, flows, cost));`
`101`	`102`	`}`
`102`	`103`
`103`	`104`	`@Override`
`104`	`105`	`public void reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message) {`
	`106`	`+ throwIfEndOfAnalysisCheck(javaCheck);`
`105`	`107`	`issues.add(createAnalyzerMessage(javaCheck, startTree, endTree, message, Collections.emptyList(), null));`
`106`	`108`	`}`
`107`	`109`
`108`	`110`	`@Override`
`109`	`111`	`public void reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message, List<Location> secondary, @Nullable Integer cost) {`
	`112`	`+ throwIfEndOfAnalysisCheck(javaCheck);`
`110`	`113`	`issues.add(createAnalyzerMessage(javaCheck, startTree, endTree, message, secondary, cost));`
`111`	`114`	`}`
`112`	`115`
`113`	`116`	`@Override`
`114`	`117`	`public void reportIssueWithFlow(JavaCheck javaCheck, Tree syntaxNode, String message, Iterable<List<Location>> flows, @Nullable Integer cost) {`
	`118`	`+ throwIfEndOfAnalysisCheck(javaCheck);`
`115`	`119`	`issues.add(createAnalyzerMessage(getInputFile(), javaCheck, syntaxNode, null, message, flows, cost));`
`116`	`120`	`}`
`117`	`121`