Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add recipe to enable Develocity build cache for Gradle #4859

Merged
merged 15 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* 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
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.openrewrite.gradle;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;

@Value
@EqualsAndHashCode(callSuper = false)
public class EnableDevelocityBuildCache extends Recipe {
shanman190 marked this conversation as resolved.
Show resolved Hide resolved

@Override
public String getDisplayName() {
return "Enable Develocity build cache";
}

@Override
public String getDescription() {
return "Add Develocity build cache configuration Develocity configuration given it lacks an existing configuration.";
}

@Option(displayName = "Enable local build cache",
description = "Value for `//develocity/buildCache/local/enabled`.",
example = "true",
required = false)
@Nullable
String localEnabled;

@Option(displayName = "Enable remote build cache",
description = "Value for `//develocity/buildCache/remote/enabled`.",
example = "true",
required = false)
@Nullable
String remoteEnabled;

@Option(displayName = "Enable remote build cache store",
description = "Value for `//develocity/buildCache/remote/storeEnabled`.",
example = "true",
required = false)
@Nullable
String remoteStoreEnabled;

@Override
public Validated<Object> validate(ExecutionContext ctx) {
return super.validate(ctx)
.and(Validated.notBlank("localEnabled", localEnabled)
.or(Validated.notBlank("remoteEnabled", remoteEnabled))
.or(Validated.notBlank("remoteStoreEnabled", remoteStoreEnabled)));
}


@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return super.getVisitor();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* 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
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.openrewrite.gradle;

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.gradle.Assertions.settingsGradle;

class EnableDevelocityBuildCacheTest implements RewriteTest {

@Test
@DocumentExample
void addBuildCacheRemoteConfig() {
rewriteRun(spec -> spec.recipe(new EnableDevelocityBuildCache("true", "true", "System.getenv(\"CI\") != null")),
settingsGradle(
"""
plugins {
id 'com.gradle.develocity' version '3.17.6'
}
develocity {
server = 'https://dev.example.com/'
}
""",
"""
plugins {
id 'com.gradle.develocity' version '3.17.6'
}
develocity {
server = 'https://dev.example.com/'
buildCache {
remote(develocity.buildCache) {
enabled = true
push = System.getenv("CI") != null
}
}
}
"""
)
);
}

@Test
void addBuildCacheLocalConfig() {
shanman190 marked this conversation as resolved.
Show resolved Hide resolved
rewriteRun(spec -> spec.recipe(new EnableDevelocityBuildCache("true", null, null)),
settingsGradle(
"""
plugins {
id 'com.gradle.develocity' version '3.17.6'
}
develocity {
server = 'https://dev.example.com/'
}
""",
"""
plugins {
id 'com.gradle.develocity' version '3.17.6'
}
develocity {
server = 'https://dev.example.com/'
buildCache {
local(develocity.buildCache) {
enabled = true
}
}
}
"""
)
);
}

@Test
@DocumentExample
void shouldNotModifyBuildCacheConfig() {
rewriteRun(spec -> spec.recipe(new EnableDevelocityBuildCache("true", "true", "#{isTrue(env['CI'])}")),
settingsGradle(
"""
plugins {
id 'com.gradle.develocity' version '3.17.6'
}
develocity {
server = 'https://dev.example.com/'
buildCache {
remote(develocity.buildCache) {
enabled = false
push = false
}
}
}
"""
)
);
}
}
Loading