cem_acpt 0.2.7-universal-java-17 → 0.2.10-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d851a1f582f7ae5bbb404a443f5a9182a9870c14cf95eb91b579f7bc23ec464
-  data.tar.gz: b99a67c2106017b09ad3fd8ae06f32e50abc5da5c0384c60d2896f86708be7b0
+  metadata.gz: 5d59f3f4432694cd766fc5ca304ade0cad8cb681849181256d8c1ced3ba68438
+  data.tar.gz: eff162b600769222a8d0670e2a528cc389eae0407e35a1d6671c1518248c0480
 SHA512:
-  metadata.gz: 92c834d242c437434dc4fac8b60f196f8458f0e1b03b26fff8e23ca1d9d79e726b44386f327bdecbdb94b2048401299fdfbfdf626f02b26792aa7f77388116d7
-  data.tar.gz: 724db71afd7efae7d8b7cb6aa572cef672ee9c705b86c293215568ec334ce706e44284054b88c972e2746a3550ea7b5d398bfe2d217a7e4b9f24aadac78297b7
+  metadata.gz: a8124eec84379d5737fc4e04327ded0de1da8cb43c724a51cfd892c150823b58b14f9f6f99ec24adff5a7bc69302595e79de34501326c1c6e85fe1b0fa3c99cc
+  data.tar.gz: c6ea839545a9c00779aec17f331a9769a743baf7e05654f25d9efaa0e7edd8490dc528342ba75cdef171dc79328ad0431b204310c53d736f0b8bd2faf71ac6b4

data/Gemfile

@@ -1,7 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cem_acpt.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '>= 12.0'
+gem 'rspec', '>= 3.0'

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.2.7-universal-java-17)
-      concurrent-ruby (~> 1.1.9)
-      deep_merge (~> 1.2.2)
+    cem_acpt (0.2.10-universal-java-17)
+      concurrent-ruby (>= 1.1, < 2.0)
+      deep_merge (>= 1.2, < 2.0)
       ed25519 (>= 1.2, < 2.0)
-      net-ssh (~> 7.0.0.beta1)
-      puppet-modulebuilder (> 0.0.1)
+      net-ssh (>= 7.0, < 8.0)
+      puppet-modulebuilder (>= 0.0.1)
       serverspec-cem-acpt
 
 GEM
@@ -31,7 +31,7 @@ GEM
       minitar (~> 0.9)
       pathspec (>= 0.2.1, < 2.0.0)
     rainbow (3.1.1)
-    rake (12.3.3)
+    rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -80,8 +80,8 @@ PLATFORMS
 
 DEPENDENCIES
   cem_acpt!
-  rake (~> 12.0)
-  rspec (~> 3.0)
+  rake (>= 12.0)
+  rspec (>= 3.0)
   rubocop
 
 BUNDLED WITH

data/cem_acpt.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.platform = Gem::Platform.local
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.1.9'
-  spec.add_runtime_dependency 'deep_merge', '~> 1.2.2'
+  spec.add_runtime_dependency 'concurrent-ruby', '>= 1.1', '< 2.0'
+  spec.add_runtime_dependency 'deep_merge', '>= 1.2', '< 2.0'
   spec.add_runtime_dependency 'ed25519', '>= 1.2', '< 2.0'
-  spec.add_runtime_dependency 'net-ssh', '~> 7.0.0.beta1'
-  spec.add_runtime_dependency 'puppet-modulebuilder', '> 0.0.1'
+  spec.add_runtime_dependency 'net-ssh', '>= 7.0', '< 8.0'
+  spec.add_runtime_dependency 'puppet-modulebuilder', '>= 0.0.1'
   spec.add_runtime_dependency 'serverspec-cem-acpt'
   spec.add_development_dependency 'rubocop'
 end

data/lib/cem_acpt/context.rb

@@ -36,10 +36,8 @@ module CemAcpt
       # Creates a SSH key and a SSH known hosts file for the acceptance test suite
       def new_test_ssh_key
         log('Creating ephemeral SSH key and known hosts file for acceptance test suites...')
