jenkins.plugins.coverity

Class CoverityUtils

java.lang.Object

jenkins.plugins.coverity.CoverityUtils

public class CoverityUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
CoverityUtils()

Method Summary

Modifier and Type	Method and Description
static String[]	addEnvVars(String[] envVarsArray, hudson.EnvVars envVars) Collects environment variables from an array and an EnvVars object and returns an updated EnvVars object.
static Map<String,String>	arrayToMap(String[] input) Jenkins API ProcStarter.envs() returns an array of environment variables where each element is a string "key=value".
static void	checkDir(hudson.remoting.VirtualChannel channel, String home)
static String	doubleQuote(String input, boolean useAdvancedParser) Coverity's parser remove double/single quotes but Jenkins parser does not.
static List<String>	evaluateEnvVars(List<String> input, hudson.EnvVars environment) Evaluates environment variables on a command represented by a list of tokens.
static String	evaluateEnvVars(String input, hudson.EnvVars environment, boolean useAdvancedParser) Evaluates an environment variable using the specified parser.
static List<String>	expand(String input, hudson.EnvVars environment) Calls intepolate() in order to evaluate environment variables.
static CoverityToolInstallation	findToolInstallationForBuild(hudson.model.Node node, hudson.EnvVars environment, hudson.model.TaskListener listener) Finds a tools installation for the running build.
static hudson.model.AbstractBuild	getBuild()
static hudson.EnvVars	getBuildEnvVars(hudson.model.TaskListener listener) Gets environment variables from the build.
static String	getCovBuild(hudson.model.TaskListener listener, hudson.model.Node node) getCovBuild Retrieves the location of cov-build executable/sh from the system and returns the string of the path
static InvocationAssistance	getInvocationAssistance() Returns the InvocationAssistance on the current thread.
static InvocationAssistance	getInvocationAssistance(hudson.model.AbstractBuild<?,?> build) Returns the InvocationAssistance for a given build.
static String	getStackTrace(Exception e) Gets the stacktrace from an exception, so that this exception can be handled.
static void	handleException(String message, hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, Exception exception)
static void	handleException(String message, hudson.model.AbstractBuild<?,?> build, hudson.model.TaskListener listener, Exception exception)
static Collection<File>	listFiles(File directory, FilenameFilter filter, boolean recurse)
static List<String>	prepareCmds(List<String> input, hudson.EnvVars envVars, boolean useAdvancedParser)
static List<String>	prepareCmds(List<String> input, String[] envVarsArray, boolean useAdvancedParser) Prepares command according with the specified parsing mechanism.
static int	runCmd(List<String> cmd, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars envVars, boolean useAdvancedParser)
static List<String>	splitKeyValue(String input) Split string of the form key=value into an array [key, value]

Methods inherited from class java.lang.Object

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

Constructor Detail

CoverityUtils

public CoverityUtils()

Method Detail

evaluateEnvVars

public static String evaluateEnvVars(String input,
                                     hudson.EnvVars environment,
                                     boolean useAdvancedParser)
                              throws RuntimeException

Evaluates an environment variable using the specified parser. The result is an interpolated string.

Throws:

RuntimeException

checkDir

public static void checkDir(hudson.remoting.VirtualChannel channel,
                            String home)
                     throws Exception

Throws:

Exception

getCovBuild

public static String getCovBuild(hudson.model.TaskListener listener,
                                 hudson.model.Node node)

getCovBuild Retrieves the location of cov-build executable/sh from the system and returns the string of the path

Returns:

string of cov-build's path

findToolInstallationForBuild

public static CoverityToolInstallation findToolInstallationForBuild(hudson.model.Node node,
                                                                    hudson.EnvVars environment,
                                                                    hudson.model.TaskListener listener)

Finds a tools installation for the running build. This method handles all behavior related to overriding tools location at either the build or node level.

expand

public static List<String> expand(String input,
                                  hudson.EnvVars environment)
                           throws ParseException

Calls intepolate() in order to evaluate environment variables. In the case that a substitution took place, it tokenize the result and it calls itself on each token in case further evaluations are needed. In the case of a recursive definition (ex: VAR1=$VAR2, VAR2=$VAR1) an exception is thrown.

Throws:

ParseException

evaluateEnvVars

public static List<String> evaluateEnvVars(List<String> input,
                                           hudson.EnvVars environment)

Evaluates environment variables on a command represented by a list of tokens.

getStackTrace

public static String getStackTrace(Exception e)

Gets the stacktrace from an exception, so that this exception can be handled.

handleException

public static void handleException(String message,
                                   hudson.model.AbstractBuild<?,?> build,
                                   hudson.model.BuildListener listener,
                                   Exception exception)

handleException

public static void handleException(String message,
                                   hudson.model.AbstractBuild<?,?> build,
                                   hudson.model.TaskListener listener,
                                   Exception exception)

prepareCmds

public static List<String> prepareCmds(List<String> input,
                                       String[] envVarsArray,
                                       boolean useAdvancedParser)

Prepares command according with the specified parsing mechanism. If "useAdvancedParser" is set to true, the plugin will evaluate environment variables with its custom mechanism. If not, environment variable substitution will be handled by Jenkins in the standard way.

prepareCmds

public static List<String> prepareCmds(List<String> input,
                                       hudson.EnvVars envVars,
                                       boolean useAdvancedParser)

arrayToMap

public static Map<String,String> arrayToMap(String[] input)

Jenkins API ProcStarter.envs() returns an array of environment variables where each element is a string "key=value". However the constructor for EnvVars accepts only arrays of the format [key1, value1, key2, value2]. Because of this, we need to transform that array into a map and use a constructor that accepts that map.

splitKeyValue

public static List<String> splitKeyValue(String input)

Split string of the form key=value into an array [key, value]

getInvocationAssistance

public static InvocationAssistance getInvocationAssistance(hudson.model.AbstractBuild<?,?> build)

Returns the InvocationAssistance for a given build.

getInvocationAssistance

public static InvocationAssistance getInvocationAssistance()

Returns the InvocationAssistance on the current thread. This can be used when an "AbstractBuild" object is not available, for example while decorating the launcher.

addEnvVars

public static String[] addEnvVars(String[] envVarsArray,
                                  hudson.EnvVars envVars)

Collects environment variables from an array and an EnvVars object and returns an updated EnvVars object. This is useful for updating the environment variables on a ProcStarter with the variables from the listener.

runCmd

public static int runCmd(List<String> cmd,
                         hudson.model.AbstractBuild<?,?> build,
                         hudson.Launcher launcher,
                         hudson.model.TaskListener listener,
                         hudson.EnvVars envVars,
                         boolean useAdvancedParser)
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

getBuild

public static hudson.model.AbstractBuild getBuild()

doubleQuote

public static String doubleQuote(String input,
                                 boolean useAdvancedParser)

Coverity's parser remove double/single quotes but Jenkins parser does not. When dealing (for instance) with streams with spaces, we would expect [--stream, My Stream]. In order to do this the token "My Stream" must be quoted if using out parser, but not if using Jenkins.

getBuildEnvVars

public static hudson.EnvVars getBuildEnvVars(hudson.model.TaskListener listener)

Gets environment variables from the build.

listFiles

public static Collection<File> listFiles(File directory,
                                         FilenameFilter filter,
                                         boolean recurse)