Services refactor

build.gradle

@@ -1,14 +1,17 @@
 buildscript {
     apply from: "https://raw.githubusercontent.com/blackducksoftware/integration-resources/master/gradle_common/buildscript-repositories.gradle", to: buildscript
-    apply from: 'https://raw.githubusercontent.com/blackducksoftware/integration-resources/master/gradle_common/buildscript-dependencies.gradle', to: buildscript
+    ////////// START BUILDSCRIPT DEPENDENCY //////////
+dependencies { classpath "com.synopsys.integration:common-gradle-plugin:1.12.0" }
+
+////////// END BUILDSCRIPT DEPENDENCY //////////
 }
 
 plugins {
     id 'org.jenkins-ci.jpi' version '0.38.0'
 }
 
 group = 'org.jenkins-ci.plugins'
-version = '3.0.0-SIGQA3-SNAPSHOT'
+version = '3.0.0'
 description = 'Allows users to run Coverity commands in their builds'
 
 apply plugin: 'com.synopsys.integration.solution'
@@ -34,7 +37,7 @@ dependencies {
     annotationProcessor 'com.synopsys.integration:jenkins-annotation-processor:0.0.1'
 
     implementation 'com.synopsys.integration:coverity-common:0.8.1'
-    implementation 'com.synopsys.integration:jenkins-common:0.4.0'
+    implementation 'com.synopsys.integration:jenkins-common:0.5.0'
 
 
     // Must be compatible with the versions declared in Jenkins Common

src/main/java/com/synopsys/integration/jenkins/coverity/CoverityDisposerCommands.java

@@ -0,0 +1,32 @@
+/*
+ * synopsys-coverity
+ *
+ * Copyright (c) 2021 Synopsys, Inc.
+ *
+ * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
+ */
+package com.synopsys.integration.jenkins.coverity;
+
+import org.apache.commons.lang.StringUtils;
+
+import com.synopsys.integration.jenkins.coverity.service.CleanUpWorkflowService;
+import com.synopsys.integration.jenkins.coverity.service.CoverityEnvironmentService;
+
+public class CoverityDisposerCommands {
+    private final CoverityEnvironmentService coverityEnvironmentService;
+    private final CleanUpWorkflowService cleanUpWorkflowService;
+
+    public CoverityDisposerCommands(CoverityEnvironmentService coverityEnvironmentService, CleanUpWorkflowService cleanUpWorkflowService) {
+        this.coverityEnvironmentService = coverityEnvironmentService;
+        this.cleanUpWorkflowService = cleanUpWorkflowService;
+    }
+
+    public void cleanUp() {
+        String authKeyFilePath = coverityEnvironmentService.getAuthKeyFilePath();
+
+        if (StringUtils.isNotBlank(authKeyFilePath)) {
+            cleanUpWorkflowService.cleanUpAuthenticationFile(authKeyFilePath);
+        }
+    }
+
+}

src/main/java/com/synopsys/integration/jenkins/coverity/CoverityFreestyleCommands.java

@@ -0,0 +1,143 @@
+/*
+ * synopsys-coverity
+ *
+ * Copyright (c) 2021 Synopsys, Inc.
+ *
+ * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
+ */
+package com.synopsys.integration.jenkins.coverity;
+
+import java.util.List;
+import java.util.Optional;
+
+import org.apache.commons.lang.StringUtils;
+
+import com.synopsys.integration.coverity.api.rest.ViewContents;
+import com.synopsys.integration.coverity.ws.view.ViewReportWrapper;
+import com.synopsys.integration.exception.IntegrationException;
+import com.synopsys.integration.jenkins.coverity.actions.IssueReportAction;
+import com.synopsys.integration.jenkins.coverity.extensions.CheckForIssuesInView;
+import com.synopsys.integration.jenkins.coverity.extensions.CleanUpAction;
+import com.synopsys.integration.jenkins.coverity.extensions.ConfigureChangeSetPatterns;
+import com.synopsys.integration.jenkins.coverity.extensions.OnCommandFailure;
+import com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityRunConfiguration;
+import com.synopsys.integration.jenkins.coverity.service.CleanUpWorkflowService;
+import com.synopsys.integration.jenkins.coverity.service.CoverityCommandService;
+import com.synopsys.integration.jenkins.coverity.service.CoverityEnvironmentService;
+import com.synopsys.integration.jenkins.coverity.service.CoverityPhoneHomeService;
+import com.synopsys.integration.jenkins.coverity.service.CoverityWorkspaceService;
+import com.synopsys.integration.jenkins.coverity.service.IssuesInViewService;
+import com.synopsys.integration.jenkins.coverity.service.ProjectStreamCreationService;
+import com.synopsys.integration.jenkins.extensions.ChangeBuildStatusTo;
+import com.synopsys.integration.jenkins.extensions.JenkinsIntLogger;
+import com.synopsys.integration.jenkins.service.JenkinsBuildService;
+import com.synopsys.integration.util.IntEnvironmentVariables;
+
+public class CoverityFreestyleCommands {
+    private final JenkinsIntLogger logger;
+    private final JenkinsBuildService jenkinsBuildService;
+    private final CoverityPhoneHomeService coverityPhoneHomeService;
+    private final CoverityWorkspaceService coverityWorkspaceService;
+    private final CoverityEnvironmentService coverityEnvironmentService;
+    private final ProjectStreamCreationService projectStreamCreationService;
+    private final CoverityCommandService coverityCommandService;
+    private final IssuesInViewService issuesInViewService;
+    private final CleanUpWorkflowService cleanUpWorkflowService;
+
+    public CoverityFreestyleCommands(JenkinsIntLogger logger, JenkinsBuildService jenkinsBuildService, CoverityPhoneHomeService coverityPhoneHomeService,
+        CoverityWorkspaceService coverityWorkspaceService, CoverityEnvironmentService coverityEnvironmentService, ProjectStreamCreationService projectStreamCreationService,
+        CoverityCommandService coverityCommandService, IssuesInViewService issuesInViewService, CleanUpWorkflowService cleanUpWorkflowService){
+        this.logger = logger;
+        this.jenkinsBuildService = jenkinsBuildService;
+        this.coverityPhoneHomeService = coverityPhoneHomeService;
+        this.coverityWorkspaceService = coverityWorkspaceService;
+        this.coverityEnvironmentService = coverityEnvironmentService;
+        this.projectStreamCreationService = projectStreamCreationService;
+        this.coverityCommandService = coverityCommandService;
+        this.issuesInViewService = issuesInViewService;
+        this.cleanUpWorkflowService = cleanUpWorkflowService;
+    }
+
+    public void runCoverityCommands(
+        String coverityInstanceUrl,
+        String credentialsId,
+        String projectName,
+        String streamName,
+        String customWorkspacePath,
+        CoverityRunConfiguration coverityRunConfiguration,
+        ConfigureChangeSetPatterns configureChangeSetPatterns,
+        CheckForIssuesInView checkForIssuesInView,
+        OnCommandFailure onCommandFailure,
+        CleanUpAction cleanUpAction
+    ) {
+        coverityPhoneHomeService.phoneHome(coverityInstanceUrl, credentialsId);
+        String viewName = Optional.ofNullable(checkForIssuesInView).map(CheckForIssuesInView::getViewName).orElse(StringUtils.EMPTY);
+        ChangeBuildStatusTo buildStatus = Optional.ofNullable(checkForIssuesInView).map(CheckForIssuesInView::getBuildStatusForIssues).orElse(ChangeBuildStatusTo.SUCCESS);
+
+        boolean shouldValidateVersion = CoverityRunConfiguration.RunConfigurationType.SIMPLE.equals(coverityRunConfiguration.getRunConFigurationType());
+
+        try {
+            String authKeyFilePath = null;
+            String intermediateDirectoryPath = null;
+            try {
+                String coverityToolHomeBin = coverityWorkspaceService.getValidatedCoverityToolHomeBin(shouldValidateVersion, coverityEnvironmentService.getCoverityToolHome());
+                authKeyFilePath = coverityWorkspaceService.createAuthenticationKeyFile(coverityInstanceUrl, credentialsId, customWorkspacePath);
+                intermediateDirectoryPath = coverityWorkspaceService.getIntermediateDirectoryPath(customWorkspacePath);
+
+                IntEnvironmentVariables coverityEnvironment = coverityEnvironmentService.createCoverityEnvironment(
+                    configureChangeSetPatterns,
+                    coverityInstanceUrl,
+                    credentialsId,
+                    projectName,
+                    streamName,
+                    viewName,
+                    intermediateDirectoryPath,
+                    coverityToolHomeBin,
+                    authKeyFilePath
+                );
+
+                projectStreamCreationService.createMissingProjectOrStream(coverityInstanceUrl, credentialsId, projectName, streamName);
+                if (coverityCommandService.shouldRunCoverityCommands(coverityEnvironment, coverityRunConfiguration)) {
+                    List<List<String>> coverityCommands = coverityCommandService.getCommands(coverityEnvironment, coverityRunConfiguration);
+                    coverityCommandService.runCommands(coverityEnvironment, coverityCommands, customWorkspacePath, onCommandFailure);
+                }
+
+                if (checkForIssuesInView != null) {
+                    ViewReportWrapper viewReportWrapper = issuesInViewService.getIssuesInView(coverityInstanceUrl, credentialsId, projectName, viewName);
+                    logger.alwaysLog("Checking for issues in view");
+                    logger.alwaysLog("-- Build state for issues in the view: " + buildStatus.getDisplayName());
+                    logger.alwaysLog("-- Coverity project name: " + projectName);
+                    logger.alwaysLog("-- Coverity view name: " + viewName);
+
+                    ViewContents viewContents = viewReportWrapper.getViewContents();
+                    String viewReportUrl = viewReportWrapper.getViewReportUrl();
+                    int defectCount = viewContents.getTotalRows().intValue();
+                    jenkinsBuildService.addAction(new IssueReportAction(defectCount, viewReportUrl));
+                    logger.alwaysLog(String.format("[Coverity] Found %s issues: %s", defectCount, viewReportUrl));
+
+                    if (defectCount > 0) {
+                        jenkinsBuildService.markBuildAs(buildStatus);
+                    }
+                }
+            } finally {
+                if (StringUtils.isNotBlank(authKeyFilePath)) {
+                    cleanUpWorkflowService.cleanUpAuthenticationFile(authKeyFilePath);
+                }
+
+                if (CleanUpAction.DELETE_INTERMEDIATE_DIRECTORY.equals(cleanUpAction)) {
+                    cleanUpWorkflowService.cleanUpIntermediateDirectory(intermediateDirectoryPath);
+                }
+            }
+        } catch (InterruptedException e) {
+            logger.error("[ERROR] Synopsys Coverity thread was interrupted.", e);
+            jenkinsBuildService.markBuildInterrupted();
+            Thread.currentThread().interrupt();
+        } catch (IntegrationException e) {
+            jenkinsBuildService.markBuildFailed(e);
+        } catch (Exception e) {
+            jenkinsBuildService.markBuildUnstable(e);
+        }
+    }
+
+
+}

src/main/java/com/synopsys/integration/jenkins/coverity/CoverityPipelineCommands.java

@@ -0,0 +1,61 @@
+/*
+ * synopsys-coverity
+ *
+ * Copyright (c) 2021 Synopsys, Inc.
+ *
+ * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
+ */
+package com.synopsys.integration.jenkins.coverity;
+
+import java.io.IOException;
+
+import com.synopsys.integration.coverity.api.ws.configuration.CovRemoteServiceException_Exception;
+import com.synopsys.integration.coverity.ws.view.ViewReportWrapper;
+import com.synopsys.integration.exception.IntegrationException;
+import com.synopsys.integration.jenkins.coverity.actions.IssueReportAction;
+import com.synopsys.integration.jenkins.coverity.exception.CoverityJenkinsException;
+import com.synopsys.integration.jenkins.coverity.service.CoverityPhoneHomeService;
+import com.synopsys.integration.jenkins.coverity.service.IssuesInViewService;
+import com.synopsys.integration.jenkins.extensions.JenkinsIntLogger;
+import com.synopsys.integration.jenkins.service.JenkinsPipelineFlowService;
+import com.synopsys.integration.jenkins.service.JenkinsRunService;
+
+public class CoverityPipelineCommands {
+    private final JenkinsIntLogger logger;
+    private final JenkinsRunService jenkinsRunService;
+    private final CoverityPhoneHomeService coverityPhoneHomeService;
+    private final IssuesInViewService issuesInViewService;
+    private final JenkinsPipelineFlowService jenkinsPipelineFlowService;
+
+    public CoverityPipelineCommands(JenkinsIntLogger logger, JenkinsPipelineFlowService jenkinsPipelineFlowService, JenkinsRunService jenkinsRunService, CoverityPhoneHomeService coverityPhoneHomeService, IssuesInViewService issuesInViewService){
+        this.logger = logger;
+        this.jenkinsPipelineFlowService = jenkinsPipelineFlowService;
+        this.jenkinsRunService = jenkinsRunService;
+        this.coverityPhoneHomeService = coverityPhoneHomeService;
+        this.issuesInViewService = issuesInViewService;
+    }
+
+    public int getIssueCount(String coverityInstanceUrl, String credentialsId, String projectName, String viewName, Boolean returnIssueCount, Boolean markUnstable) throws IntegrationException, CovRemoteServiceException_Exception, IOException {
+        coverityPhoneHomeService.phoneHome(coverityInstanceUrl, credentialsId);
+
+        ViewReportWrapper viewReportWrapper = issuesInViewService.getIssuesInView(coverityInstanceUrl, credentialsId, projectName, viewName);
+        String viewReportUrl = viewReportWrapper.getViewReportUrl();
+        int defectCount = viewReportWrapper.getViewContents().getTotalRows().intValue();
+        String defectMessage = String.format("[Coverity] Found %s issues: %s", defectCount, viewReportUrl);
+
+        jenkinsRunService.addAction(new IssueReportAction(defectCount, viewReportUrl));
+        if (defectCount > 0) {
+            if (Boolean.TRUE.equals(markUnstable)) {
+                jenkinsPipelineFlowService.markStageUnstable(defectMessage);
+            } else if (Boolean.TRUE.equals(returnIssueCount)) {
+                logger.error(defectMessage);
+            } else {
+                throw new CoverityJenkinsException(defectMessage);
+            }
+        }
+
+        return defectCount;
+    }
+
+
+}