/* * Copyright 2021 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.services import org.gradle.configurationcache.extensions.filterKeysByPrefix import org.gradle.configurationcache.extensions.getBroadcaster import org.gradle.configurationcache.extensions.uncheckedCast import org.gradle.initialization.Environment import org.gradle.internal.event.ListenerManager import org.gradle.internal.resource.local.FileResourceListener import org.gradle.internal.service.scopes.EventScope import org.gradle.internal.service.scopes.Scopes import org.gradle.util.internal.GUtil import java.io.File /** * Augments the [DefaultEnvironment] to track access to properties files, environment variables and system properties. **/ class ConfigurationCacheEnvironment( private val listenerManager: ListenerManager ) : DefaultEnvironment() { @EventScope(Scopes.Build::class) interface Listener { fun systemPropertiesPrefixedBy(prefix: String, snapshot: Map) fun envVariablesPrefixedBy(prefix: String, snapshot: Map) } private val fileResourceListener: FileResourceListener by lazy(listenerManager::getBroadcaster) private val listener: Listener by lazy(listenerManager::getBroadcaster) override fun propertiesFile(propertiesFile: File): Map? { fileResourceListener.fileObserved(propertiesFile) return super.propertiesFile(propertiesFile) } override fun getSystemProperties(): Environment.Properties = TrackingProperties(System.getProperties().uncheckedCast()) { prefix, snapshot -> listener.systemPropertiesPrefixedBy(prefix, snapshot) } override fun getVariables(): Environment.Properties = TrackingProperties(System.getenv()) { prefix, snapshot -> listener.envVariablesPrefixedBy(prefix, snapshot) } private class TrackingProperties( map: Map, val onByNamePrefix: (String, Map) -> Unit ) : DefaultProperties(map) { override fun byNamePrefix(prefix: String): Map = super.byNamePrefix(prefix).also { snapshot -> onByNamePrefix(prefix, snapshot) } } } /** * Gives direct access to system resources. */ open class DefaultEnvironment : Environment { override fun propertiesFile(propertiesFile: File): Map? = when { propertiesFile.isFile -> GUtil.loadProperties(propertiesFile).uncheckedCast() else -> null } override fun getSystemProperties(): Environment.Properties = DefaultProperties(System.getProperties().uncheckedCast()) override fun getVariables(): Environment.Properties = DefaultProperties(System.getenv()) internal open class DefaultProperties(val map: Map) : Environment.Properties { override fun byNamePrefix(prefix: String): Map = map.filterKeysByPrefix(prefix) } }