org.gradle.api.tasks.TasksWithInputsAndOutputs.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.tasks
import org.gradle.test.fixtures.file.TestFile
/**
* Methods that define Groovy implementations for certain task input and output patterns.
*/
trait TasksWithInputsAndOutputs {
abstract TestFile getBuildFile()
abstract TestFile getBuildKotlinFile()
def taskTypeWithOutputFileProperty(TestFile buildFile = getBuildFile()) {
buildFile << """
class FileProducer extends DefaultTask {
@OutputFile
final RegularFileProperty output = project.objects.fileProperty()
@Input
final Property content = project.objects.property(String).convention("content") // set to empty string to delete file
@TaskAction
def go() {
def file = output.get().asFile
def text = this.content.get()
if (text.empty) {
file.delete()
} else {
file.text = text
}
}
}
"""
}
def kotlinTaskTypeWithOutputFileProperty() {
buildKotlinFile << """
abstract class FileProducer: DefaultTask() {
@get:OutputFile
abstract val output: RegularFileProperty
@get:Input
var content = "content" // set to empty string to delete file
@TaskAction
fun go() {
val file = output.get().asFile
if (content.isBlank()) {
file.delete()
} else {
file.writeText(content)
}
}
}
"""
}
def taskTypeWithOutputDirectoryProperty(TestFile buildFile = getBuildFile()) {
buildFile << """
import javax.inject.Inject
abstract class DirProducer extends DefaultTask {
@OutputDirectory
abstract DirectoryProperty getOutput()
@Input
abstract ListProperty getNames()
@Input
abstract Property getContent() // set to empty string to delete directory
@Inject
abstract FileSystemOperations getFs()
DirProducer() {
content.convention("content")
}
@TaskAction
def go() {
def dir = output.get().asFile
def content = this.content.get()
if (content.empty) {
fs.delete { delete(dir) }
} else {
fs.delete { delete(dir) }
dir.mkdirs()
names.get().forEach {
new File(dir, it).text = content
}
}
}
}
"""
}
def taskTypeWithMultipleOutputFiles() {
buildFile << """
// Not using properties
class OutputFilesTask extends DefaultTask {
@OutputFile
File out1
@OutputFile
File out2
@TaskAction
def go() {
out1.text = "1"
out2.text = "2"
}
}
"""
}
def taskTypeWithMultipleOutputFileProperties() {
buildFile << """
class OutputFilesTask extends DefaultTask {
@OutputFile
final RegularFileProperty out1 = project.objects.fileProperty()
@OutputFile
final RegularFileProperty out2 = project.objects.fileProperty()
@TaskAction
def go() {
out1.get().asFile.text = "1"
out2.get().asFile.text = "2"
}
}
"""
}
def taskTypeWithIntInputProperty() {
buildFile << """
class InputTask extends DefaultTask {
@Input
final Property inValue = project.objects.property(Integer)
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = (inValue.get() + 10) as String
}
}
"""
}
def taskTypeWithInputListProperty() {
buildFile << """
class InputTask extends DefaultTask {
@Input
final ListProperty inValue = project.objects.listProperty(Integer)
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = inValue.get().collect { it + 10 }.join(",")
}
}
"""
}
def taskTypeWithInputMapProperty() {
buildFile << """
class InputTask extends DefaultTask {
@Input
final MapProperty inValue = project.objects.mapProperty(String, Integer)
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = inValue.get().collect { k, v -> "\$k=\${v + 10}" }.join(",")
}
}
"""
}
def taskTypeWithInputFileProperty() {
buildFile << """
class InputFileTask extends DefaultTask {
@InputFile
final RegularFileProperty inFile = project.objects.fileProperty()
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = inFile.get().asFile.text
}
}
"""
}
def taskTypeWithInputFileCollection() {
buildFile << """
class InputFilesTask extends DefaultTask {
@InputFiles
final ConfigurableFileCollection inFiles = project.files()
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = inFiles*.text.sort().join(',')
}
}
"""
}
def taskTypeLogsInputFileCollectionContent() {
buildFile << """
class ShowFilesTask extends DefaultTask {
@InputFiles
final ConfigurableFileCollection inFiles = project.files()
@TaskAction
def go() {
println "result = " + inFiles.files.name
}
}
"""
}
def taskTypeLogsArtifactCollectionDetails(TestFile buildFile = getBuildFile()) {
buildFile << """
class ShowArtifactCollection extends DefaultTask {
@Internal
ArtifactCollection collection
@InputFiles
FileCollection getFiles() {
return collection?.artifactFiles
}
@TaskAction
def log() {
println("artifacts = \${collection.artifacts.id}")
println("components = \${collection.artifacts.id.componentIdentifier}")
println("variants = \${collection.artifacts.variant.attributes}")
println("files = \${collection.artifactFiles.files.name}")
}
}
"""
}
def taskTypeWithInputFileListProperty() {
buildFile << """
class InputFilesTask extends DefaultTask {
@InputFiles
final ListProperty inFiles = project.objects.listProperty(FileSystemLocation)
@OutputFile
final RegularFileProperty outFile = project.objects.fileProperty()
@TaskAction
def go() {
outFile.get().asFile.text = inFiles.get()*.asFile.text.sort().join(',')
}
}
"""
}
}