work in progress

Author: rjeberhard

operator/src/main/java/oracle/kubernetes/operator/helpers/BasePodStepContext.java

@@ -0,0 +1,49 @@
+// Copyright 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at
+// http://oss.oracle.com/licenses/upl.
+
+package oracle.kubernetes.operator.helpers;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+import io.kubernetes.client.models.V1Container;
+import io.kubernetes.client.models.V1EnvVar;
+import io.kubernetes.client.models.V1Pod;
+import io.kubernetes.client.models.V1PodSpec;
+import oracle.kubernetes.operator.KubernetesConstants;
+
+public abstract class BasePodStepContext extends StepContextBase {
+  final void updateForDeepSubstitution(V1PodSpec podSpec) {
+    getContainer(podSpec)
+        .ifPresent(
+            c -> {
+              doDeepSubstitution(deepSubVars(c.getEnv()), podSpec);
+            });
+  }
+
+  final Map<String, String> deepSubVars(List<V1EnvVar> envVars) {
+    return varsToSubVariables(envVars);
+  }
+
+  protected void augmentSubVars(Map<String, String> vars) {
+    // no-op
+  }
+
+  protected Optional<V1Container> getContainer(V1Pod v1Pod) {
+    return getContainer(v1Pod.getSpec());
+  }
+
+  protected Optional<V1Container> getContainer(V1PodSpec v1PodSpec) {
+    return v1PodSpec.getContainers().stream().filter(this::isK8sContainer).findFirst();
+  }
+
+  protected boolean isK8sContainer(V1Container c) {
+    return getMainContainerName().equals(c.getName());
+  }
+
+  protected String getMainContainerName() {
+    return KubernetesConstants.CONTAINER_NAME;
+  }
+}

operator/src/main/java/oracle/kubernetes/operator/helpers/JobStepContext.java

@@ -7,6 +7,7 @@
 import java.io.File;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 
 import io.kubernetes.client.models.V1ConfigMapVolumeSource;
 import io.kubernetes.client.models.V1Container;
@@ -31,7 +32,7 @@
 import oracle.kubernetes.operator.work.Step;
 import oracle.kubernetes.weblogic.domain.model.Domain;
 
-public abstract class JobStepContext extends StepContextBase {
+public abstract class JobStepContext extends BasePodStepContext {
   static final long DEFAULT_ACTIVE_DEADLINE_SECONDS = 120L;
   static final long DEFAULT_ACTIVE_DEADLINE_INCREMENT_SECONDS = 60L;
   private static final LoggingFacade LOGGER = LoggingFactory.getLogger("Operator", "Operator");
@@ -76,6 +77,17 @@ Domain getDomain() {
 
   abstract String getJobName();
 
+  @Override
+  protected String getMainContainerName() {
+    return getJobName();
+  }
+
+  @Override
+  protected void augmentSubVars(Map<String, String> vars) {
+    // HERE: placeholder that needs to be documented
+    vars.put("SERVER_NAME", "introspector");
+  }
+
   String getWebLogicCredentialsSecretName() {
     return getDomain().getWebLogicCredentialsSecret().getName();
   }
@@ -186,9 +198,12 @@ V1JobSpec createJobSpec(TuningParameters tuningParameters) {
   }
 
   private V1PodTemplateSpec createPodTemplateSpec(TuningParameters tuningParameters) {
-    return new V1PodTemplateSpec()
+    V1PodTemplateSpec podTemplateSpec = new V1PodTemplateSpec()
           .metadata(createPodTemplateMetadata())
           .spec(createPodSpec(tuningParameters));
+
+    updateForDeepSubstitution(podTemplateSpec.getSpec());
+    return podTemplateSpec;
   }
 
   private V1ObjectMeta createPodTemplateMetadata() {

operator/src/main/java/oracle/kubernetes/operator/helpers/PodStepContext.java

@@ -62,7 +62,7 @@
 import static oracle.kubernetes.operator.VersionConstants.DEFAULT_DOMAIN_VERSION;
 
 @SuppressWarnings("deprecation")
-public abstract class PodStepContext extends StepContextBase {
+public abstract class PodStepContext extends BasePodStepContext {
 
   private static final LoggingFacade LOGGER = LoggingFactory.getLogger("Operator", "Operator");
 
@@ -386,14 +386,6 @@ V1Pod createPodModel() {
     return withNonHashedElements(AnnotationHelper.withSha256Hash(createPodRecipe()));
   }
 
-  protected Optional<V1Container> getContainer(V1Pod v1Pod) {
-    return v1Pod.getSpec().getContainers().stream().filter(this::isK8sContainer).findFirst();
-  }
-
-  protected boolean isK8sContainer(V1Container c) {
-    return KubernetesConstants.CONTAINER_NAME.equals(c.getName());
-  }
-
   V1Pod withNonHashedElements(V1Pod pod) {
     V1ObjectMeta metadata = pod.getMetadata();
     // Adds labels and annotations to a pod, skipping any whose names begin with "weblogic."
@@ -406,26 +398,17 @@ V1Pod withNonHashedElements(V1Pod pod) {
 
     updateForStartupMode(pod);
     updateForShutdown(pod);
-    updateForDeepSubstitution(pod);
+    updateForDeepSubstitution(pod.getSpec());
 
     return pod;
   }
 
-  final void updateForDeepSubstitution(V1Pod pod) {
-    getContainer(pod)
-        .ifPresent(
-            c -> {
-              doDeepSubstitution(deepSubVars(c.getEnv()), pod);
-            });
-  }
-
-  final Map<String, String> deepSubVars(List<V1EnvVar> envVars) {
-    Map<String, String> vars = varsToSubVariables(envVars);
+  @Override
+  protected void augmentSubVars(Map<String, String> vars) {
     String clusterName = getClusterName();
     if (clusterName != null) {
       vars.put("CLUSTER_NAME", clusterName);
     }
-    return vars;
   }
 
   final void updateForStartupMode(V1Pod pod) {