Don't copy the inputs file to the output directory if the output directory already has a copy (add corresponding unit tests to)

Author: moreaut

kubernetes/internal/create-weblogic-domain.sh

@@ -350,8 +350,12 @@ function createYamlFiles {
   # Create a directory for this domain's output files
   mkdir -p ${domainOutputDir}
 
-  # Save a copy of the inputs yaml file there
-  cp ${valuesInputFile} "${domainOutputDir}/create-weblogic-domain-inputs.yaml"
+  # Make sure the output directory has a copy of the inputs file.
+  # The user can either pre-create the output directory, put the inputs
+  # file there, and create the domain from it, or the user can put the
+  # inputs file some place else and let this script create the output directory
+  # (if needed) and copy the inputs file there.
+  copyInputsFileToOutputDirectory ${valuesInputFile} "${domainOutputDir}/create-weblogic-domain-inputs.yaml"
 
   domainPVOutput="${domainOutputDir}/weblogic-domain-persistent-volume.yaml"
   domainPVCOutput="${domainOutputDir}/weblogic-domain-persistent-volume-claim.yaml"

kubernetes/internal/create-weblogic-operator.sh

@@ -349,8 +349,12 @@ function createYamlFiles {
   # Create a directory for this operator's output files
   mkdir -p ${oprOutputDir}
 
-  # Save a copy of the inputs yaml file there
-  cp ${valuesInputFile} "${oprOutputDir}/create-weblogic-operator-inputs.yaml"
+  # Make sure the output directory has a copy of the inputs file.
+  # The user can either pre-create the output directory, put the inputs
+  # file there, and create the operator from it, or the user can put the
+  # inputs file some place else and let this script create the output directory
+  # (if needed) and copy the inputs file there.
+  copyInputsFileToOutputDirectory ${valuesInputFile} "${oprOutputDir}/create-weblogic-operator-inputs.yaml"
 
   # Generate the yaml to create the WebLogic operator
   oprOutput="${oprOutputDir}/weblogic-operator.yaml"

kubernetes/internal/utility.sh

@@ -293,3 +293,24 @@ function internalValidateGeneratedYamlFilesDoNotExist {
   done
 }
 
+# Copy the inputs file from the command line into the output directory
+# for the domain/operator unless the output directory already has an
+# inputs file and the file is the same as the one from the commandline.
+# $1 the inputs file from the command line
+# $2 the file in the output directory that needs to be made the same as $1
+function copyInputsFileToOutputDirectory {
+  local from=$1
+  local to=$2
+  local doCopy="true"
+  if [ -f "${to}" ]; then
+    local difference=`diff ${from} ${to}`
+    if [ -z "${difference}" ]; then
+      # the output file already exists and is the same as the inputs file.
+      # don't make a copy.
+      doCopy="false"
+    fi
+  fi
+  if [ "${doCopy}" = "true" ]; then
+    cp ${from} ${to}
+  fi
+}

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

@@ -78,7 +78,30 @@ public void createDomainWithCompletedDefaultsInputsFile_usesSpecifiedInputsFileA
        .domainUID("test-domain-uid")
        .weblogicDomainStoragePath("/scratch/k8s_dir/domain1");
     assertThat(execCreateDomain(userProjects.getPath(), inputs), succeedsAndPrints("Completed"));
+    assertThatOnlyTheExpectedGeneratedYamlFilesExist(inputs);
+  }
+
+  @Test
+  public void createDomainFromPreCreatedInputsFileInPreCreatedOutputDirectory_usesSpecifiedInputsFileAndSucceedsAndGeneratesExpectedYamlFiles() throws Exception {
+    // customize the domain uid and weblogic storage path so that we have a valid inputs file
+    CreateDomainInputs inputs =
+     readDefaultInputsFile()
+       .domainUID("test-domain-uid")
+       .weblogicDomainStoragePath("/scratch/k8s_dir/domain1");
+    // pre-create the output directory and the inputs file in the output directory, then
+    // use that inputs file to create the domain
+    DomainFiles domainFiles = new DomainFiles(userProjects.getPath(), inputs);
+    Files.createDirectories(domainFiles.getWeblogicDomainPath());
+    assertThat(
+      execCreateDomain(
+        userProjects.getPath(),
+        inputs,
+        domainFiles.getCreateWeblogicDomainInputsYamlPath()),
+      succeedsAndPrints("Completed"));
+    assertThatOnlyTheExpectedGeneratedYamlFilesExist(inputs);
+  }
 
+  private void assertThatOnlyTheExpectedGeneratedYamlFilesExist(CreateDomainInputs inputs) throws Exception {
     // Make sure the generated directory has the correct list of files
     DomainFiles domainFiles = new DomainFiles(userProjects.getPath(), inputs);
     List<Path> expectedFiles = domainFiles.getExpectedContents(true); // include the directory too

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

@@ -77,6 +77,24 @@ public void createOperatorWithSpecifiedInputsFile_usesSpecifiedInputsFileAndSucc
     assertThatOnlyTheExpectedGeneratedYamlFilesExist(inputs);
   }
 
+
+  @Test
+  public void createDomainFromPreCreatedInputsFileInPreCreatedOutputDirectory_usesSpecifiedInputsFileAndSucceedsAndGeneratesExpectedYamlFiles() throws Exception {
+    // customize the namespace name so that we can tell that it generated the yaml files based on this inputs instead of the default one
+    CreateOperatorInputs inputs = readDefaultInputsFile().namespace("weblogic-operator-2");
+    // pre-create the output directory and the inputs file in the output directory, then
+    // use that inputs file to create the operator
+    OperatorFiles operatorFiles = new OperatorFiles(userProjects.getPath(), inputs);
+    Files.createDirectories(operatorFiles.getWeblogicOperatorPath());
+    assertThat(
+      execCreateOperator(
+        userProjects.getPath(),
+        inputs,
+        operatorFiles.getCreateWeblogicOperatorInputsYamlPath()),
+      succeedsAndPrints("Completed"));
+    assertThatOnlyTheExpectedGeneratedYamlFilesExist(inputs);
+  }
+
   private void assertThatOnlyTheExpectedGeneratedYamlFilesExist(CreateOperatorInputs inputs) throws Exception {
     // Make sure the generated directory has the correct list of files
     OperatorFiles operatorFiles = new OperatorFiles(userProjects.getPath(), inputs);

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

@@ -14,9 +14,12 @@ public class ExecCreateDomain {
   public static final String CREATE_SCRIPT = "src/test/scripts/unit-test-create-weblogic-domain.sh";
 
   public static ExecResult execCreateDomain(Path userProjectsPath, CreateDomainInputs inputs) throws Exception {
-    Path p = getInputsYamlPath(userProjectsPath);
-    newYaml().dump(inputs, Files.newBufferedWriter(p));
-    return execCreateDomain(" -g -o " + userProjectsPath.toString() + " -i " + p.toString());
+    return execCreateDomain(userProjectsPath, inputs, getInputsYamlPath(userProjectsPath));
+  }
+
+  public static ExecResult execCreateDomain(Path userProjectsPath, CreateDomainInputs inputs, Path inputsYamlPath) throws Exception {
+    newYaml().dump(inputs, Files.newBufferedWriter(inputsYamlPath));
+    return execCreateDomain(" -g -o " + userProjectsPath.toString() + " -i " + inputsYamlPath.toString());
   }
 
   public static ExecResult execCreateDomain(String options) throws Exception {

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

@@ -14,9 +14,12 @@ public class ExecCreateOperator {
   public static final String CREATE_SCRIPT = "src/test/scripts/unit-test-create-weblogic-operator.sh";
 
   public static ExecResult execCreateOperator(Path userProjectsPath, CreateOperatorInputs inputs) throws Exception {
-    Path p = getInputsYamlPath(userProjectsPath);
-    newYaml().dump(inputs, Files.newBufferedWriter(p));
-    return execCreateOperator(" -g -o " + userProjectsPath.toString() + " -i " + p.toString());
+    return execCreateOperator(userProjectsPath, inputs, getInputsYamlPath(userProjectsPath));
+  }
+
+  public static ExecResult execCreateOperator(Path userProjectsPath, CreateOperatorInputs inputs, Path inputsYamlPath) throws Exception {
+    newYaml().dump(inputs, Files.newBufferedWriter(inputsYamlPath));
+    return execCreateOperator(" -g -o " + userProjectsPath.toString() + " -i " + inputsYamlPath.toString());
   }
 
   public static ExecResult execCreateOperator(String options) throws Exception {