org.gradle.configurationcache.build.ConfigurationCacheIncludedBuildState.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.8 API redistribution.
There is a newer version: 8.6
/*
 * Copyright 2020 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.configurationcache.build

import org.gradle.StartParameter
import org.gradle.api.artifacts.component.BuildIdentifier
import org.gradle.api.internal.BuildDefinition
import org.gradle.api.internal.GradleInternal
import org.gradle.api.internal.SettingsInternal
import org.gradle.composite.internal.DefaultIncludedBuild
import org.gradle.configuration.ProjectsPreparer
import org.gradle.configurationcache.extensions.serviceOf
import org.gradle.initialization.BuildCompletionListener
import org.gradle.initialization.BuildOptionBuildOperationProgressEventsEmitter
import org.gradle.initialization.ConfigurationCache
import org.gradle.initialization.DefaultGradleLauncher
import org.gradle.initialization.DefaultGradleLauncherFactory
import org.gradle.initialization.GradleLauncher
import org.gradle.initialization.InternalBuildFinishedListener
import org.gradle.initialization.SettingsPreparer
import org.gradle.initialization.TaskExecutionPreparer
import org.gradle.initialization.exception.ExceptionAnalyser
import org.gradle.initialization.layout.BuildLayout
import org.gradle.initialization.layout.BuildLayoutFactory
import org.gradle.internal.build.BuildState
import org.gradle.internal.event.ListenerManager
import org.gradle.internal.service.scopes.BuildScopeServices
import org.gradle.internal.work.WorkerLeaseRegistry
import org.gradle.util.Path


open class ConfigurationCacheIncludedBuildState(
    buildIdentifier: BuildIdentifier,
    identityPath: Path,
    buildDefinition: BuildDefinition,
    isImplicit: Boolean,
    owner: BuildState,
    parentLease: WorkerLeaseRegistry.WorkerLease
) : DefaultIncludedBuild(buildIdentifier, identityPath, buildDefinition, isImplicit, owner, parentLease) {

    override fun createGradleLauncher(): GradleLauncher {
        return nestedBuildFactoryInternal().nestedInstance(
            buildDefinition,
            this,
            { parent ->
                // Avoid BuildLayout discovery
                object : BuildScopeServices(parent) {
                    override fun createBuildLayout(buildLayoutFactory: BuildLayoutFactory, startParameter: StartParameter) =
                        buildDefinition.buildRootDir.let { rootDir ->
                            BuildLayout(rootDir, rootDir, null)
                        }
                }
            },
            { gradle: GradleInternal, serviceRegistry: BuildScopeServices, servicesToStop: List<*> ->
                // Create a GradleLauncher with empty project, settings and task execution preparers
                val listenerManager = serviceRegistry.get(ListenerManager::class.java)
                val projectsPreparer = ProjectsPreparer {}
                val settingsPreparer = SettingsPreparer {}
                val taskExecutionPreparer = TaskExecutionPreparer {}
                DefaultGradleLauncher(
                    gradle,
                    projectsPreparer,
                    serviceRegistry.get(ExceptionAnalyser::class.java),
                    gradle.buildListenerBroadcaster,
                    listenerManager.getBroadcaster(BuildCompletionListener::class.java),
                    listenerManager.getBroadcaster(InternalBuildFinishedListener::class.java),
                    gradle.serviceOf(),
                    serviceRegistry,
                    servicesToStop,
                    gradle.serviceOf(),
                    settingsPreparer,
                    taskExecutionPreparer,
                    NullConfigurationCache,
                    BuildOptionBuildOperationProgressEventsEmitter(gradle.serviceOf())
                )
            }
        )
    }

    private
    fun nestedBuildFactoryInternal(): DefaultGradleLauncherFactory.NestedBuildFactoryInternal =
        owner.nestedBuildFactory as DefaultGradleLauncherFactory.NestedBuildFactoryInternal

    override fun loadSettings(): SettingsInternal =
        gradle.settings

    override fun getConfiguredBuild(): GradleInternal =
        gradle

    override fun addTasks(taskPaths: MutableIterable) =
        throw UnsupportedOperationException("Cannot add tasks ${taskPaths.toList()} to included build loaded from the cache.")

    override fun scheduleTasks(tasks: MutableIterable) =
        Unit
}


private
object NullConfigurationCache : ConfigurationCache {
    override fun canLoad(): Boolean = false
    override fun load() = throw UnsupportedOperationException()
    override fun prepareForConfiguration() = Unit
    override fun save() = Unit
}