com.microsoft.jenkins.acs.util

Class DeployHelper

java.lang.Object

com.microsoft.jenkins.acs.util.DeployHelper

public final class DeployHelper
extends Object

Method Summary

Modifier and Type	Method and Description
static boolean	checkURIForMarathon(String path) Check if the URI is Marathon compatible.
static String	encodeURIPath(String path)
static String	escapeSingleQuote(String arg) Escape the ' (single quote) in the argument so that it can be safely used in a singly quoted shell command argument.
static String	generateRandomDeploymentFileName(String suffix)
static <T> T	getProperty(Object properties, String path, Class<T> type)
static String	removeVariables(String value) Remove variables (in the form $VAR or ${VAR}) from the given string.
static ByteArrayInputStream	replaceMacro(InputStream original, hudson.EnvVars envVars, boolean enabled)
static String	replaceVariables(String value, String replacement) Replace each of the variables (in the form $VAR or ${VAR}) from the given string with the given replacement.

Methods inherited from class java.lang.Object

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

Method Detail

generateRandomDeploymentFileName

public static String generateRandomDeploymentFileName(String suffix)

escapeSingleQuote

public static String escapeSingleQuote(String arg)

Escape the ' (single quote) in the argument so that it can be safely used in a singly quoted shell command argument.

For example, let's go will be quoted to let'"'"'s go. If this is fed as a singly quoted argument, it will be 'let'"'"'s go', that is, the concatenation of 'let', "'" and 's go'.

Parameters:

arg - the command line argument which may have single quote

Returns:

escaped argument which can be safely enclosed in single quotes as shell command argument.

encodeURIPath

public static String encodeURIPath(String path)

removeVariables

public static String removeVariables(String value)

Remove variables (in the form $VAR or ${VAR}) from the given string.

Parameters:

value - the input string

Returns:

the result string with all variables removed

replaceVariables

public static String replaceVariables(String value,
                                      String replacement)

Replace each of the variables (in the form $VAR or ${VAR}) from the given string with the given replacement.

Parameters:

value - the input string

replacement - the replacement for all the variables

Returns:

the result string with all variables replaced with the given replacement

checkURIForMarathon

public static boolean checkURIForMarathon(String path)

Check if the URI is Marathon compatible.

Due to the limitation in the underlying Mesos fetcher used by Marathon, some special characters as well as the URI escaped sequences are not allowed in the file:// URI paths.

At the time of the implementation (Mesos 1.3.x), these limitations are still there, we need to warn the user of such problems.

Parameters:

path - the URI path being checked

Returns:

if the URI path can be accepted by the Marathon

replaceMacro

public static ByteArrayInputStream replaceMacro(InputStream original,
                                                hudson.EnvVars envVars,
                                                boolean enabled)
                                         throws IOException

Throws:

IOException

getProperty

public static <T> T getProperty(Object properties,
                                String path,
                                Class<T> type)