cem_acpt 0.4.1-universal-java-17 → 0.5.0-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f2c9e1e9aa4fffc50e388e4a26b24f2d854e4f3bf6a6117b2e9d0fe90639da
-  data.tar.gz: f0f405849e4cec9cd02a1ae33a2e3248718531e0651b46b5e370de3eda3f597b
+  metadata.gz: cff2cb41ee31e39ce4c021c989f95d8c86ba029a4d20dd996a271dc3818894e8
+  data.tar.gz: 1717991fb2f8f883002a8a505e2a5500a366d45387cbbf99360254bd73509db9
 SHA512:
-  metadata.gz: a0c7428a5456f4c077fada428a99feeaa56c226f1e6b15b00e0f5e5cc96622fbf37a94e5d188f7bccfd959935c85c8354db0a6216dac6a95a1fc0384c7fc41ae
-  data.tar.gz: 1e695e81427ebf83324a3885ef17b233892a3f247ae8ee039a0255120aebe19aeb0087bc38df6d867a349f1126ae2d10792c4ee003d6966f8dabaa32ae5abd84
+  metadata.gz: 7bf62d8d01003f4867855916651b6c29219ec95851600c78e34737df42d3e5db883807142a22b26ee71092a4a37c1b3f4a6b4da69e5a8bf91f1372e0e1277d49
+  data.tar.gz: 977f72603efb1f9e51af9b0ac8e635684581922fdfa771998a020afea3ab4107439ac1540d0ba06aa56a75e889c251a50f42c554409fba02343fbe4d30867bd7

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.4.1-universal-java-17)
+    cem_acpt (0.5.0-universal-java-17)
       concurrent-ruby (>= 1.1, < 2.0)
       deep_merge (>= 1.2, < 2.0)
       ed25519 (>= 1.2, < 2.0)
-      net-ssh (>= 7.0, < 7.1)
+      net-ssh (>= 7.1, < 7.2)
       puppet-modulebuilder (>= 0.0.1)
       serverspec-cem-acpt
 
@@ -25,7 +25,7 @@ GEM
     multi_json (1.15.0)
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
-    net-ssh (7.0.1)
+    net-ssh (7.1.0)
     net-telnet (0.1.1)
     parallel (1.22.1)
     parser (3.2.1.1)

data/cem_acpt.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   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', '< 7.1'
+  spec.add_runtime_dependency 'net-ssh', '>= 7.1', '< 7.2'
   spec.add_runtime_dependency 'puppet-modulebuilder', '>= 0.0.1'
   spec.add_runtime_dependency 'serverspec-cem-acpt'
   spec.add_development_dependency 'rubocop'

data/lib/cem_acpt/context.rb

@@ -19,8 +19,7 @@ module CemAcpt
       KH_PATH = File.join([ENV['HOME'], '.ssh', 'acpt_test_known_hosts']).freeze
 
       def log(msg, level = :info)
-        real_msg = "CONTEXT: #{msg}"
-        logger.send(level, real_msg)
+        logger.send(level, 'CONTEXT') { msg }
       end
 
       # Builds the Puppet module package

data/lib/cem_acpt/image_name_builder.rb

@@ -41,13 +41,8 @@ module CemAcpt
     # @param test_data [Hash] The test data to use to build the image name.
     # @return [String] The image name.
     def build(test_data)
-      logger.debug 'Building image name...'
-      logger.debug "Using config: #{@config.to_h}"
-      logger.debug "Test data: #{test_data}"
       parts = resolve_parts(test_data)
-      logger.debug "Resolved parts: #{parts}"
       image_name = create_image_name(parts)
-      logger.debug "Created image name: #{image_name}"
       final_image_name = character_substitutions(image_name)
       logger.debug "Final image name: #{final_image_name}"
       final_image_name
@@ -61,10 +56,8 @@ module CemAcpt
     # @return [Array] The parts array with variables resolved.
     def resolve_parts(test_data)
       @config[:parts].each_with_object([]) do |part, ary|
-        logger.debug "Resolving part: #{part}"
         if part.start_with?('$')
           var_path = part[1..-1]
-          logger.debug "Resolving variable path: #{var_path}"
           ary << test_data.dot_dig(var_path)
         else
           ary << part
@@ -77,10 +70,8 @@ module CemAcpt
     # @return [String] The image name.
     def create_image_name(parts)
       image_name = @config[:join_with] ? parts.join(@config[:join_with]) : parts.join
-      logger.debug("Final image name: #{image_name}")
 
       if @config[:validation_pattern]
