Field Detail

• protected static java.lang.reflect.Method SCRIPT_SET_BINDING

• protected java.util.Map<MethodSignature, groovy.lang.Closure> allowedMethodCallbacks

  List of allowed methods with default interceptors. Complete this list in need with registerAllowedMethod

• protected groovy.util.GroovyScriptEngine gse

  Internal script engine

• protected LibraryLoader libLoader

  Loader for shared global libraries

• protected java.lang.Object loadInterceptor

  Method interceptor for method 'load' to load scripts via encapsulated GroovyScriptEngine

• public java.lang.Object methodInterceptor

  Method interceptor for any method called in executing script. Calls are logged on the call stack.

• protected java.lang.Object parallelInterceptor

  Method interceptor for method 'parallel'

Property Detail

• java.lang.ClassLoader baseClassloader

  Classloader to instantiate scripts

• java.lang.String baseScriptRoot

  Base path for script roots. Usually the path to the project.

• java.util.List<MethodCall> callStack

  Stack of method calls of scripts loaded by this helper

• java.util.Map<java.lang.String, java.lang.String> imports

  Default imports for scripts loaded by this helper

• java.util.Map<java.lang.String, LibraryConfiguration> libraries

  Global Shared Libraries to be loaded with scripts if necessary

  See Also:

  LibraryLoader

• java.lang.Object libraryResourceInterceptor

  Method interceptor for 'libraryResource' in Shared libraries The resource from shared library should have been added to the url classloader in advance

• java.lang.Object methodMissingInterceptor

  Method for calling custom allowed methods

• java.lang.Class scriptBaseClass

  Base class for instantiated scripts

• java.lang.String scriptExtension

  Extension for script files. Ex. jenkins

• java.lang.String[] scriptRoots

  Search paths for scripts

Constructor Detail

• PipelineTestHelper()

• PipelineTestHelper(java.lang.String[] scriptRoots, java.lang.String scriptExtension, java.lang.Class scriptBaseClass, java.util.Map<java.lang.String, java.lang.String> imports, java.lang.ClassLoader baseClassloader, java.lang.String baseScriptRoot)

Method Detail

• java.lang.Object callClosure(groovy.lang.Closure closure, java.lang.Object[] args = null)

  Call closure by handling spreading of parameter default values

  Returns:

  result of the closure call

  Parameters:

  closure - to call

  args - array of arguments passed to this closure call. Is null by default.

• java.lang.Object callIfClosure(java.lang.Object closure, java.lang.Object currentResult)

• protected java.lang.Object callMethod(groovy.lang.MetaMethod method, java.lang.Object delegate, java.lang.Object[] args)

  Call given method on delegate object with args parameters

  Returns:

  return value of the object

  Parameters:

  method - method to call

  delegate - object of the method call

  args - method call parameters

• void clearCallStack()

  Clear call stack

• protected Map.Entry<MethodSignature, groovy.lang.Closure> getAllowedMethodEntry(java.lang.String name, java.lang.Object... args)

  Search for the allowed method entry A null Closure will mean that the method is allowed but not intercepted.

  Returns:

  Map.Entry corresponding to the method

  Parameters:

  name - method name

  args - parameter objects

• java.lang.Object getMethodInterceptor()

• java.lang.Object getMethodMissingInterceptor()

• PipelineTestHelper init()

• protected boolean isInitialized()

  Returns:

  true if internal GroovyScriptEngine is set

• protected boolean isMethodAllowed(java.lang.String name, java.lang.Object args)

  Returns:

  true if method is allowed in this helper

  Parameters:

  name - method name

  args - parameter objects

• groovy.lang.Script loadScript(java.lang.String name)

  Load the script with name and empty binding, returning the Script

  Returns:

  Script object

  Parameters:

  name - path of the script

• groovy.lang.Script loadScript(java.lang.String scriptName, groovy.lang.Binding binding)

  Load the script with given binding context without running, returning the Script

  Returns:

  Script object

  Parameters:

  scriptName

  binding

• long methodCallCount(java.lang.String name)

  Count the number of calls to the method with name

  Returns:

  call number

  Parameters:

  name - method name

• void registerAllowedMethod(java.lang.String name, java.util.List<java.lang.Class> args = [], groovy.lang.Closure closure)

  Parameters:

  name - method name

  args - parameter types

  closure - method implementation, can be null

• void registerAllowedMethod(MethodSignature methodSignature, groovy.lang.Closure closure)

  Register a callback implementation for a method Calls from the loaded scripts to allowed methods will call the given implementation Null callbacks will only log the call and do nothing

  Parameters:

  methodSignature - method signature

  closure - method implementation, can be null

• void registerAllowedMethod(MethodSignature methodSignature, java.util.function.Function callback)

  Parameters:

  methodSignature

  callback

• void registerAllowedMethod(MethodSignature methodSignature, java.util.function.Consumer callback)

  Parameters:

  methodSignature

  callback

• protected void registerMethodCall(java.lang.Object target, int stackDepth, java.lang.String name, java.lang.Object... args)

  Register method call to call stack

  Parameters:

  target - target object

  stackDepth - depth in stack

  name - method name

  args - method arguments

• void registerSharedLibrary(LibraryConfiguration libraryDescription)

  Register library description See LibraryConfiguration for its description

  Parameters:

  libraryDescription - to add

• java.lang.Object runScript(java.lang.String scriptName, groovy.lang.Binding binding)

  Load and run the script, returning the result value;

  Returns:

  the return value of the script

  Parameters:

  scriptName

  binding

• java.lang.Object runScript(java.lang.String scriptName)

  Load and run the script, returning the result value;

  Returns:

  the return value of the script

  Parameters:

  scriptName

• java.lang.Object runScript(groovy.lang.Script script)

  Run the given script object

  Returns:

  the return value of the script

  Parameters:

  Script - object

• protected java.lang.Object runScriptInternal(groovy.lang.Script script)

  Run the script

  Returns:

  the return value of the script

  Parameters:

  script

• protected void setGlobalVars(groovy.lang.Binding binding)

  Sets global variables defined in loaded libraries on the binding

  Parameters:

  binding