Catch up to master, add tests for persistenceType and nfsServer, improve domain input parameter validation

Author: moreaut

kubernetes/create-weblogic-domain-inputs.yaml

@@ -36,6 +36,13 @@ managedServerNameBase: managed-server
 # Port number for each managed server
 managedServerPort: 8001
 
+# Persistent volume type, the value must be hostPath or nfs.
+# If using nfs, nfsServer must be specified.
+persistenceType: hostPath
+
+# NFS server name or ip.  Only used if persistenceType is nfs.
+nfsServer: nfsServer
+
 # Physical path of the persistent volume storage
 persistencePath: /scratch/k8s_dir/persistentVolume001
 

kubernetes/internal/create-weblogic-domain.sh

@@ -129,8 +129,8 @@ function validateClusterName {
 # When the parameter is not specified in the input file, it will default to use the value domainUid
 #
 function validateStorageClass {
-  if [ -z $persistenceStorageClass ]; then
-    persistenceStorageClass=$domainUid
+  if [ -z "${persistenceStorageClass}" ]; then
+    persistenceStorageClass=${domainUid}
     echo Defaulting the input parameter persistenceStorageClass to be $domainUid
   else
     validateLowerCase "persistenceStorageClass" ${persistenceStorageClass}
@@ -141,25 +141,51 @@ function validateStorageClass {
 # Function to validate the persistent volume claim name
 #
 function validatePersistentVolumeClaimName {
-  validateLowerCase "persistenceVolumeClaimName" ${persistenceVolumeClaimName}
-
-  if [[ ${persistenceVolumeClaimName} != ${domainUid}-* ]] ; then
-    echo persistenceVolumeClaimName specified does not starts with \'${domainUid}-\', appending it
-    persistenceVolumeClaimName=${domainUid}-${persistenceVolumeClaimName}
-    echo persistenceVolumeClaimName is now ${persistenceVolumeClaimName}
+  validateInputParamsSpecified persistenceVolumeClaimName
+  if [ ! -z "${persistenceVolumeClaimName}" ]; then
+    validateLowerCase "persistenceVolumeClaimName" ${persistenceVolumeClaimName}
+    if [[ "${persistenceVolumeClaimName}" != ${domainUid}-* ]] ; then
+      echo persistenceVolumeClaimName specified does not starts with \'${domainUid}-\', appending it
+      persistenceVolumeClaimName=${domainUid}-${persistenceVolumeClaimName}
+      echo persistenceVolumeClaimName is now ${persistenceVolumeClaimName}
+    fi
   fi
 }
 
 #
 # Function to validate the persistent volume name
 #
-function validatePersistenVolumeName {
-  validateLowerCase "persistenceVolumeName" ${persistenceVolumeName}
+function validatePersistentVolumeName {
+  validateInputParamsSpecified persistenceVolumeName
+  if [ ! -z "${persistenceVolumeName}" ]; then
+    validateLowerCase "persistenceVolumeName" ${persistenceVolumeName}
+    if [[ "${persistenceVolumeName}" != ${domainUid}-* ]] ; then
+      echo persistenceVolumeName specified does not starts with \'${domainUid}-\', appending it
+      persistenceVolumeName=${domainUid}-${persistenceVolumeName}
+      echo persistenceVolumeName is now ${persistenceVolumeName}
+    fi
+  fi
+}
 
-  if [[ ${persistenceVolumeName} != ${domainUid}-* ]] ; then
-    echo persistenceVolumeName specified does not starts with \'${domainUid}-\', appending it
-    persistenceVolumeName=${domainUid}-${persistenceVolumeName}
-    echo persistenceVolumeName is now ${persistenceVolumeName}
+#
+# Function to validate the persistence type
+#
+function validatePersistenceType {
+  validateInputParamsSpecified persistenceType
+  if [ ! -z "${persistenceType}" ]; then
+    PERSISTENCE_TYPE_HOST_PATH="hostPath"
+    PERSISTENCE_TYPE_NFS="nfs"
+    case ${persistenceType} in
+      ${PERSISTENCE_TYPE_HOST_PATH})
+      ;;
+      ${PERSISTENCE_TYPE_NFS})
+        validateInputParamsSpecified nfsServer
+      ;;
+      *)
+        validationError "Invalid value for persistenceType: ${persistenceType}. Valid values are hostPath and nfs."
+        validationError "Invalid value for loadBalancer: ${loadBalancer}. Valid values are traefik and none."
+      ;;
+    esac
   fi
 }
 
@@ -174,18 +200,20 @@ function validateSecretName {
 # Function to validate the load balancer value
 #
 function validateLoadBalancer {
-  LOAD_BALANCER_TRAEFIK="traefik"
-  LOAD_BALANCER_NONE="none"
-
-  case ${loadBalancer} in
-    ${LOAD_BALANCER_TRAEFIK})
-    ;;
-    ${LOAD_BALANCER_NONE})
-    ;;
-    *)
-      validationError "Invalid valid for loadBalancer: ${loadBalancer}. Valid values are traefik and none."
-    ;;
-  esac
+  validateInputParamsSpecified loadBalancer
+  if [ ! -z "${loadBalancer}" ]; then
+    LOAD_BALANCER_TRAEFIK="traefik"
+    LOAD_BALANCER_NONE="none"
+    case ${loadBalancer} in
+      ${LOAD_BALANCER_TRAEFIK})
+      ;;
+      ${LOAD_BALANCER_NONE})
+      ;;
+      *)
+        validationError "Invalid value for loadBalancer: ${loadBalancer}. Valid values are traefik and none."
+      ;;
+    esac
+  fi
 }
 
 #
