Add option to provide script temporary directory path instead of system temporary

Author: sagiegurari

CHANGELOG.md

@@ -1,7 +1,8 @@
 ## CHANGELOG
 
-### v0.1.12
+### v0.1.12 (2023-08-14)
 
+* Add option to provide script temporary directory path instead of system temporary
 * Updated header include guard macro name
 
 ### v0.1.11 (2022-05-9)

include/scriptexec.h

@@ -9,6 +9,9 @@ struct ScriptExecOptions
   char *working_directory;
   bool exit_on_error;
   bool print_commands;
+  // The directory used to write the temporary script in
+  // If NULL, it will use the system temporary directory as parent
+  char *temporary_directory;
 };
 
 struct ScriptExecResult

src/scriptexec.c

@@ -15,7 +15,11 @@ struct ScriptExecOptions scriptexec_create_options(void)
 {
   struct ScriptExecOptions options =
   {
-    .runner = NULL, .working_directory = NULL, .exit_on_error = true, .print_commands = false
+    .runner              = NULL,
+    .working_directory   = NULL,
+    .exit_on_error       = true,
+    .print_commands      = false,
+    .temporary_directory = NULL
   };
 
   return(options);
@@ -70,8 +74,18 @@ struct ScriptExecResult scriptexec_run_with_options(const char *script, struct S
   stringbuffer_append_string(buffer, (char *)script);
   char *updated_script = stringbuffer_to_string(buffer);
 
-  char template[] = "/tmp/scriptexec_XXXXXX";
-  char *dir_name  = mkdtemp(template);
+  bool delete_temporary_directory = false;
+  char *dir_name                  = NULL;
+  if (options.temporary_directory == NULL)
+  {
+    char template[] = "/tmp/scriptexec_XXXXXX";
+    dir_name                   = mkdtemp(template);
+    delete_temporary_directory = true;
+  }
+  else
+  {
+    dir_name = options.temporary_directory;
+  }
 
   if (dir_name == NULL)
   {
@@ -83,16 +97,18 @@ struct ScriptExecResult scriptexec_run_with_options(const char *script, struct S
   }
 
   stringbuffer_clear(buffer);
-  stringbuffer_append_string(buffer, dir_name);
-  stringbuffer_append_string(buffer, "/script");
-  char *script_file = stringbuffer_to_string(buffer);
+  char *script_file = fsio_join_paths(dir_name, "script");
+  stringbuffer_append_string(buffer, script_file);
 
   // write script file
   bool written = fsio_write_text_file(script_file, updated_script);
   free(updated_script);
   if (!written)
   {
-    rmdir(dir_name);
+    if (delete_temporary_directory)
+    {
+      rmdir(dir_name);
+    }
 
     stringbuffer_release(buffer);
     free(script_file);
@@ -140,7 +156,10 @@ struct ScriptExecResult scriptexec_run_with_options(const char *script, struct S
   free(err_file);
 
   // delete temp directory
-  rmdir(dir_name);
+  if (delete_temporary_directory)
+  {
+    rmdir(dir_name);
+  }
 
   return(result);
 } /* scriptexec_run_with_options */

tests/test_custom_temporary_directory.c

@@ -0,0 +1,32 @@
+#include "fsio.h"
+#include "scriptexec.h"
+#include "test.h"
+
+#define TEMPORARY_DIRECTORY    "./tempscripts/"
+
+
+void test_impl()
+{
+  struct ScriptExecOptions options = scriptexec_create_options();
+
+  fsio_remove(TEMPORARY_DIRECTORY);
+  assert_true(!fsio_dir_exists(TEMPORARY_DIRECTORY));
+  options.temporary_directory = TEMPORARY_DIRECTORY;
+
+  struct ScriptExecResult result = scriptexec_run_with_options("echo 1", options);
+
+  assert_num_equal(result.code, 0);
+
+  free(result.out);
+  free(result.err);
+
+  assert_true(fsio_dir_exists(TEMPORARY_DIRECTORY));
+  fsio_remove(TEMPORARY_DIRECTORY);
+}
+
+
+int main()
+{
+  test_run(test_impl);
+}
+