org.gradle.caching.internal.services.BuildCacheControllerFactoryTest.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.6 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.caching.internal.services
import org.gradle.api.Action
import org.gradle.caching.BuildCacheEntryReader
import org.gradle.caching.BuildCacheEntryWriter
import org.gradle.caching.BuildCacheException
import org.gradle.caching.BuildCacheKey
import org.gradle.caching.BuildCacheService
import org.gradle.caching.BuildCacheServiceFactory
import org.gradle.caching.configuration.AbstractBuildCache
import org.gradle.caching.configuration.internal.DefaultBuildCacheConfiguration
import org.gradle.caching.configuration.internal.DefaultBuildCacheServiceRegistration
import org.gradle.caching.internal.FinalizeBuildCacheConfigurationBuildOperationType
import org.gradle.caching.internal.controller.BuildCacheController
import org.gradle.caching.internal.controller.DefaultBuildCacheController
import org.gradle.caching.internal.controller.NoOpBuildCacheController
import org.gradle.caching.local.DirectoryBuildCache
import org.gradle.caching.local.internal.LocalBuildCacheService
import org.gradle.internal.operations.TestBuildOperationExecutor
import org.gradle.util.Path
import org.gradle.util.TestUtil
import spock.lang.Specification
import static org.gradle.caching.internal.services.BuildCacheControllerFactory.BuildCacheMode.DISABLED
import static org.gradle.caching.internal.services.BuildCacheControllerFactory.BuildCacheMode.ENABLED
import static org.gradle.caching.internal.services.BuildCacheControllerFactory.RemoteAccessMode.ONLINE
class BuildCacheControllerFactoryTest extends Specification {
def buildCacheEnabled = true
def buildOperationExecuter = new TestBuildOperationExecutor()
def config = new DefaultBuildCacheConfiguration(TestUtil.instantiatorFactory().inject(), [
new DefaultBuildCacheServiceRegistration(DirectoryBuildCache, TestDirectoryBuildCacheServiceFactory),
new DefaultBuildCacheServiceRegistration(TestOtherRemoteBuildCache, TestOtherRemoteBuildCacheServiceFactory),
new DefaultBuildCacheServiceRegistration(TestRemoteBuildCache, TestRemoteBuildCacheServiceFactory),
])
boolean logStacktraces
boolean emitDebugLogging
private DefaultBuildCacheController createController() {
createController(DefaultBuildCacheController)
}
private T createController(Class controllerType) {
def controller = BuildCacheControllerFactory.create(
buildOperationExecuter,
Path.path("test"),
null,
config,
buildCacheEnabled ? ENABLED : DISABLED,
ONLINE,
logStacktraces,
emitDebugLogging,
TestUtil.instantiatorFactory().inject()
)
assert controllerType.isInstance(controller)
controllerType.cast(controller)
}
private FinalizeBuildCacheConfigurationBuildOperationType.Result buildOpResult() {
buildOperationExecuter.log.mostRecentResult(FinalizeBuildCacheConfigurationBuildOperationType)
}
def 'local cache service is created when remote is not configured'() {
when:
def c = createController()
then:
c.legacyLocal.service == null
c.remote.service == null
c.local.service != null
and:
with(buildOpResult()) {
local.type == "directory"
local.className == DirectoryBuildCache.name
remote == null
}
}
def 'local cache service is created when remote is disabled'() {
config.remote(TestRemoteBuildCache).enabled = false
when:
def c = createController()
then:
c.local.service != null
c.remote.service == null
with(buildOpResult()) {
local.type == "directory"
local.className == DirectoryBuildCache.name
remote == null
}
}
def 'remote cache service is created when local is disabled'() {
config.local.enabled = false
config.remote(TestRemoteBuildCache)
when:
def c = createController()
then:
c.legacyLocal.service == null
c.local.service == null
c.remote.service instanceof TestRemoteBuildCacheService
with(buildOpResult()) {
local == null
remote.type == "remote"
remote.className == TestRemoteBuildCache.name
}
}
def 'can enable both'() {
config.remote(TestRemoteBuildCache)
when:
def c = createController()
then:
c.legacyLocal.service == null
c.local.service != null
c.remote.service != null
with(buildOpResult()) {
local.type == "directory"
remote.type == "remote"
}
}
def "respects debug logging setting - #setting"() {
when:
emitDebugLogging = setting
config.remote(TestRemoteBuildCache)
def c = createController()
then:
c.emitDebugLogging == setting
where:
setting << [true, false]
}
def 'when caching is disabled no services are created'() {
buildCacheEnabled = false
expect:
createController(NoOpBuildCacheController)
with(buildOpResult()) {
local == null
remote == null
}
}
def "legacy local is used if local is not a local build cache service"() {
when:
config.local(TestOtherRemoteBuildCache)
def c = createController()
then:
c.legacyLocal.service instanceof TestRemoteBuildCacheService
c.local.service == null
c.remote.service == null
with(buildOpResult()) {
local.type == "other-remote"
remote == null
}
}
static class TestRemoteBuildCache extends AbstractBuildCache {
String value
}
static class TestRemoteBuildCacheServiceFactory implements BuildCacheServiceFactory {
@Override
BuildCacheService createBuildCacheService(TestRemoteBuildCache configuration, BuildCacheServiceFactory.Describer describer) {
def chain = describer.type("remote")
if (configuration.value != null) {
chain.config("value", configuration.value)
}
new TestRemoteBuildCacheService()
}
}
static class TestOtherRemoteBuildCache extends AbstractBuildCache {
String value
}
static class TestOtherRemoteBuildCacheServiceFactory implements BuildCacheServiceFactory {
@Override
BuildCacheService createBuildCacheService(TestOtherRemoteBuildCache configuration, BuildCacheServiceFactory.Describer describer) {
def chain = describer.type("other-remote")
if (configuration.value != null) {
chain.config("value", configuration.value)
}
new TestRemoteBuildCacheService()
}
}
static class TestRemoteBuildCacheService implements BuildCacheService {
@Override
boolean load(BuildCacheKey key, BuildCacheEntryReader reader) throws BuildCacheException {
return false
}
@Override
void store(BuildCacheKey key, BuildCacheEntryWriter writer) throws BuildCacheException {
}
@Override
void close() throws IOException {
}
}
static class TestDirectoryBuildCacheServiceFactory implements BuildCacheServiceFactory {
@Override
BuildCacheService createBuildCacheService(DirectoryBuildCache configuration, BuildCacheServiceFactory.Describer describer) {
def chain = describer.type("directory")
if (configuration.directory != null) {
chain.config("location", configuration.directory.toString())
}
new TestLocalBuildCacheService()
}
}
static class TestLocalBuildCacheService implements LocalBuildCacheService, BuildCacheService {
@Override
void storeLocally(BuildCacheKey key, File file) {
}
@Override
void loadLocally(BuildCacheKey key, Action reader) {
}
@Override
boolean load(BuildCacheKey key, BuildCacheEntryReader reader) throws BuildCacheException {
return false
}
@Override
void store(BuildCacheKey key, BuildCacheEntryWriter writer) throws BuildCacheException {
}
@Override
void close() {
}
@Override
void withTempFile(BuildCacheKey key, Action action) {
}
}
}