org.gradle.api.tasks.TaskCreationBuildOperationIntegrationTest.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 2018 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.api.internal.tasks.DefaultTaskContainer
import org.gradle.api.internal.tasks.RealizeTaskBuildOperationType
import org.gradle.api.internal.tasks.RegisterTaskBuildOperationType
import org.gradle.api.specs.Spec
import org.gradle.integtests.fixtures.AbstractIntegrationSpec
import org.gradle.integtests.fixtures.BuildOperationsFixture
import org.gradle.integtests.fixtures.build.BuildTestFixture
import org.gradle.internal.logging.events.LogEvent
import org.gradle.internal.operations.BuildOperationType
import org.gradle.internal.operations.trace.BuildOperationRecord
class TaskCreationBuildOperationIntegrationTest extends AbstractIntegrationSpec {
def buildOperations = new BuildOperationsFixture(executer, testDirectoryProvider)
def "configure actions for eager creation are nested in realization build op"() {
buildFile << """
tasks.all {
logger.lifecycle 'all'
}
tasks.configureEach {
logger.lifecycle 'configureEach'
}
tasks.create('foo') {
logger.lifecycle 'create'
}
tasks.all {
logger.lifecycle 'too late'
}
"""
when:
run('foo')
then:
verifyTaskIds()
def realize = verifyTaskDetails(RealizeTaskBuildOperationType, withPath(':', ':foo'))
with(realize) {
progress.size() == 1
with(progress[0]) {
detailsClassName == LogEvent.name
details.message.startsWith("create")
}
children.size() == 2
with(children[0]) {
progress.size() == 1
progress[0].detailsClassName == LogEvent.name
progress[0].details.message.startsWith("all")
}
with(children[1]) {
progress.size() == 1
progress[0].detailsClassName == LogEvent.name
progress[0].details.message.startsWith("configureEach")
}
}
}
def "configure actions for lazy creation are nested in realization build op"() {
buildFile << """
tasks.configureEach {
logger.lifecycle 'configureEach'
}
def p = tasks.register('foo') {
logger.lifecycle 'register'
}
p.configure {
logger.lifecycle 'configure'
}
"""
when:
run('foo')
then:
verifyTaskIds()
def realize = verifyTaskDetails(RealizeTaskBuildOperationType, withPath(':', ':foo'))
with(realize) {
children.size() == 3
with(children[0]) {
progress.size() == 1
progress[0].detailsClassName == LogEvent.name
progress[0].details.message.startsWith("configureEach")
}
with(children[1]) {
progress.size() == 1
progress[0].detailsClassName == LogEvent.name
progress[0].details.message.startsWith("register")
}
with(children[2]) {
progress.size() == 1
progress[0].detailsClassName == LogEvent.name
progress[0].details.message.startsWith("configure")
}
}
}
def "emits registration build ops when tasks not realized"() {
given:
stopBeforeTaskGraphCalculation()
register('foo')
when:
runAndFail()
then:
verifyTaskIds()
verifyTaskDetails(RegisterTaskBuildOperationType, withPath(':', ':foo'))
buildOperations.none(RealizeTaskBuildOperationType)
}
def "emits two ops for eager lazy realization"() {
given:
stopBeforeTaskGraphCalculation()
register('foo')
when:
args("-D${DefaultTaskContainer.EAGERLY_CREATE_LAZY_TASKS_PROPERTY}=true")
runAndFail()
then:
verifyTaskIds()
verifyTaskDetails(RegisterTaskBuildOperationType, withPath(':', ':foo')).children.empty
def realize = verifyTaskDetails(RealizeTaskBuildOperationType, withPath(':', ':foo'))
realize.children.empty
realize.details.eager == false
}
def "op during realize are child ops"() {
given:
register('foo')
register('bar')
buildFile << """
tasks.named("foo").configure {
tasks.named("bar").get()
}
"""
when:
run("foo")
then:
verifyTaskIds()
verifyTaskDetails(RegisterTaskBuildOperationType, withPath(':', ':foo')).children.empty
def realize = verifyTaskDetails(RealizeTaskBuildOperationType, withPath(':', ':foo'))
realize.children.size() == 1
def configure = realize.children[0]
configure.children.size() == 1
buildOperations.isType(configure.children[0], RealizeTaskBuildOperationType)
withPath(":", ":bar").isSatisfiedBy(configure.children[0])
}
def "emits registration, realization build ops when tasks later realized"() {
given:
register('foo')
register('bar')
when:
run 'foo'
then:
verifyTaskIds()
verifyTaskDetails(RegisterTaskBuildOperationType, withPath(':', ':foo')).children.empty
verifyTaskDetails(RegisterTaskBuildOperationType, withPath(':', ':bar')).children.empty
verifyTaskDetails(RealizeTaskBuildOperationType, withPath(':', ':foo'), eager: false).children.empty
buildOperations.none(RealizeTaskBuildOperationType, not(withPath(':', ':foo')))
}
def "registration and realization ops have correct paths"() {
given:
def createTasks = {
buildFile << """
apply plugin: 'base'
subprojects {
apply plugin: 'base'
rootProject.tasks.named('build').configure {
it.dependsOn tasks.named('build')
}
}
"""
}
multiProjectBuild('root', ['sub'], createTasks)
includedBuild('buildSrc').multiProjectBuild('buildSrc', ['sub'], createTasks)
includedBuild('comp').multiProjectBuild('comp', ['sub'], createTasks).settingsFile
buildFile << """
tasks.named('build').configure { it.dependsOn gradle.includedBuild('comp').task(':build') }
"""
when:
run 'build'
then:
verifyTaskIds()
def expectedTasks = [
withPath(':buildSrc', ':sub:build'),
withPath(':buildSrc', ':build'),
withPath(':comp', ':sub:build'),
withPath(':comp', ':build'),
withPath(':', ':sub:build'),
withPath(':', ':build')
]
expectedTasks.each {
verifyTaskDetails(RegisterTaskBuildOperationType, it)
verifyTaskDetails(RealizeTaskBuildOperationType, it, eager: false)
}
}
private void stopBeforeTaskGraphCalculation() {
buildFile << """
gradle.projectsEvaluated {
throw new RuntimeException("stopping before task graph calculation")
}
"""
}
private void register(String name) {
buildFile << """
tasks.register("$name")
"""
}
private void create(String name) {
buildFile << """
tasks.create("$name")
"""
}
private void replace(String name) {
buildFile << """
tasks.replace("$name")
"""
}
private void verifyTaskIds() {
// all register ops have unique task id
def allRegisterOps = buildOperations.all(RegisterTaskBuildOperationType)
def allRegisterIds = allRegisterOps*.details*.taskId
allRegisterIds == allRegisterIds as Set
// all realize ops have unique task id
def allRealizeOps = buildOperations.all(RealizeTaskBuildOperationType)
def allRealizeIds = allRealizeOps*.details*.taskId
allRealizeIds == allRealizeIds as Set
// all non-eager realize ops should have corresponding register op
allRealizeOps.findAll { !it.details.eager }.each {
assert it.details.taskId in allRegisterIds
}
}
private static Spec withAnyPath(String buildPath, String... paths) {
return { (it.details.buildPath as String) == buildPath && (it.details.taskPath as String) in (paths as List) }
}
private static Spec withPath(String buildPath, String taskPath) {
return { (it.details.buildPath as String) == buildPath && (it.details.taskPath as String) == taskPath }
}
private static Spec not(Spec predicate) {
return { !predicate.isSatisfiedBy(it) }
}
private > BuildOperationRecord verifyTaskDetails(Map expectedDetails, Class type, Spec spec) {
def op = buildOperations.only(type, spec)
verifyTaskDetails(expectedDetails, op)
op
}
private > BuildOperationRecord verifyTaskDetails(Class type, Spec spec) {
def op = buildOperations.only(type, spec)
verifyTaskDetails([:], op)
op
}
static final Map DEFAULT_EXPECTED_DETAILS = [
replacement: false,
taskId: instanceOf(Number)
]
private static > BuildOperationRecord verifyTaskDetails(Map expectedDetails, BuildOperationRecord op) {
(DEFAULT_EXPECTED_DETAILS + expectedDetails).each { key, value ->
if (value instanceof Spec) {
assert value.isSatisfiedBy(op.details[key])
} else {
assert op.details[key] == value
}
}
op
}
private static Spec