cem_acpt 0.1.0 → 0.2.0

data/lib/cem_acpt/utils.rb

@@ -15,12 +15,21 @@ module CemAcpt
       end
     end
 
-    module PuppetUtils
+    # File-related utilities
+    module File
+      def self.set_permissions(permission, *file_paths)
+        file_paths.map { |p| File.chmod(permission, p) }
+      end
+    end
+
+    # Puppet-related utilities
+    module Puppet
       DEFAULT_PUPPET_PATH = {
         nix: '/opt/puppetlabs/bin/puppet',
         windows: 'C:/Program Files/Puppet Labs/Puppet/bin/puppet.bat',
       }.freeze
 
+      # Finds and returns the Puppet executable
       def self.puppet_executable
         this_os = CemAcpt::Utils.os
         if File.file?(DEFAULT_PUPPET_PATH[this_os]) && File.executable?(DEFAULT_PUPPET_PATH[this_os])
@@ -39,32 +48,95 @@ module CemAcpt
         end
         raise 'Could not find Puppet executable! Is Puppet installed?'
       end
+
+      # Builds a Puppet module package.
+      # @param module_dir [String] Path to the module directory. If target_dir
+      #   is specified as a relative path, it will be relative to the module dir.
+      # @param target_dir [String] Path to the target directory where the package
+      #   will be built. This defaults to the relative path 'pkg/'.
+      # @param should_log [Boolean] Whether or not to log the build process.
+      # @return [String] Path to the built package.
+      def self.build_module_package(module_dir, target_dir = nil, should_log: false)
+        require 'puppet/modulebuilder'
+        require 'fileutils'
+
+        builder_logger = should_log ? logger : nil
+        builder = ::Puppet::Modulebuilder::Builder.new(::File.expand_path(module_dir), target_dir, builder_logger)
+
+        # Validates module metadata by raising exception if invalid
+        _metadata = builder.metadata
+
+        # Builds the module package
+        builder.build
+      end
     end
 
-    module NodeUtils
+    # Node-related utilities
+    module Node
       def self.random_instance_name(prefix: 'cem-acpt-', length: 24)
         rand_length = length - prefix.length
         "#{prefix}#{SecureRandom.hex(rand_length)}"
       end
+    end
+
+    # SSH-related utilities
+    module SSH
+      def self.keygen
+        bin_path = `command -v ssh-keygen`.chomp
+        raise 'Cannot find ssh-keygen! Install it and verify PATH' unless bin_path
+
+        bin_path
+      end
 
-      def self.ephemeral_ssh_key(type: 'ecdsa', bits: '521', comment: nil, keydir: '/tmp')
+      def self.default_keydir
+        ssh_dir = File.join(ENV['HOME'], '.ssh')
+        raise "SSH directory at #{ssh_dir} does not exist" unless File.directory?(ssh_dir)
+
+        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)
 
-        keyfile = "#{keydir}/#{SecureRandom.hex(16)}"
-        keygen_cmd = [
-          'ssh-keygen',
-          "-t #{type}",
-          "-b #{bits}",
-          "-f #{keyfile}",
-          '-N ""',
-          '-q',
-        ]
+        keyfile = File.join(keydir, SecureRandom.hex(16))
+        keygen_cmd = [ssh_keygen, "-t #{type}", "-b #{bits}", "-f #{keyfile}", '-N ""']
         keygen_cmd << "-C \"#{comment}\"" if comment
         _, stderr, status = Open3.capture3(keygen_cmd.join(' '))
         raise "Failed to generate ephemeral SSH key: #{stderr}" unless status.success?
 
         [keyfile, "#{keyfile}.pub"]
       end
+
+      def self.acpt_known_hosts(keydir: default_keydir, file_name: 'acpt_known_hosts', overwrite: true)
+        kh_file = File.join(keydir, file_name)
+        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)
+      end
+    end
+
+    # Terminal-related utilities
+    module Terminal
+      def self.keep_terminal_alive
+        require 'concurrent-ruby'
+        executor = Concurrent::SingleThreadExecutor.new
+        executor.post do
+          loop do
+            $stdout.print(".\r")
+            sleep(1)
+            $stdout.print("..\r")
+            sleep(1)
+            $stdout.print("...\r")
+            sleep(1)
+            $stdout.print("   \r")
+            sleep(1)
+          end
+        end
+        executor
+      end
     end
   end
 end

data/lib/cem_acpt/version.rb

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

data/lib/cem_acpt.rb

@@ -10,18 +10,25 @@ module CemAcpt
   end
 
   def self.run(params)
