cem_acpt 0.3.7-universal-java-17 → 0.4.0-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 024fe8552168e6308e04edd5b2b3509f9b0249b140e1bbb42279eb0ad5095a3f
-  data.tar.gz: bd8da637c1179eec3ccb906e476996a5cc9f4f61194c81bbc378dcaed9e9fd14
+  metadata.gz: bd740df7227095812b1fa29a9267fdb3d9470567d5990a56799de780cf45d220
+  data.tar.gz: 1b53e57a9c26200cdabde23784bbfc0a06cacfd0141636682c9c590669fd697f
 SHA512:
-  metadata.gz: bef27a028ae54ef8aef9860bc2c59b71397f537cd5ece28a69443c9e6351f79b93986b6d24f57c3587adff5eccb7acc7a7d1c91c12842e8df7b18ae8f838c377
-  data.tar.gz: 417ca629dc9f5e1dc6c6df84c9f27a8e574d2350d96fa0887fcb33cd9bd349bb9536767a3a67db6ac99bab8ffe6428bb91e72d1cbd6713b83835381422032cdf
+  metadata.gz: a7932858ea4758458609cced16b9049d8ebec80304a0cb13a8aa00ff4787435686129d21c5ef60a13fabc52a4e9e945cf6b1a756a822bd70792e2b34f2df493e
+  data.tar.gz: 0dac3c3ce8acee13005e767fcaaaae93b07507f9e969c9faa87d629fc95c242f979ebff79e1249465ad37bd75eb5015b1c722c6bbf68c775738791003767af6c

data/Gemfile.lock

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

@@ -37,6 +37,9 @@ module CemAcpt
       def new_test_ssh_key
         log('Creating ephemeral SSH key and known hosts file for acceptance test suites...')
         @ssh_priv_key, @ssh_pub_key, @ssh_known_hosts = CemAcpt::Utils::SSH::Ephemeral.create
+        unless @ssh_priv_key && @ssh_pub_key && @ssh_known_hosts
+          log('Did not create ephemeral SSH key and known hosts file for acceptance test suites. Environment variable CEM_ACPT_TEST_SSH_KEY is set.', :warn)
+        end
         log('Successfully created SSH files.')
         log("SSH private key: #{@ssh_priv_key}", :debug)
         log("SSH public key: #{@ssh_pub_key}", :debug)

data/lib/cem_acpt/logging/formatter.rb

@@ -69,11 +69,11 @@ module CemAcpt
 
       class GithubActionFormatter < FileFormatter
         SEV_MAP = {
-          'DEBUG' => '::debug',
-          'INFO' => '::notice',
-          'WARN' => '::warning',
-          'ERROR' => '::error',
-          'FATAL' => '::error',
+          'DEBUG' => '::debug::',
+          'INFO' => '::notice::',
+          'WARN' => '::warning::',
+          'ERROR' => '::error::',
+          'FATAL' => '::error::',
         }.freeze
 
         def initialize
@@ -84,11 +84,7 @@ module CemAcpt
         private
 
         def format(severity, _datetime, _progname, msg)
-          if severity == 'DEBUG'
-            "#{SEV_MAP[severity]}::{#{msg}}\n"
-          else
-            "#{SEV_MAP[severity]} #{msg}\n"
-          end
+          "#{SEV_MAP[severity]}#{msg}\n"
         end
       end
     end

data/lib/cem_acpt/logging.rb

@@ -7,17 +7,17 @@ module CemAcpt
   # Logging for CemAcpt
   module Logging
     LEVEL_MAP = {
-      'debug' => Logger::DEBUG,
-      'info' => Logger::INFO,
-      'warn' => Logger::WARN,
-      'error' => Logger::ERROR,
-      'fatal' => Logger::FATAL,
-      'unknown' => Logger::UNKNOWN,
+      'debug' => ::Logger::DEBUG,
+      'info' => ::Logger::INFO,
+      'warn' => ::Logger::WARN,
+      'error' => ::Logger::ERROR,
+      'fatal' => ::Logger::FATAL,
+      'unknown' => ::Logger::UNKNOWN,
     }
 
     # Delegator class for when you want to log to multiple devices
     # at the same time, such as STDOUT and a file.
-    # @param loggers [::Logger] one or more instances of Logger
+    # @param loggers [Logger] one or more instances of CemAcpt::Logging::Logger
     class MultiLogger
       def initialize(*loggers)
         @loggers = loggers
@@ -36,6 +36,58 @@ module CemAcpt
       end
     end
 
