cem_acpt 0.3.3-universal-java-17 → 0.3.5-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d9f549fee6436b9f857dbdf313dcab94b223e988c2cbfeadd8999d86f436f0
-  data.tar.gz: 62a556754fe568b9d3bbc28b7381b3657c7aa0db872e5405bb392a1b9cef061d
+  metadata.gz: b62e59f800597758c9a69bc1ede3d3f97a9a68c6c38f0d4705201ac2613feab9
+  data.tar.gz: 4d4a0ad559702df7cff661726a962b0bbc278d2cb0ecba48241a67a55345dac6
 SHA512:
-  metadata.gz: bf027699bcf399a68a6b845ef4191b4b912736f6eb52708e35a0393e78fce74f3c0299ee627bbfe80ec06a8ef9be0e5b030db6a1ab99a678943c8ebdf21112f6
-  data.tar.gz: eb7448394e6be3719a735cf30adedae0aefb0ea8a6144523300c2e57da61bdbb3dfbf76a394b3c2014cc78a8283a6c565f2f311481951d09f1211454f22add74
+  metadata.gz: ee72270cae3121c03597e12f91c3fd6134da4ab40ef342cc3f694ea0a5ee2dcaf37363e9430b2610539120e0cf5ea733caf191d916a926e2d29dc17ac8bc7cfb
+  data.tar.gz: 79a40b4e74935a7842bffd7b9252aa63d277cc31e49c0a3a10200f647117a1c3e51d4183a3e2e16aa9cc0e1fd185d0ee375177fdc876ca4097e8828884b55f36

data/.github/workflows/spec.yml

@@ -0,0 +1,36 @@
+name: Unit Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - main
+    tags:
+      - v.*
+
+jobs:
+  tests:
+    name: RSpec tests
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v3
+      
+      - name: Set up Java 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt-hotspot'
+          java-version: '17'
+
+      - name: Set up JRuby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: jruby-9.3.3.0
+          bundler-cache: true
+
+      - name: Run RSpec
+        run: |
+          bundle exec rake spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.3.3-universal-java-17)
+    cem_acpt (0.3.5-universal-java-17)
       concurrent-ruby (>= 1.1, < 2.0)
       deep_merge (>= 1.2, < 2.0)
       ed25519 (>= 1.2, < 2.0)
@@ -13,10 +13,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
     deep_merge (1.2.2)
     diff-lcs (1.5.0)
     ed25519 (1.3.0-java)
+    ffi (1.15.5-java)
+    method_source (1.0.0)
     minitar (0.9)
     multi_json (1.15.0)
     net-scp (4.0.0)
@@ -27,6 +30,10 @@ GEM
     parser (3.1.2.0)
       ast (~> 2.4.1)
     pathspec (1.0.0)
+    pry (0.14.2-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
     puppet-modulebuilder (0.3.0)
       minitar (~> 0.9)
       pathspec (>= 0.2.1, < 2.0.0)
@@ -73,6 +80,8 @@ GEM
       net-ssh (>= 2.7)
       net-telnet (= 0.1.1)
       sfl
+    spoon (0.0.6)
+      ffi
     unicode-display_width (2.2.0)
 
 PLATFORMS
@@ -80,9 +89,10 @@ PLATFORMS
 
 DEPENDENCIES
   cem_acpt!
+  pry
   rake (>= 12.0)
   rspec (>= 3.0)
   rubocop
 
 BUNDLED WITH
-   2.3.25
+   2.3.15

data/cem_acpt.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'puppet-modulebuilder', '>= 0.0.1'
   spec.add_runtime_dependency 'serverspec-cem-acpt'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
 end

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

@@ -4,6 +4,7 @@ module CemAcpt::Platform::Gcp
   require 'json'
   require 'open3'
   require_relative File.join(__dir__, '..', 'base', 'cmd.rb')
+  require_relative File.join(__dir__, '..', 'utils', 'linux.rb')
 
   # This class provides methods to run gcloud commands. It allows for default values to be
   # set for the project, zone, and user and can also find these values from the local config.
@@ -59,6 +60,10 @@ module CemAcpt::Platform::Gcp
       @local_port ||= rand(49_512..65_535)
     end
 
+    def os_release
+      @os_release || :not_set
+    end
+
     def ssh_key
       return @ssh_key unless @ssh_key.nil?
 
@@ -108,6 +113,9 @@ module CemAcpt::Platform::Gcp
 
     # Deletes a GCP VM instance.
     def delete_instance(instance_name)
+      ssh_all_known_hosts.each do |kh_file|
+        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.
@@ -173,12 +181,38 @@ module CemAcpt::Platform::Gcp
       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}")
       true
     rescue StandardError => e
       logger.debug("SSH connection to #{instance_name} failed: #{e}")
       false
     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}")