-    require_relative 'cem_acpt/runner'
+    require_relative 'cem_acpt/context'
 
-    logger.level = params[:log_level] if params[:log_level]
-
-    if params[:log_file]
-      log_fmt = params[:log_format] ? new_log_formatter(params[:log_format]) : new_log_formatter(:file)
-      logger.formatter = log_fmt
-      logger.reopen(params[:log_file])
-    elsif params[:log_format]
-      logger.formatter = new_log_formatter(params[:log_format])
+    log_level = params[:log_level]
+    log_formatter = params[:log_format] ? new_log_formatter(params[:log_format]) : nil
+    logdevs = [$stdout]
+    if params[:log_file] && params[:quiet]
+      logdevs = [params[:log_file]]
+    elsif params[:log_file] && !params[:quiet]
+      logdevs << params[:log_file]
     end
-
-    CemAcpt::RunHandler.new(params).run
+    if (params[:CI] || ENV['CI'] || ENV['GITHUB_ACTION']) && !logdevs.include?($stdout)
+      logdevs << $stdout
+    end
+    new_logger(
+      *logdevs,
+      level: log_level,
+      formatter: log_formatter,
+    )
+    exit_code = CemAcpt::Context.with(params, &:run)
+    exit exit_code
   end
 end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.9
-  type: :runtime
+  name: concurrent-ruby
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.9
 - !ruby/object:Gem::Dependency
-  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.2
-  type: :runtime
+  name: deep_merge
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: 7.0.0.beta1
+  name: net-ssh
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 7.0.0.beta1
 - !ruby/object:Gem::Dependency
-  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :runtime
+        version: 0.0.1
+  name: puppet-modulebuilder
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
+        version: '0'
+  name: rake
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
+        version: '0'
+  name: rspec
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '0'
+  name: serverspec-cem-acpt
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: serverspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '0'
+  name: rubocop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 description: Litmus-like library focusing on CEM Acceptance Tests
 email:
 - hsnodgrass3@gmail.com
@@ -132,7 +132,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODEOWNERS
 - Gemfile
 - Gemfile.lock
@@ -159,16 +158,20 @@ files:
 - lib/cem_acpt/platform/gcp/compute.rb
 - lib/cem_acpt/platform/vmpooler.rb
 - lib/cem_acpt/puppet_helpers.rb
-- lib/cem_acpt/runner.rb
+- lib/cem_acpt/rspec_utils.rb
 - lib/cem_acpt/shared_objects.rb
 - lib/cem_acpt/spec_helper_acceptance.rb
 - lib/cem_acpt/test_data.rb
+- lib/cem_acpt/test_runner.rb
+- lib/cem_acpt/test_runner/run_handler.rb
+- lib/cem_acpt/test_runner/runner.rb
+- lib/cem_acpt/test_runner/runner_result.rb
 - lib/cem_acpt/utils.rb
 - lib/cem_acpt/version.rb
 - sample_config.yaml
 homepage: https://github.com/puppetlabs/cem_acpt
 licenses:
-- MIT
+- proprietary
 metadata:
   homepage_uri: https://github.com/puppetlabs/cem_acpt
   source_code_uri: https://github.com/puppetlabs/cem_acpt
@@ -188,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: CEM Acceptance Tests

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4

data/lib/cem_acpt/runner.rb

