cem_acpt 0.8.8 → 0.9.0

data/lib/cem_acpt/utils/files.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative '../logging'
+
+module CemAcpt
+  module Utils
+    # Utility classes and methods for files
+    module Files
+      class << self
+        # Reads a file based on its extension
+        # @param file [String] Path to the file
+        # @param log_level [Symbol] Log level to use
+        # @param log_prefix [String] Log prefix to use
+        # @param kwargs [Hash] Keyword arguments to pass to the file utility
+        # @option kwargs [String] :log_msg Log message to use when logging the file operation
+        # @option kwargs [Array] :permitted_classes Array of classes to permit when loading YAML files
+        # @return [Object] The result of the file utility's read method
+        def read(file, *args, log_level: :debug, log_prefix: 'CemAcpt', **kwargs)
+          return from_content_registry(file, :content) unless file_changed?(file)
+
+          content = new_file_util_for(file, log_level: log_level, log_prefix: log_prefix).read(file, *args, **kwargs)
+          add_to_content_registry(file, :content, content)
+          content
+        end
+
+        def write(file, content, *args, log_level: :debug, log_prefix: 'CemAcpt', **kwargs)
+          new_file_util_for(file, log_level: log_level, log_prefix: log_prefix).write(file, content, *args, **kwargs)
+        end
+
+        def delete(file, *args, log_level: :debug, log_prefix: 'CemAcpt', **kwargs)
+          new_file_util_for(file, log_level: log_level, log_prefix: log_prefix).delete(file, *args, **kwargs)
+        end
+
+        private
+
+        def mutex
+          @mutex ||= Mutex.new
+        end
+
+        def content_registry
+          @content_registry ||= {}
+        end
+
+        def file_changed?(file)
+          return true unless File.exist?(file)
+          fstat = File.stat(file)
+          rmtime = from_content_registry(file, :mtime)
+          check_res = rmtime.nil? || (fstat.mtime != rmtime)
+          add_to_content_registry(file, :mtime, fstat.mtime)
+          check_res
+        end
+
+        def add_to_content_registry(file, property, value)
+          mutex.synchronize do
+            content_registry[file] ||= {}
+            content_registry[file][property.to_sym] = value
+          end
+        end
+
+        def from_content_registry(file, property)
+          mutex.synchronize do
+            content_registry[file] ||= {}
+            content_registry[file][property.to_sym]
+          end
+        end
+
+        def new_file_util_for(file, log_level: :debug, log_prefix: 'CemAcpt')
+          case File.extname(file)
+          when *YamlUtil::VALID_EXTS
+            YamlUtil.new(log_level: log_level, log_prefix: log_prefix)
+          when *JsonUtil::VALID_EXTS
+            JsonUtil.new(log_level: log_level, log_prefix: log_prefix)
+          else
+            FileUtil.new(log_level: log_level, log_prefix: log_prefix)
+          end
+        end
+      end
+
+      # Generic file utility class
+      class FileUtil
+        include CemAcpt::Logging
+
+        attr_reader :log_level, :log_prefix, :file_exts
+
+        def initialize(log_level: :debug, log_prefix: 'CemAcpt', file_exts: [])
+          @log_level = log_level
+          @log_prefix = log_prefix
+          @file_exts = file_exts
+        end
+
+        def log_level=(level)
+          level = level.downcase.to_sym
+          raise ArgumentError, "Invalid log level #{level}" unless logger.respond_to?(level)
+
+          @log_level = level
+        end
+
+        def log_prefix=(prefix)
+          @log_prefix = prefix.to_s
+        end
+
+        def file_exts=(exts)
+          raise ArgumentError, 'file_exts must be an Array' unless exts.is_a?(Array)
+
+          @file_ext = exts
+        end
+
+        def write(file, content, *_args, log_msg: 'Writing file %s...', **_kwargs)
+          validate_and_log(file, log_msg)
+          File.write(file, content)
+        end
+
+        def read(file, *_args, log_msg: 'Reading file %s...', **_kwargs)
+          validate_and_log(file, log_msg)
+          File.read(file)
+        end
+
+        def delete(file, *_args, log_msg: 'Deleting file %s...', **_kwargs)
+          validate_and_log(file, log_msg)
+          FileUtils.rm_f(file)
+        end
+
+        private
+
+        def validate_and_log(file, log_msg)
+          file = validate_ext(file)
+          logger.send(log_level, log_prefix) { log_msg.to_s % file }
+        end
+
+        def validate_ext(file)
+          return if file_exts.empty?
+
+          ext = File.extname(file)
+          raise ArgumentError, "Invalid file extension #{ext}! Valid file extensions are #{file_exts}" unless file_exts.include?(ext)
+        end
+      end
+
+      # Utility class for working with YAML files
+      class YamlUtil < FileUtil
+        VALID_EXTS = %w[.yaml .yml].freeze
+        DEFAULT_PERMITTED_CLASSES = [Symbol].freeze
+
+        def initialize(log_level: :debug, log_prefix: 'CemAcpt', file_exts: VALID_EXTS)
+          super(log_level: log_level, log_prefix: log_prefix, file_exts: file_exts)
+          require 'yaml'
+        end
+
+        def write(file, content, *_args, log_msg: 'Writing YAML file %s...', **_kwargs)
+          raise ArgumentError, 'content must be a Hash' unless content.is_a?(Hash)
+
+          super(file, content.to_yaml, log_msg)
+        end
+
+        def read(file, *_args, log_msg: 'Reading YAML file %s...', permitted_classes: DEFAULT_PERMITTED_CLASSES, **_kwargs)
+          YAML.safe_load(super(file, log_msg), permitted_classes: permitted_classes)
+        end
+
+        def delete(file, *_args, log_msg: 'Deleting YAML file %s...', **_kwargs)
+          super(file, log_msg)
+        end
+      end
+
+      # Utility class for working with JSON files
+      class JsonUtil < FileUtil
+        VALID_EXTS = %w[.json].freeze
+
+        def initialize(log_level: :debug, log_prefix: 'CemAcpt', file_exts: VALID_EXTS)
+          super(log_level: log_level, log_prefix: log_prefix, file_exts: file_exts)
+          require 'json'
+        end
+
+        def write(file, content, *_args, log_msg: 'Writing JSON file %s...', **_kwargs)
+          raise ArgumentError, 'content must be a Hash' unless content.is_a?(Hash)
+
+          super(file, content.to_json, log_msg)
+        end
+
+        def read(file, *_args, log_msg: 'Reading JSON file %s...', **_kwargs)
+          JSON.parse(super(file, log_msg))
+        end
+
+        def delete(file, *_args, log_msg: 'Deleting JSON file %s...', **_kwargs)
+          super(file, log_msg)
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/utils/finalizer_queue.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  module Utils
+    class FinalizerQueueError < StandardError; end
+
+    # A queue that can be finalized.
+    # When a queue is finalized, no more items can be added to it, and the
+    # queue is closed and converted to a frozen array.
+    class FinalizerQueue
+      def initialize
+        @queue = Queue.new
+        @array = []
+        @finalized = false
+        @mutex = Mutex.new
+      end
+
+      def finalize!
+        return if finalized?
+
+        @finalized = true
+        new_array
+      end
+
+      def finalized?
+        @finalized
+      end
+
+      def to_a
+        raise FinalizerQueueError, 'Cannot convert to array until finalized' unless finalized?
+
+        @array
+      end
+
+      def method_missing(method_name, *args, **kwargs, &block)
+        if finalized?
+          @array.send(method_name, *args, **kwargs, &block)
+        elsif @queue.respond_to?(method_name)
+          @queue.send(method_name, *args, **kwargs, &block)
+        else
+          super
+        end
+      rescue StandardError => e
+        raise e if e.is_a?(NoMethodError) || e.is_a?(FinalizerQueueError)
+
+        new_err = FinalizerQueueError.new("Error calling #{method_name} on FinalizerQueue: #{e}")
+        new_err.set_backtrace(e.backtrace)
+        raise new_err
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @array.respond_to?(method_name, include_private) if finalized?
+
+        super
+      end
+
+      private
+
+      def new_array
+        @queue.close unless @queue.closed?
+        @array << @queue.pop until @queue.empty?
+        @array.compact!
+        @array.freeze
+      end
+
+      def require_finalized(caller_binding)
+        return if finalized?
+
+        raise FinalizerQueueError, "Cannot call #{caller_binding.eval('__method__')} on unfinalized #{self.class.name}"
+      end
+    end
+  end
+end

