Enable issue reporter configs. (#1)

codetyio · Aug 28, 2024 · f163160 · f163160
1 parent 220784d
commit f163160
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 9 deletions.
diff --git a/.github/workflows/codety.yml b/.github/workflows/codety.yml
@@ -26,9 +26,9 @@ jobs:
           #        CODETY_TOKEN: ${{ secrets.CODETY_TOKEN_PROD }}
           #test:
           CODETY_TOKEN: ${{ secrets.CODETY_TOKEN_TEST }}
-          CODETY_HOST: ${{ vars.CODETY_HOST_TEST }}
+#          CODETY_HOST: ${{ vars.CODETY_HOST_TEST }}
 
-          CODETY_ENABLE_SLACK_NOTIFICATION: true
+          CODETY_ISSUE_REPORTER_SLACK: true
           SLACK_OAUTH_TOKEN: ${{ secrets.SLACK_OAUTH_TOKEN_TEST_INTEGRATION }}
           SLACK_CONVERSATION_ID: ${{ vars.SLACK_CONVERSATION_ID }}
 

diff --git a/scanner-common/src/main/java/io/codety/scanner/service/dto/AnalyzerRequest.java b/scanner-common/src/main/java/io/codety/scanner/service/dto/AnalyzerRequest.java
@@ -19,10 +19,12 @@ public class AnalyzerRequest {
     private boolean enablePostingPullRequestComment = true;
     private boolean enablePostingPullRequestReviews = true;
     private boolean enablePostingGitHubPullRequestCheckRunAnnotations = true;
+    private boolean enableConsoleIssueReporter = true;
 
     private GitProviderType gitProviderType;
     private ComputeRunnerType computeRunnerType;
 
+
     private String localGitRepoPath;
     private String gitRepoFullName;
     private String externalGitRepoOwnerId;
@@ -84,12 +86,19 @@ public static AnalyzerRequest processSystemVariablesToRequest(Map<String, String
         analyzerRequest.setCodetyToken(envMap.get(CodetyConstant.ENV_CODETY_TOKEN));
         analyzerRequest.setCodetyHost(envMap.get(CodetyConstant.ENV_CODETY_HOST));
 
-        analyzerRequest.enableSlackNotification = "true".equals(envMap.get(CodetyConstant.ENV_CODETY_ENABLE_SLACK_NOTIFICATION));
+        analyzerRequest.enableSlackNotification = "true".equals(envMap.get(CodetyConstant.ENV_CODETY_ISSUE_REPORTER_SLACK));
         if(analyzerRequest.enableSlackNotification) {
             analyzerRequest.slackOauthToken = (envMap.get(CodetyConstant.ENV_SLACK_OAUTH_TOKEN));
             analyzerRequest.slackConversationId = (envMap.get(CodetyConstant.ENV_SLACK_CONVERSATION_ID));
         }
 
+        analyzerRequest.enableConsoleIssueReporter = !"false".equals(envMap.get(CodetyConstant.ENV_CODETY_ISSUE_REPORTER_CONSOLE));
+        analyzerRequest.enablePostingPullRequestComment = !"false".equals(envMap.get(CodetyConstant.ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_COMMENT));
+        analyzerRequest.enablePostingPullRequestReviews = !"false".equals(envMap.get(CodetyConstant.ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_REVIEW));
+        analyzerRequest.enablePostingGitHubPullRequestCheckRunAnnotations = !"false".equals(envMap.get(CodetyConstant.ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_CHECK_RUN_ANNOTATION));
+
+
+
         String handleDiff = envMap.get(CodetyConstant.ENV_CODETY_REPORT_ALL_ISSUES);
         if(handleDiff == null || "0".equals(handleDiff)){
             analyzerRequest.setFilterByGitDiff(true);
@@ -423,4 +432,12 @@ public void setSlackOauthToken(String slackOauthToken) {
     public void setSlackConversationId(String slackConversationId) {
         this.slackConversationId = slackConversationId;
     }
+
+    public boolean isEnableConsoleIssueReporter() {
+        return enableConsoleIssueReporter;
+    }
+
+    public void setEnableConsoleIssueReporter(boolean enableConsoleIssueReporter) {
+        this.enableConsoleIssueReporter = enableConsoleIssueReporter;
+    }
 }
diff --git a/scanner-common/src/main/java/io/codety/scanner/util/CodetyConstant.java b/scanner-common/src/main/java/io/codety/scanner/util/CodetyConstant.java
@@ -7,10 +7,15 @@ public class CodetyConstant {
     public static final String ENV_CODETY_TOKEN = "CODETY_TOKEN";
     public static final String ENV_SLACK_OAUTH_TOKEN = "SLACK_OAUTH_TOKEN";
     public static final String ENV_SLACK_CONVERSATION_ID = "SLACK_CONVERSATION_ID";
-    public static final String ENV_CODETY_ENABLE_SLACK_NOTIFICATION = "CODETY_ENABLE_SLACK_NOTIFICATION";
+    public static final String ENV_CODETY_ISSUE_REPORTER_SLACK = "CODETY_ISSUE_REPORTER_SLACK";
+    public static final String ENV_CODETY_ISSUE_REPORTER_CONSOLE = "CODETY_ISSUE_REPORTER_CONSOLE";
+    public static final String ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_COMMENT = "CODETY_ISSUE_REPORTER_GITHUB_PR_COMMENT";
+    public static final String ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_REVIEW = "CODETY_ISSUE_REPORTER_GITHUB_PR_REVIEW";
+    public static final String ENV_CODETY_ISSUE_REPORTER_GITHUB_PR_CHECK_RUN_ANNOTATION = "CODETY_ISSUE_REPORTER_GITHUB_PR_CHECK_RUN_ANNOTATION";
     public static final String ENV_CODETY_HOST = "CODETY_HOST";
     public static final String ENV_CODETY_REPORT_ALL_ISSUES = "CODETY_REPORT_ALL_ISSUES";
-    public static final String ENV_CODETY_CONNECTION_TIMEOUT = "CODETY_TIMEOUT";
+
+
     public static final String COMMAND_GIT = "git";
     public static final String[] COMMAND_GIT_FETCH = new String[]{COMMAND_GIT, "fetch"};
     public static final String INFO_PR_COMMENT_POSTED = "Posted the code analysis result to ";

diff --git a/scanner/doc/predefined-variables.md b/scanner/doc/predefined-variables.md
@@ -11,16 +11,46 @@ For troubleshooting purposes only.
 
 ####  CODETY_REPORT_ALL_ISSUES
 type: boolean
+
 value: false | true
 
-####  CODETY_PRINT_TO_CONSOLE
+#### CODETY_ISSUE_REPORTER_CONSOLE
+type: boolean
+
+value: false | true, default: true
+
+#### CODETY_ISSUE_REPORTER_GITHUB_PR_COMMENT
+default: true
+
+type: boolean
+
+value: false | true, default: true
+
+#### CODETY_ISSUE_REPORTER_GITHUB_PR_REVIEW
+default: true
+
+type: boolean
+
+value: false | true, default: true
+
+#### CODETY_ISSUE_REPORTER_GITHUB_PR_CHECK_RUN_ANNOTATION
+type: boolean
+
+value: false | true, default: true
 
 #### GITHUB_TOKEN
 The token will be used for posting pull request review comments
 Below GitHub permissions are needed within the Codety Scanner runtime scope:
 * `pull-requests: write`
 * `contents: read`
 
+#### CODETY_ISSUE_REPORTER_SLACK
+type: boolean
+
+value: false | true, default: false
+
+
+
 #### SLACK_OAUTH_TOKEN
 The token will be used for Slack notification integration.  
 Below Slack permissions are needed:

diff --git a/scanner/src/main/java/io/codety/scanner/reporter/CodeAnalysisResultDistributionService.java b/scanner/src/main/java/io/codety/scanner/reporter/CodeAnalysisResultDistributionService.java
@@ -49,9 +49,13 @@ public boolean distributeAnalysisResult(AnalyzerRequest analyzerRequest, CodeAna
         }
 
 
+
         consoleResultReporter.deliverResult(analyzerRequest, codeAnalysisResultSetDto);
+
         githubPullRequestResultReporter.deliverResult(analyzerRequest, codeAnalysisResultSetDto);
+
         slackResultReporter.deliverResult(analyzerRequest, codeAnalysisResultSetDto);
+
         sarifResultReporter.deliverResult(analyzerRequest, codeAnalysisResultSetDto);
 
         return true;

diff --git a/scanner/src/main/java/io/codety/scanner/reporter/console/ConsoleResultReporter.java b/scanner/src/main/java/io/codety/scanner/reporter/console/ConsoleResultReporter.java
@@ -13,6 +13,10 @@ public class ConsoleResultReporter implements ResultReporter {
     @Override
     public void deliverResult(AnalyzerRequest analyzerRequest, CodeAnalysisResultSetDto codeAnalysisResultSetDto) {
 
+        if(!analyzerRequest.isEnableConsoleIssueReporter()) {
+            CodetyConsoleLogger.info("Skip posting issue result into console terminal");
+        }
+
         String consoleOutputString = codeAnalysisResultSetDto.toConsoleOutputString(analyzerRequest);
         if(consoleOutputString!=null && consoleOutputString.length() > 0) {
             CodetyConsoleLogger.info(CodetyConstant.INFO_SHOW_ANALYSIS_RESULT);

diff --git a/scanner/src/main/java/io/codety/scanner/reporter/github/GithubPullRequestResultReporter.java b/scanner/src/main/java/io/codety/scanner/reporter/github/GithubPullRequestResultReporter.java
@@ -47,9 +47,9 @@ public void deliverResult(AnalyzerRequest analyzerRequest, CodeAnalysisResultSet
                 StringBuilder pullRequestComment = createPullRequestComment(analyzerRequest, codeAnalysisResultDtoList);
                 githubCommentService.addOrUpdatePullRequestComment(analyzerRequest, pullRequestComment.toString());
             }
-//            if(analyzerRequest.isEnablePostingGitHubPullRequestCheckRunAnnotations()){
-//                githubCommentService.addCheckRunAnnotations(analyzerRequest, codeAnalysisResultDtoList);
-//            }
+            if(analyzerRequest.isEnablePostingGitHubPullRequestCheckRunAnnotations()){
+                githubCommentService.addCheckRunAnnotations(analyzerRequest, codeAnalysisResultDtoList);
+            }
         }
 
     }