-        logger.debug "Validating image name: #{image_name}..."
         return image_name if image_name.match?(@config[:validation_pattern])
 
         raise "Image name #{image_name} does not match validation pattern #{@config[:validation_pattern]}"

data/lib/cem_acpt/logging.rb

@@ -41,51 +41,103 @@ module CemAcpt
     # correctly formats the log output when using the standard
     # Ruby Logger class methods such as #info, #debug, etc.
     class Logger < ::Logger
+      attr_accessor :trap_context
+
       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
+        @ci_mode = (kwargs[:formatter].is_a?(Formatter::GithubActionFormatter) || !ENV['GITHUB_ACTIONS'].nil? || !ENV['CI'].nil?)
+        @raw_logdev = logdev # Used for logging from trap context
+        @trap_context = false # If true, will not use the standard Logger methods and will write directly to the logdev
       end
 
       def debug(progname = nil, &block)
-        unless log_ci_mode('debug', progname, &block)
-          super
-        end
+        return if log_trap_context('debug', progname, &block)
+        return if log_ci_mode('debug', progname, &block)
+
+        super
       end
 
       def info(progname = nil, &block)
-        unless log_ci_mode('info', progname, &block)
-          super
-        end
+        return if log_trap_context('info', progname, &block)
+        return if log_ci_mode('info', progname, &block)
+
+        super
       end
 
       def warn(progname = nil, &block)
-        unless log_ci_mode('warn', progname, &block)
-          super
-        end
+        return if log_trap_context('warn', progname, &block)
+        return if log_ci_mode('warn', progname, &block)
+
+        super
       end
 
       def error(progname = nil, &block)
-        unless log_ci_mode('error', progname, &block)
-          super
-        end
+        return if log_trap_context('error', progname, &block)
+        return if log_ci_mode('error', progname, &block)
+
+        super
       end
 
       def fatal(progname = nil, &block)
-        unless log_ci_mode('fatal', progname, &block)
-          super
-        end
+        return if log_trap_context('fatal', progname, &block)
+        return if log_ci_mode('fatal', progname, &block)
+
+        super
       end
 
       private
 
+      # Can't use the standard Logger methods when in trap context
+      # because they don't work. So we have to write directly to the
+      # raw logdev. Unlike the standard Logger methods, there is no
+      # Mutex lock, so messages are not guaranteed to be in order.
+      # This is necessary in the trap context because using a Mutex
+      # lock in a trap context will cause a deadlock.
+      def log_trap_context(severity, progname = nil, &block)
+        return false unless @trap_context
+
+        if @raw_logdev.respond_to?(:puts)
+          @raw_logdev.puts(ci_format(severity, false, progname, &block))
+        elsif @raw_logdev.respond_to?(:write)
+          @raw_logdev.write(ci_format(severity, true, progname, &block))
+        else
+          # Default to logging to STDERR
+          $stderr.puts(ci_format(severity, false, progname, &block))
+        end
+        true
+      end
+
+      # CI mode uses << instead of the standard Logger methods
+      # because Github Actions wants messages to be echoed. This
+      # is a way to ensure that, in the event of using a multi-logger
+      # with a standard Logger, the CI mode messages are still
+      # formatted correctly.
       def log_ci_mode(severity, progname = nil, &block)
         return false unless @ci_mode
 
-        self.<<("::#{severity}::#{progname || (block && block.call) || ''}\n")
+        self.<<(ci_format(severity, true, progname, &block))
         true
       end
+
+      # Formats the log message for CI mode, translating the severity
+      # level to the correct format for Github Actions and adding
+      # the colon separators.
+      def ci_format(severity, newline = true, progname = nil, &block)
+        sev = if severity == 'fatal'
+                'error'
+              elsif severity == 'warn'
+                'warning'
+              elsif severity == 'info'
+                'notice'
+              else
+                severity
+              end
+        block_message = block_given? ? block.call : nil
+        base = [progname, block_message].compact.join(': ')
+        return if base.empty?
+
+        newline ? "::#{sev}::#{base}\n" : "::#{sev}::#{base}"
+      end
     end
 
     class << self

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

@@ -72,7 +72,7 @@ module CemAcpt::Platform::Gcp
       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")
+        logger.debug("Using default gcloud SSH key: #{File.join([ENV['HOME'], '.ssh', 'google_compute_engine'])}")
         @ssh_key = File.join([ENV['HOME'], '.ssh', 'google_compute_engine'])
       end
       @ssh_key
@@ -95,7 +95,13 @@ module CemAcpt::Platform::Gcp
     def local_exec(command, out_format: 'json', out_filter: nil, project_flag: true)
       final_command = format_gcloud_command(command, out_format: out_format, out_filter: out_filter, project_flag: project_flag)
       stdout, stderr, status = Open3.capture3(env, final_command)
