org.gradle.api.file.FilePropertiesIntegrationTest.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 5.5.1 API redistribution.
/*
* Copyright 2017 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.file
import org.gradle.integtests.fixtures.AbstractIntegrationSpec
import org.gradle.util.ToBeImplemented
import spock.lang.Unroll
class FilePropertiesIntegrationTest extends AbstractIntegrationSpec {
def "can attach a calculated directory to task property"() {
buildFile << """
class SomeTask extends DefaultTask {
final DirectoryProperty outputDir = project.objects.directoryProperty()
@TaskAction
void go() {
println "task output dir: " + outputDir.get()
}
}
ext.childDirName = "child"
def t = tasks.create("show", SomeTask)
t.outputDir = layout.buildDirectory.dir(providers.provider { childDirName })
println "output dir before: " + t.outputDir.getOrNull()
buildDir = "output/some-dir"
childDirName = "other-child"
"""
when:
run("show")
then:
outputContains("output dir before: " + testDirectory.file("build/child"))
outputContains("task output dir: " + testDirectory.file("output/some-dir/other-child"))
}
def "can attach a calculated file to task property"() {
buildFile << """
class SomeTask extends DefaultTask {
final RegularFileProperty outputFile = project.objects.fileProperty()
@TaskAction
void go() {
println "task output file: " + outputFile.get()
}
}
ext.childDirName = "child"
def t = tasks.create("show", SomeTask)
t.outputFile = layout.buildDirectory.file(providers.provider { childDirName })
println "output file before: " + t.outputFile.getOrNull()
buildDir = "output/some-dir"
childDirName = "other-child"
"""
when:
run("show")
then:
outputContains("output file before: " + testDirectory.file("build/child"))
outputContains("task output file: " + testDirectory.file("output/some-dir/other-child"))
}
def "can set directory property value from DSL using a value or a provider"() {
given:
buildFile << """
class SomeExtension {
final DirectoryProperty prop
@javax.inject.Inject
SomeExtension(ObjectFactory objects) {
prop = objects.directoryProperty()
}
}
extensions.create('custom', SomeExtension)
custom.prop = layout.projectDir.dir("dir1")
assert custom.prop.get().asFile == file("dir1")
custom.prop = providers.provider { layout.projectDir.dir("dir2") }
assert custom.prop.get().asFile == file("dir2")
custom.prop = layout.buildDir.dir("dir3")
assert custom.prop.get().asFile == file("build/dir3")
custom.prop = file("dir4")
assert custom.prop.get().asFile == file("dir4")
custom.prop.set((Directory)null)
assert custom.prop.getOrNull() == null
custom.prop = file("foo")
custom.prop.set(null)
assert custom.prop.getOrNull() == null
custom.prop = file("foo")
custom.prop.set((File)null)
assert custom.prop.getOrNull() == null
"""
expect:
succeeds()
}
def "can set regular file property value from DSL using a value or a provider"() {
given:
buildFile << """
class SomeExtension {
final RegularFileProperty prop
@javax.inject.Inject
SomeExtension(ObjectFactory objects) {
prop = objects.fileProperty()
}
}
extensions.create('custom', SomeExtension)
custom.prop = layout.projectDir.file("file1")
assert custom.prop.get().asFile == file("file1")
custom.prop = providers.provider { layout.projectDir.file("file2") }
assert custom.prop.get().asFile == file("file2")
custom.prop = layout.buildDir.file("file3")
assert custom.prop.get().asFile == file("build/file3")
custom.prop = file("file4")
assert custom.prop.get().asFile == file("file4")
custom.prop.set((RegularFile)null)
assert custom.prop.getOrNull() == null
custom.prop = file("foo")
custom.prop.set(null)
assert custom.prop.getOrNull() == null
custom.prop = file("foo")
custom.prop.set((File)null)
assert custom.prop.getOrNull() == null
"""
expect:
succeeds()
}
def "reports failure to set directory property value using incompatible type"() {
given:
buildFile << """
class SomeExtension {
final Property prop
@javax.inject.Inject
SomeExtension(ObjectFactory objects) {
prop = objects.directoryProperty()
}
}
extensions.create('custom', SomeExtension)
task useIntTypeDsl {
doLast {
custom.prop = 123
}
}
task useIntTypeApi {
doLast {
custom.prop.set(123)
}
}
task useFileTypeDsl {
doLast {
custom.prop = layout.projectDirectory.file("build.gradle")
}
}
task useFileProviderDsl {
doLast {
custom.prop = layout.buildDirectory.file("build.gradle")
}
}
task useFileProviderApi {
doLast {
custom.prop.set(layout.buildDirectory.file("build.gradle"))
}
}
"""
when:
fails("useIntTypeDsl")
then:
failure.assertHasDescription("Execution failed for task ':useIntTypeDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.Directory using an instance of type java.lang.Integer.")
when:
fails("useIntTypeApi")
then:
failure.assertHasDescription("Execution failed for task ':useIntTypeApi'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.Directory using an instance of type java.lang.Integer.")
when:
fails("useFileTypeDsl")
then:
failure.assertHasDescription("Execution failed for task ':useFileTypeDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.Directory using an instance of type org.gradle.api.internal.file.DefaultFilePropertyFactory\$FixedFile.")
when:
fails("useFileProviderDsl")
then:
failure.assertHasDescription("Execution failed for task ':useFileProviderDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.Directory using a provider of type org.gradle.api.file.RegularFile.")
when:
fails("useFileProviderApi")
then:
failure.assertHasDescription("Execution failed for task ':useFileProviderApi'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.Directory using a provider of type org.gradle.api.file.RegularFile.")
}
def "reports failure to set regular file property value using incompatible type"() {
given:
buildFile << """
class SomeExtension {
final Property prop
@javax.inject.Inject
SomeExtension(ObjectFactory objects) {
prop = objects.fileProperty()
}
}
extensions.create('custom', SomeExtension)
task useIntTypeDsl {
doLast {
custom.prop = 123
}
}
task useIntTypeApi {
doLast {
custom.prop.set(123)
}
}
task useDirTypeDsl {
doLast {
custom.prop = layout.projectDirectory.dir("src")
}
}
task useDirProviderDsl {
doLast {
custom.prop = layout.buildDirectory
}
}
task useDirProviderApi {
doLast {
custom.prop.set(layout.buildDirectory)
}
}
"""
when:
fails("useIntTypeDsl")
then:
failure.assertHasDescription("Execution failed for task ':useIntTypeDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.RegularFile using an instance of type java.lang.Integer.")
when:
fails("useIntTypeApi")
then:
failure.assertHasDescription("Execution failed for task ':useIntTypeApi'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.RegularFile using an instance of type java.lang.Integer.")
when:
fails("useDirTypeDsl")
then:
failure.assertHasDescription("Execution failed for task ':useDirTypeDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.RegularFile using an instance of type org.gradle.api.internal.file.DefaultFilePropertyFactory\$FixedDirectory.")
when:
fails("useDirProviderDsl")
then:
failure.assertHasDescription("Execution failed for task ':useDirProviderDsl'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.RegularFile using a provider of type org.gradle.api.file.Directory.")
when:
fails("useDirProviderApi")
then:
failure.assertHasDescription("Execution failed for task ':useDirProviderApi'.")
failure.assertHasCause("Cannot set the value of a property of type org.gradle.api.file.RegularFile using a provider of type org.gradle.api.file.Directory.")
}
@Unroll
def "can wire the output file of a task as input to another task using property created by #outputFileMethod"() {
buildFile << """
class FileOutputTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = project.objects.fileProperty()
@OutputFile
final RegularFileProperty outputFile = ${outputFileMethod}
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = inputFile.asFile.get().text
}
}
class MergeTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = ${inputFileMethod}
@OutputFile
final RegularFileProperty outputFile = project.objects.fileProperty()
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = ""
file << inputFile.asFile.get().text
}
}
task createFile(type: FileOutputTask)
task merge(type: MergeTask) {
outputFile = layout.buildDirectory.file("merged.txt")
inputFile = createFile.outputFile
}
// Set values lazily
createFile.inputFile = layout.projectDirectory.file("file-source.txt")
createFile.outputFile = layout.buildDirectory.file("file.txt")
buildDir = "output"
"""
file("file-source.txt").text = "file1"
expectDeprecated(deprecated)
when:
run("merge")
then:
result.assertTasksExecuted(":createFile", ":merge")
file("output/merged.txt").text == 'file1'
when:
run("merge")
then:
result.assertTasksNotSkipped()
when:
file("file-source.txt").text = "new-file1"
run("merge")
then:
result.assertTasksExecuted(":createFile", ":merge")
file("output/merged.txt").text == 'new-file1'
where:
outputFileMethod | inputFileMethod | deprecated
"newOutputFile()" | "newInputFile()" | 2
"project.layout.fileProperty()" | "project.layout.fileProperty()" | 1
"project.objects.fileProperty()" | "project.objects.fileProperty()" | 0
}
@Unroll
def "task #annotation file property is implicitly finalized and changes ignored when task starts execution"() {
buildFile << """
class SomeTask extends DefaultTask {
${annotation}
final RegularFileProperty prop = project.objects.fileProperty()
@TaskAction
void go() {
prop.set(project.file("other.txt"))
println "value: " + prop.get()
}
}
task show(type: SomeTask) {
prop = file("in.txt")
}
"""
file("in.txt").createFile()
when:
executer.expectDeprecationWarning()
run("show")
then:
outputContains("value: " + testDirectory.file("in.txt"))
where:
annotation | _
"@InputFile" | _
"@OutputFile" | _
}
@Unroll
def "task #annotation directory property is implicitly finalized and changes ignored when task starts execution"() {
buildFile << """
class SomeTask extends DefaultTask {
${annotation}
final DirectoryProperty prop = project.objects.directoryProperty()
@TaskAction
void go() {
prop.set(project.file("other.dir"))
println "value: " + prop.get()
}
}
task show(type: SomeTask) {
prop = file("in.dir")
}
"""
file("in.dir").createDir()
when:
executer.expectDeprecationWarning()
run("show")
then:
outputContains("value: " + testDirectory.file("in.dir"))
where:
annotation | _
"@InputDirectory" | _
"@OutputDirectory" | _
}
@Unroll
def "task ad hoc file property registered using #registrationMethod is implicitly finalized and changes ignored when task starts execution"() {
given:
buildFile << """
def prop = project.objects.fileProperty()
task thing {
${registrationMethod}(prop)
prop.set(file("file-1"))
doLast {
prop.set(file("ignored"))
println "prop = " + prop.get()
}
}
"""
file("file-1").createFile()
when:
executer.expectDeprecationWarning()
run("thing")
then:
output.contains("prop = " + file("file-1"))
where:
registrationMethod | _
"inputs.file" | _
"outputs.file" | _
}
@Unroll
def "task ad hoc directory property registered using #registrationMethod is implicitly finalized and changes ignored when task starts execution"() {
given:
buildFile << """
def prop = project.objects.directoryProperty()
task thing {
${registrationMethod}(prop)
prop.set(file("file-1"))
doLast {
prop.set(file("ignored"))
println "prop = " + prop.get()
}
}
"""
file("file-1").createDir()
when:
executer.expectDeprecationWarning()
run("thing")
then:
output.contains("prop = " + file("file-1"))
where:
registrationMethod | _
"inputs.dir" | _
"outputs.dir" | _
}
@Unroll
def "can wire the output file of an ad hoc task as input to another task using property created by #outputFileMethod"() {
buildFile << """
class MergeTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = project.objects.fileProperty()
@OutputFile
final RegularFileProperty outputFile = project.objects.fileProperty()
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = ""
file << inputFile.asFile.get().text
}
}
task createFile {
ext.outputFile = ${outputFileMethod}
outputs.file(outputFile)
doLast {
outputFile.get().asFile.text = 'file1'
}
}
task merge(type: MergeTask) {
outputFile = layout.buildDirectory.file("merged.txt")
inputFile = createFile.outputFile
}
// Set values lazily
createFile.outputFile.set(layout.buildDirectory.file("file.txt"))
buildDir = "output"
"""
when:
expectDeprecated(deprecated)
run("merge")
then:
result.assertTasksExecuted(":createFile", ":merge")
file("output/merged.txt").text == 'file1'
when:
run("merge")
then:
result.assertTasksNotSkipped()
where:
outputFileMethod | deprecated
"newOutputFile()" | 1
"project.layout.fileProperty()" | 1
"project.objects.fileProperty()" | 0
}
@Unroll
def "can wire the output directory of a task as input to another task using property created by #outputDirMethod"() {
buildFile << """
class DirOutputTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = project.objects.fileProperty()
@OutputDirectory
final DirectoryProperty outputDir = ${outputDirMethod}
@TaskAction
void go() {
def dir = outputDir.asFile.get()
new File(dir, "file.txt").text = inputFile.asFile.get().text
}
}
class MergeTask extends DefaultTask {
@InputDirectory
final DirectoryProperty inputDir = ${inputDirMethod}
@OutputFile
final RegularFileProperty outputFile = project.objects.fileProperty()
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = inputDir.asFile.get().listFiles()*.text.join(',')
}
}
task createDir(type: DirOutputTask)
task merge(type: MergeTask) {
outputFile = layout.buildDirectory.file("merged.txt")
inputDir = createDir.outputDir
}
// Set values lazily
createDir.inputFile = layout.projectDirectory.file("dir-source.txt")
createDir.outputDir = layout.buildDirectory.dir("dir")
buildDir = "output"
"""
file("dir-source.txt").text = "dir1"
when:
expectDeprecated(deprecated)
run("merge")
then:
result.assertTasksExecuted(":createDir", ":merge")
file("output/merged.txt").text == 'dir1'
when:
run("merge")
then:
result.assertTasksNotSkipped()
when:
file("dir-source.txt").text = "new-dir1"
run("merge")
then:
result.assertTasksNotSkipped(":createDir", ":merge")
file("output/merged.txt").text == 'new-dir1'
where:
outputDirMethod | inputDirMethod | deprecated
"newOutputDirectory()" | "newInputDirectory()" | 2
"project.layout.directoryProperty()" | "project.layout.directoryProperty()" | 1
"project.objects.directoryProperty()" | "project.objects.directoryProperty()" | 0
}
@Unroll
def "can wire the output directory of an ad hoc task as input to another task using property created by #outputDirMethod"() {
buildFile << """
class MergeTask extends DefaultTask {
@InputDirectory
final DirectoryProperty inputDir = project.objects.directoryProperty()
@OutputFile
final RegularFileProperty outputFile = project.objects.fileProperty()
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = inputDir.asFile.get().listFiles()*.text.join(',')
}
}
task createDir {
ext.outputDir = ${outputDirMethod}
outputs.dir(outputDir)
doLast {
new File(outputDir.get().asFile, "file.txt").text = "dir1"
}
}
task merge(type: MergeTask) {
outputFile = layout.buildDirectory.file("merged.txt")
inputDir = createDir.outputDir
}
// Set values lazily
createDir.outputDir.set(layout.buildDirectory.dir("dir1"))
buildDir = "output"
"""
when:
expectDeprecated(deprecated)
run("merge")
then:
result.assertTasksExecuted(":createDir", ":merge")
file("output/merged.txt").text == 'dir1'
when:
run("merge")
then:
result.assertTasksNotSkipped()
where:
outputDirMethod | deprecated
"newOutputDirectory()" | 1
"project.layout.directoryProperty()" | 1
"project.objects.directoryProperty()" | 0
}
@Unroll
def "can wire the output of a task created using #outputFileMethod and #outputDirMethod as a dependency of another task via #fileMethod"() {
buildFile << """
class DirOutputTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = project.objects.fileProperty()
@OutputDirectory
final DirectoryProperty outputDir = ${outputDirMethod}
@TaskAction
void go() {
def dir = outputDir.asFile.get()
new File(dir, "file.txt").text = inputFile.asFile.get().text
}
}
class FileOutputTask extends DefaultTask {
@InputFile
final RegularFileProperty inputFile = project.objects.fileProperty()
@OutputFile
final RegularFileProperty outputFile = ${outputFileMethod}
@TaskAction
void go() {
def file = outputFile.asFile.get()
file.text = inputFile.asFile.get().text
}
}
task createDir(type: DirOutputTask)
task createFile1(type: FileOutputTask)
task otherTask {
${fileMethod}(createFile1.outputFile)
${dirMethod}(createDir.outputDir.asFileTree)
}
// Set values lazily
createDir.inputFile = layout.projectDirectory.file("dir1-source.txt")
createDir.outputDir = layout.buildDirectory.dir("dir1")
createFile1.inputFile = layout.projectDirectory.file("file1-source.txt")
createFile1.outputFile = layout.buildDirectory.file("file1.txt")
buildDir = "output"
"""
file("dir1-source.txt").text = "dir1"
file("file1-source.txt").text = "file1"
when:
expectDeprecated(deprecated)
run("otherTask")
then:
result.assertTasksExecuted(":createDir", ":createFile1", ":otherTask")
where:
fileMethod | dirMethod | outputDirMethod | outputFileMethod | deprecated
'dependsOn' | 'dependsOn' | "newOutputDirectory()" | "newOutputFile()" | 2
'inputs.file' | 'inputs.dir' | "newOutputDirectory()" | "newOutputFile()" | 2
'dependsOn' | 'dependsOn' | "project.layout.directoryProperty()" | "project.layout.fileProperty()" | 2
'inputs.file' | 'inputs.dir' | "project.layout.directoryProperty()" | "project.layout.fileProperty()" | 2
'dependsOn' | 'dependsOn' | "project.objects.directoryProperty()" | "project.objects.fileProperty()" | 0
'inputs.file' | 'inputs.dir' | "project.objects.directoryProperty()" | "project.objects.fileProperty()" | 0
}
def "can use @Optional on properties with type Property"() {
given:
buildFile << """
class SomeTask extends DefaultTask {
@Optional @InputFile
Property inFile = project.objects.fileProperty()
@Optional @InputDirectory
Property inDir = project.objects.directoryProperty()
@Optional @OutputFile
Property outFile = project.objects.fileProperty()
@Optional @OutputDirectory
Property outDir = project.objects.directoryProperty()
@TaskAction
def go() { }
}
task doNothing(type: SomeTask)
"""
when:
run("doNothing")
then:
result.assertTasksNotSkipped(":doNothing")
when:
run("doNothing")
then:
result.assertTasksSkipped(":doNothing")
}
def "optional output consumed as non-optional input yields a reasonable error message"() {
given:
buildFile << """
class ProducerTask extends DefaultTask {
@Optional @OutputFile
Property outFile = project.objects.fileProperty()
@TaskAction
def go() { }
}
class NestedBean {
NestedBean(RegularFileProperty inputFile) {
this.inputFile = inputFile
}
@InputFile
final RegularFileProperty inputFile
}
class ConsumerTask extends DefaultTask {
@Nested
NestedBean bean = new NestedBean(project.objects.fileProperty())
@Optional
@OutputFile
Property outputFile = project.objects.directoryProperty()
@TaskAction
def go() { }
}
task producer(type: ProducerTask)
task consumer(type: ConsumerTask) {
bean.inputFile.set(producer.outFile)
}
"""
when:
fails("consumer")
then:
failure.assertHasDescription("A problem was found with the configuration of task ':consumer'.")
failure.assertHasCause("No value has been specified for property 'bean.inputFile'.")
executedTasks == [':consumer']
}
@ToBeImplemented("Absent Provider in FileCollection throws exception")
def "depending on an optional output from another task as part of a FileCollection works"() {
given:
buildFile << """
class ProducerTask extends DefaultTask {
@Optional @OutputFile
Property outFile = project.objects.fileProperty()
@TaskAction
def go() { }
}
class ConsumerTask extends DefaultTask {
@InputFiles
ConfigurableFileCollection inputFiles = project.objects.fileCollection()
@Optional
@OutputFile
Property outputFile = project.objects.directoryProperty()
@TaskAction
def go() { }
}
task producer(type: ProducerTask)
task consumer(type: ConsumerTask) {
inputFiles.from(producer.outFile)
}
"""
when:
// FIXME: The task should succeed
fails("consumer")
then:
failure.assertHasDescription("Execution failed for task ':consumer'.")
failure.assertHasCause("No value has been specified for this provider.")
executedAndNotSkipped(':producer', ':consumer')
}
def expectDeprecated(int count) {
if (count > 0) {
executer.beforeExecute {
expectDeprecationWarnings(count)
}
}
}
}