-        @ssh_priv_key, @ssh_pub_key = CemAcpt::Utils::SSH.ephemeral_ssh_key
-        @ssh_known_hosts = CemAcpt::Utils::SSH.acpt_known_hosts
-        CemAcpt::Utils::SSH.set_ssh_file_permissions(@ssh_priv_key, @ssh_pub_key, @ssh_known_hosts)
-        log('Successfully created SSH files...')
+        @ssh_priv_key, @ssh_pub_key, @ssh_known_hosts = CemAcpt::Utils::SSH::Ephemeral.create
+        log('Successfully created SSH files.')
         log("SSH private key: #{@ssh_priv_key}", :debug)
         log("SSH public key: #{@ssh_pub_key}", :debug)
         log("SSH known hosts: #{@ssh_known_hosts}", :debug)
@@ -48,7 +46,9 @@ module CemAcpt
       # Deletes acceptance test suite SSH files
       def clean_test_ssh_key
         log('Deleting ephemeral ssh keys and acpt_known_hosts if they exist...')
-        [@ssh_priv_key, @ssh_pub_key, @ssh_known_hosts].map { |f| File.delete(f) if File.exist?(f) }
+        cleaned = CemAcpt::Utils::SSH::Ephemeral.clean
+        log('Successfully cleaned ephemeral ssh files.')
+        log("Deleted: #{cleaned}", :debug)
       end
 
       # Prints a period to the terminal every 5 seconds in a single line to keep the terminal
@@ -62,8 +62,8 @@ module CemAcpt
       end
 
       def clean_up_test_suite(opts)
-        @ctx.node_inventory.clear!
-        @ctx.node_inventory.clean_local_files
+        @ctx&.node_inventory&.clear!
+        @ctx&.node_inventory&.clean_local_files
         clean_test_ssh_key unless opts[:no_ephemeral_ssh_key]
         @run_handler&.destroy_test_nodes
         @keep_terminal_alive&.kill

data/lib/cem_acpt/logging/formatter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  module Logging
+    module Formatter
+      class << self
+        def for(log_format)
+          all.find { |f| f.log_format == log_format.downcase.to_sym }.get
+        end
+
+        private
+
+        def all
+          @all ||= [FileFormatter.new, JSONFormatter.new, TextFormatter.new, GithubActionFormatter.new]
+        end
+      end      
+
+      class FileFormatter
+        attr_reader :log_format
+
+        def initialize
+          @log_format = :file
+        end
+  
+        def get
+          proc do |severity, datetime, progname, msg|
+            format(severity, datetime, progname, msg)
+          end
+        end
+
+        private
+
+        def format(severity, datetime, _progname, msg)
+          "[#{datetime}] #{severity}: #{msg}\n"
+        end
+      end
+
+      class JSONFormatter < FileFormatter
+        def initialize
+          super
+          @log_format = :json
+        end
+
+        private
+
+        def format(severity, datetime, progname, msg)
+          require 'json'
+          {
+            timestamp: datetime,
+            progname: progname,
+            severity: severity,
+            message: msg,
+          }.to_json + "\n"
+        end
+      end
+
+      class TextFormatter < FileFormatter
+        def initialize
+          super
+          @log_format = :text
+        end
+
+        private
+
+        def format(severity, _datetime, _progname, msg)
+          "#{severity} - #{msg}\n"
+        end
+      end
+
+      class GithubActionFormatter < FileFormatter
+        SEV_MAP = {
+          'DEBUG' => '::debug',
+          'INFO' => '::notice',
+          'WARN' => '::warning',
+          'ERROR' => '::error',
+          'FATAL' => '::error',
+        }.freeze
+
+        def initialize
+          super
+          @log_format = :github_action
+        end
+
+        private
+
+        def format(severity, _datetime, _progname, msg)
+          if severity == 'DEBUG'
+            "#{SEV_MAP[severity]}::{#{msg}}\n"
+          else
+            "#{SEV_MAP[severity]} #{msg}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/logging.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'cem_acpt/logging/formatter'
 
 module CemAcpt
   # Logging for CemAcpt
@@ -92,41 +93,7 @@ module CemAcpt
       # @param f [Symbol] the log format style to set
       # @return [Proc] the proc to be passed to Logger#formatter=
       def new_log_formatter(f)