-      raise "gcloud command '#{final_command}' failed: #{stderr}" unless status.success?
+      unless status.success?
+        if ENV['CEM_ACPT_VERBOSE'] && (final_command.start_with?('gcloud compute ssh') || final_command.start_with?('gcloud compute scp'))
+          sout, serr, stat = Open3.capture3(env, "#{final_command} --dry-run")
+          stat.success? ? logger.debug("Real command: #{sout}") : logger.debug("Failed to get real command: #{serr}")
+        end
+        raise "gcloud command '#{final_command}' failed: #{stderr}"
+      end
 
       if format(out_format) == 'json'
         begin
@@ -135,7 +141,6 @@ module CemAcpt::Platform::Gcp
     def ssh(instance_name, cmd, ignore_command_errors: false, use_proxy_command: true, opts: {})
       Net::SSH.start(instance_name, user_name,
                      ssh_opts(instance_name: instance_name, use_proxy_command: use_proxy_command, opts: opts)) do |ssh|
-        logger.debug("Running SSH command '#{cmd}' on instance '#{instance_name}'")
         result = ssh.exec!(cmd)
         if result.exitstatus != 0 && !ignore_command_errors
           abridged_cmd = cmd.length > 100 ? "#{cmd[0..100]}..." : cmd
@@ -152,11 +157,20 @@ module CemAcpt::Platform::Gcp
       cmd = [
         'compute',
         'scp',
+        # "--ssh-key-file=#{ssh_key}",
+        # "--strict-host-key-checking=no",
+        '--plain', # This suppresses ALL gcloud added SCP flags aside from ProxyCommand
+        "--scp-flag='-o IdentityFile=#{ssh_key}'", # -i is bugged
+        "--scp-flag='-o CheckHostIP=no'",
+        "--scp-flag='-o HashKnownHosts=no'",
+        "--scp-flag='-o HostKeyAlias=#{vm_alias(instance_name)}'",
+        "--scp-flag='-o IdentitiesOnly=yes'",
+        "--scp-flag='-o StrictHostKeyChecking=no'",
+        "--scp-flag='-o UserKnownHostsFile=#{ssh_opts[:user_known_hosts_file]}'",
       ]
-      cmd << '--strict-host-key-checking=no'
       cmd << "--tunnel-through-iap" if use_proxy_command
       cmd << "--recurse" if scp_opts[:recurse]
-      cmd << "#{local} #{instance_name}:#{remote}"
+      cmd << "#{local} #{ssh_opts[:user]}@#{instance_name}:#{remote}"
       local_exec(cmd.join(' '), out_format: 'json')
     end
 
@@ -167,24 +181,32 @@ module CemAcpt::Platform::Gcp
       cmd = [
         'compute',
         'scp',
+        # "--ssh-key-file=#{ssh_key}",
+        # "--strict-host-key-checking=no",
+        '--plain', # This suppresses ALL gcloud added SCP flags aside from ProxyCommand
+        "--scp-flag='-o IdentityFile=#{ssh_key}'",
+        "--scp-flag='-o CheckHostIP=no'",
+        "--scp-flag='-o HashKnownHosts=no'",
+        "--scp-flag='-o HostKeyAlias=#{vm_alias(instance_name)}'",
+        "--scp-flag='-o IdentitiesOnly=yes'",
+        "--scp-flag='-o StrictHostKeyChecking=no'",
+        "--scp-flag='-o UserKnownHostsFile=#{ssh_opts[:user_known_hosts_file]}'",
       ]
-      cmd << '--strict-host-key-checking=no'
       cmd << '--tunnel-through-iap' if use_proxy_command
       cmd << '--recurse' if scp_opts[:recurse]
-      cmd << "#{instance_name}:#{remote} #{local}"
+      cmd << "#{ssh_opts[:user]}@#{instance_name}:#{remote} #{local}"
       local_exec(cmd.join(' '), out_format: 'json')
     end
 
     def ssh_ready?(instance_name, opts: {})
-      ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
-      logger.debug("Testing SSH connection to #{instance_name} with options #{ssh_options}")
+      # ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
+      # logger.debug("Testing SSH connection to #{instance_name} with options #{ssh_options}")
       gcloud_ssh(instance_name, 'echo "SSH is ready"')
