Merge pull request #124 from fabiobrz/separate-eap8-wildfly-helm-charts

[issue 123] - Implement WildFly/EAP 8 Helm Charts provisioning differentiation
Intersmash · Jan 10, 2024 · ef18d96 · ef18d96
2 parents b4e433b + 690c905
commit ef18d96
Show file tree

Hide file tree

Showing 18 changed files with 2,665 additions and 110 deletions.
diff --git a/...tsuite/provision/openshift/WildflyHelmChartExistingValuesOpenShiftExampleApplication.java b/...tsuite/provision/openshift/WildflyHelmChartExistingValuesOpenShiftExampleApplication.java
@@ -15,22 +15,21 @@
  */
 package org.jboss.intersmash.testsuite.provision.openshift;
 
-import java.net.URL;
-import java.nio.file.Path;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import org.jboss.intersmash.deployments.WildflyDeploymentApplicationConfiguration;
+import org.jboss.intersmash.model.helm.charts.values.eap8.HelmEap8Release;
 import org.jboss.intersmash.model.helm.charts.values.wildfly.HelmWildflyRelease;
+import org.jboss.intersmash.testsuite.IntersmashTestsuiteProperties;
 import org.jboss.intersmash.tools.IntersmashConfig;
 import org.jboss.intersmash.tools.application.openshift.helm.HelmChartRelease;
 import org.jboss.intersmash.tools.application.openshift.helm.WildflyHelmChartOpenShiftApplication;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
+import org.jboss.intersmash.tools.provision.helm.HelmChartReleaseAdapter;
+import org.jboss.intersmash.tools.provision.helm.wildfly.WildFlyHelmChartReleaseAdapter;
+import org.jboss.intersmash.tools.provision.helm.wildfly.eap8.Eap8HelmChartReleaseAdapter;
 
 import io.fabric8.kubernetes.api.model.Secret;
 