+      gcloud_ssh(instance_name, 'sudo systemctl restart dnf-automatic.timer')
+      true
+    rescue StandardError => e
+      logger.error("DNF automatic updates on #{instance_name} failed: #{e}")
+      false
+    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}")
+      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}")
+      true
+    rescue StandardError => e
+      logger.error("#{pkgmgr} rpm db check on #{instance_name} failed: #{e}")
+      false
+    end
+
     # This function spawns a background thread to run a GCP IAP tunnel, run the given
     # code block, then kill the thread. The code block will be yielded ssh_opts that
     # are used to configure SSH connections over the IAP tunnel. The IAP tunnel is
@@ -287,6 +321,14 @@ module CemAcpt::Platform::Gcp
       "compute.#{vm_describe(vm)['id']}"
     end
 
+    def ssh_all_known_hosts
+      [
+        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'),
+      ]
+    end
+
     # Default options for Net::SSH
     def default_ssh_opts
       {

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

@@ -236,6 +236,7 @@ module CemAcpt::Platform::Gcp
         node_data: data,
         transport: :ssh,
         ssh_opts: opts,
+        os_release: os_release.to_h,
       }
     end
 
@@ -260,6 +261,29 @@ module CemAcpt::Platform::Gcp
       false
     end
 
+    def dnf_automatic_success?
+      if os_release.name.match?(%r{^Red Hat.*}) && os_release.version.match?(%r{^(8|9).*})
+        logger.debug("Checking dnf-automatic on #{name} with platform #{info[:os_release][:platform]}")
+        @cmd.dnf_automatic_success?(name)
+      else
+        true
+      end
+    end
+
+    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
+        true
+      end
+    end
+
+    def os_release
+      @cmd.os_release
+    end
+
     def destroy
       @cmd.delete_instance(name)
     end

data/lib/cem_acpt/platform/gcp.rb

