Ported PR fabric8io/fabric8-maven-plugin#1711

+ Add a generator for Open Liberty that extends the java-exec generator. It defaults webPort to the Liberty default port (9080) and adds an environment variable for use by S2I if it detects a Liberty runnable jar. + Add Liberty's default web ports (9080, 9443) to the ExposeEnricher so that routes get generated.
rohanKanojia · Mar 2, 2020 · c5cb636 · c5cb636
1 parent 24b3e7e
commit c5cb636
Show file tree

Hide file tree

Showing 13 changed files with 276 additions and 3 deletions.
diff --git a/...er/generic/src/main/java/org/eclipse/jkube/enricher/generic/openshift/ExposeEnricher.java b/...er/generic/src/main/java/org/eclipse/jkube/enricher/generic/openshift/ExposeEnricher.java
@@ -39,7 +39,7 @@ public ExposeEnricher(JKubeEnricherContext buildContext) {
         super(buildContext, "jkube-openshift-service-expose");
     }
 
-    private Set<Integer> webPorts = new HashSet<>(Arrays.asList(80, 443, 8080, 9090));
+    private Set<Integer> webPorts = new HashSet<>(Arrays.asList(80, 443, 8080, 9080, 9090, 9443));
 
     public static final String EXPOSE_LABEL = "expose";
 