@@ -42,7 +41,7 @@ public class WildflyHelmChartExistingValuesOpenShiftExampleApplication
 	private final Map<String, String> setOverrides = new HashMap<>();
 
 	public WildflyHelmChartExistingValuesOpenShiftExampleApplication() {
-		this.release = new HelmChartRelease(loadRelease());
+		this.release = loadRelease();
 	}
 
 	WildflyHelmChartExistingValuesOpenShiftExampleApplication addSetOverride(String name, String value) {
@@ -55,20 +54,21 @@ public Map<String, String> getSetOverrides() {
 		return setOverrides;
 	}
 
-	private HelmWildflyRelease loadRelease() {
-		URL url = this.getClass().getResource("wildfly-helm-values.yaml");
-		if (url == null) {
-			throw new IllegalStateException("No wildfly-helm-values.yaml found");
-		}
-		try {
-			Path valuePath = Path.of(url.toURI());
-			ObjectMapper mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
-			return mapper.readValue(valuePath.toFile(), HelmWildflyRelease.class);
-		} catch (Error | RuntimeException e) {
-			throw e;
-		} catch (Exception e) {
-			throw new RuntimeException(e);
-		}
+	private HelmChartRelease loadRelease() {
+		if (IntersmashTestsuiteProperties.isCommunityTestExecutionProfileEnabled()) {
+			HelmWildflyRelease helmRelease = HelmChartReleaseAdapter.<HelmWildflyRelease> fromValuesFile(
+					this.getClass().getResource("wildfly-helm-values.yaml"), HelmWildflyRelease.class);
+			return new WildFlyHelmChartReleaseAdapter(helmRelease)
+					.withJdk17BuilderImage(IntersmashConfig.wildflyImageURL())
+					.withJdk17RuntimeImage(IntersmashConfig.wildflyRuntimeImageURL());
+		} else if (IntersmashTestsuiteProperties.isProductizedTestExecutionProfileEnabled()) {
+			HelmEap8Release helmRelease = HelmChartReleaseAdapter.<HelmEap8Release> fromValuesFile(
+					this.getClass().getResource("eap8-helm-values.yaml"), HelmEap8Release.class);
+			return new Eap8HelmChartReleaseAdapter(helmRelease)
+					.withJdk17BuilderImage(IntersmashConfig.wildflyImageURL())
+					.withJdk17RuntimeImage(IntersmashConfig.wildflyRuntimeImageURL());
+		} else
+			throw new IllegalStateException("Not a valid testing profile!");
 	}
 
 	@Override

diff --git a/...tersmash/testsuite/provision/openshift/WildflyHelmChartExistingValuesProvisionerTest.java b/...tersmash/testsuite/provision/openshift/WildflyHelmChartExistingValuesProvisionerTest.java
@@ -17,7 +17,7 @@
 
 import org.jboss.intersmash.tools.IntersmashConfig;
 import org.jboss.intersmash.tools.provision.helm.HelmChartOpenShiftProvisioner;
-import org.jboss.intersmash.tools.provision.helm.WildflyHelmChartOpenShiftProvisioner;
+import org.jboss.intersmash.tools.provision.helm.wildfly.WildflyHelmChartOpenShiftProvisioner;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -37,9 +37,7 @@ public void basicProvisioningTest() {
 		final WildflyHelmChartExistingValuesOpenShiftExampleApplication application = new WildflyHelmChartExistingValuesOpenShiftExampleApplication();
 		application
 				.addSetOverride("build.uri", IntersmashConfig.deploymentsRepositoryUrl())
-				.addSetOverride("build.ref", IntersmashConfig.deploymentsRepositoryRef())
-				.addSetOverride("deploy.builderImage", application.getBuilderImage())
-				.addSetOverride("deployRuntimeImage", application.getRuntimeImage());
+				.addSetOverride("build.ref", IntersmashConfig.deploymentsRepositoryRef());
 
 		// and now get an EAP 8/WildFly provisioner for that application
 		final WildflyHelmChartOpenShiftProvisioner provisioner = new WildflyHelmChartOpenShiftProvisioner(application);

diff --git a/...intersmash/testsuite/provision/openshift/WildflyHelmChartOpenShiftExampleApplication.java b/...intersmash/testsuite/provision/openshift/WildflyHelmChartOpenShiftExampleApplication.java
@@ -15,22 +15,23 @@
  */
 package org.jboss.intersmash.testsuite.provision.openshift;
 
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import org.assertj.core.util.Strings;
 import org.jboss.intersmash.deployments.IntersmashSharedDeploymentsProperties;
 import org.jboss.intersmash.deployments.WildflyDeploymentApplicationConfiguration;
-import org.jboss.intersmash.model.helm.charts.values.wildfly.Build;
-import org.jboss.intersmash.model.helm.charts.values.wildfly.Deploy;
-import org.jboss.intersmash.model.helm.charts.values.wildfly.Env;
+import org.jboss.intersmash.model.helm.charts.values.eap8.HelmEap8Release;
 import org.jboss.intersmash.model.helm.charts.values.wildfly.HelmWildflyRelease;
-import org.jboss.intersmash.model.helm.charts.values.wildfly.S2i;
+import org.jboss.intersmash.testsuite.IntersmashTestsuiteProperties;
 import org.jboss.intersmash.tools.IntersmashConfig;
 import org.jboss.intersmash.tools.application.openshift.helm.HelmChartRelease;
 import org.jboss.intersmash.tools.application.openshift.helm.WildflyHelmChartOpenShiftApplication;
+import org.jboss.intersmash.tools.provision.helm.wildfly.WildFlyHelmChartReleaseAdapter;
+import org.jboss.intersmash.tools.provision.helm.wildfly.WildflyHelmChartRelease;
+import org.jboss.intersmash.tools.provision.helm.wildfly.eap8.Eap8HelmChartReleaseAdapter;
 
 import io.fabric8.kubernetes.api.model.Secret;
 
@@ -41,11 +42,15 @@ public class WildflyHelmChartOpenShiftExampleApplication
 	private final HelmChartRelease release;
 
 	public WildflyHelmChartOpenShiftExampleApplication() {
-		this.release = new HelmChartRelease(loadRelease());
+		if (IntersmashTestsuiteProperties.isCommunityTestExecutionProfileEnabled()) {
+			release = loadRelease(new WildFlyHelmChartReleaseAdapter(new HelmWildflyRelease()));
+		} else if (IntersmashTestsuiteProperties.isProductizedTestExecutionProfileEnabled()) {
+			release = loadRelease(new Eap8HelmChartReleaseAdapter(new HelmEap8Release()));
+		} else
+			throw new IllegalStateException("Not a valid testing profile!");
 	}
 
-	private HelmWildflyRelease loadRelease() {
-		HelmWildflyRelease release = new HelmWildflyRelease();
+	private HelmChartRelease loadRelease(final WildflyHelmChartRelease release) {
 		// let's compute some additional maven args for our s2i build to happen on a Pod
 		String mavenAdditionalArgs = "-Denforcer.skip=true";
 		// let's add configurable deployment additional args:
@@ -55,24 +60,21 @@ private HelmWildflyRelease loadRelease() {
 				(Strings.isNullOrEmpty(IntersmashSharedDeploymentsProperties.getWildflyDeploymentsBuildProfile()) ? ""
 						: " -Pwildfly-deployments-build."
 								+ IntersmashSharedDeploymentsProperties.getWildflyDeploymentsBuildProfile()));
-		// ok, let's configure the release via the fluent(-ish) API
-		List<Env> environmentVariables = new ArrayList();
+		// ok, let's configure the release via the WildflyHelmChartRelease fluent(-ish) API,
+		// which offers a common reference for both WildFly and EAP (latest)
 		release
-				.withBuild(
-						new Build()
-								.withUri(IntersmashConfig.deploymentsRepositoryUrl())
-								.withRef(IntersmashConfig.deploymentsRepositoryRef())
-								.withContextDir("deployments/openshift-jakarta-sample-standalone")
-								.withEnv(
-										Arrays.asList(
-												new Env()
-														.withName("MAVEN_ARGS_APPEND")
-														.withValue(mavenAdditionalArgs)))
-								.withS2i(
-										new S2i()
-												.withBuilderImage(IntersmashConfig.wildflyImageURL())
-												.withRuntimeImage(IntersmashConfig.wildflyRuntimeImageURL())))
-				.withDeploy(new Deploy().withReplicas(1));
+				.withSourceRepositoryUrl(IntersmashConfig.deploymentsRepositoryUrl())
+				.withSourceRepositoryRef(IntersmashConfig.deploymentsRepositoryRef())
+				.withContextDir("deployments/openshift-jakarta-sample-standalone")
+				.withJdk17BuilderImage(IntersmashConfig.wildflyImageURL())
+				.withJdk17RuntimeImage(IntersmashConfig.wildflyRuntimeImageURL())
+				.withBuildEnvironmentVariable("MAVEN_ARGS_APPEND", mavenAdditionalArgs);
+		List<String> channelDefinition = Arrays.asList(this.eeChannelGroupId(), this.eeChannelArtifactId(),
+				this.eeChannelVersion());
+		if (!channelDefinition.isEmpty()) {
+			// an example of EAP channel usage, not working with EAP 7.4.x or WildFly
+			release.withS2iChannel(channelDefinition.stream().collect(Collectors.joining(":")));
+		}
 		return release;
 	}
 

diff --git a/...a/org/jboss/intersmash/testsuite/provision/openshift/WildflyHelmChartProvisionerTest.java b/...a/org/jboss/intersmash/testsuite/provision/openshift/WildflyHelmChartProvisionerTest.java
@@ -17,7 +17,7 @@
 
 import org.jboss.intersmash.tools.application.openshift.helm.WildflyHelmChartOpenShiftApplication;
 import org.jboss.intersmash.tools.provision.helm.HelmChartOpenShiftProvisioner;
-import org.jboss.intersmash.tools.provision.helm.WildflyHelmChartOpenShiftProvisioner;
+import org.jboss.intersmash.tools.provision.helm.wildfly.WildflyHelmChartOpenShiftProvisioner;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 

diff --git a/...c/test/resources/org/jboss/intersmash/testsuite/provision/openshift/eap8-helm-values.yaml b/...c/test/resources/org/jboss/intersmash/testsuite/provision/openshift/eap8-helm-values.yaml
@@ -0,0 +1,22 @@
+build:
+  enabled: true
+  mode: "s2i"
+  # uri and ref will be specified via Helm --set arguments
+  contextDir: "deployments/openshift-jakarta-sample-standalone"
+  env:
+    - name: "MAVEN_ARGS_APPEND"
+      value: "-Denforcer.skip=true -Pwildfly-deployments-build.eap"
+  s2i:
+    kind: "DockerImage"
+    buildApplicationImage: true
+    # builderImage and runtimeImage will be specified via Helm --set arguments
+deploy:
+  enabled: true
+  replicas: 1
+  env: []
+  envFrom: []
+  volumeMounts: []
+  volumes: []
+  initContainers: []
+  extraContainers: []
+  'imagePullSecrets:': []
diff --git a/tools/intersmash-tools-provisioners/pom.xml b/tools/intersmash-tools-provisioners/pom.xml
@@ -204,7 +204,7 @@
                     <source>src/main/resources/crds</source>
                     <!--
                         This is needed to force the Java generator from CRD to stick with the original names
-                        for enums, and avoi to uppercase them, since this could generate duplicate names,
+                        for enums, and avoid to uppercase them, since this could generate duplicate names,
                         as in https://github.com/infinispan/infinispan-operator/blob/2.3.4.Final/config/crd/bases/infinispan.org_infinispans.yaml#L1473-L1477
                      -->
                     <enumUppercase>false</enumUppercase>
@@ -228,11 +228,24 @@
                             <goal>generate</goal>
                         </goals>
                         <configuration>
+                            <!-- WildFly Helm Chart model is generated from JSON schema at https://github.com/wildfly/wildfly-charts/blob/wildfly-2.3.2/charts/wildfly/values.schema.json -->
                             <sourceDirectory>${basedir}/src/main/resources/org/jboss/intersmash/tools/provision/helm/values/schema/wildfly</sourceDirectory>
                             <outputDirectory>${project.build.directory}/generated-sources/</outputDirectory>
                             <targetPackage>org.jboss.intersmash.model.helm.charts.values.wildfly</targetPackage>
                         </configuration>
                     </execution>
+                    <execution>
+                        <id>charts.values.generate-schema-model.eap8</id>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                        <configuration>
+                            <!-- JBoss EAP 8 Helm Chart model is generated from JSON schema at https://github.com/jbossas/eap-charts/blob/eap8-1.1.1/charts/eap8/values.schema.json -->
+                            <sourceDirectory>${basedir}/src/main/resources/org/jboss/intersmash/tools/provision/helm/values/schema/eap8</sourceDirectory>
+                            <outputDirectory>${project.build.directory}/generated-sources/</outputDirectory>
+                            <targetPackage>org.jboss.intersmash.model.helm.charts.values.eap8</targetPackage>
+                        </configuration>
+                    </execution>
                 </executions>
             </plugin>
         </plugins>

diff --git a/...src/main/java/org/jboss/intersmash/tools/application/openshift/helm/HelmChartRelease.java b/...src/main/java/org/jboss/intersmash/tools/application/openshift/helm/HelmChartRelease.java
@@ -15,40 +15,20 @@
  */
 package org.jboss.intersmash.tools.application.openshift.helm;
 
-import java.io.IOException;
-import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.ArrayList;
 import java.util.List;
-import java.util.stream.Collectors;
 
-import org.jboss.intersmash.model.helm.charts.values.wildfly.HelmWildflyRelease;
 import org.jboss.intersmash.tools.provision.helm.HelmChartOpenShiftProvisioner;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
-
 /**
  * Defines the contract for implementing classes to represent a Helm Charts release, as seen by the provisioning
  * tooling.
  */
-public class HelmChartRelease implements SerializableHelmChartRelease {
-
-	private final HelmWildflyRelease wildflyRelease;
-	private final List<Path> additionalValuesFiles = new ArrayList<>();
-
-	public HelmChartRelease(HelmWildflyRelease wildflyRelease) {
-		this(wildflyRelease, null);
-	}
-
-	public HelmChartRelease(HelmWildflyRelease wildflyRelease, List<Path> additionalValuesFiles) {
-		this.wildflyRelease = wildflyRelease;
-		if (additionalValuesFiles != null) {
-			this.additionalValuesFiles.addAll(additionalValuesFiles.stream().collect(Collectors.toList()));
-		}
-	}
+/**
+ * Defines the contract for implementing classes to represent a Helm Charts release, as seen by the provisioning
+ * tooling.
+ */
+public interface HelmChartRelease extends SerializableHelmChartRelease {
 
 	/**
 	 * Read the number of replicas that the release should generate
@@ -57,9 +37,7 @@ public HelmChartRelease(HelmWildflyRelease wildflyRelease, List<Path> additional
 	 *
 	 * @return {@link Integer} representing the number of replicas that the release should generate
 	 */
-	public Integer getReplicas() {
-		return wildflyRelease.getDeploy().getReplicas();
-	}
+	Integer getReplicas();
 
 	/**
 	 * Set the number of replicas that should be generated by the release
@@ -68,9 +46,7 @@ public Integer getReplicas() {
 	 *
 	 * @param replicas Number of replicas that should be generated by the release
 	 */
-	public void setReplicas(Integer replicas) {
-		this.wildflyRelease.getDeploy().setReplicas(replicas);
-	}
+	void setReplicas(Integer replicas);
 
 	/**
 	 * Access the additional values files collection
@@ -79,27 +55,5 @@ public void setReplicas(Integer replicas) {
 	 * @return List of {@link Path} instances representing the location of additional values files that make the
 	 * release
 	 */
-	public List<Path> getAdditionalValuesFiles() {
-		return this.additionalValuesFiles;
-	}
-
-	@Override
-	public Path toValuesFile() {
-		// Handle the values file creation
-		Path temp;
-		try {
-			temp = Files.createTempFile("values", ".yaml");
-		} catch (IOException e) {
-			throw new IllegalStateException("Temporary Helm Chart values file creation failed.", e);
-		}
-		ObjectMapper mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
-		mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
-		try {
-			mapper.writeValue(temp.toFile(), wildflyRelease);
-		} catch (IOException e) {
-			throw new IllegalStateException("Helm Chart values serialization failed.", e);
-		}
-		return temp;
-	}
-
+	List<Path> getAdditionalValuesFiles();
 }
diff --git a/...rc/main/java/org/jboss/intersmash/tools/provision/helm/HelmChartOpenShiftProvisioner.java b/...rc/main/java/org/jboss/intersmash/tools/provision/helm/HelmChartOpenShiftProvisioner.java
@@ -100,7 +100,7 @@ public void deploy() {
 	@Override
 	public void undeploy() {
 		helmBinary.execute(getHelmChartUninstallArguments(this.getApplication().getName()));
-		OpenShiftWaiters.get(openShift, ffCheck).areExactlyNPodsReady(0, "app.kubernetes.io/instance", application.getName())
+		OpenShiftWaiters.get(openShift, ffCheck).areNoPodsPresent("app.kubernetes.io/instance", application.getName())
 				.level(Level.DEBUG)
 				.waitFor();
 	}