com.google.jenkins.plugins.manage

Class AbstractCloudDeployment

java.lang.Object

com.google.jenkins.plugins.manage.AbstractCloudDeployment

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractCloudDeployment>

Direct Known Subclasses:

CloudDeploymentDeleter, TemplatedCloudDeployment

public abstract class AbstractCloudDeployment
extends Object
implements hudson.model.Describable<AbstractCloudDeployment>, hudson.ExtensionPoint

Instances of this class represent a deployment being managed by the Google Cloud Deployment Manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractCloudDeployment.ResolvedPath Helper type for managing the resolution of the deployment path into its final form and managing the pieces.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	verbose Controls how verbose to make the logs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloudDeployment(String credentialsId, String deploymentName, CloudDeploymentModule module) Constructs the AbstractCloudDeployment from the provided information.

Method Summary

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<AbstractCloudDeployment,AbstractCloudDeploymentDescriptor>	all() Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point
protected com.google.api.services.deploymentmanager.model.Operation	createDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager, com.google.api.services.deploymentmanager.model.Deployment deployment) Creates a new deployment.
void	delete(hudson.EnvVars environment, PrintStream logger) NOTE: This should be treated as final, but is not to allow mocking.
protected com.google.api.services.deploymentmanager.model.Operation	deleteDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager, String userDeploymentName) Deletes a deployment.
protected <T> T	execute(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T> request) Pass the given request through the executor.
static List<AbstractCloudDeploymentDescriptor>	getCompatibleCloudDeployments(hudson.model.Descriptor descriptor) This method is called by plugins utilizing this extension point for managing deployments, such as a Publisher, BuildWrapper, or Cloud.
protected com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials	getCredentials() Retrieve the credentials for this cloud deployment.
String	getCredentialsId()
protected com.google.api.services.deploymentmanager.model.Deployment	getDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager, String userDeploymentName) Fetches a deployment.
String	getDeploymentName()
AbstractCloudDeploymentDescriptor	getDescriptor() Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point
protected CloudDeploymentModule	getModule()
protected String	getProjectId() Retrieve the project id for this cloud deployment.
abstract void	insert(hudson.FilePath workspace, hudson.EnvVars environment, PrintStream logger)
void	insert(String configFileContents, Iterable<hudson.FilePath> importPaths, hudson.EnvVars environment, PrintStream logger) NOTE: This should be treated as final, but is not to allow mocking.
protected void	log(String message) This is a short-hand that issues the given message through our client's logging stream.
protected void	waitUntilDeleted(com.google.api.services.deploymentmanager.DeploymentManager manager, com.google.api.services.deploymentmanager.model.Operation operation) Waits for the newly delete deployment operation to be done.
protected void	waitUntilDeployed(com.google.api.services.deploymentmanager.DeploymentManager manager, com.google.api.services.deploymentmanager.model.Operation operation) Waits for the deployment insertion to terminate.
protected void	waitUntilDone(com.google.api.services.deploymentmanager.DeploymentManager manager, com.google.api.services.deploymentmanager.model.Operation operation, boolean areDeploying) Waits for the given operation to terminate.

Methods inherited from class java.lang.Object

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

Field Detail

verbose

protected static final boolean verbose

Controls how verbose to make the logs

See Also:

Constant Field Values

Constructor Detail

AbstractCloudDeployment

protected AbstractCloudDeployment(String credentialsId,
                                  String deploymentName,
                                  @Nullable
                                  CloudDeploymentModule module)

Constructs the AbstractCloudDeployment from the provided information.

Parameters:

credentialsId - The credentials to use for service interactions.

deploymentName - The unresolved deployment name to use

module - The module to use for allocating dependencies

Method Detail

all

public static hudson.DescriptorExtensionList<AbstractCloudDeployment,AbstractCloudDeploymentDescriptor> all()

Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point

getCompatibleCloudDeployments

public static List<AbstractCloudDeploymentDescriptor> getCompatibleCloudDeployments(hudson.model.Descriptor descriptor)

This method is called by plugins utilizing this extension point for managing deployments, such as a Publisher, BuildWrapper, or Cloud.

Parameters:

descriptor - The descriptor of the plugin wishing to consume a cloud deployment

Returns:

a list of applicable cloud deployment extensions

getCredentialsId

public String getCredentialsId()

getDeploymentName

public String getDeploymentName()

getModule

protected CloudDeploymentModule getModule()

insert

public abstract void insert(hudson.FilePath workspace,
                            hudson.EnvVars environment,
                            @Nullable
                            PrintStream logger)
                     throws CloudManagementException

Throws:

CloudManagementException

insert

public void insert(String configFileContents,
                   Iterable<hudson.FilePath> importPaths,
                   hudson.EnvVars environment,
                   @Nullable
                   PrintStream logger)
            throws CloudManagementException

NOTE: This should be treated as final, but is not to allow mocking.

Creates the given deployment.

Parameters:

configFileContents - The contents of the deployment config file

importPaths - The paths of the deployment import files

environment - The environment under which to execute the insertion

logger - The logger through which to surface messaging

Throws:

CloudManagementException - if the operation fails or times out

getCredentials

protected com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials getCredentials()

Retrieve the credentials for this cloud deployment.

getProjectId

protected String getProjectId()

Retrieve the project id for this cloud deployment.

execute

protected <T> T execute(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T> request)
                 throws IOException,
                        com.google.jenkins.plugins.util.ExecutorException

Pass the given request through the executor.

Throws:

IOException

com.google.jenkins.plugins.util.ExecutorException

getDescriptor

public AbstractCloudDeploymentDescriptor getDescriptor()

Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point

Specified by:

getDescriptor in interface hudson.model.Describable<AbstractCloudDeployment>

delete

public void delete(hudson.EnvVars environment,
                   @Nullable
                   PrintStream logger)
            throws CloudManagementException

NOTE: This should be treated as final, but is not to allow mocking.

Deletes user's deployment.

Parameters:

environment - The environment under which to execute the deletion

logger - The logger through which to surface messaging

Throws:

CloudManagementException - if the operation fails or times out

createDeployment

protected com.google.api.services.deploymentmanager.model.Operation createDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager,
                                                                                     com.google.api.services.deploymentmanager.model.Deployment deployment)
                                                                              throws CloudManagementException

Creates a new deployment.

Parameters:

manager - The connection the the Deployment Manager service

deployment - The deployment configuration information

Returns:

The new deployment of the service we've inserted.

Throws:

CloudManagementException - if anything goes wrong.

getDeployment

protected com.google.api.services.deploymentmanager.model.Deployment getDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager,
                                                                                   String userDeploymentName)
                                                                            throws CloudManagementException,
                                                                                   com.google.jenkins.plugins.util.ExecutorException

Fetches a deployment.

Parameters:

manager - The connection the the Cloud Manager service

userDeploymentName - The resolved name of the user's deployment

Returns:

The current state of our deployment of the service/template

Throws:

CloudManagementException - if anything goes wrong.

com.google.jenkins.plugins.util.ExecutorException

deleteDeployment

protected com.google.api.services.deploymentmanager.model.Operation deleteDeployment(com.google.api.services.deploymentmanager.DeploymentManager manager,
                                                                                     String userDeploymentName)
                                                                              throws CloudManagementException

Deletes a deployment.

Parameters:

manager - The connection the the Deployment Manager service

userDeploymentName - The resolved name of the user's deployment

Returns:

the created delete operation object.

Throws:

CloudManagementException - if anything goes wrong.

waitUntilDeployed

protected void waitUntilDeployed(com.google.api.services.deploymentmanager.DeploymentManager manager,
                                 com.google.api.services.deploymentmanager.model.Operation operation)
                          throws CloudManagementException

Waits for the deployment insertion to terminate. If the deployment fails, or we time out waiting a CloudManagementException is thrown.

Parameters:

manager - The connection the the Deployment Manager service.

operation - The operation to wait for.

Throws:

CloudManagementException - if anything goes wrong, the deployment fails, or we time out waiting.

waitUntilDeleted

protected void waitUntilDeleted(com.google.api.services.deploymentmanager.DeploymentManager manager,
                                com.google.api.services.deploymentmanager.model.Operation operation)
                         throws CloudManagementException

Waits for the newly delete deployment operation to be done. If the deletion fails, or we time out waiting a CloudManagementException is thrown.

Parameters:

manager - The connection the the Cloud Manager service

operation - The delete operation to wait for.

Throws:

CloudManagementException - if anything goes wrong, the deployment fails, or we time out waiting.

waitUntilDone

protected void waitUntilDone(com.google.api.services.deploymentmanager.DeploymentManager manager,
                             com.google.api.services.deploymentmanager.model.Operation operation,
                             boolean areDeploying)
                      throws CloudManagementException,
                             com.google.jenkins.plugins.util.ExecutorException,
                             IOException

Waits for the given operation to terminate. If the deployment fails, or we time-out waiting a CloudManagementException is thrown.

Parameters:

manager - The connection the the Deployment Manager service.

operation - The operation to wait for.

areDeploying - whether we are currently deploying or deleting

Throws:

CloudManagementException - if anything goes wrong, the deployment fails, or we time out waiting.

com.google.jenkins.plugins.util.ExecutorException

IOException

log

protected void log(String message)

This is a short-hand that issues the given message through our client's logging stream.

Parameters:

message - The message to be logged.