/* * 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.fingerprint import org.gradle.api.internal.file.FileCollectionInternal import org.gradle.api.internal.provider.ValueSourceProviderFactory import org.gradle.api.provider.ValueSourceParameters import org.gradle.internal.hash.HashCode import java.io.File internal sealed class ConfigurationCacheFingerprint { data class GradleEnvironment( val gradleUserHomeDir: File, val jvm: String, val startParameterProperties: Map ) : ConfigurationCacheFingerprint() data class InitScripts( val fingerprints: List ) : ConfigurationCacheFingerprint() data class WorkInputs( val workDisplayName: String, val fileSystemInputs: FileCollectionInternal, val fileSystemInputsFingerprint: HashCode ) : ConfigurationCacheFingerprint() data class InputFile( val file: File, val hash: HashCode? ) : ConfigurationCacheFingerprint() data class ValueSource( val obtainedValue: ObtainedValue ) : ConfigurationCacheFingerprint() data class UndeclaredSystemProperty( val key: String, val value: Any? ) : ConfigurationCacheFingerprint() data class UndeclaredEnvironmentVariable( val key: String, val value: Any? ) : ConfigurationCacheFingerprint() abstract class ChangingDependencyResolutionValue( val expireAt: Long ) : ConfigurationCacheFingerprint() { abstract val reason: String } class DynamicDependencyVersion( val displayName: String, expireAt: Long ) : ChangingDependencyResolutionValue(expireAt) { override val reason: String get() = "cached version information for $displayName has expired" } class ChangingModule( val displayName: String, expireAt: Long ) : ChangingDependencyResolutionValue(expireAt) { override val reason: String get() = "cached artifact information for $displayName has expired" } class SystemPropertiesPrefixedBy( val prefix: String, val snapshot: Map ) : ConfigurationCacheFingerprint() { companion object { /** * The placeholder for system properties modified by the build logic at the time of * reading. Such properties shouldn't be taken into account when comparing snapshots. */ val IGNORED: Any = Ignored.INSTANCE // Enum ensures that only one instance of INSTANCE exists and even deserialization // doesn't create a new one. The `object` has no such guarantee. private enum class Ignored { INSTANCE } } } class EnvironmentVariablesPrefixedBy( val prefix: String, val snapshot: Map ) : ConfigurationCacheFingerprint() } internal typealias ObtainedValue = ValueSourceProviderFactory.ValueListener.ObtainedValue