data/lib/cem_acpt/utils/shell.rb

@@ -6,6 +6,7 @@ require 'stringio'
 module CemAcpt
   # Error class for shell commands
   class ShellCommandError < StandardError; end
+  class ShellCommandNotFoundError < ShellCommandError; end
 
   module Utils
     # Generic utilities for running local shell commands
@@ -23,7 +24,7 @@ module CemAcpt
         io_outerr = StringIO.new
         if output.respond_to?(:debug)
           output.debug('CemAcpt::Utils::Shell') { "Running command:\n\t#{cmd}\nWith environment:\n\t#{env}" }
-        else
+        elsif output
           output << "Running command:\n\t#{cmd}\nWith environment:\n\t#{env}\n"
         end
         val = Open3.popen2e(env, cmd) do |stdin, outerr, wait_thr|
@@ -47,18 +48,26 @@ module CemAcpt
 
       # Mimics the behavior of the `which` command.
       # @param cmd [String] The command to find
-      # @return [String] The path to the command
-      # @return [nil] If the command is not found
-      def self.which(cmd)
+      # @param include_ruby_bin [Boolean] Whether to include Ruby bin directories in the search.
+      #   Setting this to true can cause errors to be raised if cem_acpt attempts to use a Ruby
+      #   command that is not available to cem_acpt, such as when running with `bundle exec`.
+      # @param raise_if_not_found [Boolean] Whether to raise an error if the command is not found
+      # @return [String, nil] The path to the command or nil if not found
+      # @raise [CemAcpt::ShellCommandNotFoundError] If the command is not found and raise_if_not_found is true
+      def self.which(cmd, include_ruby_bin: false, raise_if_not_found: false)
         return cmd if File.executable?(cmd) && !File.directory?(cmd)
 
         exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
         ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          next if path.include?('/ruby') && !include_ruby_bin
