From ebaf085694873b0a66e477d1f131468c382ec94d Mon Sep 17 00:00:00 2001
From: Yury Bushmelev <jay4mail@gmail.com>
Date: Sun, 31 Mar 2024 01:55:30 +0300
Subject: [PATCH] Add `file::with_tmpfile()` function

!feature

* **Add `file::with_tmpfile()` function**
  Create a temporary file and execute the block with the filename created as an
  argument. The file is deleted after the block execution. This will only
  operate on the machine you run Bolt on.
---
 .../lib/puppet/functions/file/with_tmpfile.rb | 39 +++++++++++++++++++
 .../spec/functions/file/with_tmpfile_spec.rb  | 12 ++++++
 2 files changed, 51 insertions(+)
 create mode 100644 bolt-modules/file/lib/puppet/functions/file/with_tmpfile.rb
 create mode 100644 bolt-modules/file/spec/functions/file/with_tmpfile_spec.rb

diff --git a/bolt-modules/file/lib/puppet/functions/file/with_tmpfile.rb b/bolt-modules/file/lib/puppet/functions/file/with_tmpfile.rb
new file mode 100644
index 0000000000..dde3af0a98
--- /dev/null
+++ b/bolt-modules/file/lib/puppet/functions/file/with_tmpfile.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+# Create a temporary file and execute the block with the filename created as an
+# argument. The file is deleted after the block execution. This will only
+# operate on the machine you run Bolt on.
+Puppet::Functions.create_function(:'file::with_tmpfile') do
+  # @param basename Determines the name of the temporary file (see ruby's Tempfile.new)
+  # @param tmpdir Directory to place the temporary file in (ruby's Dir.tmpdir is default value)
+  # @param block The block to execute with a temporary filename
+  # @example Run a command with a temporary file
+  #   # NOTE: This will work on the Bolt controller node only!
+  #   $res = file::with_tmpfile('foo') |$filename| {
+  #     run_command("do_something_with '${filename}'", 'localhost')
+  #     upload_file($filename, $targets)
+  #   }
+  dispatch :with_tmpfile do
+    param 'String', :basename
+    optional_param 'Optional[String[1]]', :tmpdir
+    block_param 'Callable[1, 1]', :block
+    return_type 'Any'
+  end
+
+  def with_tmpfile(basename = '', tmpdir = nil)
+    # Send Analytics Report
+    Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)
+
+    f = Tempfile.new(basename, tmpdir)
+    f.close
+    begin
+      result = yield f.path
+    ensure
+      f.unlink
+    end
+
+    result
+  end
+end
diff --git a/bolt-modules/file/spec/functions/file/with_tmpfile_spec.rb b/bolt-modules/file/spec/functions/file/with_tmpfile_spec.rb
new file mode 100644
index 0000000000..9897dfe01f
--- /dev/null
+++ b/bolt-modules/file/spec/functions/file/with_tmpfile_spec.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'file::with_tmpfile' do
+  it do
+    is_expected.to run
+      .with_params('foo')
+      .with_lambda { |_| 'bar' }
+      .and_return('bar')
+  end
+end