@@ -35,6 +35,18 @@ module Platform
     @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)

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  module Platform
+    module Utils
+      module Linux
+        # Module provides SSH helper methods for Linux platforms
+        class SSHelper
+          def self.ssh_keygen?
+            system('command -v ssh-keygen 2>&1 > /dev/null')
+          end
+
+          def self.remove_known_host(host, file = File.join([ENV['HOME'], '.ssh', 'known_hosts']))
+            if File.exist?(file)
+              if ssh_keygen?
+                system("ssh-keygen -R #{host} -f #{file} 2>&1 > /dev/null")
+              else
+                remove_known_host_no_keygen(host, file)
+              end
+            end
+          end
+
+          def self.remove_known_host_no_keygen(host, file = File.join([ENV['HOME'], '.ssh', 'known_hosts']))
+            require 'fileutils'
+            found = false
+            File.open("#{file}.cem_acpt_new", 'w') do |f|
+              File.readlines(file).each do |line|
+                if line.include?(host)
+                  found = true
+                else
+                  f.puts(line)
+                end
+              end
+            end
+            if found
+              FileUtils.mv("#{file}.cem_acpt_new", file)
+            else
+              FileUtils.rm("#{file}.cem_acpt_new")
+            end
+          end
+        end
+
+        # Class to parse the /etc/os-release file
+        class OSRelease
+          attr_reader :properties
+
+          def initialize(os_release)
+            @os_release = parse_string(os_release)
+            @properties = []
+            define_properties(@os_release)
+          end
+
+          def to_h
+            @os_release
+          end
+
+          private
+
+          def parse_string(os_release)
+            os_release = os_release.split("\n")
+            os_release = os_release.map { |line| line.split('=', 2) }.select { |l| l.length == 2 }
+            os_release.map! { |k, v| [k.downcase, v.delete_prefix('"').delete_suffix('"')] }
+            os_release.to_h
+          end
+
+          def define_properties(hsh)
+            hsh.each do |k, v|
+              @properties << k
+              self.class.send(:define_method, k) { v }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/test_runner/logging.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../logging'
+
+module CemAcpt
+  module TestRunner
+    # Namespace for TestRunner logging wrapper
+    module Logging
+      def use_logger(logger, **prefix_parts)
+        if logger.nil? || !logger.is_a?(CemAcpt::TestRunner::Logging::Logger)
+          CemAcpt::TestRunner::Logging::Logger.new(**prefix_parts)
+        else
+          this_prefix_parts = logger.prefix_parts.dup.merge(prefix_parts)
+          CemAcpt::TestRunner::Logging::Logger.new(**this_prefix_parts)
+        end
+      end
+
+      # Class to handle logging for Runner objects
+      class Logger
+        include CemAcpt::Logging
+
+        attr_reader :prefix_parts
+
+        def initialize(**prefix_parts)
+          @prefix_parts = prefix_parts
+        end
+
+        def log_prefix
+          parts = []
+          parts << @prefix_parts[:test] if @prefix_parts.key?(:test)
+          parts << @prefix_parts[:node] if @prefix_parts.key?(:node)
+          parts << @prefix_parts[:stage] if @prefix_parts.key?(:stage)
+          parts << @prefix_parts[:step] if @prefix_parts.key?(:step)
+          parts.join(': ')
+        end
+
+        def add_prefix_parts(**parts)
+          @prefix_parts.merge!(parts)
+        end
+
+        def debug(msg, no_prefix: false)
+          logger.debug(format_msg(msg, no_prefix))
+        end
+
+        def info(msg, no_prefix: false)
+          logger.info(format_msg(msg, no_prefix))
+        end
+
+        def warn(msg, no_prefix: false)
+          logger.warn(format_msg(msg, no_prefix))
+        end
+
+        def error(msg, no_prefix: false)
+          logger.error(format_msg(msg, no_prefix))
+        end
+
+        def fatal(msg, no_prefix: false)
+          logger.fatal(format_msg(msg, no_prefix))
+        end
+
+        def <<(msg)
+          logger << msg
+        end
+
+        private
+
+        def format_msg(msg, no_prefix)
+          if no_prefix
+            msg
+          else
+            "#{log_prefix}: #{msg}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/test_runner/run_handler.rb

@@ -3,8 +3,8 @@
 require 'concurrent-ruby'
 require 'open3'
 require_relative '../context'
-require_relative '../logging'
 require_relative '../puppet_helpers'
+require_relative 'logging'
 require_relative 'runner'
 
 module CemAcpt
@@ -19,7 +19,7 @@ module CemAcpt
     # creating Runner objects, handling input and output, and exception
     # handling.
     class RunHandler
-      include CemAcpt::Logging
+      include CemAcpt::TestRunner::Logging
 
       attr_accessor :run_context
 
@@ -29,6 +29,7 @@ module CemAcpt
         @module_pkg_path = Concurrent::IVar.new
         @runners = Concurrent::Array.new
         @thread_pool = Concurrent::SimpleExecutorService.new
+        @logger = use_logger(nil, stage: 'RunHandler')
       end
 
       # Gets the overall exit code for all runners
