viddik-gradle-plugin/io.github.youndie.viddik.gradle/ViddikRecordTask

ViddikRecordTask

@DisableCachingByDefault(because = "Recording writes goldens into the source tree as an undeclared output.")

abstract class ViddikRecordTask : ViddikScreenshotTask

The recording task, which has one more switch than a verification does.

A separate type rather than a property on ViddikScreenshotTask so --force is offered by the one task it means anything for: on viddikVerify it would be a flag that changes nothing.

Constructors

ViddikRecordTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open var allJvmArgs: List<String>

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

binaryResultsDirectory

@get:OutputDirectory

abstract val binaryResultsDirectory: DirectoryProperty?

bootstrapClasspath

open var bootstrapClasspath: FileCollection

candidateClassFiles

@get:InputFiles

@get:SkipWhenEmpty

@get:IgnoreEmptyDirectories

@get:PathSensitive(value = PathSensitivity.RELATIVE)

open val candidateClassFiles: FileTree

@get:Internal(value = "captured by stableClasspath")

open var classpath: FileCollection

@get:Internal

abstract val component: Property<String>

Which components to run, as a case-insensitive substring of "$group - $name" with * and ? as wildcards. Unset runs every fixture in the module; a value matching nothing fails the task rather than reporting an empty green run.

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping?

open var debug: Boolean

open val debugOptions: JavaDebugOptions

defaultCharacterEncoding

open var defaultCharacterEncoding: @Nullable String?

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

@get:Incubating

@get:Input

abstract val dryRun: Property<Boolean>

enableAssertions

open var enableAssertions: Boolean

open var enabled: Boolean

@get:Internal

open var environment: Map<String, Any>

@get:Internal

open val excludes: Set<String>

@get:Internal

open var executable: String

open val extensions: ExtensionContainer?

open var failFast: Boolean

failOnNoDiscoveredTests

@get:Input

abstract val failOnNoDiscoveredTests: Property<Boolean?>?

open val filter: TestFilter?

open val finalizedBy: TaskDependency?

@get:Internal

abstract val force: Property<Boolean>

Rewrite every selected golden, including the ones the verification would accept as they are.

@get:Internal

open var forkEvery: Long

open var group: @Nullable String?

open val identityPath: Path?

@get:Internal

open var ignoreFailures: Boolean

impliesSubProjects

open var impliesSubProjects: Boolean

@get:Internal

open val includes: Set<String>

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

isScanForTestClasses

@get:Input

open var isScanForTestClasses: Boolean

abstract val javaLauncher: Property<JavaLauncher>

@get:Input

open val javaVersion: JavaVersion

open var jvmArgs: List<String>

jvmArgumentProviders

open val jvmArgumentProviders: List<CommandLineArgumentProvider>

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val loggingManager: @Nullable LoggingManagerInternal?

open var maxHeapSize: @Nullable String?

maxParallelForks

@get:Internal

open var maxParallelForks: Int

open var minHeapSize: @Nullable String?

open val modularity: ModularitySpec

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val options: TestFrameworkOptions

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

open val reports: TestTaskReports?

requiredServices

open val requiredServices: TaskRequiredServices?

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

systemProperties

open var systemProperties: Map<String, @Nullable Any?>

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

testClassesDirs

@get:Internal

open var testClassesDirs: FileCollection

testDefinitionDirs

@get:Incubating

@get:InputFiles

@get:SkipWhenEmpty

@get:IgnoreEmptyDirectories

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val testDefinitionDirs: ConfigurableFileCollection

@get:Internal

open val testFramework: TestFramework

testFrameworkProperty

open val testFrameworkProperty: Property<TestFramework>

open val testLogging: TestLoggingContainer?

open val timeout: Property<Duration?>?

@get:Internal

open var workingDir: File

workingDirectory

@get:Internal

open val workingDirectory: DirectoryProperty

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

addTestListener

open fun addTestListener(listener: TestListener?)

