cem_acpt 0.2.9-universal-java-17 → 0.2.10-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4181b3fae3e4d3f0029314896873f2f604374cc4583473b0b05e689464d346f
-  data.tar.gz: 5e01be5d223962785a18e685f17cc1c3cd393f705cd2b5df174327a8631e1598
+  metadata.gz: 5d59f3f4432694cd766fc5ca304ade0cad8cb681849181256d8c1ced3ba68438
+  data.tar.gz: eff162b600769222a8d0670e2a528cc389eae0407e35a1d6671c1518248c0480
 SHA512:
-  metadata.gz: e9dc631cf11d32f85405358a8bc4e8501afc290a15ed68e80688472de838cfdd81cf09e9a10d346f396de6f1c2505188c443c60e0d4b106b346fd77f079c311c
-  data.tar.gz: 7866ca7c6272369e15c2fbf3f2dd69ce6d6caf6d059b08ad686e7b2fcaf5d63d5d093dbfac076c4c68f3ac7c07f4bcacc2bcd01107667531e069821c00e90313
+  metadata.gz: a8124eec84379d5737fc4e04327ded0de1da8cb43c724a51cfd892c150823b58b14f9f6f99ec24adff5a7bc69302595e79de34501326c1c6e85fe1b0fa3c99cc
+  data.tar.gz: c6ea839545a9c00779aec17f331a9769a743baf7e05654f25d9efaa0e7edd8490dc528342ba75cdef171dc79328ad0431b204310c53d736f0b8bd2faf71ac6b4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.2.9-universal-java-17)
+    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)

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/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.9'
+  VERSION = '0.2.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -160,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