Skip to content

Commit

Permalink
Merge pull request #53 from jenkinsci/use-latest-common
Browse files Browse the repository at this point in the history 
Use latest common
  • Loading branch information
@ghannamz
ghannamz authored Oct 25, 2020
2 parents 3751e86 + c2c8a18 commit 514623b
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 61 deletions.
8 changes: 4 additions & 4 deletions build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,23 @@ dependencies {
compileOnly 'com.intellij:annotations:12.0',
'org.slf4j:slf4j-api:1.6.1'

compile 'com.checkmarx:cx-client-common:2020.3.82',
compile 'com.checkmarx:cx-client-common:2020.4.96',
'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.10.5',
'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.10.5'

optionalJenkinsPlugins 'org.jenkins-ci.main:maven-plugin:1.509.4@jar',
'org.jenkins-ci.plugins:credentials:2.1.19@jar'


testCompile 'junit:junit:4.12',
testCompile 'junit:junit:4.13.1',
'org.eclipse.sisu:org.eclipse.sisu.plexus:0.0.0.M5',
'org.jmockit:jmockit:1.16'


// Fails with Gradle 2.12 and up without it. Related to https://issues.jenkins-ci.org/browse/JENKINS-17129
jenkinsTest 'org.jenkins-ci.plugins:ant:1.2@jar',
'org.jenkins-ci.plugins:mailer:1.1@jar',
'org.jenkins-ci.plugins:matrix-project:1.14@jar'
'org.jenkins-ci.plugins:mailer:1.32.1@jar',
'org.jenkins-ci.plugins:matrix-project:1.18@jar'

testImplementation('org.junit.jupiter:junit-jupiter-api:5.4.2',
'org.mockito:mockito-junit-jupiter:2.23.0')
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
description = Provides automatic scan of code by Checkmarx server and shows results summary and trend in Jenkins interface.
group = com.checkmarx.jenkins
version = 2020.3.6
version = 2020.4.3

repositoryVersion=

Expand Down
74 changes: 56 additions & 18 deletions src/main/java/com/checkmarx/jenkins/CxScanBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

Expand Down Expand Up @@ -435,6 +433,11 @@ public boolean isOsaEnabled() {
return osaEnabled;
}

@DataBoundSetter
public void setOsaEnabled(boolean osaEnabled) {
this.osaEnabled = osaEnabled;
}

@Nullable
public Integer getOsaHighThreshold() {
return osaHighThreshold;
Expand Down Expand Up @@ -470,21 +473,41 @@ public String getExcludeOpenSourceFolders() {
return excludeOpenSourceFolders;
}

@DataBoundSetter
public void setExcludeOpenSourceFolders(@Nullable String excludeOpenSourceFolders) {
this.excludeOpenSourceFolders = excludeOpenSourceFolders;
}

@Nullable
public String getIncludeOpenSourceFolders() {
return includeOpenSourceFolders;
}

@DataBoundSetter
public void setIncludeOpenSourceFolders(@Nullable String includeOpenSourceFolders) {
this.includeOpenSourceFolders = includeOpenSourceFolders;
}

@Nullable
public String getOsaArchiveIncludePatterns() {
return osaArchiveIncludePatterns;
}

@DataBoundSetter
public void setOsaArchiveIncludePatterns(@Nullable String osaArchiveIncludePatterns) {
this.osaArchiveIncludePatterns = osaArchiveIncludePatterns;
}

@Nullable
public boolean isOsaInstallBeforeScan() {
return osaInstallBeforeScan;
}

@DataBoundSetter
public void setOsaInstallBeforeScan(boolean osaInstallBeforeScan) {
this.osaInstallBeforeScan = osaInstallBeforeScan;
}

public boolean isGeneratePdfReport() {
return generatePdfReport;
}
Expand Down Expand Up @@ -857,6 +880,17 @@ private CxScanConfig resolveConfiguration(Run<?, ?> run, DescriptorImpl descript
}
}

if (isOsaEnabled() && getDependencyScanConfig() == null) {
DependencyScanConfig config = new DependencyScanConfig();
config.overrideGlobalConfig = true;
config.dependencyScannerType = DependencyScannerType.OSA;
config.dependencyScanPatterns = getIncludeOpenSourceFolders();
config.dependencyScanExcludeFolders = getExcludeOpenSourceFolders();
config.osaArchiveIncludePatterns = getOsaArchiveIncludePatterns();
config.osaInstallBeforeScan = isOsaInstallBeforeScan();
setDependencyScanConfig(config);
}

configureDependencyScan(run, descriptor, env, ret);

if (!ret.getSynchronous()) {
Expand Down Expand Up @@ -886,7 +920,16 @@ private void configureDependencyScan(Run<?, ?> run, DescriptorImpl descriptor, E
return;
}

config.addScannerType(effectiveConfig.dependencyScannerType);
ScannerType scannerType = null;
if (effectiveConfig.dependencyScannerType == DependencyScannerType.OSA) {
scannerType = ScannerType.OSA;
} else if (effectiveConfig.dependencyScannerType == DependencyScannerType.SCA) {
scannerType = ScannerType.AST_SCA;
}

if (scannerType != null) {
config.addScannerType(scannerType);
}

config.setOsaFilterPattern(env.expand(effectiveConfig.dependencyScanPatterns));
config.setOsaFolderExclusions(env.expand(effectiveConfig.dependencyScanExcludeFolders));
Expand Down Expand Up @@ -1063,9 +1106,9 @@ private void failTheBuild(Run<?, ?> run, CxScanConfig config, ScanResults ret) {
//assert if expected exception is thrown OR when vulnerabilities under threshold OR when policy violated
ScanSummary scanSummary = new ScanSummary(config, ret.getSastResults(), ret.getOsaResults(), ret.getScaResults());
if (scanSummary.hasErrors() || ret.getGeneralException() != null ||
(ret.getSastResults() != null && (ret.getSastResults().getCreateException() != null || ret.getSastResults().getWaitException() != null)) ||
(ret.getOsaResults() != null && (ret.getOsaResults().getCreateException() != null || ret.getOsaResults().getWaitException() != null)) ||
(ret.getScaResults() != null && (ret.getScaResults().getCreateException() != null || ret.getScaResults().getWaitException() != null))) {
(ret.getSastResults() != null && ret.getSastResults().getException() != null) ||
(ret.getOsaResults() != null && ret.getOsaResults().getException() != null) ||
(ret.getScaResults() != null && ret.getScaResults().getException() != null)) {
printBuildFailure(scanSummary.toString(), ret, log);
if (resolvedVulnerabilityThresholdResult != null) {
run.setResult(resolvedVulnerabilityThresholdResult);
Expand All @@ -1085,17 +1128,12 @@ private void printBuildFailure(String thDescription, ScanResults ret, CxLoggerAd
log.error("********************************************");

logError(ret.getGeneralException());
if (ret.getSastResults() != null) {
logError(ret.getSastResults().getCreateException());
logError(ret.getSastResults().getWaitException());
}
if (ret.getOsaResults() != null) {
logError(ret.getOsaResults().getCreateException());
logError(ret.getOsaResults().getWaitException());
}
if (ret.getScaResults() != null) {
logError(ret.getScaResults().getCreateException());
logError(ret.getScaResults().getWaitException());

Map<ScannerType, Results> resultsMap = ret.getResults();
for (Results results : resultsMap.values()) {
if (results != null && results.getException() != null) {
logError(results.getException());
}
}

if (thDescription != null) {
Expand Down
63 changes: 33 additions & 30 deletions src/main/java/com/checkmarx/jenkins/CxScanCallable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

import com.cx.restclient.CxClientDelegator;
import com.cx.restclient.configuration.CxScanConfig;
import com.cx.restclient.dto.Results;
import com.cx.restclient.dto.ScanResults;
import com.cx.restclient.dto.ScannerType;
import com.cx.restclient.exception.CxClientException;
import hudson.FilePath;
import hudson.ProxyConfiguration;
Expand All @@ -13,6 +15,9 @@
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.logging.StreamHandler;
Expand All @@ -25,10 +30,6 @@ public class CxScanCallable implements FilePath.FileCallable<RemoteScanInfo>, Se
private final TaskListener listener;
private ProxyConfiguration jenkinsProxy = null;

private Exception sastCreateEx;
private Exception osaCreateEx;
private Exception scaCreateEx;

public CxScanCallable(CxScanConfig config, TaskListener listener) {
this.config = config;
this.listener = listener;
Expand All @@ -47,21 +48,22 @@ public RemoteScanInfo invoke(File file, VirtualChannel channel) throws IOExcepti
config.setReportsDir(file);

RemoteScanInfo result = new RemoteScanInfo();
ScanResults scanResults = new ScanResults();
result.setScanResults(scanResults);

CxClientDelegator delegator = null;
List<ScanResults> results = new ArrayList<>();

try {
//todo: add proxy support in new common
delegator = CommonClientFactory.getClientDelegatorInstance(config, log);
delegator.init();
ScanResults initResults = delegator.init();
results.add(initResults);

// Make sure CxARMUrl is passed in the result.
// Cannot pass CxARMUrl in the config object, because this callable can be executed on a Jenkins agent.
// On a Jenkins agent we'll get a cloned config instead of the original object reference.
result.setCxARMUrl(config.getCxARMUrl());
} catch (Exception ex) {
ScanResults scanResults = new ScanResults();
scanResults.setGeneralException(ex);
result.setScanResults(scanResults);

String message = ex.getMessage();
// Can actually be null e.g. for NullPointerException.
Expand Down Expand Up @@ -102,25 +104,27 @@ public RemoteScanInfo invoke(File file, VirtualChannel channel) throws IOExcepti
}

ScanResults createScanResults = delegator.initiateScan();
updateCreateExceptions(createScanResults, false);
results.add(createScanResults);

if (rootLog != null) {
handler.flush();
rootLog.removeHandler(handler);
}

scanResults = config.getSynchronous() ? delegator.waitForScanResults() : delegator.getLatestScanResults();
updateCreateExceptions(scanResults, true);
ScanResults scanResults = config.getSynchronous() ? delegator.waitForScanResults() : delegator.getLatestScanResults();
results.add(scanResults);

if (config.getSynchronous() && config.isSastEnabled() && scanResults.getSastResults().getWaitException() != null) {
if (config.getSynchronous() && config.isSastEnabled() &&
((createScanResults.getSastResults() != null && createScanResults.getSastResults().getException() != null && createScanResults.getSastResults().getScanId() > 0) || (scanResults.getSastResults() != null && scanResults.getSastResults().getException() != null))) {
cancelScan(delegator);
}

if (config.getEnablePolicyViolations()) {
delegator.printIsProjectViolated(scanResults);
}

result.setScanResults(scanResults);
ScanResults finalScanResults = getFinalScanResults(results);
result.setScanResults(finalScanResults);
return result;
}

Expand All @@ -136,22 +140,21 @@ public void checkRoles(RoleChecker checker) throws SecurityException {

}

private void updateCreateExceptions(ScanResults results, boolean shouldAddException) {
boolean sastResults = results.getSastResults() != null;
boolean osaResults = results.getOsaResults() != null;
boolean scaResults = results.getScaResults() != null;

if (!shouldAddException) {
sastCreateEx = sastResults ? results.getSastResults().getCreateException() : null;
osaCreateEx = osaResults ? results.getOsaResults().getCreateException() : null;
scaCreateEx = scaResults ? results.getScaResults().getCreateException() : null;
} else {
if (sastResults)
results.getSastResults().setCreateException(sastCreateEx);
if (osaResults)
results.getOsaResults().setCreateException(osaCreateEx);
if (scaResults)
results.getScaResults().setCreateException(scaCreateEx);
private ScanResults getFinalScanResults(List<ScanResults> results) {
ScanResults scanResults = new ScanResults();

for (int i = 0; i < results.size(); i++) {
Map<ScannerType, Results> resultsMap = results.get(i).getResults();
for (Map.Entry<ScannerType, Results> entry : resultsMap.entrySet()) {
if (entry != null && entry.getValue() != null && entry.getValue().getException() != null && scanResults.get(entry.getKey()) == null) {
scanResults.put(entry.getKey(), entry.getValue());
}
if (i == results.size() - 1 && entry != null && entry.getValue() != null && entry.getValue().getException() == null) {
scanResults.put(entry.getKey(), entry.getValue());
}
}
}

return scanResults;
}
}
3 changes: 1 addition & 2 deletions src/main/java/com/checkmarx/jenkins/DependencyScanConfig.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package com.checkmarx.jenkins;

import com.cx.restclient.dto.ScannerType;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand All @@ -22,7 +21,7 @@ public class DependencyScanConfig {
public String dependencyScanExcludeFolders;

@DataBoundSetter
public ScannerType dependencyScannerType;
public DependencyScannerType dependencyScannerType;

@DataBoundSetter
public String osaArchiveIncludePatterns;
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/com/checkmarx/jenkins/DependencyScannerType.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package com.checkmarx.jenkins;

public enum DependencyScannerType {
OSA,
SCA
}
3 changes: 1 addition & 2 deletions src/main/java/com/checkmarx/jenkins/PluginDataMigration.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package com.checkmarx.jenkins;

import com.cx.restclient.dto.ScannerType;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.jetbrains.annotations.NotNull;
Expand Down Expand Up @@ -43,7 +42,7 @@ private boolean needToMigrate(CxScanBuilder builder) {
private DependencyScanConfig extractDependencyScanConfig(CxScanBuilder builder) {
DependencyScanConfig config = new DependencyScanConfig();
config.overrideGlobalConfig = true;
config.dependencyScannerType = ScannerType.OSA;
config.dependencyScannerType = DependencyScannerType.OSA;
config.dependencyScanPatterns = builder.getIncludeOpenSourceFolders();
config.dependencyScanExcludeFolders = builder.getExcludeOpenSourceFolders();
config.osaArchiveIncludePatterns = builder.getOsaArchiveIncludePatterns();
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/com/checkmarx/jenkins/CxScanBuilder/config.jelly
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@
</f:nested>
</f:radioBlock>

<f:radioBlock checked="${instance.dependencyScanConfig.dependencyScannerType == 'AST_SCA'}"
inline="true" name="dependencyScannerType" title="Use CxSCA dependency scanner" value="AST_SCA">
<f:radioBlock checked="${instance.dependencyScanConfig.dependencyScannerType == 'SCA'}"
inline="true" name="dependencyScannerType" title="Use CxSCA dependency scanner" value="SCA">
<f:nested>
<f:entry title="CxSCA API URL" field="scaServerUrl">
<f:textbox default="${descriptor.DEFAULT_SCA_SERVER_URL}"
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/com/checkmarx/jenkins/CxScanBuilder/global.jelly
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@
</f:nested>
</f:radioBlock>

<f:radioBlock checked="${descriptor.dependencyScanConfig.dependencyScannerType == 'AST_SCA'}"
inline="true" name="dependencyScannerType" title="Use CxSCA dependency scanner" value="AST_SCA">
<f:radioBlock checked="${descriptor.dependencyScanConfig.dependencyScannerType == 'SCA'}"
inline="true" name="dependencyScannerType" title="Use CxSCA dependency scanner" value="SCA">
<f:nested>
<f:entry title="CxSCA API URL" field="scaServerUrl">
<f:textbox default="${descriptor.DEFAULT_SCA_SERVER_URL}"
Expand Down

0 comments on commit 514623b

Please sign in to comment.