+    # Delagator class for the standard Ruby Logger class.
+    # This class is used to ensure the Github Actions formatter
+    # correctly formats the log output when using the standard
+    # Ruby Logger class methods such as #info, #debug, etc.
+    class Logger < ::Logger
+      def initialize(logdev, shift_age = 0, shift_size = 1_048_576, **kwargs)
+        super(logdev, shift_age, shift_size, **kwargs)
+        if kwargs[:formatter].is_a?(Formatter::GithubActionFormatter) || ENV['GITHUB_ACTIONS'] || ENV['CI']
+          @ci_mode = true
+        end
+      end
+
+      def debug(progname = nil, &block)
+        unless log_ci_mode('debug', progname, &block)
+          super
+        end
+      end
+
+      def info(progname = nil, &block)
+        unless log_ci_mode('info', progname, &block)
+          super
+        end
+      end
+
+      def warn(progname = nil, &block)
+        unless log_ci_mode('warn', progname, &block)
+          super
+        end
+      end
+
+      def error(progname = nil, &block)
+        unless log_ci_mode('error', progname, &block)
+          super
+        end
+      end
+
+      def fatal(progname = nil, &block)
+        unless log_ci_mode('fatal', progname, &block)
+          super
+        end
+      end
+
+      private
+
+      def log_ci_mode(severity, progname = nil, &block)
+        return false unless @ci_mode
+
+        self.<<("::#{severity}::#{progname || (block && block.call) || ''}")
+        true
+      end
+    end
+
     class << self
       def new_logger(*logdevs, **configs)
         new_configs = current_log_config.merge(configs.reject { |_, v| v.nil? })
@@ -106,7 +158,7 @@ module CemAcpt
           logdev: $stdout,
           shift_age: 'o',
           shift_size: 1_048_576,
-          level: Logger::INFO,
+          level: ::Logger::INFO,
           progname: 'CemAcpt',
           datetime_format: '%Y%m%dT%H%M%S%z',
           formatter: formatter,

data/lib/cem_acpt/platform/gcp/cmd.rb

@@ -67,7 +67,9 @@ module CemAcpt::Platform::Gcp
     def ssh_key
       return @ssh_key unless @ssh_key.nil?
 
-      if File.exist?(File.join([ENV['HOME'], '.ssh', 'acpt_test_key']))
+      if CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_pri_key?
+        @ssh_key = CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_pri_key
+      elsif File.exist?(File.join([ENV['HOME'], '.ssh', 'acpt_test_key']))
         @ssh_key = File.join([ENV['HOME'], '.ssh', 'acpt_test_key'])
       else
         logger.debug("Test SSH key not found at #{File.join([ENV['HOME'], '.ssh', 'acpt_test_key'])}, using default")
@@ -117,13 +119,14 @@ module CemAcpt::Platform::Gcp
         CemAcpt::Platform::Utils::Linux::SSHelper.remove_known_host(vm_alias(instance_name), kh_file)
       end
       local_exec("compute instances delete #{instance_name} --quiet")
-    rescue StandardError
-      # Ignore errors when deleting instances.
+    rescue StandardError => e
+      # Just debug logging, otherwise ignore
+      logger.debug("Failed to delete known host for #{instance_name}, alias #{vm_alias(instance_name)}: #{e.message}")
     end
 
     # Returns a Hash describing a GCP VM instance.
     def vm_describe(instance_name, out_format: 'json', out_filter: nil)
-      local_exec("compute instances describe #{instance_name}", out_format: out_format, out_filter: out_filter)
+      @vm_describe ||= local_exec("compute instances describe #{instance_name}", out_format: out_format, out_filter: out_filter)
     end
 
     # This function runs the specified command as the currently authenticated user
@@ -312,7 +315,17 @@ module CemAcpt::Platform::Gcp
     end
 
     def gcloud_ssh(instance_name, command, ignore_command_errors: false)
-      local_exec("compute ssh --ssh-key-file #{ssh_key} --tunnel-through-iap #{instance_name} --command='#{command}'")
+      cmd = [
+        'compute',
+        'ssh',
+        '--ssh-key-file',
+        ssh_key,
+        '--tunnel-through-iap',
+        "--ssh-flag='-o UserKnownHostsFile=#{ssh_opts[:user_known_hosts_file]}'",
+        instance_name,
+        "--command='#{command}'",
+      ].join(' ')
+      local_exec(cmd)
     rescue StandardError => e
       raise e unless ignore_command_errors
     end
@@ -322,16 +335,21 @@ module CemAcpt::Platform::Gcp
     end
 
     def ssh_all_known_hosts