diff --git a/jkube-kit/jkube-kit-openliberty/pom.xml b/jkube-kit/jkube-kit-openliberty/pom.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2019 Red Hat, Inc.
+    This program and the accompanying materials are made
+    available under the terms of the Eclipse Public License 2.0
+    which is available at:
+
+        https://www.eclipse.org/legal/epl-2.0/
+
+    SPDX-License-Identifier: EPL-2.0
+
+    Contributors:
+      Red Hat, Inc. - initial API and implementation
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>jkube-kit-parent</artifactId>
+        <groupId>org.eclipse.jkube</groupId>
+        <version>0.1.1-SNAPSHOT</version>
+        <relativePath>../parent/pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>jkube-kit-openliberty</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-maven-enricher-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-maven-enricher-specific</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-maven-generator-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-maven-generator-java-exec</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-kit-common</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-kit-config-image</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jmockit</groupId>
+            <artifactId>jmockit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/...enliberty/src/main/java/org/eclipse/jkube/openliberty/generator/OpenLibertyGenerator.java b/...enliberty/src/main/java/org/eclipse/jkube/openliberty/generator/OpenLibertyGenerator.java
@@ -0,0 +1,141 @@
+/**
+ * Copyright (c) 2019 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at:
+ *
+ *     https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.jkube.openliberty.generator;
+
+
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.assembly.model.Assembly;
+import org.apache.maven.plugins.assembly.model.DependencySet;
+import org.apache.maven.plugins.assembly.model.FileSet;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.jkube.generator.api.GeneratorContext;
+import org.eclipse.jkube.generator.javaexec.FatJarDetector;
+import org.eclipse.jkube.generator.javaexec.JavaExecGenerator;
+import org.eclipse.jkube.kit.build.service.docker.ImageConfiguration;
+import org.eclipse.jkube.kit.common.util.MavenUtil;
+import org.eclipse.jkube.kit.config.image.build.AssemblyConfiguration;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import static org.eclipse.jkube.kit.common.util.FileUtil.getRelativePath;
+
+public class OpenLibertyGenerator extends JavaExecGenerator {
+
+	protected static final String LIBERTY_SELF_EXTRACTOR = "wlp.lib.extract.SelfExtractRun";
+	protected static final String LIBERTY_RUNNABLE_JAR = "LIBERTY_RUNNABLE_JAR";
+	protected static final String JAVA_APP_JAR = "JAVA_APP_JAR";
+
+	private String runnableJarName = null;
+
+	public OpenLibertyGenerator(GeneratorContext context) {
+        super(context, "openliberty");
+    }
+
+    // Override so that the generator kicks in when the liberty-maven-plugin is used
+    @Override
+    public boolean isApplicable(List<ImageConfiguration> configs) {
+        return shouldAddImageConfiguration(configs)
+                && MavenUtil.hasPlugin(getProject(), "io.openliberty.tools", "liberty-maven-plugin");
+
+    }
+
+    // Override extractPorts so that we default to 9080 rather than 8080 for the web port. 
+    @Override
+    protected List<String> extractPorts() {
+        List<String> ret = new ArrayList<>();
+        addPortIfValid(ret, getConfig(JavaExecGenerator.Config.webPort, "9080"));
+        addPortIfValid(ret, getConfig(JavaExecGenerator.Config.jolokiaPort));
+        addPortIfValid(ret, getConfig(JavaExecGenerator.Config.prometheusPort));
+        return ret;
+    }
+
+
+    @Override
+    protected Map<String, String> getEnv(boolean prePackagePhase) throws MojoExecutionException {
+    	Map<String,String> ret = super.getEnv(prePackagePhase);
+    	if ( runnableJarName != null) {
+    		ret.put(LIBERTY_RUNNABLE_JAR, runnableJarName);
+    		ret.put(JAVA_APP_JAR, runnableJarName);
+    	}
+    	return ret;
+    }
+    @Override
+    protected AssemblyConfiguration createAssembly() throws MojoExecutionException {
+        AssemblyConfiguration.Builder builder = new AssemblyConfiguration.Builder().targetDir(getConfig(Config.targetDir));
+        addAssembly(builder);
+        return builder.build();
+    }
+
+    @Override
+    protected void addAssembly(AssemblyConfiguration.Builder builder) throws MojoExecutionException {
+        String assemblyRef = getConfig(Config.assemblyRef);
+        if (assemblyRef != null) {
+            builder.descriptorRef(assemblyRef);
+        } else {
+            Assembly assembly = new Assembly();
+            addAdditionalFiles(assembly);
+            if (isFatJar()) {
+                FatJarDetector.Result fatJar = detectFatJar();
+                MavenProject project = getProject();
+                if (fatJar == null) {
+                    DependencySet dependencySet = new DependencySet();
+                    dependencySet.addInclude(project.getGroupId() + ":" + project.getArtifactId());
+                    assembly.addDependencySet(dependencySet);
+                } else {
+                    FileSet fileSet = getOutputDirectoryFileSet(fatJar, project);
+                    if ( LIBERTY_SELF_EXTRACTOR.equals(fatJar.getMainClass())) {
+                    	this.runnableJarName = fatJar.getArchiveFile().getName();
+                    }
+                    assembly.addFileSet(fileSet);
+                }
+            } else {
+                builder.descriptorRef("artifact-with-dependencies");
+            }
+            builder.assemblyDef(assembly);
+        }
+    }
+
+    private void addAdditionalFiles(Assembly assembly) {
+        assembly.addFileSet(createFileSet("src/main/fabric8-includes/bin","bin","0755","0755"));
+        assembly.addFileSet(createFileSet("src/main/fabric8-includes",".","0644","0755"));
+        // Add server.xml file
+        assembly.addFileSet(createFileSet("src/main/liberty/config","src/wlp/config","0644", "0755"));
+
+    }
+
+    private FileSet getOutputDirectoryFileSet(FatJarDetector.Result fatJar, MavenProject project) {
+        FileSet fileSet = new FileSet();
+        File buildDir = new File(project.getBuild().getDirectory());
+        fileSet.setDirectory(getRelativePath(project.getBasedir(), buildDir).getPath());
+        fileSet.addInclude(getRelativePath(buildDir, fatJar.getArchiveFile()).getPath());
+        fileSet.setOutputDirectory(".");
+        fileSet.setFileMode("0640");
+        return fileSet;
+    }
+
+    private FileSet createFileSet(String sourceDir, String outputDir, String fileMode, String directoryMode) {
+        FileSet fileSet = new FileSet();
+        fileSet.setDirectory(sourceDir);
+        fileSet.setOutputDirectory(outputDir);
+        fileSet.setFileMode(fileMode);
+        fileSet.setDirectoryMode(directoryMode);
+        return fileSet;
+    }
+
+
+
+}
diff --git a/jkube-kit/jkube-kit-openliberty/src/main/resources/META-INF/jkube/generator-default b/jkube-kit/jkube-kit-openliberty/src/main/resources/META-INF/jkube/generator-default
@@ -0,0 +1,5 @@
+# The order of the generators used is defined in the active profile
+# (which is the profile "default" by default)
+# You can find the default profiles in "profiles-default.yml"
+
+org.eclipse.jkube.openliberty.generator.OpenLibertyGenerator
diff --git a/jkube-kit/pom.xml b/jkube-kit/pom.xml
@@ -55,6 +55,7 @@
       <module>jkube-kit-thorntail-v2</module>
       <module>jkube-kit-vertx</module>
       <module>jkube-kit-quarkus</module>
+      <module>jkube-kit-openliberty</module>
   </modules>
 
 </project>
diff --git a/kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_generator.adoc b/kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_generator.adoc
@@ -45,6 +45,11 @@ All default generators examine the build information for certain aspects and gen
 | <<generator-quarkus,Quarkus>>
 | `Quarkus`
 | Generator for Quarkus based applications
+
+
+| <<generator-openliberty,Open Liberty>>
+| `webapps`
+| Generator for Open Liberty applications
 |===
 
 include::generator/_options_common.adoc[]
@@ -57,5 +62,6 @@ include::generator/_vertx.adoc[]
 include::generator/_karaf.adoc[]
 include::generator/_webapp.adoc[]
 include::generator/_quarkus.adoc[]
+include::generator/_openliberty.adoc[]
 
 include::generator/_api.adoc[]
diff --git a/kubernetes-maven-plugin/doc/src/main/asciidoc/inc/generator/_openliberty.adoc b/kubernetes-maven-plugin/doc/src/main/asciidoc/inc/generator/_openliberty.adoc
@@ -0,0 +1,8 @@
+[[generator-openliberty]]
+=== Open Liberty
+
+The Open Liberty generator runs when the Open Liberty plugin is enabled in the maven build. 
+
+The generator is similar to the <<generator-java-exec,java-exec generator>>. It supports the  <<generator-options-common, common generator options>> and the <<generator-java-exec-options, `java-exec` options>>.
+
+For Open Liberty, the default value of webPort is 9080. 
diff --git a/kubernetes-maven-plugin/plugin/pom.xml b/kubernetes-maven-plugin/plugin/pom.xml
@@ -105,6 +105,12 @@
             <artifactId>jkube-kit-quarkus</artifactId>
             <version>${jkube.kit.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-kit-openliberty</artifactId>
+            <version>${jkube.kit.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>org.eclipse.jkube</groupId>

diff --git a/kubernetes-maven-plugin/plugin/src/main/resources/META-INF/jkube/profiles-default.yml b/kubernetes-maven-plugin/plugin/src/main/resources/META-INF/jkube/profiles-default.yml
@@ -74,6 +74,7 @@
     - spring-boot
     - wildfly-swarm
     - thorntail-v2
+    - openliberty
     - karaf
     - vertx
     - java-exec
@@ -140,4 +141,4 @@
     excludes: []
   enricher:
     excludes:
-      - jkube-openshift-service-expose
+      - jkube-openshift-service-expose
diff --git a/openshift-maven-plugin/doc/src/main/asciidoc/inc/_generator.adoc b/openshift-maven-plugin/doc/src/main/asciidoc/inc/_generator.adoc
@@ -45,6 +45,10 @@ All default generators examine the build information for certain aspects and gen
 | <<generator-quarkus,Quarkus>>
 | `Quarkus`
 | Generator for Quarkus based applications
+
+| <<generator-openliberty,Open Liberty>>
+| `webapps`
+| Generator for Open Liberty applications
 |===
 
 include::generator/_options_common.adoc[]
@@ -57,5 +61,6 @@ include::generator/_vertx.adoc[]
 include::generator/_karaf.adoc[]
 include::generator/_webapp.adoc[]
 include::generator/_quarkus.adoc[]
+include::generator/_openliberty.adoc[]
 
 include::generator/_api.adoc[]
diff --git a/openshift-maven-plugin/doc/src/main/asciidoc/inc/generator/_openliberty.adoc b/openshift-maven-plugin/doc/src/main/asciidoc/inc/generator/_openliberty.adoc
@@ -0,0 +1,8 @@
+[[generator-openliberty]]
+=== Open Liberty
+
+The Open Liberty generator runs when the Open Liberty plugin is enabled in the maven build. 
+
+The generator is similar to the <<generator-java-exec,java-exec generator>>. It supports the  <<generator-options-common, common generator options>> and the <<generator-java-exec-options, `java-exec` options>>.
+
+For Open Liberty, the default value of webPort is 9080. 
diff --git a/openshift-maven-plugin/plugin/pom.xml b/openshift-maven-plugin/plugin/pom.xml
@@ -105,6 +105,12 @@
             <artifactId>jkube-kit-quarkus</artifactId>
             <version>${jkube.kit.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.jkube</groupId>
+            <artifactId>jkube-kit-openliberty</artifactId>
+            <version>${jkube.kit.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>org.eclipse.jkube</groupId>

diff --git a/openshift-maven-plugin/plugin/src/main/resources/META-INF/jkube/profiles-default.yml b/openshift-maven-plugin/plugin/src/main/resources/META-INF/jkube/profiles-default.yml
@@ -74,6 +74,7 @@
     - spring-boot
     - wildfly-swarm
     - thorntail-v2
+    - openliberty
     - karaf
     - vertx
     - java-exec
@@ -133,4 +134,4 @@
     excludes: []
   enricher:
     excludes:
-      - jkube-openshift-service-expose
+      - jkube-openshift-service-expose