addTestMetadataListener

@Incubating

open fun addTestMetadataListener(listener: TestMetadataListener?)

addTestOutputListener

open fun addTestOutputListener(listener: TestOutputListener?)

open fun ~~afterSuite~~(closure: Closure<*>?)

open fun ~~afterTest~~(closure: Closure<*>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open fun ~~beforeSuite~~(closure: Closure<*>?)

open fun ~~beforeTest~~(closure: Closure<*>?)

bootstrapClasspath

open fun bootstrapClasspath(vararg classpath: @Nullable Any?): Test

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

conventionMapping

open fun conventionMapping(property: String?, mapping: Closure<*>?): Task?

open fun conventionMapping(property: String?, mapping: Callable<*>?): Task?

open fun copyTo(target: JavaForkOptions): Test

open fun copyTo(target: ProcessForkOptions): Test

open fun debugOptions(action: Action<JavaDebugOptions>)

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun environment(environmentVariables: Map<String, *>): Test

open fun environment(name: String, value: Any): Test

open fun exclude(excludeSpec: Closure<*>): Test

open fun exclude(excludes: Iterable<String>): Test

open fun exclude(excludeSpec: Spec<FileTreeElement>): Test

open fun exclude(vararg excludes: String): Test

open fun executable(executable: Any): Test

open fun executeTests()

open fun filter(action: Action<TestFilter>)

open fun finalizedBy(vararg paths: Any?): Task?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun include(includeSpec: Closure<*>): Test

open fun include(includes: Iterable<String>): Test

open fun include(includeSpec: Spec<FileTreeElement>): Test

open fun include(vararg includes: String): Test

open fun jvmArgs(arguments: Iterable<*>): Test

open fun jvmArgs(vararg arguments: Any): Test

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun ~~onOutput~~(closure: Closure<*>?)

open fun options(@DelegatesTo(value = TestFrameworkOptions::class) testFrameworkConfigure: Closure<*>): TestFrameworkOptions

open fun options(testFrameworkConfigure: Action<in TestFrameworkOptions>): TestFrameworkOptions

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

removeTestListener

open fun removeTestListener(listener: TestListener?)

removeTestMetadataListener

@Incubating

open fun removeTestMetadataListener(listener: TestMetadataListener?)

removeTestOutputListener

open fun removeTestOutputListener(listener: TestOutputListener?)

open fun reports(closure: Closure<*>?): TestTaskReports?

open fun reports(configureAction: Action<in TestTaskReports?>?): TestTaskReports?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setExcludes(excludes: Iterable<String>): Test

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

open fun setIncludes(includes: Iterable<String>): Test

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

setTestNameIncludePatterns

open fun setTestNameIncludePatterns(testNamePattern: List<String>): Test

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

systemProperties

open fun systemProperties(properties: Map<String, out @Nullable Any?>): Test

open fun systemProperty(name: String, value: @Nullable Any?): Test

open fun ~~testFramework~~(testFrameworkConfigure: @Nullable Closure<*>??): TestFramework

open fun testLogging(@DelegatesTo(value = TestLoggingContainer::class) closure: Closure<*>?)

open fun testLogging(action: Action<in TestLoggingContainer?>?)

open fun useJUnit()

open fun useJUnit(@DelegatesTo(value = JUnitOptions::class) testFrameworkConfigure: @Nullable Closure<*>??)

open fun useJUnit(testFrameworkConfigure: Action<in JUnitOptions>)

useJUnitPlatform

open fun useJUnitPlatform()

open fun useJUnitPlatform(testFrameworkConfigure: Action<in JUnitPlatformOptions>)

open fun usesService(service: Provider<out BuildService<*>?>?)

open fun useTestNG()

open fun useTestNG(@DelegatesTo(value = TestNGOptions::class) testFrameworkConfigure: Closure<*>)

open fun useTestNG(testFrameworkConfigure: Action<in TestNGOptions>)

open fun workingDir(dir: Any): Test