Merge branch 'develop' into owls-69919-domain-resource-properties

Author: rakillen

integration-tests/src/test/java/oracle/kubernetes/operator/utils/Operator.java

@@ -202,18 +202,48 @@ private void callHelmInstall() throws Exception {
     logger.info("Running " + cmd);
     ExecResult result = ExecCommand.exec(cmd.toString());
     if (result.exitValue() != 0) {
-      throw new RuntimeException(
-          "FAILURE: command "
-              + cmd
-              + " failed, returned "
-              + result.stdout()
-              + "\n"
-              + result.stderr());
+      reportHelmInstallFailure(cmd.toString(), result);
     }
     String outputStr = result.stdout().trim();
     logger.info("Command returned " + outputStr);
   }
 
+  private void reportHelmInstallFailure(String cmd, ExecResult result) throws Exception {
+    String cause = getExecFailure(cmd, result);
+    if (result.stderr().contains("Error: Job failed: BackoffLimitExceeded")) {
+      // The operator helm chart pre-install hook probably failed.
+      // This is probably because there is a problem with the values passed in,
+      // for example a listed domain namespace does not exist.
+      // Fetch the pre-install hook's results and return it too.
+      String hookResults = getOperatorHelmChartHookResults("pre-install");
+      cause = cause + "\n pre-install-hook returned\n" + hookResults;
+    }
+    throw new RuntimeException(cause);
+  }
+
+  private String getOperatorHelmChartHookResults(String hookType) throws Exception {
+    String cmd =
+        "kubectl logs job/"
+            + operatorMap.get("releaseName")
+            + "-weblogic-operator-"
+            + hookType
+            + "-hook -n kube-system";
+    ExecResult result = ExecCommand.exec(cmd);
+    if (result.exitValue() != 0) {
+      return getExecFailure(cmd, result);
+    }
+    return result.stdout();
+  }
+
+  private String getExecFailure(String cmd, ExecResult result) throws Exception {
+    return "FAILURE: command "
+        + cmd
+        + " failed, stdout:\n"
+        + result.stdout()
+        + "stderr:\n"
+        + result.stderr();
+  }
+
   private void generateInputYaml() throws Exception {
     Path parentDir =
         Files.createDirectories(Paths.get(userProjectsDir + "/weblogic-operators/" + operatorNS));

integration-tests/src/test/resources/operator1.yaml

@@ -7,4 +7,4 @@ serviceAccount: weblogic-operator
 namespace: weblogic-operator1
 domainNamespaces: [ "default", "test1" ]
 externalRestEnabled: true
-javaLoggingLevel: FINE
+javaLoggingLevel: FINE

integration-tests/src/test/resources/operator2.yaml

@@ -8,4 +8,4 @@ namespace: weblogic-operator2
 domainNamespaces: [ "test2" ]
 externalRestEnabled: true
 externalRestHttpsPort: 32001
-javaLoggingLevel: FINE
+javaLoggingLevel: FINE

kubernetes/charts/weblogic-operator/templates/_operator-verification-hook.tpl

@@ -0,0 +1,45 @@
+# Copyright 2018 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.
+
+{{- define "operator.operatorVerificationHook" }}
+{{- $scope := index . 0 }}
+{{- $hookType := index . 1 }}
+---
+apiVersion: "batch/v1"
+kind: "Job"
+metadata:
+  name: {{ "OPERATOR_RELEASE-weblogic-operator-HOOK_TYPE-hook" | replace "OPERATOR_RELEASE" $scope.Release.Name | replace "HOOK_TYPE" $hookType | quote }}
+  namespace: {{ $scope.tillerNamespace | quote }}
+  labels:
+    weblogic.resourceVersion: "operator-v2"
+    weblogic.operatorName: {{ $scope.Release.Namespace | quote }}
+  annotations:
+    "helm.sh/hook": {{ $hookType | quote }}
+    "helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded"
+spec:
+  backoffLimit: 0
+  template:
+    metadata:
+      labels:
+        weblogic.resourceVersion: "operator-v2"
+        weblogic.operatorName: {{ $scope.Release.Namespace | quote }}
+    spec:
+      restartPolicy: Never
+      serviceAccount: {{ $scope.tillerServiceAccount | quote }}
+      containers:
+      - name: "weblogic-operator"
+        command:
+        - "/operator/operator-helm-verification-hook.sh"
+        - {{ $hookType | quote }}
+        - {{ $scope.Release.Namespace | quote }}
+        - {{ $scope.serviceAccount | quote }}
+        {{- range $key := $scope.domainNamespaces }}
+        - {{ $key | quote }}
+        {{- end }}
+        image: {{ $scope.image | quote }}
+        imagePullPolicy: {{ $scope.imagePullPolicy | quote }}
+      {{- if $scope.imagePullSecrets }}
+      imagePullSecrets:
+      {{ $scope.imagePullSecrets | toYaml }}
+      {{- end }}
+{{- end }}

kubernetes/charts/weblogic-operator/templates/_validate-inputs.tpl

@@ -33,5 +33,9 @@
 {{-     $ignore := include "utils.verifyInteger" (list $scope "elasticSearchPort") -}}
 {{-   end -}}
 {{- end -}}
+{{- $ignore := include "utils.verifyString" (list $scope "tillerNamespace") -}}
+{{- $ignore := include "utils.verifyString" (list $scope "tillerServiceAccount") -}}
 {{- $ignore:= include "utils.endValidation" $scope -}}
+{{- include "operator.operatorVerificationHook" (list $scope "pre-upgrade") }}
+{{- include "operator.operatorVerificationHook" (list $scope "pre-install") }}
 {{- end -}}

kubernetes/charts/weblogic-operator/values.yaml

@@ -3,7 +3,7 @@
 
 # serviceAccount specifies the name of the service account that the operator will use to
 # make requests to the Kubernetes API server.
-# The name must be lowercase
+# The name must be lowercase.
 serviceAccount: "default"
 
 # domainNamespaces specifies list of WebLogic Domain namespaces which the operator manages
@@ -96,3 +96,9 @@ elasticSearchHost: "elasticsearch.default.svc.cluster.local"
 
 # elasticSearchPort specifies the port number of where elasticsearch is running
 elasticSearchPort: 9200
+
+# tillerNamespace is the name of the namespace that tiller is configured to use.
+tillerNamespace: "kube-system"
+
+# tillerServiceAccount is the name of the service account that tiller is configured to use.
+tillerServiceAccount: "default"

kubernetes/src/test/java/oracle/kubernetes/operator/create/CreateOperatorGeneratedFilesOptionalFeaturesEnabledTestBase.java

@@ -13,6 +13,7 @@
 
 import io.kubernetes.client.models.ExtensionsV1beta1Deployment;
 import io.kubernetes.client.models.V1Container;
+import io.kubernetes.client.models.V1Job;
 import io.kubernetes.client.models.V1Service;
 import oracle.kubernetes.operator.utils.OperatorYamlFactory;
 
@@ -50,6 +51,18 @@ protected V1Service getExpectedExternalWeblogicOperatorService() {
     return getExpectedExternalWeblogicOperatorService(true, true);
   }
 
+  @Override
+  protected V1Job getExpectedWeblogicOperatorHookJob(String hookType) {
+    V1Job expected = super.getExpectedWeblogicOperatorHookJob(hookType);
+    expected
+        .getSpec()
+        .getTemplate()
+        .getSpec()
+        .addImagePullSecretsItem(
+            newLocalObjectReference().name(getInputs().getWeblogicOperatorImagePullSecretName()));
+    return expected;
+  }
+
   @Override
   public ExtensionsV1beta1Deployment getExpectedWeblogicOperatorDeployment() {
     ExtensionsV1beta1Deployment expected = super.getExpectedWeblogicOperatorDeployment();
@@ -66,14 +79,17 @@ public ExtensionsV1beta1Deployment getExpectedWeblogicOperatorDeployment() {
         .addContainersItem(
             newContainer()
                 .name("logstash")
-                .image("logstash:5")
+                .image(getInputs().getLogStashImage())
                 .addArgsItem("-f")
                 .addArgsItem("/logs/logstash.conf")
                 .addEnvItem(
                     newEnvVar()
                         .name("ELASTICSEARCH_HOST")
-                        .value("elasticsearch.default.svc.cluster.local"))
-                .addEnvItem(newEnvVar().name("ELASTICSEARCH_PORT").value("9200"))
+                        .value(getInputs().getElasticSearchHost()))
+                .addEnvItem(
+                    newEnvVar()
+                        .name("ELASTICSEARCH_PORT")
+                        .value(getInputs().getElasticSearchPort()))
                 .addVolumeMountsItem(newVolumeMount().name("log-dir").mountPath("/logs")))
         .addVolumesItem(
             newVolume().name("log-dir").emptyDir(newEmptyDirVolumeSource().medium("Memory")))

kubernetes/src/test/java/oracle/kubernetes/operator/create/CreateOperatorGeneratedFilesTestBase.java

@@ -21,6 +21,8 @@
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newEnvVar;
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newEnvVarSource;
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newExecAction;
+import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newJob;
+import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newJobSpec;
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newNamespace;
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newObjectFieldSelector;
 import static oracle.kubernetes.operator.utils.KubernetesArtifactUtils.newObjectMeta;
@@ -48,6 +50,8 @@
 import io.kubernetes.client.models.V1ClusterRole;
 import io.kubernetes.client.models.V1ClusterRoleBinding;
 import io.kubernetes.client.models.V1ConfigMap;
+import io.kubernetes.client.models.V1Container;
+import io.kubernetes.client.models.V1Job;
 import io.kubernetes.client.models.V1Namespace;
 import io.kubernetes.client.models.V1Role;
 import io.kubernetes.client.models.V1RoleBinding;
@@ -68,6 +72,8 @@
  */
 public abstract class CreateOperatorGeneratedFilesTestBase {
 
+  private static String OPERATOR_RELEASE = "weblogic-operator";
+
   private static OperatorValues inputs;
   private static GeneratedOperatorObjects generatedFiles;
   private static OperatorYamlFactory factory;
@@ -86,6 +92,79 @@ protected static void setup(OperatorYamlFactory factory, OperatorValues val) thr
     generatedFiles = factory.generate(val);
   }
 
+  @Test
+  public void generatesCorrect_operatorPreInstallHookJob() {
+    assertThat(
+        getActualWeblogicOperatorPreInstallHookJob(),
+        yamlEqualTo(getExpectedWeblogicOperatorPreInstallHookJob()));
+  }
+
+  private V1Job getActualWeblogicOperatorPreInstallHookJob() {
+    return getGeneratedFiles().getOperatorPreInstallHookJob();
+  }
+
+  protected V1Job getExpectedWeblogicOperatorPreInstallHookJob() {
+    return getExpectedWeblogicOperatorHookJob("pre-install");
+  }
+
+  @Test
+  public void generatesCorrect_operatorPreUpgradeHookJob() {
+    assertThat(
+        getActualWeblogicOperatorPreUpgradeHookJob(),
+        yamlEqualTo(getExpectedWeblogicOperatorPreUpgradeHookJob()));
+  }
+
+  private V1Job getActualWeblogicOperatorPreUpgradeHookJob() {
+    return getGeneratedFiles().getOperatorPreUpgradeHookJob();
+  }
+
+  protected V1Job getExpectedWeblogicOperatorPreUpgradeHookJob() {
+    return getExpectedWeblogicOperatorHookJob("pre-upgrade");
+  }
+
+  protected V1Job getExpectedWeblogicOperatorHookJob(String hookType) {
+    V1Job job =
+        newJob()
+            .metadata(
+                newObjectMeta()
+                    .name(OPERATOR_RELEASE + "-weblogic-operator-" + hookType + "-hook")
+                    .namespace(getInputs().getTillerNamespace())
+                    .putLabelsItem(RESOURCE_VERSION_LABEL, OPERATOR_V2)
+                    .putLabelsItem(OPERATORNAME_LABEL, getInputs().getNamespace())
+                    .putAnnotationsItem("helm.sh/hook", hookType)
+                    .putAnnotationsItem(
+                        "helm.sh/hook-delete-policy", "before-hook-creation,hook-succeeded"))
+            .spec(
+                newJobSpec()
+                    .backoffLimit(0)
+                    .template(
+                        newPodTemplateSpec()
+                            .metadata(
+                                newObjectMeta()
+                                    .putLabelsItem(RESOURCE_VERSION_LABEL, OPERATOR_V2)
+                                    .putLabelsItem(OPERATORNAME_LABEL, getInputs().getNamespace()))
+                            .spec(
+                                newPodSpec()
+                                    .restartPolicy("Never")
+                                    .serviceAccount(getInputs().getTillerServiceAccount())
+                                    .addContainersItem(
+                                        newContainer()
+                                            .name("weblogic-operator")
+                                            .image(getInputs().getWeblogicOperatorImage())
+                                            .imagePullPolicy(
+                                                getInputs().getWeblogicOperatorImagePullPolicy())
+                                            .addCommandItem(
+                                                "/operator/operator-helm-verification-hook.sh")
+                                            .addCommandItem(hookType)
+                                            .addCommandItem(getInputs().getNamespace())
+                                            .addCommandItem(getInputs().getServiceAccount())))));
+    V1Container container = job.getSpec().getTemplate().getSpec().getContainers().get(0);
+    for (String targetNamespace : getInputs().getTargetNamespaces().split(",")) {
+      container.addCommandItem(targetNamespace);
+    }
+    return job;
+  }
+
   @Test
   public void generatesCorrect_operatorConfigMap() {
     assertThat(

kubernetes/src/test/java/oracle/kubernetes/operator/helm/ChartDefaultValues.java

@@ -0,0 +1,94 @@
+// Copyright 2018, 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.helm;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.util.stream.Collectors;
+import oracle.kubernetes.operator.utils.PathUtils;
+
+/** Gets a helm chart's default values */
+@SuppressWarnings({"unchecked", "SameParameterValue"})
+public class ChartDefaultValues {
+
+  private String chartName;
+
+  ChartDefaultValues(String chartName) {
+    this.chartName = chartName;
+  }
+
+  /**
+   * Returns the default values that the chart creates.
+   *
+   * @return a yaml string
+   */
+  String getDefaultValuesAsYaml() throws Exception {
+    processChart();
+    return getDefaultValuesFromDebugProcessStdout(processChart());
+  }
+
+  private String getDefaultValuesFromDebugProcessStdout(String stdout) throws Exception {
+    String BEGIN_MARKER = "\nCOMPUTED VALUES:\n";
+    int begin = stdout.indexOf(BEGIN_MARKER);
+    if (begin == -1) {
+      reportProcessError("stdout does not contain " + BEGIN_MARKER + "\nstdout:\n" + stdout);
+    }
+    begin = begin + BEGIN_MARKER.length();
+    String END_MARKER = "\nHOOKS:\n";
+    int end = stdout.indexOf(END_MARKER, begin);
+    if (end == -1) {
+      reportProcessError(
+          "stdout does not contain \""
+              + END_MARKER
+              + " after "
+              + BEGIN_MARKER
+              + ".\nstdout:\n"
+              + stdout);
+    }
+    return stdout.substring(begin, end);
+  }
+
+  private String processChart() throws Exception {
+    ProcessBuilder pb = new ProcessBuilder(createCommandLine());
+    Process p = pb.start();
+    p.waitFor();
+    String stdout = read(p.getInputStream());
+    if (p.exitValue() != 0) {
+      String stderr = read(p.getErrorStream());
+      reportProcessError(
+          "Non-zero exit value.\nexit value: "
+              + p.exitValue()
+              + "\nstdout:\n"
+              + stdout
+              + "\nstderr:\n"
+              + stderr);
+    }
+    return stdout;
+  }
+
+  private void reportProcessError(String msg) throws Exception {
+    String cmd = String.join(" ", createCommandLine());
+    throw new Exception(cmd + ": " + msg);
+  }
+
+  private String read(InputStream is) throws Exception {
+    return new BufferedReader(new InputStreamReader(is)).lines().collect(Collectors.joining("\n"));
+  }
+
+  private String[] createCommandLine() throws Exception {
+    File chartDir = getChartDir(this.chartName);
+    return new String[] {"helm", "template", chartDir.getAbsolutePath(), "--debug"};
+  }
+
+  private File getChartDir(String chartName) throws Exception {
+    return new File(getChartsParentDir(), chartName);
+  }
+
+  private File getChartsParentDir() throws Exception {
+    return new File(PathUtils.getModuleDir(getClass()), "charts");
+  }
+}