hudson.plugins.sauce_ondemand

Class SauceOnDemandBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

hudson.plugins.sauce_ondemand.SauceOnDemandBuildWrapper

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.BuildWrapper>, Serializable

public class SauceOnDemandBuildWrapper
extends hudson.tasks.BuildWrapper
implements Serializable

BuildWrapper that sets up the Sauce OnDemand SSH tunnel and populates environment variables which represent the selected browser(s).

Author:

Kohsuke Kawaguchi, Ross Rowe

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SauceOnDemandBuildWrapper.DescriptorImpl Plugin descriptor, which adds the plugin details to the Jenkins job configuration page.
class	SauceOnDemandBuildWrapper.SauceOnDemandLogParser Captures the output of a Jenkins build, so that it can be parsed to find Sauce jobs invoked by the build.

Nested classes/interfaces inherited from class hudson.tasks.BuildWrapper

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	ENVIRONMENT_VARIABLE_PATTERN Regex pattern which is used to identify replacement parameters.
static String	SAUCE_ONDEMAND_BROWSERS Environment variable key which contains a JSON formatted list of selected browsers.
static String	SELENIUM_BROWSER Environment variable key which contains the browser value for the selected browser.
static String	SELENIUM_DEVICE Environment variable key which contains the device value for the selected browser.
static String	SELENIUM_DEVICE_ORIENTATION Environment variable key which contains the device orientation for the selected browser.
static String	SELENIUM_DEVICE_TYPE Environment variable key which contains the device type for the selected browser.
static String	SELENIUM_DRIVER Environment variable key which contains Selenium Client Factory driver for selected browser.
static String	SELENIUM_HOST Environment variable key which contains the selenium host.
static String	SELENIUM_PLATFORM Environment variable key which contains the platform for the selected browser.
static String	SELENIUM_PORT Environment variable key which contains the selenium port.
static String	SELENIUM_VERSION Environment variable key which contains the version for the selected browser.

Constructor Summary

Constructors

Constructor and Description

SauceOnDemandBuildWrapper(boolean enableSauceConnect, org.jenkins_ci.plugins.run_condition.RunCondition condition, Credentials credentials, SeleniumInformation seleniumInformation, String seleniumHost, String seleniumPort, String options, String sauceConnectPath, boolean launchSauceConnectOnSlave, boolean verboseLogging, boolean useLatestVersion, List<String> webDriverBrowsers, List<String> appiumBrowsers, String nativeAppPackage, boolean useGeneratedTunnelIdentifier) Constructs a new instance using data entered on the job configuration screen.

Method Summary

