org.jenkinsci.plugins.pipelineConfigHistory

Class PluginUtils

java.lang.Object

org.jenkinsci.plugins.pipelineConfigHistory.PluginUtils

public final class PluginUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static org.xmlunit.diff.Diff	computeXmlDiff(hudson.XmlFile xmlFile1, hudson.XmlFile xmlFile2) Compare two xml files, ignore whitespace.
static String	fileToString(File file) Get a file's content as String.
static hudson.XmlFile	getBuildXml(File buildRootDir) Get the build xml file contained in the buildRootDir.
static PipelineItemHistoryDao	getHistoryDao() Get the history dao which is used to manage the config history storage.
static String	getJenkinsfilePath(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob) Get the path to a workflowJob's current jenkinsfile.
static String	getJenkinsfilePathFromFlowDefinition(org.jenkinsci.plugins.workflow.flow.FlowDefinition flowDefinition) Get the path to a flowDefinition's current jenkinsfile.
static File	getJenkinsRootDir() Get the current Jenkins root directory.
static File	getLibDir(File buildRootDir) Get the library directory for a given root directory (normally a build dir).
static String	getMissingRequiredPlugins() Get the missing required plugins as String.
static int	getOriginalNumberFromBuildXml(File buildXmlFile) Get the original number for builds which are replays from other builds.
static org.jenkinsci.plugins.workflow.job.WorkflowJob	getWorkflowJob(String fullName) get the workflowJob associated with the given fullName.
static Date	parsedDate(String timeStamp) Returns a Date.
static boolean	requiredPluginsInstalled() Test if the required plugins are installed.
static boolean	scriptInXmlFileIsEqual(hudson.XmlFile xmlFile1, hudson.XmlFile xmlFile2) Test if the scripts contained in the two files are equal.

Methods inherited from class java.lang.Object

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

Method Detail

getHistoryDao

public static PipelineItemHistoryDao getHistoryDao()

Get the history dao which is used to manage the config history storage.

Returns:

the currently used history dao.

getLibDir

public static File getLibDir(File buildRootDir)

Get the library directory for a given root directory (normally a build dir).

Parameters:

buildRootDir - the build root directory.

Returns:

the library subdirectory.

getBuildXml

public static hudson.XmlFile getBuildXml(File buildRootDir)

Get the build xml file contained in the buildRootDir.

Parameters:

buildRootDir - the directory containing the build xml file

Returns:

the build xml file

getOriginalNumberFromBuildXml

public static int getOriginalNumberFromBuildXml(File buildXmlFile)
                                         throws ParserConfigurationException,
                                                IOException,
                                                SAXException

Get the original number for builds which are replays from other builds.

Parameters:

buildXmlFile - the build xml file

Returns:

the original number.

Throws:

ParserConfigurationException - if something goes wrong creating a document parser.

IOException - if something IO related goes wrong int the parsing process.

SAXException - if something goes wrong parsing the xml file.

fileToString

public static String fileToString(File file)
                           throws IOException

Get a file's content as String.

Parameters:

file - the file to read

Returns:

the file's content as \n-separated String.

Throws:

IOException - if the file could not be read.

getWorkflowJob

public static org.jenkinsci.plugins.workflow.job.WorkflowJob getWorkflowJob(String fullName)

get the workflowJob associated with the given fullName.

Parameters:

fullName - the job's fullName

Returns:

the associated workflowJob.

getJenkinsfilePath

public static String getJenkinsfilePath(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

Get the path to a workflowJob's current jenkinsfile.

Parameters:

workflowJob - the workflowJob.

Returns:

the path

getJenkinsfilePathFromFlowDefinition

public static String getJenkinsfilePathFromFlowDefinition(org.jenkinsci.plugins.workflow.flow.FlowDefinition flowDefinition)

Get the path to a flowDefinition's current jenkinsfile.

Parameters:

flowDefinition - the FlowDefinition.

Returns:

the path

getJenkinsRootDir

public static File getJenkinsRootDir()

Get the current Jenkins root directory.

Returns:

the current Jenkins root directory

requiredPluginsInstalled

public static boolean requiredPluginsInstalled()

Test if the required plugins are installed.

Returns:

whether the required plugins this plugin needs to work correctly are installed or not.

getMissingRequiredPlugins

public static String getMissingRequiredPlugins()

Get the missing required plugins as String.

Returns:

the missing required plugins.

scriptInXmlFileIsEqual

public static boolean scriptInXmlFileIsEqual(hudson.XmlFile xmlFile1,
                                             hudson.XmlFile xmlFile2)
                                      throws ParserConfigurationException,
                                             IOException,
                                             SAXException

Test if the scripts contained in the two files are equal.

Parameters:

xmlFile1 - file1

xmlFile2 - file2

Returns:

whether the scripts contained in the two files are equal.

Throws:

ParserConfigurationException - if creating a parser fails

IOException - if one of the two files is corrupt.

SAXException - if parsing one xml file fails

parsedDate

public static Date parsedDate(String timeStamp)

Returns a Date.

Parameters:

timeStamp - date as string.

Returns:

The parsed date as a java.util.Date.

computeXmlDiff

public static org.xmlunit.diff.Diff computeXmlDiff(hudson.XmlFile xmlFile1,
                                                   hudson.XmlFile xmlFile2)

Compare two xml files, ignore whitespace.

Parameters:

xmlFile1 - the first file

xmlFile2 - the second file

Returns:

a Diff object mapping the xml structure of the diffs found.