com.ibm.devops.dra

Class AbstractDevOpsAction

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.ibm.devops.dra.AbstractDevOpsAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

Direct Known Subclasses:

EvaluateGate, PublishBuild, PublishDeploy, PublishSQ, PublishTest

public abstract class AbstractDevOpsAction
extends hudson.tasks.Recorder

Abstract DRA Builder to share common method between two different post-build actions

Nested Class Summary

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_KEY
static String	APP_NAME
static String	CONTROL_CENTER
static String	DEFAULT_ENV
static String	DLMS
static String	ENV
static String	GATE_SERVICE
static Logger	LOGGER
static String	PASSWORD
static String	RESULT_FAIL
static String	RESULT_SUCCESS
static String	TOOLCHAIN_ID
static String	USERNAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AbstractDevOpsAction()

Method Summary

Modifier and Type	Method and Description
static String	chooseAppsUrl(String environment)
static String	chooseIAMAPI(String environment)
static String	chooseOrganizationsUrl(String environment)
static String	chooseSpacesUrl(String environment)
static String	chooseTargetAPI(String environment)
static String	constructBuildNumber(String jobName, hudson.model.Run build) construct the build number, format will be the jobName:buildNumber
static String	expandVariable(String key, hudson.EnvVars envVars, boolean isRequired) expand the env var and check if it is a required var
static Map<String,String>	getAllEndpoints(String OTCBrokerServer, String token, String toolchainId)
static String	getAppId(String token, String appName, String orgName, String spaceName, String environment, Boolean debug_mode)
static String	getBluemixToken(String username, String password, String targetAPI, PrintStream printStream) given the username and password, get the UAA token
static String	getBuildNumber(hudson.EnvVars envVars, String jobName, hudson.model.Run build, PrintStream printStream) get build number if it is not specified
static com.google.gson.JsonObject	getDecisionFromDRA(String bluemixToken, String toolchainId, String draUrl, PrintStream printStream, boolean isDebugMode) Get gate decision from DevOps Insights
static String	getDeploymentRiskUrl(String baseUrl, String toolchainId)
static String	getIAMToken(String apikey, String iamAPI, PrintStream printStream) get IAM token using API key
static String	getIBMCloudToken(String credentialsId, String apikey, String username, String password, String env, hudson.model.Job context, PrintStream printStream) get token for either pipeline or freestyle in the runtime
static String	getOrgId(String token, String orgName, String environment, Boolean debug_mode)
static String	getOTCBrokerServer(String env) get the OTC broker server endpoint
static hudson.util.ListBoxModel	getPolicyList(String token, String toolchainId, String environment, boolean isDebugMode) Get a list of policies that belong to a toolchain
static String	getReportUrl(String baseUrl, String toolchainId, String reportId)
static String	getSpaceId(String token, String spaceName, String environment, Boolean debug_mode)
static String	getTokenForFreeStyleJob(com.cloudbees.plugins.credentials.common.StandardCredentials credentials, String iamAPI, String targetAPI, PrintStream printStream) get IAM or UAA token based on the credentials id, only used by freestyle job's test connection or get the policy list
static void	passEnvToNextBuildStep(hudson.model.Run build, String bluemixToken, String buildId) write to the environment variables to pass to next build step
static void	printDebugLog(PrintStream printStream, org.apache.http.client.methods.HttpEntityEnclosingRequestBase method, String status, String resStr)
static void	publishDecision(com.google.gson.JsonObject obj, hudson.model.Run build, String reportUrl, String ccUrl, String policyName, boolean willDisrupt, PrintStream printStream) publish the decision to Jenkins UI and fail the build/job/pipeline if needed
static String	setDLMSUrl(String baseUrl, String toolchainId, String appName, String buildId) set DLMS endpoint url to upload data to DLMS
static String	setGateServiceUrl(String baseUrl, String toolchainId, String applicationName, String buildId, String policyName, String environmentName)
static HashMap<String,String>	setRequiredEnvVars(AbstractDevOpsStep step, hudson.EnvVars envVars) set the required env variables' HashMap for all steps

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getRequiredMonitorService

Field Detail

LOGGER

public static final Logger LOGGER

APP_NAME

public static final String APP_NAME

See Also:

Constant Field Values

TOOLCHAIN_ID

public static final String TOOLCHAIN_ID

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

API_KEY

public static final String API_KEY

See Also:

Constant Field Values

ENV

public static final String ENV

See Also:

Constant Field Values

RESULT_SUCCESS

public static final String RESULT_SUCCESS

See Also:

Constant Field Values

RESULT_FAIL

public static final String RESULT_FAIL

See Also:

Constant Field Values

DEFAULT_ENV

public static final String DEFAULT_ENV

See Also:

Constant Field Values

DLMS

public static final String DLMS

See Also:

Constant Field Values

GATE_SERVICE

public static final String GATE_SERVICE

See Also:

Constant Field Values

CONTROL_CENTER

public static final String CONTROL_CENTER

See Also:

Constant Field Values

Constructor Detail

AbstractDevOpsAction

public AbstractDevOpsAction()

Method Detail

getOTCBrokerServer

public static String getOTCBrokerServer(String env)

get the OTC broker server endpoint

Parameters:

env -

Returns:

getAllEndpoints

public static Map<String,String> getAllEndpoints(String OTCBrokerServer,
                                                 String token,
                                                 String toolchainId)
                                          throws Exception

Throws:

Exception

setRequiredEnvVars

public static HashMap<String,String> setRequiredEnvVars(AbstractDevOpsStep step,
                                                        hudson.EnvVars envVars)

set the required env variables' HashMap for all steps

Parameters:

step -

envVars -

Returns:

chooseTargetAPI