-        case f.downcase.to_sym
-        when :json
-          require 'json'
-          @current_log_format = :json
-          proc do |severity, datetime, progname, msg|
-            {
-              timestamp: datetime,
-              progname: progname,
-              severity: severity,
-              message: msg,
-            }.to_json + "\n"
-          end
-        when :text
-          @current_log_format = :text
-          proc do |severity, _datetime, _progname, msg|
-            "#{severity} - #{msg}\n"
-          end
-        when :github_action
-          @current_log_format = :github_action
-          sev_map = {
-            'DEBUG' => '::debug::',
-            'INFO' => '::notice::',
-            'WARN' => '::warning::',
-            'ERROR' => '::error::',
-            'FATAL' => '::error::',
-          }
-          proc do |severity, _datetime, _progname, msg|
-            "#{sev_map[severity]}{#{msg}}\n"
-          end
-        else
-          @current_log_format = :file
-          proc do |severity, datetime, _progname, msg|
-            "[#{datetime}] #{severity}: #{msg}\n"
-          end
-        end
+        CemAcpt::Logging::Formatter.for(f)
       end
 
       # Returns the current log config if set, or the default if not.

data/lib/cem_acpt/rspec_utils.rb

@@ -12,13 +12,17 @@ module CemAcpt
     class BundlerNotFoundError < StandardError; end
     class RSpecNotFoundError < StandardError; end
 
-    # Holds and formats a RSpec command
-    class Command
-      include CemAcpt::LoggingAsync
-      attr_reader :debug, :format, :test_path, :use_bundler, :pty_pid
+    # Holds RSpec options used by Command
+    class Options
+      OPTIONS = %i[test_path bundle rspec use_bundler bundle_install format debug quiet env].freeze
 
+      attr_accessor(*OPTIONS)
+
+      # @param config [CemAcpt::Config] A config object
       # @param opts [Hash] options hash for the RSpec command
       # @option opts [String] :test_path The path (or glob path) to the test file(s) to run. If blank, runs all.
+      # @option opts [String] :bundle The path to the `bundle` binary.
+      # @option opts [String] :rspec The path to the `rspec` binary.
       # @option opts [Hash] :format Format options for rspec where the key is the format (documentation, json, etc)
       #   and the value is the out-file path. If you do not want to save the results of a format to a file, the
       #   value should be `nil`.
@@ -30,56 +34,97 @@ module CemAcpt
       #   Default is `true`.
       # @option opts [Boolean] :bundle_install Whether or not to run `bundle install` before the RSpec command
       #   if `use_bundler` is `true`.
-      # @option opts [Boolean] :use_shell Whether or not to add `$SHELL` as a prefix to the command
       # @option opts [Hash] :env Environment variables to prepend to the command
-      def initialize(opts = {})
-        @test_path = opts[:test_path]&.shellescape
-        @format = opts.fetch(:format, {})
-        @debug = opts.fetch(:debug, false)
-        @quiet = @debug ? false : opts.fetch(:quiet, false)
-        @use_bundler = opts.fetch(:use_bundler, false)
-        @bundle_install = opts.fetch(:bundle_install, false)
-        @env = opts.fetch(:env, {})
-        @pty_pid = nil
-        validate_and_set_bin_paths(opts)
+      def initialize(config, **opts)
+        @config = config
+        @opts = opts
+        define_option_instance_vars
+      end
+
+      # Finds and sets the paths to the `bundle` and `rspec` binaries. The paths can
+      # be either passed in as options in the `opts` Hash or interrogated from the
+      # system.
+      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
+      #   `bundle` binary is not found.
+      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
+      def resolve_bin_paths
+        %i[bundle rspec].each do |bin|
+          bin_path = instance_variable_get("@#{bin}") || `#{ENV['SHELL']} -c 'command -v #{bin}'`.strip
+          bin_not_found(bin, bin_path) unless bin_path && File.exist?(bin_path)
+          instance_variable_set("@#{bin}", bin_path)
+        end
+      end
+
+      # Detects if the current Ruby context is JRuby
+      def jruby?
+        Object.const_defined?('JRUBY_VERSION')
       end
 
