Package 

Class RunRobotTask

  • All Implemented Interfaces:
    kotlin.Comparable , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.IConventionAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.process.BaseExecSpec , org.gradle.process.JavaExecSpec , org.gradle.process.JavaForkOptions , org.gradle.process.ProcessForkOptions , org.gradle.util.Configurable 
    
public class RunRobotTask
extends BasicRobotFrameworkTask

    • Constructor Summary

      Constructors 
      Constructor Description
      RunRobotTask()

    • Method Summary

      Modifier and Type Method Description
      final FileCollection getSources() Robot Framework test cases are created in files and directories , and they are executed by giving the path to the file or directory in question to the selected runner script.
      final Unit setSources(@InputFiles() @PathSensitive(value = PathSensitivity.ABSOLUTE) FileCollection sources) Robot Framework test cases are created in files and directories , and they are executed by giving the path to the file or directory in question to the selected runner script.
      final DirectoryProperty getOutputDir() Directory where the output shall be put to
      final List<String> getRfArgs() Additional properties that will be append to end of the configuration arguments.
      final Unit setRfArgs(@Input() List<String> rfArgs) Additional properties that will be append to end of the configuration arguments.
      final Unit robot(Action<RunRobotConfiguration> action)
      final Unit robot(Function1<RunRobotConfiguration, Unit> config)
      Unit exec()

      • Methods inherited from class org.gradle.api.internal.ConventionTask

        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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class org.gradle.api.DefaultTask

        appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class org.gradle.api.tasks.JavaExec

        conventionMapping, conventionMapping, getConventionMapping

      • Methods inherited from class de.qualersoft.robotframework.gradleplugin.tasks.BasicRobotFrameworkTask

        args, args, bootstrapClasspath, classpath, copyTo, copyTo, debugOptions, environment, environment, executable, getAllJvmArgs, getArgs, getArgumentProviders, getBootstrapClasspath, getClasspath, getCommandLine, getDebug, getDebugOptions, getDefaultCharacterEncoding, getEnableAssertions, getEnvironment, getErrorOutput, getExecActionFactory, getExecutable, getExecutionResult, getJavaLauncher, getJavaVersion, getJvmArgs, getJvmArgumentProviders, getMain, getMainClass, getMainModule, getMaxHeapSize, getMinHeapSize, getModularity, getObjectFactory, getProviderFactory, getStandardInput, getStandardOutput, getSystemProperties, getWorkingDir, isIgnoreExitValue, jvmArgs, jvmArgs, setAllJvmArgs, setAllJvmArgs, setArgs, setArgs, setArgsString, setBootstrapClasspath, setClasspath, setDebug, setDefaultCharacterEncoding, setEnableAssertions, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setJvmArgs, setJvmArgs, setMain, setMaxHeapSize, setMinHeapSize, setStandardInput, setStandardOutput, setSystemProperties, setWorkingDir, setWorkingDir, systemProperties, systemProperty, workingDir

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RunRobotTask

        RunRobotTask()

    • Method Detail

      • getSources

         final FileCollection getSources()

        Robot Framework test cases are created in files and directories , and they are executed by giving the path to the file or directory in question to the selected runner script. The path can be absolute or, more commonly, relative to the directory where tests are executed from. The given file or directory creates the top-level test suite, which gets its name, unless overridden with the RunRobotConfiguration.name&nbsp; option, from the file or directory name.

        Different execution possibilities are illustrated in the examples below. Note that in these examples, as well as in other examples in this section, only the robot script is used, but other execution approaches could be used similarly.

        robot tests.robot
robot path/to/my_tests/
robot c:\robot\tests.robot

        It is also possible to give paths to several test case files or directories at once, separated with spaces. In this case, Robot Framework creates the top-level test suite automatically, and the specified files and directories become its child test suites. The name of the created test suite is got from child suite names by concatenating them together with an ampersand (&) and spaces. For example, the name of the top-level suite in the first example below is My Tests & Your Tests. These automatically created names are often quite long and complicated. In most cases, it is thus better to use the RunRobotConfiguration.name option for overriding it, as in the second example below:

        robot my_tests.robot your_tests.robot
robot --name Example path/to/tests/pattern_*.robot

      • setSources

         final Unit setSources(@InputFiles() @PathSensitive(value = PathSensitivity.ABSOLUTE) FileCollection sources)

        Robot Framework test cases are created in files and directories , and they are executed by giving the path to the file or directory in question to the selected runner script. The path can be absolute or, more commonly, relative to the directory where tests are executed from. The given file or directory creates the top-level test suite, which gets its name, unless overridden with the RunRobotConfiguration.name&nbsp; option, from the file or directory name.

        Different execution possibilities are illustrated in the examples below. Note that in these examples, as well as in other examples in this section, only the robot script is used, but other execution approaches could be used similarly.

        robot tests.robot
robot path/to/my_tests/
robot c:\robot\tests.robot

        It is also possible to give paths to several test case files or directories at once, separated with spaces. In this case, Robot Framework creates the top-level test suite automatically, and the specified files and directories become its child test suites. The name of the created test suite is got from child suite names by concatenating them together with an ampersand (&) and spaces. For example, the name of the top-level suite in the first example below is My Tests & Your Tests. These automatically created names are often quite long and complicated. In most cases, it is thus better to use the RunRobotConfiguration.name option for overriding it, as in the second example below:

        robot my_tests.robot your_tests.robot
robot --name Example path/to/tests/pattern_*.robot

      • getOutputDir

         final DirectoryProperty getOutputDir()

        Directory where the output shall be put to

      • getRfArgs

         final List<String> getRfArgs()

        Additional properties that will be append to end of the configuration arguments. Can be used to 'override' configuration or to provide task specific parameters.

      • setRfArgs

         final Unit setRfArgs(@Input() List<String> rfArgs)

        Additional properties that will be append to end of the configuration arguments. Can be used to 'override' configuration or to provide task specific parameters.