-      [
+      kh = [
         File.join(ENV['HOME'], '.ssh', 'acpt_test_known_hosts'),
         File.join(ENV['HOME'], '.ssh', 'known_hosts'),
         File.join(ENV['HOME'], '.ssh', 'google_compute_known_hosts'),
       ]
+      if CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_known_hosts?
+        # Env var takes precedence
+        kh.unshift(CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_known_hosts)
+      end
+      kh
     end
 
     # Default options for Net::SSH
     def default_ssh_opts
-      {
+      dopts = {
         auth_methods: ['publickey'],
         check_host_ip: false,
         compression: true,
@@ -342,9 +360,14 @@ module CemAcpt::Platform::Gcp
         non_interactive: true,
         port: 22,
         user: user_name,
-        user_known_hosts_file: File.join(ENV['HOME'], '.ssh', 'acpt_test_known_hosts'),
         verify_host_key: :never,
       }
+      if CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_known_hosts?
+        dopts[:user_known_hosts_file] = CemAcpt::Platform::Utils::Linux::SSHelper.env_ssh_known_hosts
+      else
+        dopts[:user_known_hosts_file] = ssh_all_known_hosts.find { |f| File.exist?(File.expand_path(f)) unless f.nil? }
+      end
+      dopts
     end
 
     # Returns a Proxy::Command object to use for the SSH option ProxyCommand.

data/lib/cem_acpt/platform/gcp/compute.rb

@@ -248,7 +248,8 @@ module CemAcpt::Platform::Gcp
       end
       @cmd.local_exec(create_cmd)
     rescue StandardError => e
-      raise "Failed to create VM #{name} with command #{create_cmd}: #{e}"
+      logger.error("Failed to create VM #{name} with command #{create_cmd}: #{e}")
+      raise e
     end
 
     def ready?

data/lib/cem_acpt/platform/utils/linux.rb

@@ -6,6 +6,40 @@ module CemAcpt
       module Linux
         # Module provides SSH helper methods for Linux platforms
         class SSHelper
+          def self.env_ssh_pri_key
+            return unless ENV['CEM_ACPT_SSH_PRI_KEY']
+
+            File.expand_path(ENV['CEM_ACPT_SSH_PRI_KEY'])
+          end
+
+          def self.env_ssh_pri_key?
+            return false unless env_ssh_pri_key
+
+            File.exist?(env_ssh_pri_key)
+          end
+
+          def self.env_ssh_pub_key
+            "#{env_ssh_pri_key}.pub" if env_ssh_pri_key
+          end
+
+          def self.env_ssh_pub_key?
+            return false unless env_ssh_pub_key
+
+            File.exist?(env_ssh_pub_key)
+          end
+
+          def self.env_ssh_known_hosts
+            return unless ENV['CEM_ACPT_SSH_KNOWN_HOSTS']
+
+            File.expand_path(ENV['CEM_ACPT_SSH_KNOWN_HOSTS'])
+          end
+
+          def self.env_ssh_known_hosts?
+            return false unless env_ssh_known_hosts
+
+            File.exist?(env_ssh_known_hosts)
+          end
+
           def self.ssh_keygen?
             system('command -v ssh-keygen 2>&1 > /dev/null')
           end

data/lib/cem_acpt/test_runner/run_handler.rb

@@ -133,7 +133,18 @@ module CemAcpt
       def handle_runner_error_results(runner)
         @logger.error("SUMMARY: Encountered an error with test #{runner.node.test_data[:test_name]} on node #{runner.node.node_name}", no_prefix: true)
         runner.run_result.to_h.each do |k, v|
-          @logger.error("#{k.upcase}: #{v}", no_prefix: true)
+          if k == 'standard_error'
+            msg = v['message']
+            backtrace = v['backtrace']
+            @logger.error("#{k.upcase}: #{msg}", no_prefix: true) unless msg.nil?
+            @logger.error("BACKTRACE:\n#{backtrace.join("\n")}", no_prefix: true) unless backtrace.nil?
+          elsif v.is_a?(Hash)
+            v.each do |k2, v2|
+              @logger.error("#{k.upcase}: #{k2.upcase}: #{v2}", no_prefix: true)
+            end
+          else
+            @logger.error("#{k.upcase}: #{v}", no_prefix: true)
+          end
         end
       end
 

data/lib/cem_acpt/utils.rb

@@ -97,12 +97,16 @@ module CemAcpt
         end
 
         def self.create(keydir: CemAcpt::Utils::SSH.default_keydir)
+          return [false, false, false] if ENV['CEM_ACPT_TEST_SSH_KEY'] # Don't create ephemeral keys if this is set
+
           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
+          return if ENV['CEM_ACPT_TEST_SSH_KEY']
+
           [@priv_key, @pub_key, @known_hosts].each_with_object([]) do |f, arr|
             next unless f
 

data/lib/cem_acpt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement