cem_acpt 0.3.2-universal-java-17 → 0.3.4-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1403d7aad1f43c9ab46a2ec09e10e6e6971a895f864f908da36d1aa4f459ccb
-  data.tar.gz: 7c24f47c835e7422311e21fb3b398d871ba88fa8ba295a6b403c0b5006cfe890
+  metadata.gz: c289fcb52a1115630ffece04c465e5a8d945bdefdcc99fbf73a800398d2f2bc6
+  data.tar.gz: aca0f41efe831bf5bb8dc4399cd1a2d771f7bb72fb1ee13eeccb79d59bd45183
 SHA512:
-  metadata.gz: d828aa44f6879dacbd6b5dabd5682dad73e7f4150436a0bffb51c73707345f61bd1b45527d102dfe67cb060acf0cec639c24c89df1a11b6c3f8598e48c939621
-  data.tar.gz: fa6b986ce60edafa468ee41a7dda019aad8fe09590918e93ec41325e9158a9bd96712a26b6575b1f08d7f239e66d14665ca2a3cbd90dcf08e0d6ce95347ceb73
+  metadata.gz: 65dd7b8c5023304f0c5f9fd371a64cfb157567004d6f93ebdadc76bbf99f50f7483fab575f73fb9c07256cbb0db688ad4d8c10a6b644a8f7670a3441a54e866e
+  data.tar.gz: 2504bc3dc1ef1ac1a09c16d00c3cd99b08127ccd31f2b9da134f31ffb2dc19730eda580ec893def0a9b183bd4198c5aa8263ea735f50c0b2c21156a5f8f7124d

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.2-universal-java-17)
+    cem_acpt (0.3.4-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?
 
@@ -173,12 +178,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

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

@@ -12,9 +12,9 @@ module Platform
 
   # Provision a GCP instance
   def provision
-    creation_params = config.dup
-    creation_params[:disk][:image_name] = image_name.dup
-    creation_params[:local_port] = local_port.dup
+    creation_params = Marshal.load(Marshal.dump(config))
+    creation_params[:disk][:image_name] = image_name
+    creation_params[:local_port] = local_port
     @instance = CemAcpt::Platform::Gcp::VM.new(
       node_name.dup,
       components: creation_params,
@@ -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)
@@ -64,7 +76,7 @@ module Platform
       CemAcpt::Platform::Gcp::Cmd.new(out_format: 'json')
     end
 
-    # Apllies the given Puppet manifest on the given instance
+    # Applies the given Puppet manifest on the given instance
     # @param instance_name [String] the name of the instance to apply the manifest to
     # @param manifest [String] the Puppet manifest to apply
     # @param opts [Hash] options to pass to the apply command

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  module Platform
+    module Utils
+      module Linux
+        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) }.reject { |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/platform.rb

@@ -59,12 +59,13 @@ module CemAcpt::Platform
     # @param platform [String] the name of the platform.
     # @return [Class] the platform-specific Object.
     def platform_class(platform)
+      class_name = platform.capitalize
       # We require the platform base class here so that we can use it as
       # a parent class for the platform-specific class.
       require_relative 'platform/base'
       # If the class has already been defined, we can just use it.
-      if Object.const_defined?(platform.capitalize)
-        klass = Object.const_get(platform.capitalize)
+      if Object.const_defined?(class_name)
+        klass = Object.const_get(class_name)
       else
         # Otherwise, we need to create the class. We do this by setting
         # a new constant with the name of the platform capitalized, and
@@ -74,7 +75,7 @@ module CemAcpt::Platform
         # include Logging and Concurrent::Async, and finally call the
         # initialize method on the class.
         klass = Object.const_set(
-          platform.capitalize,
+          class_name,
           Class.new(CemAcpt::Platform::Base) do
             require_relative "platform/#{platform}"
             include Platform

data/lib/cem_acpt/test_runner/runner.rb

@@ -5,6 +5,8 @@ require 'English'
 require_relative '../logging'
 require_relative '../rspec_utils'
 require_relative 'runner_result'
+require_relative 'runner_workflow_builder'
+#require_relative 'workflow'
 
 module CemAcpt
   module TestRunner
@@ -23,6 +25,8 @@ module CemAcpt
 
     class RunnerProvisionError < RunnerStepError; end
 
+    
+
     # Runner is a class that runs a single acceptance test suite on a single node.
     # It is responsible for managing the lifecycle of the test suite and
     # reporting the results back to the main thread. Runner objects are created
@@ -32,6 +36,8 @@ module CemAcpt
 
       attr_reader :node, :node_exists, :run_result
 
+      MAX_PROVISION_ATTEMPTS = 3
+
       # @param node [String] the name of the node to run the acceptance test suite on
       # @param ctx [CemAcpt::RunnerCtx] a cem_acpt Ctx (context) object
       # @param module_pkg_path [Concurrent::IVar] the path to the module package
@@ -42,34 +48,33 @@ module CemAcpt
         @debug_mode = @context.config.debug_mode?
         @node_inventory = @context.node_inventory
         @module_pkg_path = @context.module_package_path
+        @provision_attempts = 0
+        @provision_start_time = nil
         @node_exists = false
         @run_result = CemAcpt::TestRunner::RunnerResult.new(@node, debug: @debug_mode)
-        @completed_steps = []
         validate!
       end
 
-      def run_step(step_sym)
-        send(step_sym)
-        @completed_steps << step_sym
-      rescue StandardError => e
-        err = CemAcpt::TestRunner::RunnerStepError.new(step_sym, e)
-        step_error_logging(err)
-        @run_result.from_error(err)
-        destroy unless step_sym == :destroy
-      end
-
       # Executes test suite steps
       def start
         async_info("Starting test suite for #{@node.node_name}", log_prefix('RUNNER'))
-        run_step(:provision)
-        run_step(:bootstrap)
-        run_step(:run_tests)
-        run_step(:destroy)
-        true
+        @workflow = new_workflow
+        @workflow.run
+        if @workflow.success?
+          @run_result = @workflow.last_result
+          @workflow.completed_steps.each do |s|
+            async_info("Step '#{s.name}' completed successfully", log_prefix('RUNNER'))
+          end
+          true
+        else
+          @run_result = @workflow.last_error
+          step_error_logging(@workflow.last_error)
+          false
+        end
       rescue StandardError => e
         step_error_logging(e)
+        @run_result = CemAcpt::TestRunner::RunnerResult.new(@node, debug: @debug_mode)
         @run_result.from_error(e)
-        destroy
       end
 
       # Checks for failures in the test results.
@@ -81,6 +86,24 @@ module CemAcpt
 
       private
 
+      # Builds a new workflow for the runner
+      # @return [CemAcpt::TestRunner::Workflow::Manager] the new workflow
+      def new_workflow
+        builder = RunnerWorkflowBuilder.new(@node, config: @context.config)
+        builder.add_provision
+        builder.add_sleep(time: 30)
+        builder.add_wait_for_node_ssh
+        builder.add_check_dnf_automatic
+        builder.add_check_rpm_db
+        builder.add_save_node_to_inventory(node_inventory: @node_inventory, platform: @platform)
+        builder.add_check_for_module_package_path(module_pkg_path: @module_pkg_path)
+        builder.add_install_module(module_pkg_path: @module_pkg_path)
+        builder.add_check_node_inventory_file(node_inventory: @node_inventory)
+        builder.add_run_tests(rspec_opts: rspec_opts, rspec_cmd: CemAcpt::RSpecUtils::Command, run_result: @run_result)
+        builder.add_clean_up
+        builder.workflow
+      end
+
       def step_error_logging(err)
         prefix = err.respond_to?(:step) ? log_prefix(err.step.capitalize) : log_prefix('RUNNER')
         fatal_msg = ["runner failed: #{err.message}"]
@@ -94,93 +117,6 @@ module CemAcpt
         "#{prefix}: #{@node.test_data[:test_name]}:"
       end
 
-      # Provisions the node for the acceptance test suite.
-      def provision
-        async_info("Provisioning #{@node.node_name}...", log_prefix('PROVISION'))
-        start_time = Time.now
-        @node.provision
-        @node_exists = true
-        max_retries = 60 # equals 300 seconds because we check every five seconds
-        until @node.ready?
-          if max_retries <= 0
-            async_fatal("Node #{@node.node_name} failed to provision", log_prefix('PROVISION'))
-            raise CemAcpt::TestRunner::RunnerProvisionError, "Provisioning timed out for node #{@node.node_name}"
-          end
-
-          async_info("Waiting for #{@node.node_name} to be ready for remote connections...", log_prefix('PROVISION'))
-          max_retries -= 1
-          sleep(5)
-        end
-        async_info("Node #{@node.node_name} is ready...", log_prefix('PROVISION'))
-        node_desc = {
-          test_data: @node.test_data,
-          platform: @platform,
-          local_port: @node.local_port,
-        }.merge(@node.node)
-        @node_inventory.add(@node.node_name, node_desc)
-        @node_inventory.save
-        async_info("Node #{@node.node_name} provisioned in #{Time.now - start_time} seconds", log_prefix('PROVISION'))
-      end
-
-      # Bootstraps the node for the acceptance test suite. Currently, this
-      # just uploads and installs the module package.
-      def bootstrap
-        async_info("Bootstrapping #{@node.node_name}...", log_prefix('BOOTSTRAP'))
-        until File.exist?(@module_pkg_path)
-          async_debug("Waiting for module package #{@module_pkg_path} to exist...", log_prefix('BOOTSTRAP'))
-          sleep(1)
-        end
-        async_info("Installing module package #{@module_pkg_path}...", log_prefix('BOOTSTRAP'))
-        @node.install_puppet_module_package(@module_pkg_path)
-      end
-
-      # Runs the acceptance test suite via rspec.
-      def run_tests
-        attempts = 0
-        until File.exist?(@node_inventory.save_file_path)
-          raise 'Node inventory file not found' if (attempts += 1) > 3
-
-          sleep(1)
-        end
-        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 = 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(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)
-          rescue StandardError => e
-            async_error("failed to run rspec: #{@node.test_data[:test_name]}: #{e.message}", log_prefix('RSPEC'))
-            async_debug("Backtrace:\n#{e.backtrace}", log_prefix('RSPEC'))
-            @run_result.from_error(e)
-          end
-        end
-        async_info("Tests completed with exit code: #{@run_result.exit_status}", log_prefix('RSPEC'))
-      end
-
-      # Destroys the node for the acceptance test suite.
-      def destroy
-        kill_spec_pty_if_exists
-        if @context.config.get('no_destroy_nodes')
-          async_info("Not destroying node #{@node.node_name} because 'no_destroy_nodes' is set to true",
-                     log_prefix('DESTROY'))
-        else
-          async_info("Destroying #{@node.node_name}...", log_prefix('DESTROY'))
-          @node.destroy
-          @node_exists = false
-          async_info("Node #{@node.node_name} destroyed successfully", log_prefix('DESTROY'))
-        end
-      end
-
-      def kill_spec_pty_if_exists
-        @rspec_cmd&.kill_pty
-      end
-
       # Validates the runner configuration.
       def validate!
         raise 'No node provided' unless @node