-      logger.debug('Removing ecdsa & ed25519 host keys from config due to bug in jruby-openssl')
-      gcloud_ssh(instance_name, 'sudo sed -E -i "s;HostKey /etc/ssh/ssh_host_(ecdsa|ed25519)_key;;g" /etc/ssh/sshd_config')
-      logger.debug('Restarting SSH service')
-      gcloud_ssh(instance_name, 'sudo systemctl restart sshd', ignore_command_errors: true)
+      # logger.debug('Removing ecdsa & ed25519 host keys from config due to bug in jruby-openssl')
+      # gcloud_ssh(instance_name, 'sudo sed -E -i "s;HostKey /etc/ssh/ssh_host_(ecdsa|ed25519)_key;;g" /etc/ssh/sshd_config')
+      # logger.debug('Restarting SSH service')
+      # gcloud_ssh(instance_name, 'sudo systemctl restart sshd', ignore_command_errors: true)
       logger.info("SSH connection to #{instance_name} is ready")
-      logger.debug('Getting OS release')
       osr = gcloud_ssh(instance_name, 'sudo cat /etc/os-release')
       @os_release = CemAcpt::Platform::Utils::Linux::OSRelease.new(osr)
       logger.debug("OS release: #{@os_release.to_h}")
@@ -195,8 +217,8 @@ module CemAcpt::Platform::Gcp
     end
 
     def dnf_automatic_success?(instance_name, opts: {})
-      ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
-      logger.debug("Checking dnf-automatic success on #{instance_name} with options #{ssh_options}")
+      # ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
+      # logger.debug("Checking dnf-automatic success on #{instance_name} with options #{ssh_options}")
       gcloud_ssh(instance_name, 'sudo systemctl restart dnf-automatic.timer')
       true
     rescue StandardError => e
@@ -205,8 +227,8 @@ module CemAcpt::Platform::Gcp
     end
 
     def rpm_db_check_success?(instance_name, pkgmgr, opts: {})
-      ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
-      logger.debug("Checking #{pkgmgr} rpm db on #{instance_name} with options #{ssh_options}")
+      # ssh_options = ssh_opts(instance_name: instance_name, opts: opts)
+      # logger.debug("Checking #{pkgmgr} rpm db on #{instance_name} with options #{ssh_options}")
       gcloud_ssh(instance_name, "sudo #{pkgmgr} upgrade -y rpm glibc")
       gcloud_ssh(instance_name, "sudo rm -f /var/lib/rpm/.rpm.lock")
       gcloud_ssh(instance_name, "sudo #{pkgmgr} upgrade -y #{pkgmgr}")
@@ -318,11 +340,16 @@ module CemAcpt::Platform::Gcp
       cmd = [
         'compute',
         'ssh',
-        '--ssh-key-file',
-        ssh_key,
         '--tunnel-through-iap',
+        '--plain', # This suppresses ALL gcloud added SSH flags aside from ProxyCommand
+        "--ssh-flag='-i #{ssh_key}'",
+        "--ssh-flag='-o CheckHostIP=no'",
+        "--ssh-flag='-o HashKnownHosts=no'",
+        "--ssh-flag='-o HostKeyAlias=#{vm_alias(instance_name)}'",
+        "--ssh-flag='-o IdentitiesOnly=yes'",
+        "--ssh-flag='-o StrictHostKeyChecking=no'",
         "--ssh-flag='-o UserKnownHostsFile=#{ssh_opts[:user_known_hosts_file]}'",
-        instance_name,
+        "#{ssh_opts[:user]}@#{instance_name}",
         "--command='#{command}'",
       ].join(' ')
       local_exec(cmd)