-      # Sets debug mode to `true`
-      def set_debug
-        @debug = true
-        if @quiet
-          async_debug('Setting :quiet to false because :debug is now true.')
-          @quiet = false
+      private
+
+      def defaults
+        @defaults ||= { use_bundler: false,
+                        bundle_install: false,
+                        format: { documentation: nil },
+                        debug: false,
+                        quiet: false,
+                        env: {} }
+      end
+
+      def define_option_instance_vars
+        OPTIONS.each do |o|
+          val = @config.get("rspec.#{o}") || @opts[o] || defaults[o] || nil
+          instance_variable_set("@#{o}", val)
         end
       end
 
-      # Sets debug mode to `false`
-      def unset_debug
-        @debug = false
+      # Handles binary paths which are not found
+      # @param bin [Symbol] The binary that was not found, either :bundle or :rspec.
+      # @param bin_path [String] The path to the binary that was checked.
+      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
+      #   `bundle` binary is not found.
+      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
+      # @raise [RuntimeError] if `bin` is not :bundle or :rspec.
+      def bin_not_found(bin, bin_path)
+        msg_base = "#{bin} not found."
+        msg = bin_path.nil? ? "#{msg_base} Path is nil." : "#{msg_base} Path: #{bin_path}"
+        case bin
+        when :bundle
+          raise BundlerNotFoundError, msg if opts.use_bundler
+        when :rspec
+          raise RSpecNotFoundError, msg
+        else
+          raise "bin #{bin} not recognized!"
+        end
       end
+    end
+
+    # Holds and formats a RSpec command
+    class Command
+      include CemAcpt::LoggingAsync
+      attr_reader :opts, :pty_pid
+
+      def initialize(opts = Options.new)
+        raise 'opts must be instance of CemAcpt::RSpecUtils::Options' unless opts.is_a?(CemAcpt::RSpecUtils::Options)
 
-      def quiet
-        @quiet && !debug
+        @opts = opts
+        @opts.resolve_bin_paths
+        @opts.env = @opts.env.merge({ 'RSPEC_DEBUG' => 'true' }) if @opts.debug
+        @pty_pid = nil
       end
 
       # Adds a new format to the RSpec command
       # @param fmt [String] The name of the format (i.e. "documentation", "json", etc.)
       # @param out [String] If specified, saves the specified format to a file at this path
       def with_format(fmt, out: nil)
-        @format[fmt.to_sym] = out
-      end
-
-      # Environment variables that will be used for the RSpec command
-      # @return [Hash] A Hash of environment variables with each key pair being: <var name> => <var value>
-      def env
-        @debug ? @env.merge({ 'RSPEC_DEBUG' => 'true' }) : @env
+        opts.format[fmt.to_sym] = out
       end
 
       # Returns an array representation of the RSpec command
       def to_a
         cmd = cmd_base.dup
-        cmd << test_path if test_path
-        format.each do |fmt, out|
+        cmd << opts.test_path if opts.test_path
+        opts.format.each do |fmt, out|
           cmd += ['--format', fmt.to_s.shellescape]
           cmd += ['--out', out.to_s.shellescape] if out
         end
@@ -112,12 +157,12 @@ module CemAcpt
       # @return [Integer] The exit code of the RSpec command
       def execute_pty(log_prefix: 'RSPEC')
         async_debug("Executing RSpec command '#{self}' in PTY...", log_prefix)
-        PTY.spawn(env, ENV['SHELL']) do |r, w, pid|
+        PTY.spawn(opts.env, ENV['SHELL']) do |r, w, pid|
           @pty_pid = pid
           async_debug("Spawned RSpec PTY with PID #{@pty_pid}", log_prefix)
           export_envs(w)
           w.puts "#{self}; exit $?"
-          quiet ? wait_io(r) : read_io(r, log_prefix: log_prefix)
+          handle_io(r, log_prefix: log_prefix)
         end
         $CHILD_STATUS
       end
@@ -130,9 +175,9 @@ module CemAcpt
       def execute_no_pty(log_prefix: 'RSPEC')
         async_info("Executing RSpec command '#{self}' with Open3.popen2e()...", log_prefix)
         exit_status = nil
-        Open3.popen2e(env, to_s) do |stdin, std_out_err, wait_thr|
+        Open3.popen2e(opts.env, to_s) do |stdin, std_out_err, wait_thr|
           stdin.close
-          quiet ? wait_io(std_out_err) : read_io(std_out_err, log_prefix: log_prefix)
+          handle_io(std_out_err, log_prefix: log_prefix)
           exit_status = wait_thr.value
         end
         exit_status
@@ -147,26 +192,21 @@ module CemAcpt
 
       private
 
-      # Detects if the current Ruby context is JRuby
-      def jruby?
-        File.basename(RbConfig.ruby) == 'jruby'
-      end
-
       # The base RSpec command
       def cmd_base
-        use_bundler ? cmd_base_bundler : cmd_base_rspec
+        opts.use_bundler ? cmd_base_bundler : cmd_base_rspec
       end
 
       # The base RSpec command if `:use_bundler` is `true`.
       def cmd_base_bundler
-        base = [@bundle, 'exec', 'rspec']
-        base.unshift("#{@bundle} install;") if @bundle_install
+        base = [opts.bundle, 'exec', 'rspec']
+        base.unshift("#{opts.bundle} install;") if opts.bundle_install
         base
       end
 
       # The base RSpec command if `:use_bundler` is `false`
       def cmd_base_rspec
-        [@rspec]
+        [opts.rspec]
       end
 
       # Puts export statements for each key-value pair in `env` to the given writer.
@@ -174,46 +214,14 @@ module CemAcpt
       # pass the statements to a shell.
       # @param writer [IO] An IO object that supprts `puts` and can send statements to a shell
       def export_envs(writer)
-        env.each do |key, val|
+        @opts.env.each do |key, val|
           writer.puts "export #{key}=#{val}"
         end
       end
 
-      # Finds and sets the paths to the `bundle` and `rspec` binaries. The paths can
-      # be either passed in as options in the `opts` Hash or interrogated from the
-      # system.
-      # @param opts [Hash] The options hash
-      # @option opts [String] :bundle An absolute path on the system to the `bundle` binary.
-      # @option opts [String] :rspec An absolute path on the system to the `rspec` binary.
-      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
-      #   `bundle` binary is not found.
-      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
-      def validate_and_set_bin_paths(opts = {})
-        %i[bundle rspec].each do |bin|
-          bin_path = opts[bin] || `command -v #{bin}`.strip
-          bin_not_found(bin, bin_path) unless bin_path && File.exist?(bin_path)
-          instance_variable_set("@#{bin}", bin_path)
-        end
-      end
-
-      # Handles binary paths which are not found
-      # @param bin [Symbol] The binary that was not found, either :bundle or :rspec.
-      # @param bin_path [String] The path to the binary that was checked.
-      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
-      #   `bundle` binary is not found.
-      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
-      # @raise [RuntimeError] if `bin` is not :bundle or :rspec.
-      def bin_not_found(bin, bin_path)
-        msg_base = "#{bin} not found."
-        msg = bin_path.nil? ? "#{msg_base} Path is nil." : "#{msg_base} Path: #{bin_path}"
-        case bin
-        when :bundle
-          raise BundlerNotFoundError, msg if @use_bundler
-        when :rspec
-          raise RSpecNotFoundError, msg
-        else
-          raise "bin #{bin} not recognized!"
-        end
+      # Handles IO output
+      def handle_io(io_stream, **kwargs)
+        opts.quiet ? wait_io(io_stream) : read_io(io_stream, log_prefix: kwargs[:log_prefix])
       end
 
       # Blocking wait on an IO stream. Wait stops once the IO stream has reached

data/lib/cem_acpt/test_runner/runner.rb

@@ -9,6 +9,7 @@ require_relative 'runner_result'
 module CemAcpt
   module TestRunner
     class RunnerError < StandardError; end
+
     # Error used to wrap fatal errors raised in Runner steps
     class RunnerStepError < StandardError
       attr_reader :step
@@ -19,6 +20,7 @@ module CemAcpt
         set_backtrace err.backtrace if err.respond_to?(:backtrace)
       end
     end
+
     class RunnerProvisionError < RunnerStepError; end
 
     # Runner is a class that runs a single acceptance test suite on a single node.