public static String chooseTargetAPI(String environment)

chooseIAMAPI

public static String chooseIAMAPI(String environment)

chooseOrganizationsUrl

public static String chooseOrganizationsUrl(String environment)

chooseSpacesUrl

public static String chooseSpacesUrl(String environment)

chooseAppsUrl

public static String chooseAppsUrl(String environment)

getTokenForFreeStyleJob

public static String getTokenForFreeStyleJob(com.cloudbees.plugins.credentials.common.StandardCredentials credentials,
                                             String iamAPI,
                                             String targetAPI,
                                             PrintStream printStream)
                                      throws Exception

get IAM or UAA token based on the credentials id, only used by freestyle job's test connection or get the policy list

Parameters:

iamAPI -

targetAPI -

credentials -

Returns:

IAM token when user is using apikey, otherwise return UAA token

Throws:

Exception

getIBMCloudToken

public static String getIBMCloudToken(String credentialsId,
                                      String apikey,
                                      String username,
                                      String password,
                                      String env,
                                      hudson.model.Job context,
                                      PrintStream printStream)
                               throws Exception

get token for either pipeline or freestyle in the runtime

Parameters:

credentialsId -

apikey -

username -

password -

env -

context -

Returns:

Throws:

Exception

getBluemixToken

public static String getBluemixToken(String username,
                                     String password,
                                     String targetAPI,
                                     PrintStream printStream)
                              throws MalformedURLException,
                                     org.cloudfoundry.client.lib.CloudFoundryException

given the username and password, get the UAA token

Parameters:

username -

password -

targetAPI -

Returns:

Throws:

MalformedURLException

org.cloudfoundry.client.lib.CloudFoundryException

getIAMToken

public static String getIAMToken(String apikey,
                                 String iamAPI,
                                 PrintStream printStream)
                          throws Exception

get IAM token using API key

Parameters:

apikey -

iamAPI -

Returns:

Throws:

Exception

setDLMSUrl

public static String setDLMSUrl(String baseUrl,
                                String toolchainId,
                                String appName,
                                String buildId)
                         throws UnsupportedEncodingException

set DLMS endpoint url to upload data to DLMS

Parameters:

baseUrl -

toolchainId -

appName -

buildId -

Returns:

Throws:

UnsupportedEncodingException

setGateServiceUrl

public static String setGateServiceUrl(String baseUrl,
                                       String toolchainId,
                                       String applicationName,
                                       String buildId,
                                       String policyName,
                                       String environmentName)
                                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getDeploymentRiskUrl

public static String getDeploymentRiskUrl(String baseUrl,
                                          String toolchainId)
                                   throws URISyntaxException

Throws:

URISyntaxException

getReportUrl

public static String getReportUrl(String baseUrl,
                                  String toolchainId,
                                  String reportId)
                           throws URISyntaxException

Throws:

URISyntaxException

getBuildNumber

public static String getBuildNumber(hudson.EnvVars envVars,
                                    String jobName,
                                    hudson.model.Run build,
                                    PrintStream printStream)
                             throws Exception

get build number if it is not specified

Parameters:

envVars -

jobName -

build -

Returns:

Throws:

Exception

constructBuildNumber

public static String constructBuildNumber(String jobName,
                                          hudson.model.Run build)

construct the build number, format will be the jobName:buildNumber

Parameters:

build -

Returns:

expandVariable

public static String expandVariable(String key,
                                    hudson.EnvVars envVars,
                                    boolean isRequired)
                             throws Exception

expand the env var and check if it is a required var

Parameters:

key -

envVars -

isRequired -

Returns:

Throws:

Exception

getOrgId

public static String getOrgId(String token,
                              String orgName,
                              String environment,
                              Boolean debug_mode)

getSpaceId

public static String getSpaceId(String token,
                                String spaceName,
                                String environment,
                                Boolean debug_mode)

getAppId

public static String getAppId(String token,
                              String appName,
                              String orgName,
                              String spaceName,
                              String environment,
                              Boolean debug_mode)

getPolicyList

public static hudson.util.ListBoxModel getPolicyList(String token,
                                                     String toolchainId,
                                                     String environment,
                                                     boolean isDebugMode)

Get a list of policies that belong to a toolchain

Parameters:

token -

toolchainId -

environment -

isDebugMode -

Returns:

getDecisionFromDRA

public static com.google.gson.JsonObject getDecisionFromDRA(String bluemixToken,
                                                            String toolchainId,
                                                            String draUrl,
                                                            PrintStream printStream,
                                                            boolean isDebugMode)
                                                     throws Exception

Get gate decision from DevOps Insights

Parameters:

bluemixToken -

toolchainId -

draUrl -

printStream -

Returns:

Throws:

IOException

Exception

publishDecision

public static void publishDecision(com.google.gson.JsonObject obj,
                                   hudson.model.Run build,
                                   String reportUrl,
                                   String ccUrl,
                                   String policyName,
                                   boolean willDisrupt,
                                   PrintStream printStream)
                            throws hudson.AbortException

publish the decision to Jenkins UI and fail the build/job/pipeline if needed

Parameters:

obj -

build -

reportUrl -

ccUrl -

policyName -

willDisrupt -

printStream -

Throws:

hudson.AbortException

printDebugLog

public static void printDebugLog(PrintStream printStream,
                                 org.apache.http.client.methods.HttpEntityEnclosingRequestBase method,
                                 String status,
                                 String resStr)

passEnvToNextBuildStep

public static void passEnvToNextBuildStep(hudson.model.Run build,
                                          String bluemixToken,
                                          String buildId)

write to the environment variables to pass to next build step

Parameters:

build - - the current build

bluemixToken - - the Bluemix Token

buildId - - the build number of the build job in the Jenkins