+
           exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
           end
         end
+        raise CemAcpt::ShellCommandNotFoundError, "Command #{cmd} not found in PATH" if raise_if_not_found
+
         nil
       end
     end

data/lib/cem_acpt/version.rb

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

data/sample_config.yaml

@@ -58,6 +58,19 @@ tests:
   # - stig_rhel-7_firewalld_public_3
   # - stig_rhel-8_firewalld_public_3
 
+bolt:
+  project:
+    name: 'cem-acpt'
+    analytics: false
+  tests:
+    only: [] # Test names from the "tests" array above
+    ignore: []
+  tasks:
+    ignore: [] # Task names to ignore
+    only: []
+    module_pattern: '^.*$'
+    name_filter: '^fake_task$'
+
 cem_acpt_image:
   no_windows: true
   no_linux: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -180,6 +180,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Litmus-like library focusing on CEM Acceptance Tests
 email:
 - abide-team@puppet.com
@@ -205,6 +219,20 @@ files:
 - exe/cem_acpt_image
 - lib/cem_acpt.rb
 - lib/cem_acpt/action_result.rb
+- lib/cem_acpt/actions.rb
+- lib/cem_acpt/bolt.rb
+- lib/cem_acpt/bolt/cmd.rb
+- lib/cem_acpt/bolt/cmd/base.rb
+- lib/cem_acpt/bolt/cmd/output.rb
+- lib/cem_acpt/bolt/cmd/task.rb
+- lib/cem_acpt/bolt/errors.rb
+- lib/cem_acpt/bolt/helpers.rb
+- lib/cem_acpt/bolt/inventory.rb
+- lib/cem_acpt/bolt/project.rb
+- lib/cem_acpt/bolt/summary_results.rb
+- lib/cem_acpt/bolt/tasks.rb
+- lib/cem_acpt/bolt/tests.rb
+- lib/cem_acpt/bolt/yaml_file.rb
 - lib/cem_acpt/cli.rb
 - lib/cem_acpt/config.rb
 - lib/cem_acpt/config/base.rb
@@ -233,9 +261,17 @@ files:
 - lib/cem_acpt/test_data.rb
 - lib/cem_acpt/test_runner.rb
 - lib/cem_acpt/test_runner/log_formatter.rb
-- lib/cem_acpt/test_runner/log_formatter/error_formatter.rb
+- lib/cem_acpt/test_runner/log_formatter/base.rb
+- lib/cem_acpt/test_runner/log_formatter/bolt_error_formatter.rb
+- lib/cem_acpt/test_runner/log_formatter/bolt_output_formatter.rb
+- lib/cem_acpt/test_runner/log_formatter/bolt_summary_results_formatter.rb
 - lib/cem_acpt/test_runner/log_formatter/goss_action_response.rb
+- lib/cem_acpt/test_runner/log_formatter/goss_error_formatter.rb
+- lib/cem_acpt/test_runner/log_formatter/standard_error_formatter.rb
+- lib/cem_acpt/test_runner/test_results.rb
 - lib/cem_acpt/utils.rb
+- lib/cem_acpt/utils/files.rb
+- lib/cem_acpt/utils/finalizer_queue.rb
 - lib/cem_acpt/utils/puppet.rb
 - lib/cem_acpt/utils/shell.rb
 - lib/cem_acpt/utils/ssh.rb
@@ -270,14 +306,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: CEM Acceptance Tests

data/lib/cem_acpt/test_runner/log_formatter/error_formatter.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module CemAcpt
-  module TestRunner
-    module LogFormatter
-      class ErrorFormatter
-        def inspect
-          to_s
-        end
-
-        def to_s
-          "#<#{self.class.name}:0x#{object_id.to_s(16)}>"
-        end
-
-        def summary(response)
-          "Error: #{response.summary}"
-        end
-
-        def results(response)
-          [response.summary, response.results.join("\n")]
-        end
-
-        def host_name(response)
-          "Error: #{response.error.class.name}"
-        end
-
-        def test_name(response)
-          "Error: #{response.error.class.name}"
-        end
-      end
-    end
-  end
-end