Version the input files

Author: moreaut

kubernetes/create-weblogic-domain-inputs.yaml

@@ -1,6 +1,9 @@
 # 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.
 
+# The version of this inputs file.  Do not modify.
+version: create-weblogic-domain-inputs/v1
+
 # Port number for admin server
 adminPort: 7001
 

kubernetes/create-weblogic-operator-inputs.yaml

@@ -1,6 +1,9 @@
 # Copyright 2017, 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.
 
+# The version of this inputs file.  Do not modify.
+version: create-weblogic-operator-inputs/v1
+
 # The name of the service account that the operator will use to
 # make requests to the Kubernetes API server.
 # The name must be lowercase

kubernetes/internal/create-weblogic-domain.sh

@@ -107,6 +107,16 @@ function initAndValidateOutputDir {
     domain-custom-resource.yaml
 }
 
+#
+# Function to validate the version of the inputs file
+#
+function validateVersion {
+  local requiredVersion='create-weblogic-domain-inputs/v1'
+  if [ "${version}" != "${requiredVersion}" ]; then
+    validationError "Invalid version: \"${version}\".  Must be ${requiredVersion}."
+  fi
+}
+
 #
 # Function to ensure the domain uid is lowercase
 #
@@ -376,7 +386,8 @@ function initialize {
     weblogicCredentialsSecretName \
     namespace \
     javaOptions \
-    t3PublicAddress
+    t3PublicAddress \
+    version
 
   validateIntegerInputParamsSpecified \
     adminPort \
@@ -393,6 +404,7 @@ function initialize {
     exposeAdminT3Channel \
     exposeAdminNodePort
 
+  validateVersion
   validateDomainUid
   validateNamespace
   validateClusterName

kubernetes/internal/create-weblogic-operator.sh

@@ -117,10 +117,12 @@ function initialize {
   # Parse the common inputs file
   parseCommonInputs
 
-  validateInputParamsSpecified serviceAccount namespace targetNamespaces weblogicOperatorImage
+  validateInputParamsSpecified version serviceAccount namespace targetNamespaces weblogicOperatorImage
 
   validateBooleanInputParamsSpecified elkIntegrationEnabled
 
+  validateVersion
+
   validateServiceAccount
 
   validateNamespace
@@ -203,6 +205,16 @@ function validateImagePullPolicy {
   fi
 }
 
+#
+# Function to validate the version of the inputs file
+#
+function validateVersion {
+  local requiredVersion='create-weblogic-operator-inputs/v1'
+  if [ "${version}" != "${requiredVersion}" ]; then
+    validationError "Invalid version: \"${version}\".  Must be ${requiredVersion}."
+  fi
+}
+
 #
 # Function to validate the service account is lowercase
 #

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

@@ -76,6 +76,7 @@ public class CreateDomainInputs {
   private String loadBalancerVolumePath = "";
   private String loadBalancerAppPrepath = "";
   private String javaOptions = "";
+  private String version = "";
 
   public static CreateDomainInputs newInputs() throws Exception {
     return
@@ -534,6 +535,19 @@ public CreateDomainInputs javaOptions(String javaOptions) {
     return this;
   }
 
+  public String getVersion() {
+    return version;
+  }
+
+  public void setVersion(String version) {
+    this.version = convertNullToEmptyString(version);
+  }
+
+  public CreateDomainInputs version(String version) {
+    setVersion(version);
+    return this;
+  }
+
   private String convertNullToEmptyString(String val) {
     return Objects.toString(val, "");
   }

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

@@ -48,6 +48,7 @@ public class CreateDomainInputsValidationTest {
   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_JAVA_OPTIONS = "javaOptions";
+  private static final String PARAM_VERSION = "version";
 
   @Before
   public void setup() throws Exception {
@@ -523,6 +524,21 @@ public void createDomain_with_missingJavaOptions_failsAndReturnsError() throws E
       failsAndPrints(paramMissingError(PARAM_JAVA_OPTIONS)));
   }
 
+  @Test
+  public void createDomain_with_missingVersion_failsAndReturnsError() throws Exception {
+    assertThat(
+      execCreateDomain(newInputs().version("")),
+      failsAndPrints(paramMissingError(PARAM_VERSION)));
+  }
+
+  @Test
+  public void createDomainwith_invalidVersion_failsAndReturnsError() throws Exception {
+    String val = "no-such-version";
+    assertThat(
+      execCreateDomain(newInputs().version(val)),
+      failsAndPrints(invalidEnumParamValueError(PARAM_VERSION, val)));
+  }
+
   private void createDomain_with_validStartupControl_succeeds(String startupControl) throws Exception {
     createDomain_with_validInputs_succeeds(newInputs().startupControl(startupControl));
   }

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

@@ -148,6 +148,11 @@ private String internalSans() {
   // Note: don't allow null strings since, if you use snakeyaml to write out the instance
   // to a yaml file, the nulls are written out as "null".  Use "" instead.
 
+  private String version = "";
+  public String getVersion() { return version; }
+  public void setVersion(String val) { version = convertNullToEmptyString(val); }
+  public CreateOperatorInputs version(String val) { setVersion(val); return this; }
+
   private String serviceAccount = "";
   public String getServiceAccount() { return serviceAccount; }
   public void setServiceAccount(String val) { serviceAccount = convertNullToEmptyString(val); }

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

@@ -33,6 +33,7 @@ public void tearDown() throws Exception {
     }
   }
 
+  private static final String PARAM_VERSION = "version";
   private static final String PARAM_SERVICE_ACCOUNT = "serviceAccount";
   private static final String PARAM_NAMESPACE = "namespace";
   private static final String PARAM_TARGET_NAMESPACES = "targetNamespaces";
@@ -50,6 +51,23 @@ public void tearDown() throws Exception {
   private static final String PARAM_JAVA_LOGGING_LEVEL = "javaLoggingLevel";
   private static final String PARAM_ELK_INTEGRATION_ENABLED = "elkIntegrationEnabled";
 
+  private static final String VERSION_V1 = "create-weblogic-operator-inputs/v1";
+
+  @Test
+  public void createOperator_with_missingVersion_failsAndReturnsError() throws Exception {
+    assertThat(
+      execCreateOperator(newInputs().version("")),
+      failsAndPrints(paramMissingError(PARAM_VERSION)));
+  }
+
+  @Test
+  public void createOperator_with_invalidVersion_failsAndReturnsError() throws Exception {
+    String val = "no-such-version";
+    assertThat(
+      execCreateOperator(newInputs().version(val)),
+      failsAndPrints(invalidEnumParamValueError(PARAM_VERSION, val)));
+  }
+
   @Test
   public void createOperator_with_missingServiceAccount_failsAndReturnsError() throws Exception {
     assertThat(