io.fabric8.maven.enricher.deprecated.AbstractLiveEnricher Maven / Gradle / Ivy
/**
* Copyright 2016 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version
* 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package io.fabric8.maven.enricher.deprecated;
import java.net.ConnectException;
import java.util.Stack;
import io.fabric8.kubernetes.api.model.Service;
import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.maven.core.access.ClusterAccess;
import io.fabric8.maven.core.util.Configs;
import io.fabric8.maven.core.util.kubernetes.KubernetesHelper;
import io.fabric8.maven.core.util.kubernetes.ServiceUrlUtil;
import io.fabric8.maven.enricher.api.BaseEnricher;
import io.fabric8.maven.enricher.api.MavenEnricherContext;
import org.apache.commons.lang3.StringUtils;
public abstract class AbstractLiveEnricher extends BaseEnricher {
private KubernetesClient kubernetesClient;
private enum Config implements Configs.Key {
online,
namespace;
public String def() { return d; } protected String d;
}
AbstractLiveEnricher(MavenEnricherContext buildContext, String name) {
super(buildContext, name);
}
/**
* Returns true if in offline mode, "false" if not speciied.
* Can be overriden by
*/
boolean isOnline() {
String isOnline = getConfig(Config.online);
if (isOnline != null) {
return Configs.asBoolean(isOnline);
}
Boolean ret = asBooleanFromGlobalProp("fabric8.online");
return ret != null ? ret : getDefaultOnline();
}
/**
* Return the value to return if no online mode is explicitely specified.
* Can be overridden, by default it returns false.
*
* @return the default value.
*/
protected boolean getDefaultOnline() {
return false;
}
/**
* Returns the external access to the given service name
*
* @param serviceName name of the service
* @param protocol URL protocol such as http
*/
protected String getExternalServiceURL(String serviceName, String protocol) {
if (!isOnline()) {
getLog().info("Not looking for service " + serviceName + " as we are in offline mode");
return null;
} else {
try {
KubernetesClient kubernetes = getKubernetes();
String ns = kubernetes.getNamespace();
if (StringUtils.isBlank(ns)) {
ns = getNamespace();
}
Service service = kubernetes.services().inNamespace(ns).withName(serviceName).get();
return service != null ?
ServiceUrlUtil.getServiceURL(kubernetes, serviceName, ns, protocol, true) :
null;
} catch (Throwable e) {
Throwable cause = e;
boolean notFound = false;
boolean connectError = false;
Stack stack = unfoldExceptions(e);
while (!stack.isEmpty()) {
Throwable t = stack.pop();
if (t instanceof ConnectException || "No route to host".equals(t.getMessage())) {
getLog().warn("Cannot connect to Kubernetes to find URL for service %s : %s",
serviceName, cause.getMessage());
return null;
} else if (t instanceof IllegalArgumentException ||
t.getMessage() != null && t.getMessage().matches("^No.*found.*$")) {
getLog().warn("%s", cause.getMessage());
return null;
};
}
getLog().warn("Cannot find URL for service %s : %s", serviceName, cause.getMessage());
return null;
}
}
}
/**
* Creates an Iterable to walk the exception from the bottom up
* (the last caused by going upwards to the root exception).
*
* @param exception the exception
* @return the Iterable
* @see java.lang.Iterable
*/
protected Stack unfoldExceptions(Throwable exception) {
Stack throwables = new Stack<>();
Throwable current = exception;
// spool to the bottom of the caused by tree
while (current != null) {
throwables.push(current);
current = current.getCause();
}
return throwables;
}
// ====================================================================================
// Check a global prop from the project or system props
protected Boolean asBooleanFromGlobalProp(String prop) {
String value = getContext().getConfiguration().getProperty(prop);
if (value == null) {
value = System.getProperty(prop);
}
return value != null ? Boolean.valueOf(value) : null;
}
private KubernetesClient getKubernetes() {
if (kubernetesClient == null) {
String namespace = getNamespace();
kubernetesClient = new ClusterAccess(namespace).createDefaultClient(log);
}
return kubernetesClient;
}
// Get names space in the order:
// - plugin configuration
// - default name space from the kubernetes helper
// - "default"
private String getNamespace() {
String namespace = getConfig(Config.namespace);
if (StringUtils.isNotBlank(namespace)){
return namespace;
}
namespace = getContext().getConfiguration().getProperty("fabric8.namespace");
if (StringUtils.isNotBlank(namespace)){
return namespace;
}
namespace = System.getProperty("fabric8.namespace");
if (StringUtils.isNotBlank(namespace)){
return namespace;
}
return KubernetesHelper.getDefaultNamespace();
}
}