io.fabric8.jenkins.openshiftsync

Class OpenShiftUtils

java.lang.Object

io.fabric8.jenkins.openshiftsync.OpenShiftUtils

public class OpenShiftUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenShiftUtils()

Method Summary

Modifier and Type	Method and Description
static NamespaceName	buildConfigNameFromJenkinsJobName(String jobName, String namespace) Maps a Jenkins Job name to an ObjectShift BuildConfig name
static String	dumpWithoutRuntimeStateAsYaml(io.fabric8.kubernetes.api.model.HasMetadata obj)
static String	formatTimestamp(long timestamp)
static io.fabric8.openshift.client.OpenShiftClient	getAuthenticatedOpenShiftClient()
static String	getExternalServiceUrl(io.fabric8.openshift.client.OpenShiftClient openShiftClient, String defaultProtocolText, String namespace, String serviceName) Returns the public URL of the given service
static String	getJenkinsURL(io.fabric8.openshift.client.OpenShiftClient openShiftClient, String namespace) Calculates the external URL to access Jenkins
static String[]	getNamespaceOrUseDefault(String[] configuredNamespaces, io.fabric8.openshift.client.OpenShiftClient client) Gets the current namespace running Jenkins inside or returns a reasonable default
static io.fabric8.openshift.client.OpenShiftClient	getOpenShiftClient()
static void	initializeOpenShiftClient(String serverUrl) Initializes an OpenShiftClient
static boolean	isCancellable(io.fabric8.openshift.api.model.BuildStatus buildStatus)
static boolean	isCancelled(io.fabric8.openshift.api.model.BuildStatus status)
static boolean	isJenkinsBuildConfig(io.fabric8.openshift.api.model.BuildConfig bc) Checks if a BuildConfig relates to a Jenkins build
static boolean	isNew(io.fabric8.openshift.api.model.BuildStatus buildStatus)
static boolean	isResourceWithoutStateEqual(io.fabric8.kubernetes.api.model.HasMetadata oldObj, io.fabric8.kubernetes.api.model.HasMetadata newObj)
static String	jenkinsJobDisplayName(io.fabric8.openshift.api.model.BuildConfig bc) Finds the Jenkins job display name for the given BuildConfig.
static String	jenkinsJobDisplayName(String namespace, String buildConfigName) Creates the Jenkins Job display name for the given buildConfigName
static String	jenkinsJobName(io.fabric8.openshift.api.model.BuildConfig bc) Finds the Jenkins job name for the given BuildConfig.
static String	jenkinsJobName(String namespace, String buildConfigName) Creates the Jenkins Job name for the given buildConfigName
static long	parseResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata obj)
static long	parseResourceVersion(String resourceVersion)
static long	parseTimestamp(String timestamp)
static void	shutdownOpenShiftClient()
static void	updateGitSourceUrl(io.fabric8.openshift.api.model.BuildConfig buildConfig, String gitUrl, String ref) Lazily creates the GitSource if need be then updates the git URL
static void	updateOpenShiftBuildPhase(io.fabric8.openshift.api.model.Build build, String phase)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenShiftUtils

public OpenShiftUtils()

Method Detail

initializeOpenShiftClient

public static void initializeOpenShiftClient(String serverUrl)

Initializes an OpenShiftClient

Parameters:

serverUrl - the optional URL of where the OpenShift cluster API server is running

getOpenShiftClient

public static io.fabric8.openshift.client.OpenShiftClient getOpenShiftClient()

getAuthenticatedOpenShiftClient

public static io.fabric8.openshift.client.OpenShiftClient getAuthenticatedOpenShiftClient()

shutdownOpenShiftClient

public static void shutdownOpenShiftClient()

isJenkinsBuildConfig

public static boolean isJenkinsBuildConfig(io.fabric8.openshift.api.model.BuildConfig bc)

Checks if a BuildConfig relates to a Jenkins build

Parameters:

bc - the BuildConfig

Returns:

true if this is an OpenShift BuildConfig which should be mirrored to a Jenkins Job

jenkinsJobName

public static String jenkinsJobName(io.fabric8.openshift.api.model.BuildConfig bc)

Finds the Jenkins job name for the given BuildConfig.

