Skip to content

Commit 330f0f0

Browse files
Add initScripts and projectProperties to IncludeCheckRemotePlugin
Issue gh-10344
1 parent e45dcb3 commit 330f0f0

File tree

3 files changed

+61
-5
lines changed

3 files changed

+61
-5
lines changed

build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,10 @@ tasks.register('checkSamples') {
154154
includeCheckRemote {
155155
repository = 'spring-projects/spring-security-samples'
156156
ref = samplesBranch
157+
if (project.hasProperty("samplesInitScript")) {
158+
initScripts = [samplesInitScript]
159+
projectProperties = ["localRepositoryPath": localRepositoryPath, "springSecurityVersion": project.version]
160+
}
157161
}
158162
dependsOn checkRemote
159163
}

buildSrc/src/main/groovy/io/spring/gradle/convention/IncludeCheckRemotePlugin.groovy

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2021 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
55
* use this file except in compliance with the License. You may obtain a copy of
@@ -19,7 +19,6 @@ package io.spring.gradle.convention
1919
import io.spring.gradle.IncludeRepoTask
2020
import org.gradle.api.Plugin
2121
import org.gradle.api.Project
22-
import org.gradle.api.provider.Property
2322
import org.gradle.api.tasks.GradleBuild
2423
import org.gradle.api.tasks.TaskProvider
2524

@@ -40,6 +39,12 @@ class IncludeCheckRemotePlugin implements Plugin<Project> {
4039
it.dependsOn 'includeRepo'
4140
it.dir = includeRepoTask.get().outputDirectory
4241
it.tasks = extension.getTasks()
42+
extension.getInitScripts().forEach {script ->
43+
it.startParameter.addInitScript(new File(script))
44+
}
45+
extension.getProjectProperties().entrySet().forEach { entry ->
46+
it.startParameter.projectProperties.put(entry.getKey(), entry.getValue())
47+
}
4348
}
4449
}
4550

@@ -60,6 +65,16 @@ class IncludeCheckRemotePlugin implements Plugin<Project> {
6065
*/
6166
List<String> tasks = ['check']
6267

68+
/**
69+
* Init scripts for the build
70+
*/
71+
List<String> initScripts = []
72+
73+
/**
74+
* Map of properties for the build
75+
*/
76+
Map<String, String> projectProperties = [:]
77+
6378
}
6479

6580
}

buildSrc/src/test/java/io/spring/gradle/convention/IncludeCheckRemotePluginTest.java

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2021 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
55
* use this file except in compliance with the License. You may obtain a copy of
@@ -16,6 +16,11 @@
1616

1717
package io.spring.gradle.convention;
1818

19+
import java.io.File;
20+
import java.util.Arrays;
21+
import java.util.HashMap;
22+
import java.util.Map;
23+
1924
import io.spring.gradle.IncludeRepoTask;
2025
import org.apache.commons.io.FileUtils;
2126
import org.gradle.api.Project;
@@ -24,8 +29,6 @@
2429
import org.junit.jupiter.api.AfterEach;
2530
import org.junit.jupiter.api.Test;
2631

27-
import java.util.Arrays;
28-
2932
import static org.assertj.core.api.Assertions.assertThat;
3033

3134
class IncludeCheckRemotePluginTest {
@@ -68,6 +71,40 @@ void applyWhenExtensionPropertiesTasksThenCreateCheckRemoteWithProvidedTasks() {
6871
assertThat(checkRemote.getTasks()).containsExactly("clean", "build", "test");
6972
}
7073

74+
@Test
75+
void applyWhenExtensionPropertiesInitScriptsThenCreateCheckRemoteWithProvidedTasks() {
76+
this.rootProject = ProjectBuilder.builder().build();
77+
this.rootProject.getPluginManager().apply(IncludeCheckRemotePlugin.class);
78+
this.rootProject.getExtensions().configure(IncludeCheckRemotePlugin.IncludeCheckRemoteExtension.class,
79+
(includeCheckRemoteExtension) -> {
80+
includeCheckRemoteExtension.setProperty("repository", "my-project/my-repository");
81+
includeCheckRemoteExtension.setProperty("ref", "main");
82+
includeCheckRemoteExtension.setProperty("initScripts", Arrays.asList("spring-security-ci.gradle"));
83+
});
84+
85+
GradleBuild checkRemote = (GradleBuild) this.rootProject.getTasks().named("checkRemote").get();
86+
assertThat(checkRemote.getStartParameter().getAllInitScripts()).extracting(File::getName).containsExactly("spring-security-ci.gradle");
87+
}
88+
89+
@Test
90+
void applyWhenExtensionPropertiesBuildPropertiesThenCreateCheckRemoteWithProvidedTasks() {
91+
Map<String, String> projectProperties = new HashMap<>();
92+
projectProperties.put("localRepositoryPath", "~/local/repository");
93+
projectProperties.put("anotherProperty", "some_value");
94+
this.rootProject = ProjectBuilder.builder().build();
95+
this.rootProject.getPluginManager().apply(IncludeCheckRemotePlugin.class);
96+
this.rootProject.getExtensions().configure(IncludeCheckRemotePlugin.IncludeCheckRemoteExtension.class,
97+
(includeCheckRemoteExtension) -> {
98+
includeCheckRemoteExtension.setProperty("repository", "my-project/my-repository");
99+
includeCheckRemoteExtension.setProperty("ref", "main");
100+
includeCheckRemoteExtension.setProperty("projectProperties", projectProperties);
101+
});
102+
103+
GradleBuild checkRemote = (GradleBuild) this.rootProject.getTasks().named("checkRemote").get();
104+
assertThat(checkRemote.getStartParameter().getProjectProperties()).containsEntry("localRepositoryPath", "~/local/repository")
105+
.containsEntry("anotherProperty", "some_value");
106+
}
107+
71108
@Test
72109
void applyWhenExtensionPropertiesThenRegisterIncludeRepoTaskWithExtensionProperties() {
73110
this.rootProject = ProjectBuilder.builder().build();

0 commit comments

Comments
 (0)