Merge pull request #351 from oracle/apache_config_validation

Issue#330: Add validation for Apache loadBalancerVolumePath

Author: rjeberhard

kubernetes/create-weblogic-domain-inputs.yaml

@@ -102,10 +102,13 @@ loadBalancer: TRAEFIK
 # This defines the /location in the built-in Apache plugin configuration module for WebLogic
 loadBalancerAppPrepath: /
 
-# Docker volume path for APACHE. By default, it is empty, which causes the volume mount be 
-# disabled and, thereforem the built-in Apache plugin config be used.
-# Use this to provide your own Apache plugin configuration as needed; simply define this 
-# path and put your own custom_mod_wl_apache.conf file under this path.
+# Docker volume path for APACHE.
+# By default, the path is empty, and therefore, the built-in default Apache plugin
+# configuration is used.
+# Use this to provide your own Apache plugin configuration as needed; simply define
+# this path and put your own custom_mod_wl_apache.conf file under this path.
+# If specified path does not exist, or customer_mod_wl_apache.conf file is missing 
+# under the specified path, the create domain script will fail with a validation error.
 loadBalancerVolumePath:
 
 # Boolean to indicate if the admin port is going to be exposed for APACHE. By default, it is false.

kubernetes/internal/create-weblogic-domain.sh

@@ -604,11 +604,20 @@ function createYamlFiles {
       enableLoadBalancerExposeAdminPortPrefix="${disabledPrefix}"
     fi
 
+    enableLoadBalancerVolumePathPrefix="${disabledPrefix}"
+    apacheConfigFileName="custom_mod_wl_apache.conf"
     if [ ! -z "${loadBalancerVolumePath}" ]; then
-      enableLoadBalancerVolumePathPrefix="${enabledPrefix}"
-      sed -i -e "s:%LOAD_BALANCER_VOLUME_PATH%:${loadBalancerVolumePath}:g" ${apacheOutput}
-    else
-      enableLoadBalancerVolumePathPrefix="${disabledPrefix}"
+      if [ ! -d ${loadBalancerVolumePath} ]; then
+        echo -e "\nERROR - The specified loadBalancerVolumePath $loadBalancerVolumePath does not exist! \n"
+        fail "Exiting due to a validation error"
+      elif [ ! -f ${loadBalancerVolumePath}/${apacheConfigFileName} ]; then
+        echo -e "\nERROR - The required file ${apacheConfigFileName} does not exist under the specified loadBalancerVolumePath $loadBalancerVolumePath! \n"
+        fail "Exiting due to a validation error"
+      else
+        enableLoadBalancerVolumePathPrefix="${enabledPrefix}"
+        sed -i -e "s:%LOAD_BALANCER_VOLUME_PATH%:${loadBalancerVolumePath}:g" ${apacheOutput}
+
+      fi
     fi
 
     sed -i -e "s:%ENABLE_LOAD_BALANCER_EXPOSE_ADMIN_PORT%:${enableLoadBalancerExposeAdminPortPrefix}:g" ${apacheOutput}

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

@@ -58,6 +58,7 @@ public class CreateDomainInputsValidationTest {
   private static final String PARAM_LOAD_BALANCER = "loadBalancer";
   private static final String PARAM_LOAD_BALANCER_WEB_PORT = "loadBalancerWebPort";
   private static final String PARAM_LOAD_BALANCER_DASHBOARD_PORT = "loadBalancerDashboardPort";
+  private static final String PARAM_LOAD_BALANCER_VOLUME_PATH = "loadBalancerVolumePath";
   private static final String PARAM_JAVA_OPTIONS = "javaOptions";
   private static final String PARAM_VERSION = "version";
 
@@ -554,6 +555,26 @@ public void createDomain_with_invalidLoadBalancerDashboardPort_failsAndReturnsEr
         failsAndPrints(invalidIntegerParamValueError(PARAM_LOAD_BALANCER_DASHBOARD_PORT, val)));
   }
 
+  @Test
+  public void createDomain_with_invalidLoadBalancerVolumePath_failsAndReturnsError()
+      throws Exception {
+    String val = "invalid-load-balancer-volume-path";
+    assertThat(
+        execCreateDomain(
+            newInputs().loadBalancer(LOAD_BALANCER_APACHE).loadBalancerVolumePath(val)),
+        failsAndPrints(missingDirectoryError(PARAM_LOAD_BALANCER_VOLUME_PATH, val)));
+  }
+
+  public void createDomain_with_invalidLoadBalancerVolumePath_missingFile_failsAndReturnsError()
+      throws Exception {
+    String val = "/";
+    assertThat(
+        execCreateDomain(
+            newInputs().loadBalancer(LOAD_BALANCER_APACHE).loadBalancerVolumePath(val)),
+        failsAndPrints(
+            missingFileError(PARAM_LOAD_BALANCER_VOLUME_PATH, val, "custom-mod-wl-apache.conf")));
+  }
+
   // TBD - shouldn't we allow empty java options?
   @Test
   public void createDomain_with_missingJavaOptions_failsAndReturnsError() throws Exception {
@@ -613,6 +634,14 @@ private String invalidRelatedParamValueError(
     return errorRegexp("Invalid.*" + param + ".*" + val + " with " + param2 + ".*" + val2);
   }
 
+  private String missingDirectoryError(String param, String val) {
+    return errorRegexp(param + ".*" + val + ".*" + "does not exist!");
+  }
+
+  private String missingFileError(String param, String val, String dir) {
+    return errorRegexp(param + ".*" + val + ".*" + "does not exist under" + ".*" + dir + ".*");
+  }
+
   private String paramMissingError(String param) {
     return errorRegexp(param + ".*missing");
   }