@@ -352,21 +379,24 @@ module CemAcpt::Platform::Gcp
       dopts = {
         auth_methods: ['publickey'],
         check_host_ip: false,
-        compression: true,
         config: false,
+        global_known_hosts_file: '/dev/null',
+        user_known_hosts_file: '/dev/null',
         keys: [ssh_key],
         keys_only: true,
         kex: ['diffie-hellman-group-exchange-sha256'], # ecdh algos cause jruby to shit the bed
+        max_pkt_size: 0x10000,
         non_interactive: true,
         port: 22,
         user: user_name,
         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[:logger] = logger if ENV['CEM_ACPT_VERBOSE']
+      # 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
 

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

@@ -229,7 +229,6 @@ module CemAcpt::Platform::Gcp
 
     def info
       describe_cmd = "compute instances describe #{name}"
-      logger.debug("Gathering info for VM #{name} with gcloud command: #{describe_cmd}")
       data = @cmd.local_exec(describe_cmd, out_format: 'json')
       opts = @cmd.ssh_opts(instance_name: name)
       {
@@ -243,7 +242,7 @@ module CemAcpt::Platform::Gcp
     def create
       unless @cmd.ssh_key.include?('google_compute_engine')
         # Add the test ssh key to os-login
-        logger.debug("Adding test SSH key to os-login for #{name}")
+        logger.info("Adding test SSH key #{@cmd.ssh_key}.pub to os-login for #{name}")
         @cmd.local_exec("compute os-login ssh-keys add --key-file #{@cmd.ssh_key}.pub --project #{project.name} --ttl 1h")
       end
       @cmd.local_exec(create_cmd)
@@ -253,12 +252,10 @@ module CemAcpt::Platform::Gcp
     end
 
     def ready?
-      logger.debug("Checking if VM #{name} is ready")
       instance_status = @cmd.local_exec('compute instances list', out_filter: "NAME = #{name}").first['status']
       logger.debug("Instance #{name} status: #{instance_status}")
       return false unless instance_status == 'RUNNING'
 
-      logger.debug("Checking instance #{name} SSH connectivity")
       @cmd.ssh_ready?(name)
     rescue StandardError, Exception
       false
@@ -275,7 +272,6 @@ module CemAcpt::Platform::Gcp
 
     def rpm_db_check_success?
       if os_release.name.match?(%r{^Red Hat.*})
-        logger.debug("Checking rpmdb on #{name} with platform #{info[:os_release][:platform]}")
         pkgmgr = os_release.version.match?(%r{^(8|9).*}) ? 'dnf' : 'yum'
         @cmd.rpm_db_check_success?(name, pkgmgr)
       else

data/lib/cem_acpt/platform/gcp.rb

@@ -20,7 +20,6 @@ module Platform
       components: creation_params,
     )
     @instance.configure!
-    logger.debug("Creating with command: #{@instance.send(:create_cmd)}")
     @instance.create
   end
 
@@ -31,26 +30,22 @@ module Platform
 
   # Returns true if the GCP instance is ready for use in the test suite
   def ready?
-    logger.debug("Checking if #{node_name} is ready...")
     @instance.ready?
   end
 
   # Returns true if dnf_automatic ran successfully on the GCP instance
   def dnf_automatic_success?
-    logger.debug("Checking if dnf_automatic ran successfully on #{node_name}...")
     @instance.dnf_automatic_success?
   end
 
   # Returns true if rpm_db_check ran successfully on the GCP instance
   def rpm_db_check_success?
-    logger.debug("Checking if rpm_db_check ran successfully on #{node_name}...")
     @instance.rpm_db_check_success?
   end
 
   # Runs the test suite against the GCP instance. Must be given a block.
   # If necessary, can pass information into the block to be used in the test suite.
   def run_tests(&block)
-    logger.debug("Running tests for #{node_name}...")
     block.call @instance.cmd.env
   end
 
@@ -58,7 +53,6 @@ module Platform
   def install_puppet_module_package(module_pkg_path, remote_path = nil, puppet_path = '/opt/puppetlabs/bin/puppet')
     remote_path = remote_path.nil? ? File.join('/tmp', File.basename(module_pkg_path)) : remote_path
     logger.info("Uploading module package #{module_pkg_path} to #{remote_path} on #{node_name} and installing it...")
-    logger.debug("Using puppet path: #{puppet_path}")
     @instance.install_puppet_module_package(module_pkg_path, remote_path, puppet_path)
     logger.info("Module package #{module_pkg_path} installed on #{node_name}")
   end

data/lib/cem_acpt/puppet_helpers.rb

@@ -28,7 +28,6 @@ module CemAcpt
 
         # Validates module metadata by raising exception if invalid
         _metadata = builder.metadata
-        logger.debug("Metadata for module #{builder.release_name} is valid")
 
         # Builds the module package
         logger.info("Building module package for #{builder.release_name}")

data/lib/cem_acpt/rspec_utils.rb

@@ -14,7 +14,7 @@ module CemAcpt
 
     # Holds RSpec options used by Command
     class Options
-      OPTIONS = %i[test_path bundle rspec use_bundler bundle_install format debug quiet env].freeze
+      OPTIONS = %i[test_path bundle rspec use_bundler bundle_install format debug profile backtrace quiet env].freeze
 
       attr_accessor(*OPTIONS)
 
@@ -65,9 +65,11 @@ module CemAcpt
       def defaults
         @defaults ||= { use_bundler: false,
                         bundle_install: false,
-                        format: { documentation: nil },
+                        format: { progress: nil },
                         debug: false,
                         quiet: false,
+                        profile: false,
+                        backtrace: false,
                         env: {} }
       end
 
@@ -123,7 +125,11 @@ module CemAcpt
       # Returns an array representation of the RSpec command
       def to_a
         cmd = cmd_base.dup
+        cmd << '--no-color'
         cmd << opts.test_path if opts.test_path
+        cmd << '--debug' if opts.debug
+        cmd << '--profile' if opts.profile
+        cmd << '--backtrace' if opts.backtrace
         opts.format.each do |fmt, out|
           cmd += ['--format', fmt.to_s.shellescape]
           cmd += ['--out', out.to_s.shellescape] if out
@@ -156,10 +162,8 @@ module CemAcpt
       #   the RSpec command.
       # @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(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 $?"
           handle_io(r, log_prefix: log_prefix)
@@ -173,14 +177,15 @@ module CemAcpt
       #   the RSpec command.
       # @return [Integer] The exit code of the RSpec command
       def execute_no_pty(log_prefix: 'RSPEC')
-        async_info("Executing RSpec command '#{self}' with Open3.popen2e()...", log_prefix)
-        exit_status = nil
-        Open3.popen2e(opts.env, to_s) do |stdin, std_out_err, wait_thr|
-          stdin.close
-          handle_io(std_out_err, log_prefix: log_prefix)
-          exit_status = wait_thr.value
-        end
-        exit_status
+        _std_out_err, exit_status = Open3.capture2e(opts.env, to_s)
+        exit_status.to_i
+        # exit_status = nil
+        # Open3.popen2e(opts.env, to_s) do |stdin, std_out_err, wait_thr|
+        #   stdin.close
+        #   handle_io(std_out_err, log_prefix: log_prefix)
+        #   exit_status = wait_thr.value
+        # end
+        # exit_status
       end
 
       # Kills the PTY process with `SIGKILL` if the process exists

data/lib/cem_acpt/shared_objects.rb

@@ -484,7 +484,9 @@ module CemAcpt
   # total assignable ports are set to all ports in the ephemeral port range.
   # When a port is allocated, it's removed from the port range.
   class LocalPortAllocator
-    EPHEMERAL_PORT_RANGE = (49_152..65_535).to_a.freeze
+    # The ephemeral port range is 49,152 to 65,534. We don't use 65,535
+    # because MacOS shits the bed when trying to use it.
+    EPHEMERAL_PORT_RANGE = (49_152..65_534).to_a.freeze
 
     def initialize
       @port_range = Concurrent::Array.new(EPHEMERAL_PORT_RANGE.dup).shuffle!

data/lib/cem_acpt/test_data.rb

@@ -35,7 +35,6 @@ module CemAcpt
         logger.info 'Gathering acceptance test data...'
         raise "No 'tests' entry found in config file" unless @config.has?('tests')
         @config.get('tests').each_with_object([]) do |test_name, a|
-          logger.debug("Processing test #{test_name}...")
           test_file = acceptance_tests.find { |f| File.basename(f, '_spec.rb') == test_name }
           raise "Test file not found for test #{test_name}" unless test_file
           logger.debug("Test file found for test #{test_name}: #{test_file}")

data/lib/cem_acpt/test_runner/run_handler.rb

@@ -28,7 +28,6 @@ module CemAcpt
         @run_context = run_context
         @module_pkg_path = Concurrent::IVar.new
         @runners = Concurrent::Array.new
-        @thread_pool = Concurrent::SimpleExecutorService.new
         @logger = use_logger(nil, stage: 'RunHandler')
       end
 
@@ -39,13 +38,17 @@ module CemAcpt
 
       # Runs the acceptance test suites.
       def run
-        @logger.info('creating and starting test runners...')
         create_runners
-        @logger.info("created #{@runners.length} runners...")
-        @runners.map { |r| @thread_pool.post { r.start } }
-        @thread_pool.shutdown
-        @thread_pool.wait_for_termination
-        @thread_pool = Concurrent::SimpleExecutorService.new
+        @logger.info("created #{@runners.length} runner(s)...")
+        if @runners.length > 1
+          @thread_pool = Concurrent::SimpleExecutorService.new
+          @runners.map { |r| @thread_pool.post { r.start } }
+          @thread_pool.shutdown
+          @thread_pool.wait_for_termination
+          @thread_pool = Concurrent::SimpleExecutorService.new
+        else
+          @runners[0].start
+        end
         @logger.info('test runners have all exited...')
       rescue StandardError => e
         handle_fatal_error(e)
@@ -56,8 +59,14 @@ module CemAcpt
       def destroy_test_nodes
         return if @runners.empty? || @runners.none?(&:node_exists)
 
-        @runners.each do |r|
-          r.send(:destroy) if r.node_exists
+        if @runners.length > 1
+          @thread_pool.kill
+          destroy_thread_pool = Concurrent::SimpleExecutorService.new
+          @runners.map { |r| destroy_thread_pool.post { r.destroy } if r.node_exists }
+          destroy_thread_pool.shutdown
+          destroy_thread_pool.wait_for_termination
+        else
+          @runners[0].destroy if @runners[0].node_exists
         end
       end
 
@@ -98,6 +107,7 @@ module CemAcpt
             next
           end
           unless runner.test_failures?
+            debug_test_results(runner)
             @logger << "::endgroup::\n"
             next
           end
@@ -111,7 +121,7 @@ module CemAcpt
           else
             handle_runner_error_results(runner)
           end
-          #debug_test_results(runner) if logger.debug?
+          debug_test_results(runner)
           @logger << "::endgroup::\n"
         end
       end
@@ -138,8 +148,8 @@ module CemAcpt
             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|
+          elsif v.respond_to?(:to_h)
+            v.to_h.each do |k2, v2|
               @logger.error("#{k.upcase}: #{k2.upcase}: #{v2}", no_prefix: true)
             end
           else
@@ -192,24 +202,16 @@ module CemAcpt
 
       # Logs performance data for the acceptance test suites.
       # This is only logged if the log level is set to debug.
-      # def debug_test_results(runner)
-      #   examples_by_time = []
-      #   runner.run_result.to_h.each do |node, result|
-      #     next unless result['examples']
-
-      #     result['examples'].each do |e|
-      #       examples_by_time << [e['run_time'], e['id'], e['status'], e['line_number'], node]
-      #     end
-      #   end
-      #   if examples_by_time
-      #     logger.debug('Showing test results in order of execution time...')
-      #     examples_by_time.sort_by(&:first).reverse.each do |e|
-      #       logger.debug("RUNTIME: #{e[0]}; ID: #{e[1]}; STATUS: #{e[2]}; LINE: #{e[3]}; HOST: #{e[4]};")
-      #     end
-      #   else
-      #     logger.debug('No debug results to show')
-      #   end
-      # end
+      def debug_test_results(runner)
+        @logger.debug("RSPEC VERSION: #{runner.run_result.rspec_version}", no_prefix: true) if runner.run_result.rspec_version
+        @logger.debug("TOTAL RSPEC RUN TIME: #{runner.run_result.duration} seconds", no_prefix: true) if runner.run_result.duration
+        num_slowest = runner.run_result.slowest_examples.length
+        if num_slowest.positive?
+          runner.run_result.slowest_examples.each_with_index do |e, idx|
+            @logger.debug("SLOWEST TEST(#{idx + 1} of #{num_slowest}): #{e}", no_prefix: true)
+          end
+        end
+      end
 
       # Gracefully handles a fatal error and exits the program.
       # @param err [StandardError, Exception] the error that caused the fatal error

data/lib/cem_acpt/test_runner/runner.rb

@@ -47,7 +47,10 @@ module CemAcpt
         @provision_attempts = 0
         @provision_start_time = nil
         @node_exists = false
-        @run_result = CemAcpt::TestRunner::RunnerResult.new(@node, debug: @debug_mode)
+        @run_result = CemAcpt::TestRunner::RunnerResult.new(@node,
+                                                            config: @context.config,
+                                                            test_data: @context.test_data,
+                                                            debug: @debug_mode)
         @logger = use_logger(nil, stage: 'Runner', node: @node.node_name, test: @node.test_data[:test_name])
         validate!
       end
@@ -59,9 +62,9 @@ module CemAcpt
         @workflow.run
         if @workflow.success?
           @run_result = @workflow.last_result
-          @workflow.completed_steps.each do |s|
-            @logger.info("Step '#{s.name}' completed successfully")
-          end
+          # @workflow.completed_steps.each do |s|
+          #   @logger.info("Step '#{s.name}' completed successfully")
+          # end
           true
         else
           @run_result = @workflow.last_error
@@ -70,7 +73,10 @@ module CemAcpt
         end
       rescue StandardError => e
         step_error_logging(e, :fatal)
-        @run_result = CemAcpt::TestRunner::RunnerResult.new(@node, debug: @debug_mode)
+        @run_result = CemAcpt::TestRunner::RunnerResult.new(@node,
+                                                            config: @context.config,
+                                                            test_data: @context.test_data,
+                                                            debug: @debug_mode)
         @run_result.from_error(e)
       end
 
@@ -108,8 +114,8 @@ module CemAcpt
                 "runner failed: #{err.message}"
               end
         @logger.send(kind, msg)
-        @logger.debug("failed runner backtrace:\n#{err.backtrace.join("\n")}")
-        @logger.debug("failed runner test data: #{@node.test_data}")
+        # @logger.debug("failed runner backtrace:\n#{err.backtrace.join("\n")}")
+        # @logger.debug("failed runner test data: #{@node.test_data}")
       end
 
       def log_prefix(prefix)

data/lib/cem_acpt/test_runner/runner_result.rb

@@ -16,14 +16,31 @@ module CemAcpt
     class RunnerResult
       attr_reader :run_result
 
-      def initialize(node, debug: false)
+      def initialize(node, config: nil, test_data: nil, debug: false)
         @node = node
-        @run_result = {}
+        @config = config
+        @test_data = test_data
         @debug = debug
+        @run_result = {}
+      end
+      alias to_h run_result
+
+      def duration
+        return unless run_result['summary']&.key?('duration')
+
+        @duration ||= run_result['summary']['duration']
+      end
+
+      def slowest_examples
+        return [] unless run_result&.key?('examples')
+
+        @slowest_examples ||= run_result['examples'].sort_by { |e| e['run_time'] }.reverse[0..4].map do |e|
+          "#{e['full_description']} (~#{e['run_time'].round(1)} seconds)"
+        end
       end
 
-      def to_h
-        @run_result
+      def rspec_version
+        run_result['version']
       end
 
       def debug?
@@ -91,8 +108,8 @@ module CemAcpt
         results.merge(
           {
             'debug' => {
-              'node' => @node,
-              'config' => @config,
+              'node' => @node.node,
+              'config' => @config.to_h,
               'test_data' => @test_data,
             }
           }

data/lib/cem_acpt/test_runner/runner_workflow_builder.rb

@@ -130,7 +130,7 @@ module CemAcpt
           node: @node,
           module_pkg_path: module_pkg_path,
           retryable: kwargs[:retryable] || true,
-          retry_delay: kwargs[:retry_delay] || 60,
+          retry_delay: kwargs[:retry_delay] || 30,
         }
         @workflow.add_step(:bootstrap, **opts) do |s|
           s.opts[:node].install_puppet_module_package(s.opts[:module_pkg_path])

data/lib/cem_acpt/test_runner/workflow/manager.rb

@@ -139,14 +139,14 @@ module CemAcpt
           case result
           when :retry_workflow
             log_warn("step '#{step.name}' failed and requested a workflow retry")
-            log_debug("step '#{step.name}' failed with error: #{step.last_error.message}")
-            log_debug("step '#{step.name}' failed with error: #{step.last_error.backtrace.join("\n")}")
+            # log_debug("step '#{step.name}' failed with error: #{step.last_error.message}")
+            # log_debug("step '#{step.name}' failed with error: #{step.last_error.backtrace.join("\n")}")
             @last_error = step.last_error
             retry_workflow
           when :fail
             log_warn("step '#{step.name}' failed")
-            log_debug(step.last_error.message)
-            log_debug(step.last_error.backtrace.join("\n"))
+            # log_debug(step.last_error.message)
+            # log_debug(step.last_error.backtrace.join("\n"))
             @last_error = step.last_error
             if ignore_failures?
               log_warn("ignoring failure of step '#{step.name}'")
@@ -157,7 +157,7 @@ module CemAcpt
             end
           else
             log_info("step '#{step.name}' succeeded")
-            log_debug("step '#{step.name}' returned: #{result}")
+            # log_debug("step '#{step.name}' returned: #{result}")
             @completed_steps << step
           end
         end

data/lib/cem_acpt/version.rb

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

data/lib/cem_acpt.rb

@@ -28,6 +28,20 @@ module CemAcpt
       level: log_level,
       formatter: log_formatter,
     )
+    Signal.trap('INT') do
+      logger.trap_context = true
+      logger.fatal('Signal Handler') { 'Received interrupt signal. Cleaning up test suite...' }
+      CemAcpt::Context.clean_up_test_suite(params)
+      logger.fatal('Signal Handler') { 'Exiting due to interrupt signal' }
+      exit 1
+    end
+    Signal.trap('TERM') do
+      logger.trap_context = true
+      logger.fatal('Signal Handler') { 'Received terminate signal. Cleaning up test suite...' }
+      CemAcpt::Context.clean_up_test_suite(params)
+      logger.fatal('Signal Handler') { 'Exiting due to terminate signal' }
+      exit 1
+    end
     exit_code = CemAcpt::Context.with(params, &:run)
     exit exit_code
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -75,10 +75,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   name: net-ssh
   prerelease: false
   type: :runtime
@@ -86,10 +86,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: