From 7ca6723b4d88dca4a7df297daa59bf53a20e7dbc Mon Sep 17 00:00:00 2001
From: ansgarz <ansgar.zwick@meissa-gmbh.de>
Date: Sat, 14 May 2022 12:25:32 +0200
Subject: [PATCH] createFile also creates a potentially missing directory,
 dependent on parameter createDirIfMissing

---
 .run/test.run.xml                             |  2 +-
 .../framework/core/platforms/UbuntuProv.kt    | 15 +++---
 .../ubuntu/filesystem/base/Filesystem.kt      | 23 ++++-----
 .../filesystem/base/FilesystemKtTest.kt       | 48 ++++++++++++++++++-
 4 files changed, 64 insertions(+), 24 deletions(-)

diff --git a/.run/test.run.xml b/.run/test.run.xml
index f92dc9f..9fcbb78 100644
--- a/.run/test.run.xml
+++ b/.run/test.run.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="test" type="JUnit" factoryName="JUnit">
+  <configuration default="false" name="testquick" type="JUnit" factoryName="JUnit">
     <module name="provs.test" />
     <option name="PACKAGE_NAME" value="org" />
     <option name="MAIN_CLASS_NAME" value="" />
diff --git a/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/core/platforms/UbuntuProv.kt b/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/core/platforms/UbuntuProv.kt
index 9c6995e..254e333 100644
--- a/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/core/platforms/UbuntuProv.kt
+++ b/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/core/platforms/UbuntuProv.kt
@@ -1,9 +1,6 @@
 package org.domaindrivenarchitecture.provs.framework.core.platforms
 
-import org.domaindrivenarchitecture.provs.framework.core.ProgressType
-import org.domaindrivenarchitecture.provs.framework.core.Prov
-import org.domaindrivenarchitecture.provs.framework.core.ProvResult
-import org.domaindrivenarchitecture.provs.framework.core.escapeAndEncloseByDoubleQuoteForShell
+import org.domaindrivenarchitecture.provs.framework.core.*
 import org.domaindrivenarchitecture.provs.framework.core.processors.LocalProcessor
 import org.domaindrivenarchitecture.provs.framework.core.processors.Processor
 
