Update generator plugin for adding execution to spring-boot-maven-plu…

…gin.
spring-cloud · Jun 10, 2024 · 9410a09 · 9410a09
1 parent 7fb4765
commit 9410a09
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 22 deletions.
diff --git a/...java/org/springframework/cloud/dataflow/app/plugin/SpringCloudStreamAppGeneratorMojo.java b/...java/org/springframework/cloud/dataflow/app/plugin/SpringCloudStreamAppGeneratorMojo.java
@@ -129,6 +129,9 @@ public void execute() throws MojoFailureException, MojoExecutionException {
 				this.global.getApplication().getFunctionDefinition() : this.application.getFunctionDefinition();
 		app.setFunctionDefinition(applicationFunctionDefinition); //TODO is applicationFunctionDefinition required?
 
+		app.setBootPluginConfiguration(this.application.getBootPluginConfiguration());
+		app.setBootExecution(this.application.getBootExecution());
+
 		String metadataMavenPluginVersion = StringUtils.isEmpty(this.application.getMetadata().getMavenPluginVersion()) ?
 				this.global.getApplication().getMetadata().getMavenPluginVersion() : this.application.getMetadata().getMavenPluginVersion();
 		if (StringUtils.isEmpty(metadataMavenPluginVersion)) {
@@ -306,8 +309,6 @@ else if (StringUtils.hasText(this.global.getApplication().getContainerImage().ge
 				})
 				.collect(Collectors.toList());
 
-		app.setBootPluginConfiguration(this.application.getBootPluginConfiguration());
-
 		// ----------------------------------------------------------------------------------------------------------
 		//                                 Project Generator
 		// ----------------------------------------------------------------------------------------------------------
@@ -465,6 +466,7 @@ public static class Application {
 		private final Maven maven = new Maven();
 
 		private String bootPluginConfiguration;
+		private String bootExecution;
 
 		public String getBootPluginConfiguration() {
 			return bootPluginConfiguration;
@@ -474,6 +476,15 @@ public void setBootPluginConfiguration(String bootPluginConfiguration) {
 			this.bootPluginConfiguration = bootPluginConfiguration;
 		}
 
+		public String getBootExecution() {
+			return bootExecution;
+		}
+
+		public void setBootExecution(String bootExecution) {
+			System.out.println(getClass() + ".bootExecution=" + bootExecution);
+			this.bootExecution = bootExecution;
+		}
+
 		public Map<String, String> getProperties() {
 			return properties;
 		}
@@ -631,7 +642,7 @@ public static class ContainerImage {
 			/**
 			 * Base images to be used by the target container image.
 			 */
-			private String baseImage;
+			private String baseImage = "${project.artifactId}";
 
 			/**
 			 * Enable or disable the inclusion of application's metadata into the image's labels.

diff --git a/.../src/main/java/org/springframework/cloud/dataflow/app/plugin/generator/AppDefinition.java b/.../src/main/java/org/springframework/cloud/dataflow/app/plugin/generator/AppDefinition.java
@@ -87,9 +87,18 @@ public class AppDefinition {
 	 * Application metadata related configurations to be applied for this App definition.
 	 */
 	private final Metadata metadata = new Metadata();
-
+	private String bootExecution;
 	private String bootPluginConfiguration;
 
+	public String getBootExecution() {
+		return bootExecution;
+	}
+
+	public void setBootExecution(String bootExecution) {
+		System.out.println(getClass() + ".bootExecution=" + bootExecution);
+		this.bootExecution = bootExecution;
+	}
+
 	public String getBootPluginConfiguration() {
 		return bootPluginConfiguration;
 	}

diff --git a/...lugin/spring-cloud-dataflow-apps-generator-plugin/src/main/resources/template/app-pom.xml b/...lugin/spring-cloud-dataflow-apps-generator-plugin/src/main/resources/template/app-pom.xml
@@ -138,16 +138,26 @@
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
+				{{#app.bootExecution}}
+				<executions>
+					<execution>
+					<!-- bootExecution -->
+					{{this}}
+					</execution>
+				</executions>
+				{{/app.bootExecution}}
 				<configuration>
-				<image>
-					<name>{{app.containerImage.orgName}}/${project.artifactId}:{{app.containerImage.tag}}</name>
-				</image>
 				{{#app.bootPluginConfiguration}}
-					{{this}}
+				<!-- bootPluginConfiguration -->
+				{{this}}
 				{{/app.bootPluginConfiguration}}
+				<image>
+					<name>{{app.containerImage.orgName}}/{{app.containerImage.baseImage}}:{{app.containerImage.tag}}</name>
+				</image>
 				</configuration>
 			</plugin>
 			{{#app.containerImage.enableMetadata}}
+			<!-- enableMetadata -->
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
 				<artifactId>properties-maven-plugin</artifactId>
@@ -176,15 +186,18 @@
 				<version>{{app.metadata.mavenPluginVersion}}</version>
 				<configuration>
 					{{#app.containerImage.enableMetadata}}
+					<!-- enableMetadata -->
 					<storeFilteredMetadata>true</storeFilteredMetadata>
 					<metadataFilter>
 						<names>
 							{{#app.metadataNameFilters}}
+							<!-- metadataNameFilters -->
 							<filter>{{this}}</filter>
 							{{/app.metadataNameFilters}}
 						</names>
 						<sourceTypes>
 							{{#app.metadata.sourceTypeFilters}}
+							<!-- sourceTypeFilters -->
 							<filter>{{this}}</filter>
 							{{/app.metadata.sourceTypeFilters}}
 						</sourceTypes>

diff --git a/...r-plugin/src/test/java/org/springframework/cloud/dataflow/app/plugin/MojoHarnessTest.java b/...r-plugin/src/test/java/org/springframework/cloud/dataflow/app/plugin/MojoHarnessTest.java
@@ -49,6 +49,18 @@ public class MojoHarnessTest {
 	@Rule
 	public MojoRule mojoRule = new MojoRule();
 
+	//	@Before
+//	public void before() {
+//		setMojoProperty("generatedProjectHome", projectHome.getRoot().getAbsolutePath());
+//	}
+//	private SpringCloudStreamAppGeneratorMojo springCloudStreamAppMojo = new SpringCloudStreamAppGeneratorMojo();
+//
+//	private Class<? extends SpringCloudStreamAppGeneratorMojo> mojoClazz = springCloudStreamAppMojo.getClass();
+//	private void setMojoProperty(String propertyName, Object value) throws NoSuchFieldException {
+//		Field mojoProperty = mojoClazz.getDeclaredField(propertyName);
+//		mojoProperty.setAccessible(true);
+//		ReflectionUtils.setField(mojoProperty, springCloudStreamAppMojo, value);
+//	}
 	@Test
 	public void testSomething() throws Exception {
 
@@ -106,8 +118,14 @@ public void testSomething() throws Exception {
 		assertThat(springBootPlugin.getConfiguration().toString()).containsPattern("\\<image\\>\\s*" +
 				"\\<name\\>.+/\\$\\{project.artifactId\\}:\\d+\\.\\d+\\.\\d+.*\\</name\\>\\s*" +
 				"\\</image\\>");
-		assertThat(pomModel.getRepositories().size()).isEqualTo(5);
 
+		List<String> executions = springBootPlugin.getExecutions().stream().map(pluginExecution -> pluginExecution.getId() + ":" + pluginExecution.getPhase() + ":" + pluginExecution.getGoals()).collect(Collectors.toList());
+		assertThat(executions).as("Exepcted executions").isNotEmpty();
+		assertThat(executions.toString()).contains("process-aot");
+
+		assertThat(springBootPlugin.getConfiguration().toString()).contains("requiresUnpack");
+
+		assertThat(pomModel.getRepositories().size()).isEqualTo(5);
 		assertThat(pomModel.getRepositories().stream().map(r -> r.getId()).collect(Collectors.toList()))
 				.contains("bintray-global", "bintray-application", "bintray-binder");
 	}

diff --git a/.../org/springframework/cloud/dataflow/app/plugin/SpringCloudStreamAppGeneratorMojoTest.java b/.../org/springframework/cloud/dataflow/app/plugin/SpringCloudStreamAppGeneratorMojoTest.java
@@ -85,7 +85,7 @@ public void before() throws NoSuchFieldException {
 
 		// BOM
 		application.setBootVersion("3.3.0");
-		application.getMetadata().setMavenPluginVersion("1.0.2.BUILD-SNAPSHOT");
+		application.getMetadata().setMavenPluginVersion("1.1.0-SNAPSHOT");
 
 		setMojoProperty("application", application);
 
@@ -142,23 +142,27 @@ public void testDefaultProjectCreationByPlugin() throws Exception {
 	}
 
 	@Test
-	public void testCustomBootMavenPluginConfiguration() throws Exception {
-		application.setBootPluginConfiguration("<![CDATA[\n" +
-				"                            <requiresUnpack>\n" +
-				"                                <dependency>\n" +
-				"                                    <groupId>org.python</groupId>\n" +
-				"                                    <artifactId>jython-standalone</artifactId>\n" +
-				"                                </dependency>\n" +
-				"                            </requiresUnpack>\n" +
-				"                            ]]>");
-
+	public void testCustomBootMavenExecutionsAndPluginConfiguration() throws Exception {
+		application.setBootPluginConfiguration("<requiresUnpack>" +
+				"<dependency>" +
+				"<groupId>org.python</groupId>" +
+				"<artifactId>jython-standalone</artifactId>" +
+				"</dependency>" +
+				"</requiresUnpack>");
+		application.setBootExecution("<id>process-aot</id>" +
+				"<goals>" +
+				"<goal>process-aot</goal>" +
+				"</goals>");
 		springCloudStreamAppMojo.execute();
 
 		Model pomModel = getModel(new File(projectHome.getRoot().getAbsolutePath()));
 		List<Plugin> plugins = pomModel.getBuild().getPlugins();
 		final Optional<Plugin> bootPlugin = plugins.stream().filter(p -> p.getArtifactId().equals("spring-boot-maven-plugin")).findFirst();
 		assertThat(bootPlugin.isPresent()).isTrue();
-
+		assertThat(bootPlugin.get().getConfiguration().toString()).contains("requiresUnpack");
+		assertThat(bootPlugin.get().getExecutions()).as("Expected executions").isNotEmpty();
+		assertThat(bootPlugin.get().getExecutions().get(0).getGoals()).as("Expected goals").isNotEmpty();
+		assertThat(bootPlugin.get().getExecutions().get(0).getGoals().get(0)).isEqualTo("process-aot");
 	}
 
 	private void assertGeneratedPomXml(File rootPath) {

diff --git a/...ing-cloud-dataflow-apps-generator-plugin/src/test/resources/unit/http-source-apps/pom.xml b/...ing-cloud-dataflow-apps-generator-plugin/src/test/resources/unit/http-source-apps/pom.xml
@@ -229,7 +229,24 @@
 						<version>${project.version}</version>
 						<configClass>io.pivotal.java.function.http.supplier.HttpSupplierConfiguration.class</configClass>
 						<groupId>org.springframework.cloud.stream.app.test</groupId>
-
+						<bootExecution><![CDATA[
+								<!-- http-source-apps -->
+								<id>process-aot</id>
+								<goals>
+									<goal>process-aot</goal>
+								</goals>
+								]]>
+						</bootExecution>
+						<bootPluginConfiguration><![CDATA[
+								<!-- http-source-apps -->
+								<requiresUnpack>
+									<dependency>
+										<groupId>org.python</groupId>
+										<artifactId>jython-standalone</artifactId>
+									</dependency>
+								</requiresUnpack>
+								]]>
+						</bootPluginConfiguration>
 						<properties>
 							<spring.main.web-application-type>reactive</spring.main.web-application-type>
 							<spring.cloud.streamapp.security.enabled>false</spring.cloud.streamapp.security.enabled>