io.fabric8.maven

Class AbstractFabric8Mojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.AbstractNamespacedMojo

io.fabric8.maven.AbstractFabric8Mojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ApplyMojo, AttachMojo, CreateEnvMojo, DeletePodsMojo, DeployToWikiMojo, DescribeEnvMojo, HelmMojo, JsonMojo, ZipMojo

public abstract class AbstractFabric8Mojo
extends AbstractNamespacedMojo

Abstract base class for Fabric8 based Mojos

Field Summary

Fields

Modifier and Type	Field and Description
protected File	appConfigDir The folder used for defining project specific files
protected boolean	combineDependencies Whether we should combine kubernetes JSON dependencies on the classpath into the generated JSON
protected File	environmentVariableToAnnotationsFile Specifies a file which maps environment variables or system properties to annotations which are then recorded on the ReplicationController of the generated or applied JSON
protected File	envPropertiesFile The properties file used to specify environment variables which allows ${FOO_BAR} expressions to be used without any Maven property expansion
static String[]	ICON_EXTENSIONS
protected String	iconRef Provides the resource name of the icon to use; found using the current classpath (including the ones shipped inside the maven plugin).
protected File	kubernetesSourceJson The source kubernetes JSON file
protected boolean	pureKubernetes Should we exclude OpenShift templates and any extensions like OAuthConfigs in the generated or combined JSON?
protected File	zipFile Name of the created app zip file

Fields inherited from class io.fabric8.maven.AbstractNamespacedMojo

failOnError, recreate, routeDomain

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFabric8Mojo()

Method Summary

Modifier and Type	Method and Description
protected void	addEnvironmentAnnotations(File json)
protected void	addEnvironmentAnnotations(io.fabric8.kubernetes.api.model.HasMetadata resource)
protected void	addEnvironmentAnnotations(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> items)
protected static void	addPropertiesFileToMap(File file, Map<String,String> answer)
protected static void	addPropertiesFileToMap(URL url, Map<String,String> answer)
protected void	copyAppConfigFiles(File appBuildDir, File appConfigDir) Copies any local configuration files into the app directory
protected File	copyIconToFolder(File appBuildDir)
protected void	copyReadMe(File appBuildDir)
protected static File	copyReadMe(File src, File appBuildDir)
protected static File	copyReadMe(File src, File appBuildDir, String outputFileName)
protected void	copySummaryText(File appBuildDir)
protected URLClassLoader	createClassLoader(List<String> classpathElements, String... paths)
protected static Iterable<Throwable>	createExceptionIterable(Throwable exception) Creates an Iterable to walk the exception from the bottom up (the last caused by going upwards to the root exception).
protected static URLClassLoader	createURLClassLoader(Collection<URL> jars)
protected String	findDocumentationUrl()
protected org.apache.maven.model.DistributionManagement	findProjectDistributionManagement()
protected URLClassLoader	getCompileClassLoader()
String	getDockerImage()
JsonSchema	getEnvironmentVariableJsonSchema()
Map<String,String>	getEnvironmentVariableProperties() Returns all the environment variable properties defined in the pom.xml which are prefixed with "fabric8.env."
protected String	getGitCommitId(String envVarName, File basedir)
protected org.eclipse.jgit.lib.Repository	getGitRepository(File basedir, String envVarName)
File	getKubernetesCombineJson()
File	getKubernetesJson()
org.apache.maven.project.MavenProject	getProject()
protected Properties	getProjectAndFabric8Properties(org.apache.maven.project.MavenProject project)
Integer	getReplicas()
protected URLClassLoader	getTestClassLoader()
File	getZipFile()
protected boolean	hasConfigDir()
boolean	isIgnoreProject()
protected boolean	isInCDBuild() Returns true if the current build is being run inside a CI / CD build in which case lets warn if we cannot detect things like the GIT commit or Jenkins build server URL
protected boolean	isPom(org.apache.maven.project.MavenProject reactorProject) Returns true if this project is a pom packaging project
protected boolean	isPomProject()
protected static Object	loadJsonFile(File file)
protected InputStream	loadPluginResource(String iconRef)
protected void	overrideTemplateParameters(io.fabric8.openshift.api.model.Template template) Before applying the given template lets allow template parameters to be overridden via the maven properties - or optionally - via the command line if in interactive mode.
protected void	printSummary(Object kubeResource)
protected static String	replaceProperties(String text, Properties properties) Replaces all text of the form {foo}$ with the value in the properties object
protected boolean	shouldGenerateForThisProject()
protected boolean	toBeExclude(String fileName)
protected String	tryDefaultAnnotationEnvVar(String envVarName) Tries to default some environment variables if they are not already defined.
static String	unquoteTemplateExpression(String value) If supported we should escape ${FOO} for template expressions
protected void	warnIfInCDBuild(String message)
protected void	warnIfInCDBuild(String message, Throwable exception)