@@ -143,12 +145,12 @@ module CemAcpt
         async_info("Running test #{@node.test_data[:test_name]} on node #{@node.node_name}...", log_prefix('RSPEC'))
         @node.run_tests do |cmd_env|
           cmd_opts = rspec_opts
-          cmd_opts[:env].merge!(cmd_env) if cmd_env
+          cmd_opts.env = cmd_opts.env.merge(cmd_env) if cmd_env
           # Documentation format gets logged in real time, JSON file is read after the fact
           begin
             @rspec_cmd = CemAcpt::RSpecUtils::Command.new(cmd_opts)
-            @rspec_cmd.execute(log_prefix: log_prefix('RSPEC'))
-            @run_result.from_json_file(cmd_opts[:format][:json])
+            @rspec_cmd.execute(pty: false, log_prefix: log_prefix('RSPEC'))
+            @run_result.from_json_file(cmd_opts.format[:json])
           rescue Errno::EIO => e
             async_error("failed to run rspec: #{@node.test_data[:test_name]}: #{$ERROR_INFO}", log_prefix('RSPEC'))
             @run_result.from_error(e)
@@ -189,21 +191,21 @@ module CemAcpt
 
       # Options used with RSpec
       def rspec_opts
-        opts = {
-          test_path: @node.test_data[:test_file],
-          use_bundler: false,
-          bundle_install: false,
-          format: {
-            json: "results_#{@node.test_data[:test_name]}.json",
-          },
-          debug: (@debug_mode && @context.config.get('verbose')),
-          quiet: @context.config.get('quiet'),
-          env: {
-            'TARGET_HOST' => @node.node_name,
-          }
-        }
-        opts[:format][:documentation] = nil unless @context.config.get('verbose')
-        opts
+        opts_test_path = @node.test_data[:test_file]
+        opts_env = { 'TARGET_HOST' => @node.node_name }
+        opts_debug = (@debug_mode && @context.config.get('verbose'))
+        opts_quiet = @context.config.get('quiet')
+        opts_format = if @context.config.get('verbose')
+                        { json: "results_#{@node.test_data[:test_name]}.json", documentation: nil }
+                      else
+                        { json: "results_#{@node.test_data[:test_name]}.json" }
+                      end
+        CemAcpt::RSpecUtils::Options.new(@context.config,
+                                         test_path: opts_test_path,
+                                         env: opts_env,
+                                         debug: opts_debug,
+                                         quiet: opts_quiet,
+                                         format: opts_format)
       end
     end
   end

data/lib/cem_acpt/utils.rb

@@ -81,6 +81,40 @@ module CemAcpt
 
     # SSH-related utilities
     module SSH
+      module Ephemeral
+        PRIV_KEY = 'acpt_test_key'
+        CREATE_OPTS = {
+          type: 'rsa',
+          bits: '4096',
+          comment: 'Ephemeral for cem_acpt',
+          password: '',
+          known_hosts: 'acpt_known_hosts',
+          overwrite_known_hosts: true,
+        }.freeze
+
+        class << self
+          attr_accessor :ephemeral_keydir
+        end
+
+        def self.create(keydir: CemAcpt::Utils::SSH.default_keydir)
+          self.ephemeral_keydir = keydir
+          @priv_key, @pub_key, @known_hosts = CemAcpt::Utils::SSH.create(PRIV_KEY, keydir: ephemeral_keydir, **CREATE_OPTS)
+          [@priv_key, @pub_key, @known_hosts]
+        end
+
+        def self.clean
+          [@priv_key, @pub_key, @known_hosts].each_with_object([]) do |f, arr|
+            next unless f
+
+            path = CemAcpt::Utils::SSH.file_path(f, keydir: ephemeral_keydir)
+            if ::File.exist?(path)
+              ::File.delete(path)
+              arr << path
+            end
+          end
+        end
+      end
+
       def self.ssh_keygen
         bin_path = `#{ENV['SHELL']} -c 'command -v ssh-keygen'`.chomp
         raise 'Cannot find ssh-keygen! Install it and verify PATH' unless bin_path
@@ -97,26 +131,52 @@ module CemAcpt
         ssh_dir
       end
 