Parameters:

bc - the BuildConfig

Returns:

the jenkins job name for the given BuildConfig

jenkinsJobName

public static String jenkinsJobName(String namespace,
                                    String buildConfigName)

Creates the Jenkins Job name for the given buildConfigName

Parameters:

namespace - the namespace of the build

buildConfigName - the name of the BuildConfig in in the namespace

Returns:

the jenkins job name for the given namespace and name

jenkinsJobDisplayName

public static String jenkinsJobDisplayName(io.fabric8.openshift.api.model.BuildConfig bc)

Finds the Jenkins job display name for the given BuildConfig.

Parameters:

bc - the BuildConfig

Returns:

the jenkins job display name for the given BuildConfig

jenkinsJobDisplayName

public static String jenkinsJobDisplayName(String namespace,
                                           String buildConfigName)

Creates the Jenkins Job display name for the given buildConfigName

Parameters:

namespace - the namespace of the build

buildConfigName - the name of the BuildConfig in in the namespace

Returns:

the jenkins job display name for the given namespace and name

getNamespaceOrUseDefault

public static String[] getNamespaceOrUseDefault(String[] configuredNamespaces,
                                                io.fabric8.openshift.client.OpenShiftClient client)

Gets the current namespace running Jenkins inside or returns a reasonable default

Parameters:

configuredNamespaces - the optional configured namespace(s)

client - the OpenShift client

Returns:

the default namespace using either the configuration value, the default namespace on the client or "default"

getExternalServiceUrl

public static String getExternalServiceUrl(io.fabric8.openshift.client.OpenShiftClient openShiftClient,
                                           String defaultProtocolText,
                                           String namespace,
                                           String serviceName)

Returns the public URL of the given service

Parameters:

openShiftClient - the OpenShiftClient to use

defaultProtocolText - the protocol text part of a URL such as http://

namespace - the Kubernetes namespace

serviceName - the service name

Returns:

the external URL of the service

getJenkinsURL

public static String getJenkinsURL(io.fabric8.openshift.client.OpenShiftClient openShiftClient,
                                   String namespace)

Calculates the external URL to access Jenkins

Parameters:

namespace - the namespace Jenkins is runing inside

openShiftClient - the OpenShift client

Returns:

the external URL to access Jenkins

updateGitSourceUrl

public static void updateGitSourceUrl(io.fabric8.openshift.api.model.BuildConfig buildConfig,
                                      String gitUrl,
                                      String ref)

Lazily creates the GitSource if need be then updates the git URL

Parameters:

buildConfig - the BuildConfig to update

gitUrl - the URL to the git repo

ref - the git ref (commit/branch/etc) for the build

updateOpenShiftBuildPhase

public static void updateOpenShiftBuildPhase(io.fabric8.openshift.api.model.Build build,
                                             String phase)

buildConfigNameFromJenkinsJobName

public static NamespaceName buildConfigNameFromJenkinsJobName(String jobName,
                                                              String namespace)

Maps a Jenkins Job name to an ObjectShift BuildConfig name

Parameters:

jobName - the job to associate to a BuildConfig name

namespace - the default namespace that Jenkins is running inside

Returns:

the namespaced name for the BuildConfig

parseResourceVersion

public static long parseResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata obj)

parseResourceVersion

public static long parseResourceVersion(String resourceVersion)

formatTimestamp

public static String formatTimestamp(long timestamp)

parseTimestamp

public static long parseTimestamp(String timestamp)

isResourceWithoutStateEqual

public static boolean isResourceWithoutStateEqual(io.fabric8.kubernetes.api.model.HasMetadata oldObj,
                                                  io.fabric8.kubernetes.api.model.HasMetadata newObj)

dumpWithoutRuntimeStateAsYaml

public static String dumpWithoutRuntimeStateAsYaml(io.fabric8.kubernetes.api.model.HasMetadata obj)
                                            throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

isCancellable

public static boolean isCancellable(io.fabric8.openshift.api.model.BuildStatus buildStatus)

isNew

public static boolean isNew(io.fabric8.openshift.api.model.BuildStatus buildStatus)

isCancelled

public static boolean isCancelled(io.fabric8.openshift.api.model.BuildStatus status)