OWLS-67274 (v1.1) - add validation to domainUID, adminServerName, managedServerNameBase and clusterName

Signed-off-by: doxiao <dongbo.xiao@oracle.com>

Author: doxiao

kubernetes/create-weblogic-domain-inputs.yaml

@@ -8,13 +8,14 @@ version: create-weblogic-domain-inputs-v1
 adminPort: 7001
 
 # Name of the Admin Server
+# This name must not contain an underscope ("_"), and must be lowercase. 
 adminServerName: admin-server
 
 # Name of the WebLogic domain to create
 domainName: base_domain
 
-# Unique id identifying a domain.
-# This id must be lowercase and unique across all domains in a Kubernetes cluster.
+# Unique ID identifying a domain. 
+# This ID must not contain an underscope ("_"), and must be lowercase and unique across all domains in a Kubernetes cluster. 
 #domainUID: domain1
 
 # Type of WebLogic Cluster
@@ -26,6 +27,7 @@ clusterType: DYNAMIC
 startupControl: AUTO
 
 # Cluster name
+# This name must not contain an underscope ("_"), and must be lowercase. 
 clusterName: cluster-1
 
 # Number of managed servers to generate for the domain
@@ -35,6 +37,7 @@ configuredManagedServerCount: 2
 initialManagedServerReplicas: 2
 
 # Base string used to generate managed server names
+# This name must not contain an underscope ("_"), and must be lowercase. 
 managedServerNameBase: managed-server
 
 # Port number for each managed server

kubernetes/internal/create-weblogic-domain.sh

@@ -118,10 +118,25 @@ function validateVersion {
 }
 
 #
-# Function to ensure the domain uid is lowercase
+# Function to ensure the domain uid is legal DNS name
 #
 function validateDomainUid {
   validateLowerCase "domainUID" ${domainUID}
+  validateDNS1123LegalName domainUID ${domainUID}
+}
+
+#
+# Function to ensure the adminServerName is legal DNS name
+#
+function validateAdminServerName {
+  validateDNS1123LegalName adminServerName ${adminServerName}
+}
+
+#
+# Function to ensure the managedServerNameBase is legal DNS name
+#
+function validateManagedServerNameBase {
+  validateDNS1123LegalName managedServerNameBase ${managedServerNameBase}
 }
 
 #
@@ -132,10 +147,11 @@ function validateNamespace {
 }
 
 #
-# Create an instance of clusterName to be used in cases where lowercase is required.
+# Function to ensure the clusterName is legal DNS name
 #
 function validateClusterName {
-  clusterNameLC=$(toLower $clusterName)
+  clusterNameLC=$(toDNS1123Legal $clusterName)
+  validateDNS1123LegalName clusterName ${clusterName}
 }
 
 #