Methods inherited from class io.fabric8.maven.AbstractNamespacedMojo

createController, findProjectConfig, getKubernetes, getNamespace, getNamespaceForEnvironment, getRootProject, getRootProjectFolder, getRouteDomain, isFailOnError, isRecreate, setFailOnError, setNamespace, setRecreate, setRouteDomain

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

ICON_EXTENSIONS

public static String[] ICON_EXTENSIONS

zipFile

@Parameter(property="fabric8.zip.file",
           defaultValue="${project.build.directory}/${project.artifactId}-${project.version}-app.zip")
protected File zipFile

Name of the created app zip file

appConfigDir

@Parameter(property="fabric8.source.dir",
           defaultValue="${basedir}/src/main/fabric8")
protected File appConfigDir

The folder used for defining project specific files

iconRef

@Parameter(property="fabric8.iconRef")
protected String iconRef

Provides the resource name of the icon to use; found using the current classpath (including the ones shipped inside the maven plugin).

You can refer to a common set of icons by setting this option to a value of:

• activemq
• camel
• java
• jetty
• karaf
• mule
• spring-boot
• tomcat
• tomee
• weld
• wildfly

kubernetesSourceJson

@Parameter(property="fabric8.json.source",
           defaultValue="${basedir}/src/main/fabric8/kubernetes.json")
protected File kubernetesSourceJson

The source kubernetes JSON file

combineDependencies

@Parameter(property="fabric8.combineDependencies",
           defaultValue="false")
protected boolean combineDependencies

Whether we should combine kubernetes JSON dependencies on the classpath into the generated JSON

pureKubernetes

@Parameter(property="fabric8.pureKubernetes",
           defaultValue="false")
protected boolean pureKubernetes

Should we exclude OpenShift templates and any extensions like OAuthConfigs in the generated or combined JSON?

envPropertiesFile

@Parameter(property="fabric8.envProperties",
           defaultValue="${basedir}/src/main/fabric8/env.properties")
protected File envPropertiesFile

The properties file used to specify environment variables which allows ${FOO_BAR} expressions to be used without any Maven property expansion

environmentVariableToAnnotationsFile

@Parameter(property="fabric8.environmentVariableToAnnotationsFile",
           defaultValue="${basedir}/src/main/fabric8/environemntToAnnotations.properties")
protected File environmentVariableToAnnotationsFile

Specifies a file which maps environment variables or system properties to annotations which are then recorded on the ReplicationController of the generated or applied JSON

Constructor Detail

AbstractFabric8Mojo

public AbstractFabric8Mojo()

Method Detail

copyReadMe

protected static File copyReadMe(File src,
                                 File appBuildDir)
                          throws IOException

Throws:

IOException

copyReadMe

protected static File copyReadMe(File src,
                                 File appBuildDir,
                                 String outputFileName)
                          throws IOException

Throws:

IOException

loadJsonFile

protected static Object loadJsonFile(File file)
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getProject

public org.apache.maven.project.MavenProject getProject()

Overrides:

getProject in class AbstractNamespacedMojo

createURLClassLoader

protected static URLClassLoader createURLClassLoader(Collection<URL> jars)

getKubernetesJson

public File getKubernetesJson()

getKubernetesCombineJson

public File getKubernetesCombineJson()

getReplicas

public Integer getReplicas()

isIgnoreProject

public boolean isIgnoreProject()

getZipFile

public File getZipFile()

isPom

protected boolean isPom(org.apache.maven.project.MavenProject reactorProject)

Returns true if this project is a pom packaging project

loadPluginResource

protected InputStream loadPluginResource(String iconRef)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCompileClassLoader

protected URLClassLoader getCompileClassLoader()
                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getTestClassLoader

protected URLClassLoader getTestClassLoader()
                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createClassLoader

protected URLClassLoader createClassLoader(List<String> classpathElements,
                                           String... paths)
                                    throws MalformedURLException

Throws:

MalformedURLException

hasConfigDir

protected boolean hasConfigDir()

isPomProject

protected boolean isPomProject()

addEnvironmentAnnotations

protected void addEnvironmentAnnotations(File json)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addEnvironmentAnnotations

protected void addEnvironmentAnnotations(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> items)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addEnvironmentAnnotations

protected void addEnvironmentAnnotations(io.fabric8.kubernetes.api.model.HasMetadata resource)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

findDocumentationUrl

protected String findDocumentationUrl()

replaceProperties

protected static String replaceProperties(String text,
                                          Properties properties)

Replaces all text of the form {foo}$ with the value in the properties object

findProjectDistributionManagement

protected org.apache.maven.model.DistributionManagement findProjectDistributionManagement()

tryDefaultAnnotationEnvVar

protected String tryDefaultAnnotationEnvVar(String envVarName)

Tries to default some environment variables if they are not already defined. This can happen if using Jenkins Workflow which doens't seem to define BUILD_URL or GIT_URL for example

Returns:

the value of the environment variable name if it can be found or calculated

getGitCommitId

protected String getGitCommitId(String envVarName,
                                File basedir)

warnIfInCDBuild

protected void warnIfInCDBuild(String message)

isInCDBuild

protected boolean isInCDBuild()

Returns true if the current build is being run inside a CI / CD build in which case lets warn if we cannot detect things like the GIT commit or Jenkins build server URL

warnIfInCDBuild

protected void warnIfInCDBuild(String message,
                               Throwable exception)

createExceptionIterable

protected static Iterable<Throwable> createExceptionIterable(Throwable exception)

Creates an Iterable to walk the exception from the bottom up (the last caused by going upwards to the root exception).

Parameters:

exception - the exception

Returns:

the Iterable

See Also:

Iterable

getGitRepository

protected org.eclipse.jgit.lib.Repository getGitRepository(File basedir,
                                                           String envVarName)

shouldGenerateForThisProject

protected boolean shouldGenerateForThisProject()

getEnvironmentVariableProperties

public Map<String,String> getEnvironmentVariableProperties()
                                                    throws org.apache.maven.plugin.MojoExecutionException

Returns all the environment variable properties defined in the pom.xml which are prefixed with "fabric8.env."

Throws:

org.apache.maven.plugin.MojoExecutionException

addPropertiesFileToMap

protected static void addPropertiesFileToMap(File file,
                                             Map<String,String> answer)
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addPropertiesFileToMap

protected static void addPropertiesFileToMap(URL url,
                                             Map<String,String> answer)
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

unquoteTemplateExpression

public static String unquoteTemplateExpression(String value)

If supported we should escape ${FOO} for template expressions

getEnvironmentVariableJsonSchema

public JsonSchema getEnvironmentVariableJsonSchema()
                                            throws IOException,
                                                   org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

copyIconToFolder

protected File copyIconToFolder(File appBuildDir)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                IOException

Throws:

org.apache.maven.plugin.MojoExecutionException

IOException

copyAppConfigFiles

protected void copyAppConfigFiles(File appBuildDir,
                                  File appConfigDir)
                           throws IOException

Copies any local configuration files into the app directory

Throws:

IOException

toBeExclude

protected boolean toBeExclude(String fileName)

copyReadMe

protected void copyReadMe(File appBuildDir)
                   throws IOException

Throws:

IOException

copySummaryText

protected void copySummaryText(File appBuildDir)
                        throws IOException

Throws:

IOException

printSummary

protected void printSummary(Object kubeResource)
                     throws IOException

Throws:

IOException

getDockerImage

public String getDockerImage()

overrideTemplateParameters

protected void overrideTemplateParameters(io.fabric8.openshift.api.model.Template template)

Before applying the given template lets allow template parameters to be overridden via the maven properties - or optionally - via the command line if in interactive mode.

getProjectAndFabric8Properties

protected Properties getProjectAndFabric8Properties(org.apache.maven.project.MavenProject project)