@@ -1,304 +0,0 @@
-# frozen_string_literal: true
-
-require 'concurrent-ruby'
-require 'json'
-require 'open3'
-
-module CemAcpt
-  require_relative 'bootstrap'
-  require_relative 'context'
-  require_relative 'logging'
-  require_relative 'puppet_helpers'
-  require_relative 'test_data'
-  require_relative 'utils'
-
-  # RunHandler orchestrates the acceptance test suites, including
-  # creating Runner objects, handling input and output, and exception
-  # handling.
-  class RunHandler
-    include CemAcpt::Logging
-
-    attr_accessor :params, :config_file
-
-    # @param params [Hash] the parameters passed from the command line
-    def initialize(params)
-      @params = params
-      @config_file = params[:config_file] || File.expand_path('./cem_acpt_config.yaml')
-      @module_pkg_path = Concurrent::IVar.new
-      @start_time = nil
-      @runners = Concurrent::Array.new
-      @results = Concurrent::Map.new
-    end
-
-    # Runs the acceptance test suites.
-    def run
-      @start_time = Time.now
-      logger.info("Running acceptance test suite at #{@start_time}")
-      logger.debug("Params: #{@params}")
-      logger.debug("Config file: #{@config_file}")
-      logger.info("Using module directory: #{@params[:module_dir]}")
-      context_opts = {
-        config_opts: @params,
-        config_file: @config_file,
-      }
-      build_module_package
-      begin
-        keep_terminal_alive if params[:CI] || ENV['CI'] || ENV['GITHUB_ACTION']
-        create_and_start_runners(context_opts)
-      rescue StandardError, SignalException, SystemExit => e
-        handle_fatal_error(e)
-      ensure
-        @keep_terminal_alive&.exit
-      end
-      handle_test_results
-      exit_code = @runners.map(&:spec_exit_code).any? { |rc| rc != 0 } ? 1 : 0
-      exit exit_code
-    end
-
-    private
-
-    # Prints periods to the terminal in a single line to keep the terminal
-    # alive. This is used when running in CI mode.
-    def keep_terminal_alive
-      @keep_terminal_alive = Thread.new do
-        loop do
-          $stdout.print("|\r")
-          sleep(1)
-          $stdout.print("/\r")
-          sleep(1)
-          $stdout.print("-\r")
-          sleep(1)
-          $stdout.print("\\\r")
-          sleep(1)
-        end
-      end
-    end
-
-    # @return [String] the module directory that contains the acceptance tests
-    def module_dir
-      if @params.key?(:working_dir)
-        @params[:working_dir]
-      else
-        Dir.pwd
-      end
-    end
-
-    # Builds the module package in a separate thread.
-    # This thread is set to abort_on_exception so that any
-    # exceptions raised in the thread will be caught and
-    # handled by the main thread.
-    def build_module_package
-      pkg_thread = Thread.new do
-        pkg_path = CemAcpt::PuppetHelpers::Module.build_module_package(@params[:module_dir])
-        @module_pkg_path.set(pkg_path)
-      end
-      pkg_thread.abort_on_exception = true
-    end
-
-    # Creates and starts Runner objects for each node in the acceptance test suites.
-    # @param context_opts [Hash] the options to pass to the Context object
-    # @param timeout [Integer] the timeout to use for the Runner object threads in seconds
-    def create_and_start_runners(context_opts, timeout = 600)
-      CemAcpt::Context.with(**context_opts) do |nodes, conf, tdata, node_inv|
-        nodes.each do |node|
-          runner = CemAcpt::Runner.new(node, conf, tdata, node_inv, @module_pkg_path, @results)
-          runner.start
-          @runners << runner
-        end
-        @runners.each { |r| r.join(timeout) }
-      end
-    end
-
-    # Handles how test results are logged.
-    def handle_test_results
-      @results.each_pair do |node, result|
-        logger.info("SUMMARY: #{result['summary_line']} on node #{node}")
-        next unless test_failures?(result)
-
-        failed = result['examples'].reject { |e| e['status'] == 'passed' }
-        failed.each do |e|
-          logger.error(test_error_msg(node, e))
-        end
-      end
-      debug_test_results if logger.debug?
-    end
-
-    # Formats a test result for tests that have failed. Is used for logging.
-    # @param node [String] the name of the node the test ran on
-    # @param result [Hash] the test result to format
-    # @return [String] the formatted test result
-    def test_error_msg(node, result)
-      [
-        "TEST FAILED: #{result['id']}",
-        "DESCRIPTION: #{result['full_description']}",
-        "STATUS: #{result['status']}",
-        "LOCATION: #{result['file_path']}:#{result['line_number']}",
-        "NODE: #{node}",
-        result['exception']['message'],
-        "\n",
-      ].join("\n")
-    end
-
-    # Logs performance data for the acceptance test suites.
-    # This is only logged if the log level is set to debug.
-    def debug_test_results
-      examples_by_time = []
-      @results.each_pair do |node, result|
-        result['examples'].each do |e|
-          examples_by_time << [e['run_time'], e['id'], e['status'], e['line_number'], node]
-        end
-      end
-      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
-    end
-
-    # Checks for failures in the test results.
-    # @param result [Hash] the test result to check
-    # @return [Boolean] whether or not there are test failures in result
-    def test_failures?(result)
-      result['summary']['failure_count'].positive? || result['summary']['errors_outside_of_examples_count'].positive?
-    end
-
-    # 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)
-      @keep_terminal_alive&.exit
-      logger.fatal("Fatal error: #{err.message}")
-      logger.debug(err.backtrace.join('; '))
-      kill_runners
-      logger.fatal("Exiting with status 1 after #{Time.now - @start_time} seconds")
-      exit(1)
-    end
-
-    # Kills all running Runner objects.
-    def kill_runners
-      @runners.each(&:kill) unless @runners.empty?
-    end
-  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
-  # by the RunHandler and then, when started, execute their logic in a thread.
-  class Runner
-    include CemAcpt::Logging
-
-    attr_reader :spec_exit_code
-
-    # @param node [String] the name of the node to run the acceptance test suite on
-    # @param conf [CemAcpt::Config] the acceptance test suite configuration
-    # @param tdata [Hash] the test data to use for the acceptance test suite
-    # @param node_inv [CemAcpt::NodeInventory] the node inventory to use for the acceptance test suite
-    # @param module_pkg_path [Concurrent::IVar] the path to the module package
-    # @param results [Concurrent::Map] the results map to use for reporting test results
-    def initialize(node, conf, tdata, node_inv, module_pkg_path, results)
-      @node = node
-      @conf = conf
-      @tdata = tdata
-      @node_inv = node_inv
-      @module_pkg_path = module_pkg_path
-      @results = results
-      @spec_exit_code = 0
-      validate!
-    end
-
-    # Starts the runner thread and runs the lifecycle stages of the
-    # acceptance test suite.
-    def start
-      logger.info("Starting test suite for #{@node.node_name}")
-      @thread = Thread.new do
-        provision
-        bootstrap
-        run_tests
-        destroy
-      end
-    end
-
-    # Joins the runner thread.
-    # @param timeout [Integer] thread timeout in seconds
-    def join(timeout = 600)
-      @thread.join(timeout)
-    end
-
-    # Runner thread exits and runner node is destroyed, if it exists.
-    def exit
-      @thread.exit
-      @node&.destroy
-    end
-
-    # Runner thread is killed and runner node is destroyed, if it exists.
-    def kill
-      @thread.kill
-      @node&.destroy
-    end
-
-    private
-
-    # Provisions the node for the acceptance test suite.
-    def provision
-      logger.info("Provisioning #{@node.node_name}...")
-      start_time = Time.now
-      @node.provision
-      sleep(1) until @node.ready?
-      logger.info("Node #{@node.node_name} is ready...")
-      node_desc = {
-        test_data: @node.test_data,
-        platform: @conf.get('platform'),
-        local_port: @node.local_port,
-      }.merge(@node.node)
-      @node_inv.add(@node.node_name, node_desc)
-      logger.info("Node #{@node.node_name} provisioned in #{Time.now - start_time} seconds")
-      @node_inv.save(File.join(@conf.get('module_dir'), 'spec', 'fixtures', 'node_inventory.yaml'))
-    end
-
-    # Bootstraps the node for the acceptance test suite. Currently, this
-    # just uploads and installs the module package.
-    def bootstrap
-      logger.info("Bootstrapping #{@node.node_name}...")
-      until File.exist?(@module_pkg_path.value)
-        logger.debug("Waiting for module package #{@module_pkg_path.value} to exist...")
-        sleep(1)
-      end
-      logger.info("Installing module package #{@module_pkg_path.value}...")
-      @node.install_puppet_module_package(@module_pkg_path.value)
-    end
-
-    # Runs the acceptance test suite via rspec.
-    def run_tests
-      require 'json'
-
-      logger.info("Running tests for #{@node.node_name}...")
-      stdout = nil
-      stderr = nil
-      # ENV['RSPEC_DEBUG'] = 'true' if @conf.get('log_level') == 'debug'
-      test_command = "cd #{@conf.get('module_dir')} && bundle exec rspec #{@node.test_data[:test_file]} --format json"
-      @node.run_tests do
-        stdout, stderr, status = Open3.capture3(test_command)
-        @spec_exit_code = status.exitstatus
-      end
-      logger.info("Tests completed with exit code: #{@spec_exit_code}")
-      @results.put_if_absent(@node.node_name, JSON.parse(stdout))
-    end
-
-    # Destroys the node for the acceptance test suite.
-    def destroy
-      if @conf.get('no_destroy_nodes')
-        logger.info("Not destroying node #{@node.node_name} because 'no_destroy_nodes' is set to true")
-        return
-      end
-      logger.info("Destroying #{@node.node_name}...")
-      @node.destroy
-      logger.info("Node #{@node.node_name} destroyed successfully")
-    end
-
-    # Validates the runner configuration.
-    def validate!
-      raise 'No node provided' unless @node
-      raise 'No config provided' unless @conf
-      raise 'No test data provided' unless @tdata
-      raise 'No node inventory provided' unless @node_inv
-    end
-  end
-end