@@ -420,6 +436,8 @@ function initialize {
 
   validateVersion
   validateDomainUid
+  validateAdminServerName
+  validateManagedServerNameBase
   validateNamespace
   validateClusterName
   validateWeblogicDomainStorageType

kubernetes/internal/utility.sh

@@ -175,15 +175,35 @@ function toLower {
 
 #
 # Function to check if a value is lowercase
-# $1 - value to check
-# $2 - name of object being checked
+# $1 - name of object being checked
+# $2 - value to check
 function validateLowerCase {
   local lcVal=$(toLower $2)
   if [ "$lcVal" != "$2" ]; then
     validationError "The value of $1 must be lowercase: $2"
   fi
 }
 
+# 
+# Function to lowercase a value and make it a legal DNS1123 name 
+# $1 - value to convert to DNS legal name
+function toDNS1123Legal { 
+  local val=`echo $1 | tr "[:upper:]" "[:lower:]"` 
+  val=${val//"_"/"-"} 
+  echo "$val" 
+}
+
+# 
+# Function to check if a value is lowercase and legal DNS name 
+# $1 - name of object being checked 
+# $2 - value to check 
+function validateDNS1123LegalName { 
+  local val=$(toDNS1123Legal $2) 
+  if [ "$val" != "$2" ]; then 
+    validationError "The value of $1 contains invalid charaters (uppercase letters or "_"): $2" 
+  fi 
+}
+
 #
 # Function to validate the namespace
 #

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

@@ -126,6 +126,14 @@ public void createDomain_with_missingAdminServerName_failsAndReturnsError() thro
         failsAndPrints(paramMissingError(PARAM_ADMIN_SERVER_NAME)));
   }
 
+  @Test
+  public void createDomain_with_invalidAdminServerName() throws Exception {
+    String val = "test_admin_Server";
+    assertThat(
+        execCreateDomain(newInputs().adminServerName(val)),
+        failsAndPrints(paramInvalidError(PARAM_ADMIN_SERVER_NAME, val)));
+  }
+
   @Test
   public void createDomain_with_missingDomainName_failsAndReturnsError() throws Exception {
     assertThat(
@@ -148,6 +156,14 @@ public void createDomain_with_upperCaseDomainUID_failsAndReturnsError() throws E
         failsAndPrints(paramNotLowercaseError(PARAM_DOMAIN_UID, val)));
   }
 
+  @Test
+  public void createDomain_with_invalidDomainUID_failsAndReturnsError() throws Exception {
+    String val = "test_domain_1";
+    assertThat(
+        execCreateDomain(newInputs().domainUID(val)),
+        failsAndPrints(paramInvalidError(PARAM_DOMAIN_UID, val)));
+  }
+
   @Test
   public void createDomain_with_missingStartupControl_failsAndReturnsError() throws Exception {
     assertThat(
@@ -220,6 +236,14 @@ public void createDomain_with_missingClusterName_failsAndReturnsError() throws E
         failsAndPrints(paramMissingError(PARAM_CLUSTER_NAME)));
   }
 
+  @Test
+  public void createDomain_with_invalidClusterName_failsAndReturnsError() throws Exception {
+    String val = "test_Cluster_1";
+    assertThat(
+        execCreateDomain(newInputs().clusterName(val)),
+        failsAndPrints(paramInvalidError(PARAM_CLUSTER_NAME, val)));
+  }
+
   @Test
   public void createDomain_with_missingConfiguredManagedServerCount_failsAndReturnsError()
       throws Exception {
@@ -262,6 +286,15 @@ public void createDomain_with_missingManagedServerNameBase_failsAndReturnsError(
         failsAndPrints(paramMissingError(PARAM_MANAGED_SERVER_NAME_BASE)));
   }
 
+  @Test
+  public void createDomain_with_invalidManagedServerNameBase_failsAndReturnsError()
+      throws Exception {
+    String val = "test_MS";
+    assertThat(
+        execCreateDomain(newInputs().managedServerNameBase(val)),
+        failsAndPrints(paramInvalidError(PARAM_MANAGED_SERVER_NAME_BASE, val)));
+  }
+
   @Test
   public void createDomain_with_missingManagedServerPort_failsAndReturnsError() throws Exception {
     assertThat(
@@ -638,6 +671,10 @@ private String invalidEnumParamValueError(String param, String val) {
     return errorRegexp("Invalid.*" + param + ".*" + val);
   }
 
+  private String paramInvalidError(String param, String val) {
+    return errorRegexp(param + ".*invalid");
+  }
+
   @SuppressWarnings("SameParameterValue")
   private String invalidRelatedParamValueError(
       String param, String val, String param2, String val2) {

kubernetes/src/test/java/oracle/kubernetes/operator/utils/DomainValues.java

@@ -92,8 +92,8 @@ protected String convertNullToEmptyString(String val) {
   public DomainValues withTestDefaults() {
     return this.adminNodePort("30702")
         .adminPort("7002")
-        .adminServerName("TestAdminServer")
-        .clusterName("TestCluster")
+        .adminServerName("test-admin-server")
+        .clusterName("test-cluster")
         .clusterType(CLUSTER_TYPE_DYNAMIC)
         .domainName("TestDomain")
         .weblogicImage("store/oracle/weblogic:12.2.1.3")
@@ -102,7 +102,7 @@ public DomainValues withTestDefaults() {
         .loadBalancerDashboardPort("31315")
         .loadBalancerWebPort("31305")
         .configuredManagedServerCount("4")
-        .managedServerNameBase("TestManagedServer")
+        .managedServerNameBase("test-managed-server")
         .managedServerPort("8002")
         .initialManagedServerReplicas("3")
         .weblogicDomainStorageNFSServer("TestDomainStorageNFSServer")