com.infostretch.labs.plugins

Class Plugins

java.lang.Object

com.infostretch.labs.plugins.Plugins

Direct Known Subclasses:

AnsiblePlaybookBuilder, Ant, ArtifactArchiver, BatchFile, CheckStylePublisher, Git, JUnitResultArchiver, Mailer, Maven, NpmPackagesBuildWrapper, Shell, TestNG

public abstract class Plugins
extends Object

Super class for plugins. This class is extended by every plugin whose transformation support is to be added. Common functionalities that can be used by all plugins for transformation are also included here.

Author:

Mohit Dharamshi

Field Summary

Fields

Modifier and Type	Field and Description
protected Node	node Node block from which the properties are to be read and converted.
protected Transformer	transformer Transformer instance whose variables need to be read and written to.

Constructor Summary

Constructors

Constructor and Description
Plugins() Default constructor.
Plugins(Transformer transformer, Node node) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
protected void	appendBuildSteps(String string) Helper method to append string to buildSteps in transformer.
protected void	appendPublishSteps(String string) Helper method to append string to publishSteps in transformer.
protected Element	getElementByTag(Node node, String tag) Helper method to extract Element from given node by tag name.
protected Element	getElementByTag(String tag) Helper method to extract Element by tag name from node initialised by constructor.
static Class	getPluginClass(String nodeName) Returns Class that matches nodeName.
void	pushJenkinsfile(File workSpace, String script, String url, String branchName, String commitMessage, org.eclipse.jgit.transport.CredentialsProvider credentialsProvider) Method to be overridden by subclass when pushing Jenkinsfile.
void	transformBuild() Method to be overridden by subclass when transforming build steps.
void	transformBuildWrapper() Method to be overridden by subclass when transforming build-wrappers.
void	transformPublisher() Method to be overridden by subclass when transforming post-build actions.
void	transformSCM() Method to be overridden by subclass when transforming SCM.
Element	writeCPSFlow(Document dest, String scmURL, String branchName, String scmCredentialsId) Write CPS Flow XML structure for SCM type defined.

Methods inherited from class java.lang.Object

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

Field Detail

transformer

protected Transformer transformer

Transformer instance whose variables need to be read and written to.

node

protected Node node

Node block from which the properties are to be read and converted.

Constructor Detail

Plugins

public Plugins(Transformer transformer,
               Node node)

Parameterized constructor. This will be invoked by super() in each plugin class. This constructor is implemented in plugin classes that will be performing transformations.

Parameters:

transformer - Transformer instance whose variables need to be read and written to.

node - Node block from which the properties are to be read and converted.

Plugins

public Plugins()

Default constructor. This is implemented in plugin classes that do not need transformer and node variables for particular methods. Such methods will handle non-transformation actions such as pushJenkinsfile.

Method Detail

transformBuild

public void transformBuild()

Method to be overridden by subclass when transforming build steps.

transformPublisher

public void transformPublisher()

Method to be overridden by subclass when transforming post-build actions.

transformBuildWrapper

public void transformBuildWrapper()

Method to be overridden by subclass when transforming build-wrappers.

transformSCM

public void transformSCM()

Method to be overridden by subclass when transforming SCM.

pushJenkinsfile

public void pushJenkinsfile(File workSpace,
                            String script,
                            String url,
                            String branchName,
                            String commitMessage,
                            org.eclipse.jgit.transport.CredentialsProvider credentialsProvider)

Method to be overridden by subclass when pushing Jenkinsfile. Clone the repo, add Jenkinsfile and push to SCM.

Parameters:

workSpace - The temporary workspace where the repo will be cloned.

script - Groovy script to be written in Jenkinsfile.

url - URL of SCM repository where Jenkinsfile is to be pushed.

branchName - Branch of SCM where Jenkinsfile is to be pushed.

commitMessage - Commit message to be included in commit when pushing Jenkinsfile.

credentialsProvider - Credentials to use for clone and push operations.

writeCPSFlow

public Element writeCPSFlow(Document dest,
                            String scmURL,
                            String branchName,
                            String scmCredentialsId)

Write CPS Flow XML structure for SCM type defined.

Parameters:

dest - Document object in which the new XML elements are to be defined.

scmURL - URL of SCM where new pipeline job will point for Jenkinsfile.

branchName - Branch name of SCM where new pipeline job will point for Jenkinsfile.

scmCredentialsId - Credentials id to use to checkout Jenkinsfile by new pipeline job.

Returns:

Element object definition with XML

getElementByTag

protected final Element getElementByTag(String tag)

Helper method to extract Element by tag name from node initialised by constructor.

Parameters:

tag - Tag name to find in node.

Returns:

Element object extracted from node.

getElementByTag

protected final Element getElementByTag(Node node,
                                        String tag)

Helper method to extract Element from given node by tag name.

Parameters:

node - Node from which the Element needs to be extracted.

tag - Tag name to find in node.

Returns:

Element object extracted from node.

appendBuildSteps

protected final void appendBuildSteps(String string)

Helper method to append string to buildSteps in transformer.

Parameters:

string - String to be appended to build steps.

appendPublishSteps

protected final void appendPublishSteps(String string)

Helper method to append string to publishSteps in transformer.

Parameters:

string - String to be appended to publish steps.

getPluginClass

public static final Class getPluginClass(String nodeName)

Returns Class that matches nodeName. The method checks if any node nodeNames need to be ignored. For valid nodeNames; PluginClass enum is checked for known values. If found within PluginClass enum, the corresponding Class is derived. If PluginClass enum does not have a valid entry; then the assumption is that the last word of the fully qualified class name in the nodeName matches a class that exists in com.infostretch.labs.plugins package. If none of the above 2 scenarios suffice; then this plugin does not support the plugin that corresponds to the nodeName.

Parameters:

nodeName - The node name whose plugin class needs to be found.

Returns:

Returns Class that matches nodeName.