Package org.creekservice.api.system.test.gradle.plugin.test

Class SystemTest

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.creekservice.api.system.test.gradle.plugin.test.SystemTest
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public abstract class SystemTest extends org.gradle.api.DefaultTask
Task for running Creek system tests.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONTAINER_DEBUG_MOUNT
    The path with in the container where a directory containing the AttachMe agent will be mounted

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    SystemTest()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<Integer>
    getDebugAttachMePort()
    The port on which the attachMe plugin is listening on.
    abstract org.gradle.api.provider.Property<Integer>
    getDebugBaseServicePort()
    The base debug port.
    abstract org.gradle.api.provider.SetProperty<String>
    getDebugServiceInstanceNames()
    The set of service instances to be debugged.
    abstract org.gradle.api.provider.SetProperty<String>
    getDebugServiceNames()
    The set of services to be debugged.
    protected abstract org.gradle.process.ExecOperations
    getExecOperations()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getExtraArguments()
     
    abstract org.gradle.api.file.DirectoryProperty
    getResultDirectory()
     
    abstract org.gradle.api.provider.Property<String>
    getSuitesPathPattern()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSystemTestComponents()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSystemTestExecutor()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSystemTestExtensions()
     
    abstract org.gradle.api.file.DirectoryProperty
    getTestDirectory()
     
    abstract org.gradle.api.provider.Property<String>
    getVerificationTimeoutSeconds()
     
    void
    run()
    Run the task.
    void
    setDebugServiceInstances(List<String> args)
    Method to allow setting debug service instance names the command line.
    void
    setDebugServices(List<String> args)
    Method to allow setting debug service names the command line.
    void
    setExtraArgumentsFromOption(List<String> args)
    Method to allow setting extra arguments from the command line.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getLoggingManager, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

    • CONTAINER_DEBUG_MOUNT

      public static final String CONTAINER_DEBUG_MOUNT
      The path with in the container where a directory containing the AttachMe agent will be mounted
      See Also:

  • Constructor Details

    • SystemTest

      public SystemTest()
      Constructor.

  • Method Details

    • getExecOperations

      @Inject protected abstract org.gradle.process.ExecOperations getExecOperations()
      Returns:
      the exec operations service for running Java processes.

    • getTestDirectory

      @SkipWhenEmpty @InputDirectory @PathSensitive(RELATIVE) public abstract org.gradle.api.file.DirectoryProperty getTestDirectory()
      Returns:
      the source directory containing test

    • getResultDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getResultDirectory()
      Returns:
      the directory result files will be written to.

    • getSystemTestExecutor

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getSystemTestExecutor()
      Returns:
      dependencies of the system test executor.

    • getSystemTestExtensions

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getSystemTestExtensions()
      Returns:
      dependencies of the system test extensions.

    • getSystemTestComponents

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getSystemTestComponents()
      Returns:
      dependencies of the components being system tested.

    • getVerificationTimeoutSeconds

      @Input public abstract org.gradle.api.provider.Property<String> getVerificationTimeoutSeconds()
      Returns:
      verification timeout property.

    • getSuitesPathPattern

      @Input public abstract org.gradle.api.provider.Property<String> getSuitesPathPattern()
      Returns:
      suite path pattern property.

    • getExtraArguments

      @Input public abstract org.gradle.api.provider.ListProperty<String> getExtraArguments()
      Returns:
      additional command line arguments to pass to the executor

    • setExtraArgumentsFromOption

      public void setExtraArgumentsFromOption(List<String> args)
      Method to allow setting extra arguments from the command line.
      Parameters:
      args - the extra arguments.

    • getDebugAttachMePort

      @Input public abstract org.gradle.api.provider.Property<Integer> getDebugAttachMePort()
      The port on which the attachMe plugin is listening on.

      This is the port the attachMe agent running within the microservice's process will call out on to ask the debugger to attach.

      Returns:
      the port the attachMe plugin is listening on.

    • getDebugBaseServicePort

      @Input public abstract org.gradle.api.provider.Property<Integer> getDebugBaseServicePort()
      The base debug port.

      The port the first service being debugged will listen on for the debugger to attach. Subsequent services being debugged will use sequential port numbers.

      Returns:
      the base port number used for debugging.

    • getDebugServiceNames

      @Input public abstract org.gradle.api.provider.SetProperty<String> getDebugServiceNames()
      The set of services to be debugged.
      Returns:
      set of services to debug.

    • setDebugServices

      public void setDebugServices(List<String> args)
      Method to allow setting debug service names the command line.
      Parameters:
      args - the service names

    • getDebugServiceInstanceNames

      @Input public abstract org.gradle.api.provider.SetProperty<String> getDebugServiceInstanceNames()
      The set of service instances to be debugged.

      An instance name is the name of the service with a dash and the instance number appended, e.g. my-service-1.

      Returns:
      set of service instances to debug.

    • setDebugServiceInstances

      public void setDebugServiceInstances(List<String> args)
      Method to allow setting debug service instance names the command line.
      Parameters:
      args - the instance names

    • run

      public void run()
      Run the task.