@@ -231,7 +259,6 @@ function validateImagePullSecretName {
 # Function to validate the image pull secret exists
 #
 function validateImagePullSecret {
-
   # The kubernetes secret for pulling images from the docker store is optional.
   # If it was specified, make sure it exists.
   validateSecretExists ${imagePullSecretName} ${namespace}
@@ -242,27 +269,29 @@ function validateImagePullSecret {
 # Function to validate the server startup control value
 #
 function validateStartupControl {
-  STARTUP_CONTROL_NONE="NONE"
-  STARTUP_CONTROL_ALL="ALL"
-  STARTUP_CONTROL_ADMIN="ADMIN"
-  STARTUP_CONTROL_SPECIFIED="SPECIFIED"
-  STARTUP_CONTROL_AUTO="AUTO"
-
-  case ${startupControl} in
-    ${STARTUP_CONTROL_NONE})
-    ;;
-    ${STARTUP_CONTROL_ALL})
-    ;;
-    ${STARTUP_CONTROL_ADMIN})
-    ;;
-    ${STARTUP_CONTROL_SPECIFIED})
-    ;;
-    ${STARTUP_CONTROL_AUTO})
-    ;;
-    *)
-      validationError "Invalid valid for startupControl: ${startupControl}. Valid values are 'NONE', 'ALL', 'ADMIN', 'SPECIFIED', and 'AUTO'."
-    ;;
-  esac
+  validateInputParamsSpecified startupControl
+  if [ ! -z "${startupControl}" ]; then
+    STARTUP_CONTROL_NONE="NONE"
+    STARTUP_CONTROL_ALL="ALL"
+    STARTUP_CONTROL_ADMIN="ADMIN"
+    STARTUP_CONTROL_SPECIFIED="SPECIFIED"
+    STARTUP_CONTROL_AUTO="AUTO"
+    case ${startupControl} in
+      ${STARTUP_CONTROL_NONE})
+      ;;
+      ${STARTUP_CONTROL_ALL})
+      ;;
+      ${STARTUP_CONTROL_ADMIN})
+      ;;
+      ${STARTUP_CONTROL_SPECIFIED})
+      ;;
+      ${STARTUP_CONTROL_AUTO})
+      ;;
+      *)
+        validationError "Invalid valid for startupControl: ${startupControl}. Valid values are 'NONE', 'ALL', 'ADMIN', 'SPECIFIED', and 'AUTO'."
+      ;;
+    esac
+  fi
 }
 
 #
