Package 

Class TestdocTask

  • 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 TestdocTask
extends BasicRobotFrameworkTask

    Testdoc generates a high level test documentation based on Robot Framework test data. Generated documentation includes name, documentation and other metadata of each test suite and test case, as well as the top-level keywords and their arguments.

    Data can be given as a single file, directory, or as multiple files and directories. In all these cases, the last argument must be the file where to write the output. The output is always created in HTML format.

    • Constructor Summary

      Constructors 
      Constructor Description
      TestdocTask()

    • Method Summary

      Modifier and Type Method Description
      final FileCollection getSources()
      final Unit setSources(@InputFiles() @PathSensitive(value = PathSensitivity.ABSOLUTE) FileCollection sources)
      final DirectoryProperty getOutputDir() Directory to which to put the generated documentation.
      final RegularFileProperty getOutputFile() Filename of the generated documentation.
      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 testdoc(Action<TestdocRobotConfiguration> action)
      final Unit testdoc(Function1<TestdocRobotConfiguration, 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

      • TestdocTask

        TestdocTask()

    • Method Detail

      • setSources

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

      • getOutputDir

         final DirectoryProperty getOutputDir()

        Directory to which to put the generated documentation.

        Default: ${buildDir}/doc

      • getOutputFile

         final RegularFileProperty getOutputFile()

        Filename of the generated documentation.

        Default: testdoc.html

      • 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.