io.jenkins.plugins.servicenow.rest

Class QCScanRest

java.lang.Object

io.jenkins.plugins.servicenow.rest.QCScanRest

public class QCScanRest
extends Object

Author:

akramkohansal This class is to make connection to QC API, run scan and fetch the result.

Constructor Summary

Constructors

Constructor and Description
QCScanRest()

Method Summary

Modifier and Type	Method and Description
int	checkHighSeverityIssuesCount(SNowScanRestResponse snowScan, int highSeverityThreshold, String credential, org.apache.http.client.HttpClient client, String issueUrl)
Map<String,Object>	doScan(String credential, String instanceUrl, hudson.model.TaskListener taskListener, int issuesCountThreshold, int techDebtThreshold, int qcThreshold, int highSeverityThreshold) This method is responsible to do scan
int	evaluateScanResult(SNowScanRestResponse snowScan, int issuesCountThreshold, int techDebtThreshold, int qcThreshold)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QCScanRest

public QCScanRest()

Method Detail

doScan

public Map<String,Object> doScan(String credential,
                                 String instanceUrl,
                                 hudson.model.TaskListener taskListener,
                                 int issuesCountThreshold,
                                 int techDebtThreshold,
                                 int qcThreshold,
                                 int highSeverityThreshold)

This method is responsible to do scan

Parameters:

credential - The API key

instanceUrl - The URL to scan

taskListener - The task Listener - logging, etc

issuesCountThreshold - Number of issues to fail the build

techDebtThreshold - Technical debt minutes to fail the build

qcThreshold - Minimum Quality of Cloud to fail the build

highSeverityThreshold - Number of high severity issues to fail the build

Returns:

The results of the scan

evaluateScanResult

public int evaluateScanResult(SNowScanRestResponse snowScan,
                              int issuesCountThreshold,
                              int techDebtThreshold,
                              int qcThreshold)

Parameters:

snowScan - The results of the scan

issuesCountThreshold - Number of issues to fail the build

techDebtThreshold - Technical debt to fail the build

qcThreshold - Minimum Quality of Cloud to fail the build

Returns:

The scan result code

checkHighSeverityIssuesCount

public int checkHighSeverityIssuesCount(SNowScanRestResponse snowScan,
                                        int highSeverityThreshold,
                                        String credential,
                                        org.apache.http.client.HttpClient client,
                                        String issueUrl)
                                 throws IOException

Throws:

IOException