Modifier and Type	Method and Description
OutputStream	decorateLogger(hudson.model.AbstractBuild build, OutputStream logger) Creates a new SauceOnDemandBuildWrapper.SauceOnDemandLogParser instance, which is added to the logParserMap.
String	getApiKey()
List<String>	getAppiumBrowsers()
org.jenkins_ci.plugins.run_condition.RunCondition	getCondition()
Credentials	getCredentials()
String	getNativeAppPackage()
String	getOptions()
String	getSauceConnectPath()
static com.saucelabs.ci.sauceconnect.AbstractSauceTunnelManager	getSauceTunnelManager() Retrieve the AbstractSauceTunnelManager instance to be used to launch Sauce Connect.
String	getSeleniumHost()
SeleniumInformation	getSeleniumInformation()
String	getSeleniumPort()
String	getUserName()
List<String>	getWebDriverBrowsers()
boolean	isEnableSauceConnect()
boolean	isLaunchSauceConnectOnSlave()
boolean	isUseChromeForAndroid()
boolean	isUseGeneratedTunnelIdentifier()
boolean	isUseLatestVersion()
boolean	isVerboseLogging()
static String	sanitiseBuildNumber(String buildNumber) Replace all spaces and hashes with underscores.
void	setAppiumBrowsers(List<String> appiumBrowsers)
void	setCredentials(Credentials credentials)
void	setEnableSauceConnect(boolean enableSauceConnect)
void	setLaunchSauceConnectOnSlave(boolean launchSauceConnectOnSlave)
void	setNativeAppPackage(String nativeAppPackage)
void	setOptions(String options)
void	setSauceConnectPath(String sauceConnectPath)
void	setSeleniumHost(String seleniumHost)
void	setSeleniumInformation(SeleniumInformation seleniumInformation)
void	setSeleniumPort(String seleniumPort)
hudson.tasks.BuildWrapper.Environment	setUp(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Invoked prior to the running of a Jenkins build.
void	setUseChromeForAndroid(boolean useChromeForAndroid)
void	setUseGeneratedTunnelIdentifier(boolean useGeneratedTunnelIdentifier)
void	setUseLatestVersion(boolean useLatestVersion)
void	setVerboseLogging(boolean verboseLogging)
void	setWebDriverBrowsers(List<String> webDriverBrowsers)
boolean	shouldSendUsageData()

Methods inherited from class hudson.tasks.BuildWrapper

all, decorateLauncher, getProjectAction, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, preCheckout, setUp

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

SELENIUM_DRIVER

public static final String SELENIUM_DRIVER

Environment variable key which contains Selenium Client Factory driver for selected browser.

See Also:

Constant Field Values

SAUCE_ONDEMAND_BROWSERS

public static final String SAUCE_ONDEMAND_BROWSERS

Environment variable key which contains a JSON formatted list of selected browsers.

See Also:

Constant Field Values

SELENIUM_HOST

public static final String SELENIUM_HOST

Environment variable key which contains the selenium host.

See Also:

Constant Field Values

SELENIUM_PORT

public static final String SELENIUM_PORT

Environment variable key which contains the selenium port.

See Also:

Constant Field Values

SELENIUM_DEVICE

public static final String SELENIUM_DEVICE

Environment variable key which contains the device value for the selected browser.

See Also:

Constant Field Values

SELENIUM_DEVICE_TYPE

public static final String SELENIUM_DEVICE_TYPE

Environment variable key which contains the device type for the selected browser.

See Also:

Constant Field Values

SELENIUM_DEVICE_ORIENTATION

public static final String SELENIUM_DEVICE_ORIENTATION

Environment variable key which contains the device orientation for the selected browser.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_PATTERN

public static final Pattern ENVIRONMENT_VARIABLE_PATTERN

Regex pattern which is used to identify replacement parameters.

SELENIUM_BROWSER

public static final String SELENIUM_BROWSER

Environment variable key which contains the browser value for the selected browser.

See Also:

Constant Field Values

SELENIUM_PLATFORM

public static final String SELENIUM_PLATFORM

Environment variable key which contains the platform for the selected browser.

See Also:

Constant Field Values

SELENIUM_VERSION

public static final String SELENIUM_VERSION

Environment variable key which contains the version for the selected browser.

See Also:

Constant Field Values

Constructor Detail

SauceOnDemandBuildWrapper

@DataBoundConstructor
public SauceOnDemandBuildWrapper(boolean enableSauceConnect,
                                                       org.jenkins_ci.plugins.run_condition.RunCondition condition,
                                                       Credentials credentials,
                                                       SeleniumInformation seleniumInformation,
                                                       String seleniumHost,
                                                       String seleniumPort,
                                                       String options,
                                                       String sauceConnectPath,
                                                       boolean launchSauceConnectOnSlave,
                                                       boolean verboseLogging,
                                                       boolean useLatestVersion,
                                                       List<String> webDriverBrowsers,
                                                       List<String> appiumBrowsers,
                                                       String nativeAppPackage,
                                                       boolean useGeneratedTunnelIdentifier)

Constructs a new instance using data entered on the job configuration screen.

Parameters:

enableSauceConnect - indicates whether Sauce Connect should be started as part of the build.

condition - allows users to define rules which enable Sauce Connect

credentials - the Sauce username/access key that should be used for the build.

seleniumInformation - the browser information that is to be used for the build.

seleniumHost - host location of the selenium server.

seleniumPort - port location of the selenium server.

options - the Sauce Connect command line options to be used

sauceConnectPath - Path to sauce connect

launchSauceConnectOnSlave - indicates whether Sauce Connect should be launched on the slave or master node

verboseLogging - indicates whether the Sauce Connect output should be written to the Jenkins job output

useLatestVersion - indicates whether the latest version of the selected browser(s) should be used

webDriverBrowsers - which browser(s) should be used for web driver

appiumBrowsers - which browser(s( should be used for appium

nativeAppPackage - indicates whether the latest version of the selected browser(s) should be used

useGeneratedTunnelIdentifier - indicated whether tunnel identifers and ports should be managed by the plugin

Method Detail

setUp

public hudson.tasks.BuildWrapper.Environment setUp(hudson.model.AbstractBuild build,
                                                   hudson.Launcher launcher,
                                                   hudson.model.BuildListener listener)
                                            throws IOException,
                                                   InterruptedException

Invoked prior to the running of a Jenkins build. Populates the Sauce specific environment variables and launches Sauce Connect.

Overrides:

setUp in class hudson.tasks.BuildWrapper

Returns:

a new Environment instance populated with the Sauce environment variables

Throws:

IOException

InterruptedException

shouldSendUsageData

public boolean shouldSendUsageData()

sanitiseBuildNumber

public static String sanitiseBuildNumber(String buildNumber)

Replace all spaces and hashes with underscores.

Parameters:

buildNumber - the current Jenkins build number

Returns:

the build number with all non-alphanumeric characters replaced with _

getUserName

public String getUserName()

Returns:

the Sauce username to be used

getApiKey

public String getApiKey()

Returns:

the Sauce access key to be used

isUseLatestVersion

public boolean isUseLatestVersion()

getSeleniumHost

public String getSeleniumHost()

setSeleniumHost

public void setSeleniumHost(String seleniumHost)

getSeleniumPort

public String getSeleniumPort()

setSeleniumPort

public void setSeleniumPort(String seleniumPort)

getCredentials

public Credentials getCredentials()

setCredentials

public void setCredentials(Credentials credentials)

getSeleniumInformation

public SeleniumInformation getSeleniumInformation()

setSeleniumInformation

public void setSeleniumInformation(SeleniumInformation seleniumInformation)

isEnableSauceConnect

public boolean isEnableSauceConnect()

setEnableSauceConnect

public void setEnableSauceConnect(boolean enableSauceConnect)

getWebDriverBrowsers

public List<String> getWebDriverBrowsers()

setWebDriverBrowsers

public void setWebDriverBrowsers(List<String> webDriverBrowsers)

getAppiumBrowsers

public List<String> getAppiumBrowsers()

setAppiumBrowsers

public void setAppiumBrowsers(List<String> appiumBrowsers)

isLaunchSauceConnectOnSlave

public boolean isLaunchSauceConnectOnSlave()

setLaunchSauceConnectOnSlave

public void setLaunchSauceConnectOnSlave(boolean launchSauceConnectOnSlave)

isUseGeneratedTunnelIdentifier

public boolean isUseGeneratedTunnelIdentifier()

setUseGeneratedTunnelIdentifier

public void setUseGeneratedTunnelIdentifier(boolean useGeneratedTunnelIdentifier)

isVerboseLogging

public boolean isVerboseLogging()

setVerboseLogging

public void setVerboseLogging(boolean verboseLogging)

getOptions

public String getOptions()

setOptions

public void setOptions(String options)

getCondition

public org.jenkins_ci.plugins.run_condition.RunCondition getCondition()

getSauceConnectPath

public String getSauceConnectPath()

setSauceConnectPath

public void setSauceConnectPath(String sauceConnectPath)

isUseChromeForAndroid

public boolean isUseChromeForAndroid()

getNativeAppPackage

public String getNativeAppPackage()

setUseLatestVersion

public void setUseLatestVersion(boolean useLatestVersion)

setNativeAppPackage

public void setNativeAppPackage(String nativeAppPackage)

setUseChromeForAndroid

public void setUseChromeForAndroid(boolean useChromeForAndroid)

decorateLogger

public OutputStream decorateLogger(hudson.model.AbstractBuild build,
                                   OutputStream logger)
                            throws IOException,
                                   InterruptedException,
                                   hudson.model.Run.RunnerAbortedException

Creates a new SauceOnDemandBuildWrapper.SauceOnDemandLogParser instance, which is added to the logParserMap.

Overrides:

decorateLogger in class hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException

hudson.model.Run.RunnerAbortedException

getSauceTunnelManager

public static com.saucelabs.ci.sauceconnect.AbstractSauceTunnelManager getSauceTunnelManager()
                                                                                      throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Retrieve the AbstractSauceTunnelManager instance to be used to launch Sauce Connect.

Returns:

AbstractSauceTunnelManager instance

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException - see plexus