CommonUtils (jenkins-automation 1.0-SNAPSHOT API)

jenkins.automation.utils.CommonUtils

Utils class when most reused common properties should live. Adds a minimum base functionality required -build claiming, notifications and log.
Parameters:
context - delegate passed in context

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`python27Virtualenv` Common string for creating and activating a python 2.7 virtualenv in a shell block

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`addDefaults(java.lang.Object context)` Adds bare minimum defaults
	`static void`	`addExtendedEmail(java.lang.Object context, java.util.List<java.lang.String> emails, java.util.List<java.lang.String> triggerList = ["failure", java.lang.Object sendToDevelopers = false, java.lang.Object sendToRequester = true, java.lang.Object includeCulprits = false, java.lang.Object sendToRecipientList = true, java.lang.Object preSendScript = "\$DEFAULT_PRESEND_SCRIPT", java.lang.Object attachmentPattern = "")` Utility function to add extended email
	`static void`	`addExtendedEmail(java.lang.Object context, java.lang.String emails, java.util.List<java.lang.String> triggerList = ["failure", java.lang.Object sendToDevelopers = false, java.lang.Object sendToRequester = true, java.lang.Object includeCulprits = false, java.lang.Object sendToRecipientList = true, java.lang.Object preSendScript = "\$DEFAULT_PRESEND_SCRIPT", java.lang.Object attachmentPattern = "")` Utility function to add extended email
	`static void`	`addExtendedEmail(java.util.Map params, java.lang.Object context)` @param context Closure context, i.e delegate
	`static void`	`addInjectGlobalPasswords(java.lang.Object context)` Utility function to add injectGlobalPasswords
	`static void`	`addLogParserPublisher(java.lang.Object context, java.lang.Object rulesPath = "/var/lib/jenkins/shell_parse_rules.txt")` Utility function to add log parser publisher
	`static void`	`addPerformancePublisher(java.lang.Object context, java.lang.String reportPattern = "*/results/.jtl", java.lang.String unstableResponseTimeThreshold = "", int failedThresholdPositive, int failedThresholdNegative, int unstableThresholdPositive, int unstableThresholdNegative)` Utility to add a performance publisher block, for use in performance tests

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static java.lang.String python27Virtualenv
    
    Common string for creating and activating a python 2.7 virtualenv in a shell block
    See Also:
    Common utils
- Method Detail
  - static void addDefaults(java.lang.Object context)
    
    Adds bare minimum defaults
  - static void addExtendedEmail(java.lang.Object context, java.util.List<java.lang.String> emails, java.util.List<java.lang.String> triggerList = ["failure", java.lang.Object sendToDevelopers = false, java.lang.Object sendToRequester = true, java.lang.Object includeCulprits = false, java.lang.Object sendToRecipientList = true, java.lang.Object preSendScript = "\$DEFAULT_PRESEND_SCRIPT", java.lang.Object attachmentPattern = "")
    
    Utility function to add extended email
    Parameters:
    List - emails List of email string to make it seamlessly compatible with builders
    triggersList - List triggers E.g failure, fixed etc...
    sendToDevelopers - Default false,
    sendToRequester - Default true,
    includeCulprits - Default false,
    sendToRecipientList - Default true
    preSendScript - Default \$DEFAULT_PRESEND_SCRIPT
    See Also:
    Common utils
  - static void addExtendedEmail(java.lang.Object context, java.lang.String emails, java.util.List<java.lang.String> triggerList = ["failure", java.lang.Object sendToDevelopers = false, java.lang.Object sendToRequester = true, java.lang.Object includeCulprits = false, java.lang.Object sendToRecipientList = true, java.lang.Object preSendScript = "\$DEFAULT_PRESEND_SCRIPT", java.lang.Object attachmentPattern = "")
    
    Utility function to add extended email
    Parameters:
    String - emails Comma separated string of emails
    triggerList - List triggers E.g failure, fixed etc...
    sendToDevelopers - Default false,
    sendToRequester - Default true,
    includeCulprits - Default false,
    sendToRecipientList - Default true
    preSendScript - Default \$DEFAULT_PRESEND_SCRIPT
    attachmentPattern - Ant style pattern matching for attachments
    See Also:
    Common utils
  - static void addExtendedEmail(java.util.Map params, java.lang.Object context)
    
    Parameters:
    context - Closure context, i.e delegate
    params - Maps of params emails: , please note it does not support ArrayList triggers: ["failure", "unstable", "fixed"], sendToDevs:, sendToRequester:, includeCulprits:, endToRecipient:, preSendScript = , attachmentPattern =
    See Also:
    Common utils
  - static void addInjectGlobalPasswords(java.lang.Object context)
    
    Utility function to add injectGlobalPasswords
    See Also:
    Common utils
  - static void addLogParserPublisher(java.lang.Object context, java.lang.Object rulesPath = "/var/lib/jenkins/shell_parse_rules.txt")
    
    Utility function to add log parser publisher
    See Also:
    Common utils
  - static void addPerformancePublisher(java.lang.Object context, java.lang.String reportPattern = "**/results/*.jtl", java.lang.String unstableResponseTimeThreshold = "", int failedThresholdPositive, int failedThresholdNegative, int unstableThresholdPositive, int unstableThresholdNegative)
    
    Utility to add a performance publisher block, for use in performance tests
    See Also:
    Common utils

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class CommonUtils

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

static java.lang.String python27Virtualenv

Method Detail

static void addDefaults(java.lang.Object context)

static void addExtendedEmail(java.util.Map params, java.lang.Object context)

static void addInjectGlobalPasswords(java.lang.Object context)

static void addLogParserPublisher(java.lang.Object context, java.lang.Object rulesPath = "/var/lib/jenkins/shell_parse_rules.txt")

static void addPerformancePublisher(java.lang.Object context, java.lang.String reportPattern = "**/results/*.jtl", java.lang.String unstableResponseTimeThreshold = "", int failedThresholdPositive, int failedThresholdNegative, int unstableThresholdPositive, int unstableThresholdNegative)