@@ -334,13 +363,11 @@ function initialize {
     managedServerNameBase \
     persistencePath \
     persistenceSize \
-    persistenceVolumeClaimName \
     persistenceVolumeName \
+    persistenceVolumeClaimName \
     secretName \
     namespace \
-    loadBalancer \
     javaOptions \
-    startupControl \
     t3PublicAddress
 
   validateIntegerInputParamsSpecified \
@@ -362,7 +389,8 @@ function initialize {
   validateNamespace
   validateClusterName
   validateStorageClass
-  validatePersistenVolumeName
+  validatePersistenceType
+  validatePersistentVolumeName
   validatePersistentVolumeClaimName
   validateSecretName
   validateImagePullSecretName
@@ -398,12 +426,23 @@ function createYamlFiles {
   echo Generating ${domainPVOutput}
 
   cp ${domainPVInput} ${domainPVOutput}
+  if [ "${persistenceType}" == "nfs" ]; then
+    hostPathPrefix="${disabledPrefix}"
+    nfsPrefix="${enabledPrefix}"
+    sed -i -e "s:%NFS_SERVER%:${nfsServer}:g" ${domainPVOutput}
+  else
+    hostPathPrefix="${enabledPrefix}"
+    nfsPrefix="${disabledPrefix}"
+  fi
+
   sed -i -e "s:%DOMAIN_UID%:${domainUid}:g" ${domainPVOutput}
   sed -i -e "s:%NAMESPACE%:$namespace:g" ${domainPVOutput}
   sed -i -e "s:%PERSISTENT_VOLUME%:${persistenceVolumeName}:g" ${domainPVOutput}
   sed -i -e "s:%PERSISTENT_VOLUME_PATH%:${persistencePath}:g" ${domainPVOutput}
   sed -i -e "s:%PERSISTENT_VOLUME_SIZE%:${persistenceSize}:g" ${domainPVOutput}
   sed -i -e "s:%STORAGE_CLASS_NAME%:${persistenceStorageClass}:g" ${domainPVOutput}
+  sed -i -e "s:%HOST_PATH_PREFIX%:${hostPathPrefix}:g" ${domainPVOutput}
+  sed -i -e "s:%NFS_PREFIX%:${nfsPrefix}:g" ${domainPVOutput}
 
   # Generate the yaml to create the persistent volume claim
   echo Generating ${domainPVCOutput}

kubernetes/internal/create-weblogic-operator.sh

@@ -161,7 +161,7 @@ function initAndValidateOutputDir {
 # Function to validate the image pull secret name
 #
 function validateImagePullSecretName {
-  if [ ! -z ${imagePullSecretName} ]; then
+  if [ ! -z "${imagePullSecretName}" ]; then
     validateLowerCase imagePullSecretName ${imagePullSecretName}
     imagePullSecretPrefix=""
     validateImagePullSecret

kubernetes/internal/weblogic-domain-persistent-volume-template.yaml

@@ -14,5 +14,7 @@ spec:
   accessModes:
     - ReadWriteMany
   persistentVolumeReclaimPolicy: Retain
-  hostPath:
+  %HOST_PATH_PREFIX%hostPath:
+  %NFS_PREFIX%nfs:
+    %NFS_PREFIX%server: %NFS_SERVER%
     path: "%PERSISTENT_VOLUME_PATH%"

src/integration-tests/bash/run.sh

@@ -885,6 +885,24 @@ function get_cluster_replicas {
     echo $replicas
 }
 
+function get_startup_control {
+    if [ "$#" != 1 ] ; then
+      fail "requires 1 parameter: domainkey"
+    fi
+
+    local NAMESPACE="`dom_get $1 NAMESPACE`"
+    local DOMAIN_UID="`dom_get $1 DOMAIN_UID`"
+
+    local startup_control_cmd="kubectl get domain $DOMAIN_UID -n $NAMESPACE -o jsonpath='{.spec.startupControl}'"
+    local startup_control=`eval $startup_control_cmd`
+
+    if [ -z ${startup_control} ]; then
+      fail "startupControl not found in domain $DOMAIN_UID"
+    fi
+
+    echo $startup_control
+}
+
 function verify_managed_servers_ready {
     if [ "$#" != 1 ] ; then
       fail "requires 1 parameter: domainkey"
@@ -1888,7 +1906,6 @@ function verify_domain_created {
 
     local NAMESPACE="`dom_get $1 NAMESPACE`"
     local DOMAIN_UID="`dom_get $1 DOMAIN_UID`"
-    local STARTUP_CONTROL="`dom_get $1 STARTUP_CONTROL`"
     local MS_BASE_NAME="`dom_get $1 MS_BASE_NAME`"
 
     trace "verify domain $DOMAIN_UID in $NAMESPACE namespace"
@@ -1908,8 +1925,10 @@ function verify_domain_created {
     trace "verify the service and pod of admin server"
     verify_service_and_pod_created $DOM_KEY 0
 
+    local startup_control=`get_startup_control $DOM_KEY`
+
     local verify_as_only=false
-    if [ "$STARTUP_CONTROL" = "ADMIN" ] ; then
+    if [ "${startup_control}" = "ADMIN" ] ; then
       verify_as_only=true
     fi
 
@@ -2218,6 +2237,22 @@ function test_operator_lifecycle {
     declare_test_pass
 }
 
+function test_create_domain_startup_control_admin {
+    declare_new_test 1 "$@"
+
+    if [ "$#" != 1 ] ; then
+      fail "requires 1 parameters: domainKey"
+    fi
+
+    local DOM_KEY=${1}
+    local DOMAIN_UID="`dom_get $1 DOMAIN_UID`"
+
+    run_create_domain_job $DOMAIN_UID
+    verify_domain_created $DOMAIN_UID
+
+    declare_test_pass
+}
+
 # scale domain $1 up and down, and optionally verify the scaling had no effect on domain $2
 function test_cluster_scale {
     declare_new_test 1 "$@"
@@ -2557,8 +2592,7 @@ function test_suite {
       test_domain_lifecycle domain1 domain4 
 
       # create another domain in the default namespace with startupControl="ADMIN", and verify that only admin server is created
-      run_create_domain_job domain5
-      verify_domain_created domain5
+      test_create_domain_startup_control_admin domain5
 
       # test managed server 1 pod auto-restart
       test_wls_liveness_probe domain1

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

@@ -8,6 +8,7 @@
 
 import io.kubernetes.client.models.V1ConfigMap;
 import io.kubernetes.client.models.V1Job;
+import io.kubernetes.client.models.V1PersistentVolume;
 import static oracle.kubernetes.operator.create.KubernetesArtifactUtils.*;
 import static oracle.kubernetes.operator.create.YamlUtils.*;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -377,20 +378,14 @@ public void generatesCorrect_traefikSecurityYaml_traefikDashboardClusterRoleBind
 
   @Test
   public void generatesCorrect_weblogicDomainPersistentVolumeYaml_weblogicDomainPersistentVolume() throws Exception {
+    V1PersistentVolume want =
+      generatedFiles.getWeblogicDomainPersistentVolumeYaml().getExpectedBaseCreateWeblogicDomainPersistentVolume();
+    want.getSpec()
+      .hostPath(newHostPathVolumeSource()
+        .path(inputs.getPersistencePath()));
     assertThat(
       generatedFiles.getWeblogicDomainPersistentVolumeYaml().getWeblogicDomainPersistentVolume(),
-      yamlEqualTo(
-        newPersistentVolume()
-          .metadata(newObjectMeta()
-            .name(getDomainScope() + "-" + inputs.getPersistenceVolumeName())
-            .putLabelsItem("weblogic.domainUID", inputs.getDomainUid()))
-          .spec(newPersistentVolumeSpec()
-            .storageClassName(inputs.getDomainUid())
-            .putCapacityItem("storage", inputs.getPersistenceSize())
-            .addAccessModesItem("ReadWriteMany")
-            .persistentVolumeReclaimPolicy("Retain")
-            .hostPath(newHostPathVolumeSource()
-              .path(inputs.getPersistencePath())))));
+      yamlEqualTo(want));
   }
 
   @Test
@@ -400,7 +395,7 @@ public void generatesCorrect_weblogicDomainPersistentVolumeClaimYaml_weblogicDom
       yamlEqualTo(
         newPersistentVolumeClaim()
           .metadata(newObjectMeta()
-            .name(getDomainScope() + "-" + inputs.getPersistenceVolumeClaimName())
+            .name(inputs.getDomainUid() + "-" + inputs.getPersistenceVolumeClaimName())
             .namespace(inputs.getNamespace())
             .putLabelsItem("weblogic.domainUID", inputs.getDomainUid()))
           .spec(newPersistentVolumeClaimSpec()
@@ -415,11 +410,7 @@ private String getTraefikScope() {
   }
 
   private String getClusterLCScope() {
-    return getDomainScope() + "-" + getClusterNameLC();
-  }
-
-  public String getDomainScope() {
-    return inputs.getDomainUid();
+    return inputs.getDomainUid() + "-" + getClusterNameLC();
   }
 
   private String getClusterNameLC() {