-      def self.ephemeral_ssh_key(type: 'rsa', bits: '4096', comment: nil, keydir: default_keydir)
-        raise ArgumentError, 'keydir does not exist' unless ::File.directory?(keydir)
+      def self.file_path(file_name, keydir: default_keydir)
+        ::File.join(keydir, file_name)
+      end
+
+      # Takes a file name (not path) and optional SSH key directory and returns the paths
+      # to the private key and public key based on the file name given.
+      # @param file_name [String] The base name for the keys
+      # @param keydir [String] An optional SSH key directory
+      def self.key_paths(file_name, keydir: default_keydir)
+        [file_path(file_name, keydir: keydir), file_path("#{file_name}.pub", keydir: keydir)]
+      end
 
-        keyfile = ::File.join(keydir, 'acpt_test_key')
-        keygen_cmd = [ssh_keygen, "-t #{type}", "-b #{bits}", "-f #{keyfile}", '-N ""']
+      def self.create(key_name, type: 'rsa', bits: '4096', comment: nil, password: '', known_hosts: nil, overwrite_known_hosts: true, keydir: default_keydir)
+        raise ArgumentError, "Key directory #{keydir} does not exist" unless ::File.directory?(keydir)
+
+        keys = key_paths(key_name, keydir: keydir)
+        # If we don't delete an existing key file, generation will fail
+        keys.each { |f| ::File.delete(f) if ::File.exist?(f) }
+        keygen_cmd = [ssh_keygen, "-t #{type}", "-b #{bits}", "-f #{keys[0]}", "-N '#{password}'"]
         keygen_cmd << "-C \"#{comment}\"" if comment
         _, stderr, status = Open3.capture3(keygen_cmd.join(' '))
-        raise "Failed to generate ephemeral SSH key: #{stderr}" unless status.success?
+        raise "Failed to generate ephemeral SSH key: STDOUT: #{stdout}; STDERR: #{stderr}" unless status.success?
 
-        [keyfile, "#{keyfile}.pub"]
+        keys << create_known_hosts(known_hosts, overwrite: overwrite_known_hosts, keydir: keydir)
+        set_ssh_file_permissions(*keys)
+        keys
       end
 
-      def self.acpt_known_hosts(keydir: default_keydir, file_name: 'acpt_known_hosts', overwrite: true)
-        kh_file = ::File.join(keydir, file_name)
+      def self.create_known_hosts(known_hosts, overwrite: true, keydir: default_keydir)
+        return nil unless known_hosts
+
+        kh_file = file_path(known_hosts, keydir: keydir)
         ::File.open(kh_file, 'w') { |f| f.write("\n") } unless ::File.exist?(kh_file) && !overwrite
         kh_file
       end
 
-      def self.set_ssh_file_permissions(priv_key, pub_key, known_hosts)
-        CemAcpt::Utils::File.set_permissions(0o600, priv_key, pub_key, known_hosts)
+      def self.set_ssh_file_permissions(*files)
+        CemAcpt::Utils::File.set_permissions(0o600, *files.uniq.compact)
+      end
+
+      def self.ephemeral_ssh_key(keydir: default_keydir)
+        CemAcpt::Utils::SSH::Ephemeral.create(keydir: keydir)
+      end
+
+      def self.clean_ephemeral_keys
+        CemAcpt::Utils::SSH::Ephemeral.clean
       end
     end
 

data/lib/cem_acpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CemAcpt
-  VERSION = '0.2.7'
+  VERSION = '0.2.10'
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.10
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: '2.0'
   name: concurrent-ruby
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
   name: deep_merge
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -61,21 +73,27 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.beta1
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   name: net-ssh
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0.beta1
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.1
   name: puppet-modulebuilder
@@ -83,7 +101,7 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.1
 - !ruby/object:Gem::Dependency
@@ -142,6 +160,7 @@ files:
 - lib/cem_acpt/core_extensions.rb
 - lib/cem_acpt/image_name_builder.rb
 - lib/cem_acpt/logging.rb
+- lib/cem_acpt/logging/formatter.rb
 - lib/cem_acpt/platform.rb
 - lib/cem_acpt/platform/base.rb
 - lib/cem_acpt/platform/base/cmd.rb