@@ -38,14 +39,14 @@ module CemAcpt
 
       # Runs the acceptance test suites.
       def run
-        logger.info('RUN HANDLER: Creating and starting test runners...')
+        @logger.info('creating and starting test runners...')
         create_runners
-        logger.info("RUN HANDLER: Created #{@runners.length} 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('Test runners have all exited...')
+        @logger.info('test runners have all exited...')
       rescue StandardError => e
         handle_fatal_error(e)
       ensure
@@ -70,17 +71,17 @@ module CemAcpt
       end
 
       def create_runner(node, platform)
-        logger.info("RUN HANDLER: Creating runner for #{node.test_data[:test_name]} on node #{node.node_name}...")
+        @logger.info("creating runner for #{node.test_data[:test_name]} on node #{node.node_name}...")
         runner = CemAcpt::TestRunner::Runner.new(node, @run_context, platform)
         runner || runner_creation_error(node)
       end
 
       def runner_creation_error(node)
         msg = [
-          "Failed to create runner object for node #{node.node_name}.",
+          "failed to create runner object for node #{node.node_name}!",
           "Cannot run test #{node.test_data[:test_name]}",
         ].join(' ')
-        logger.error(msg)
+        @logger.error(msg)
         nil
       end
 
@@ -88,22 +89,22 @@ module CemAcpt
       def handle_test_results
         @runners.each do |runner|
           result = runner.run_result.to_h
-          logger << "::group::{Results for #{runner.node.test_data[:test_name]}}\n"
+          @logger << "::group::{Results for #{runner.node.test_data[:test_name]}}\n"
           if result.key?('summary_line')
-            logger.info("SUMMARY: #{result['summary_line']} for test #{runner.node.test_data[:test_name]}")
+            @logger.info("SUMMARY: #{result['summary_line']} for test #{runner.node.test_data[:test_name]}", no_prefix: true)
           else
             handle_runner_error_results(runner)
-            logger << "::endgroup::\n"
+            @logger << "::endgroup::\n"
             next
           end
           unless runner.test_failures?
-            logger << "::endgroup::\n"
+            @logger << "::endgroup::\n"
             next
           end
 
           if result.key?('examples') # Log errors outside of examples
             if result['examples'].empty? && !result['messages'].empty?
-              logger.error(result['messages'].join("\n"))
+              @logger.error(result['messages'].join("\n"), no_prefix: true)
             else
               handle_example_error_pending_skipped(runner.node.node_name, result['examples'])
             end
@@ -111,7 +112,7 @@ module CemAcpt
             handle_runner_error_results(runner)
           end
           #debug_test_results(runner) if logger.debug?
-          logger << "::endgroup::\n"
+          @logger << "::endgroup::\n"
         end
       end
 
@@ -121,18 +122,18 @@ module CemAcpt
           next if e['status'] == 'passed'
 
           if e['status'] == 'pending'
-            logger.info(test_pending_msg(node_name, e))
+            @logger.info(test_pending_msg(node_name, e), no_prefix: true)
           else
-            logger.error(test_error_msg(node_name, e))
+            @logger.error(test_error_msg(node_name, e), no_prefix: true)
           end
         end
       end
 
       # Handles logging the results of the runners that errored.
       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}")
+        @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}")
+          @logger.error("#{k.upcase}: #{v}", no_prefix: true)
         end
       end
 
@@ -202,8 +203,8 @@ module CemAcpt
       # Gracefully handles a fatal error and exits the program.
       # @param err [StandardError, Exception] the error that caused the fatal error
       def handle_fatal_error(err)
-        logger.fatal("RUN HANDLER: Fatal error: #{err.message}")
-        logger.debug(err.backtrace.join("\n"))
+        @logger.fatal("fatal error: #{err.message}")
+        @logger.debug(err.backtrace.join("\n"), no_prefix: true)
       end
     end
   end