@@ -52,9 +49,13 @@ class UbuntuProv internal constructor(
 
 private fun commandWithDirAndSudo(cmd: String, dir: String?, sudo: Boolean): String {
     val cmdWithDir = if (dir == null) cmd else "cd $dir && $cmd"
-    return if (sudo) cmdWithDir.sudoize() else cmdWithDir
+    return if (sudo) cmdWithDir.sudoizeCommand() else cmdWithDir
 }
 
-private fun String.sudoize(): String {
-    return "sudo " + SHELL + " -c " + this.escapeAndEncloseByDoubleQuoteForShell()
+/**
+ * Returns a command encapsulated in a shell command and executed with sudo.
+ * For simple cases consider using sudo as prefix if the command instead.
+ */
+internal fun String.sudoizeCommand(): String {
+    return "sudo -E " + SHELL + " -c " + this.escapeAndEncloseByDoubleQuoteForShell()
 }
\ No newline at end of file
diff --git a/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/Filesystem.kt b/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/Filesystem.kt
index c0bd5a6..6024256 100644
--- a/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/Filesystem.kt
+++ b/src/main/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/Filesystem.kt
@@ -1,8 +1,7 @@
 package org.domaindrivenarchitecture.provs.framework.ubuntu.filesystem.base
 
-import org.domaindrivenarchitecture.provs.framework.core.platforms.SHELL
 import org.domaindrivenarchitecture.provs.framework.core.*
-import org.domaindrivenarchitecture.provs.framework.core.getLocalFileContent
+import org.domaindrivenarchitecture.provs.framework.core.platforms.sudoizeCommand
 import java.io.File
 import java.util.*
 
@@ -89,10 +88,17 @@ fun Prov.createFile(
     text: String?,
     posixFilePermission: String? = null,
     sudo: Boolean = false,
-    overwriteIfExisting: Boolean = true
+    overwriteIfExisting: Boolean = true,
+    createDirIfMissing: Boolean = true,
 ): ProvResult = taskWithResult {
     val maxBlockSize = 50000
     val withSudo = if (sudo) "sudo " else ""
+    val file = File(fullyQualifiedFilename)
+    val dir = file.parent?.toString()
+
+    if (dir != null && dir != "" && createDirIfMissing && !checkDir(dir, sudo = sudo)) {
+        createDirs(dir, sudo = sudo)
+    }
 
     posixFilePermission?.let {
         ensureValidPosixFilePermission(posixFilePermission)
@@ -358,17 +364,6 @@ private fun ensureValidPosixFilePermission(posixFilePermission: String) {
     if (!Regex("^[0-7]{3}$").matches(posixFilePermission)) throw IllegalArgumentException("Wrong file permission ($posixFilePermission), permission must consist of 3 digits as e.g. 664")
 }
 
-
-/**
- * Returns a command encapsulated in a shell command and executed with sudo.
- * For simple cases consider sudo as prefix instead.
- * @see prefixWithSudo
- */
-private fun String.sudoizeCommand(): String {
-    return "sudo " + SHELL + " -c " + this.escapeAndEncloseByDoubleQuoteForShell()
-}
-
-
 /**
  * Returns path with a trailing fileSeparator if path not empty
  */
diff --git a/src/test/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/FilesystemKtTest.kt b/src/test/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/FilesystemKtTest.kt
index e43e14f..107eaa1 100644
--- a/src/test/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/FilesystemKtTest.kt
+++ b/src/test/kotlin/org/domaindrivenarchitecture/provs/framework/ubuntu/filesystem/base/FilesystemKtTest.kt
@@ -23,7 +23,7 @@ internal class FilesystemKtTest {
         prov.createDir("tmp")
 
         // when
-        val filename = "tmp/testfile9"
+        val filename = "tmp/provstestfile123"
         val res2 = prov.createFile(filename, testtext)
         val textFromFile = prov.fileContent(filename)
         prov.deleteFile(filename)
@@ -35,7 +35,7 @@ internal class FilesystemKtTest {
 
     @Test
     @ContainerTest
-    fun createFile_in_container() {
+    fun createFile_successfully() {
         // given
         val prov = defaultTestContainer()
         val filename = "testfile8"
@@ -51,6 +51,50 @@ internal class FilesystemKtTest {
         assertEquals(testtext, prov.fileContent("sudo$filename"))
     }
 
+    @Test
+    @ContainerTest
+    fun createFile_with_dir_successfully() {
+        // given
+        val prov = defaultTestContainer()
+        val filename = "dir1/dir2/testfile-with-dir"
+
+        // when
+        val res1 = prov.createFile(filename, testtext)
+        val res2 = prov.createFile("sudo$filename", testtext, sudo = true)
+        // check idempotence
+        val res1b = prov.createFile(filename, testtext)
+        val res2b = prov.createFile("sudo$filename", testtext, sudo = true)
+
+        // then
+        assertTrue(res1.success)
+        assertTrue(prov.checkDir("dir1/dir2"))
+        assertTrue(res1b.success)
+
+        assertTrue(res2.success)
+        assertTrue(prov.checkDir("sudodir1/dir2", sudo = true))
+        assertTrue(res2b.success)
+        assertEquals(testtext, prov.fileContent(filename))
+        assertEquals(testtext, prov.fileContent("sudo$filename"))
+    }
+
+    @Test
+    @ContainerTest
+    fun createFile_with_dir_fails_if_createDirIfMissing_is_false() {
+        // given
+        val prov = defaultTestContainer()
+        val filename = "dirDoesNotExist/dir2/testfile-with-dir"
+
+        // when
+        val res = prov.createFile(filename, testtext, createDirIfMissing = false)
+        val res2 = prov.createFile("sudo$filename", testtext, sudo = true, createDirIfMissing = false)
+
+        // then
+        assertFalse(res.success)
+        assertFalse(res2.success)
+        assertFalse(prov.checkDir("dirDoesNotExist"))
+        assertFalse(prov.checkDir("sudodirDoesNotExist", sudo = true))
+    }
+
     @Test
     @ContainerTest
     fun create_large_file_in_container() {