cem_acpt 0.1.0

data/lib/cem_acpt/test_data.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  # This module provides a method and class for extracting and formatting
+  # test data.
+  module TestData
+    require_relative 'core_extensions'
+    require_relative 'logging'
+
+    # Returns a hash of test data.
+    # @param config [CemAcpt::Config] the config object
+    # @return [Array<Hash>] an array of test data hashes
+    def self.acceptance_test_data(config)
+      Fetcher.new(config).acceptance_test_data
+    end
+
+    # Fetcher provides the methods for extracting and formatting test data.
+    class Fetcher
+      include CemAcpt::Logging
+      using CemAcpt::CoreExtensions::ExtendedHash
+
+      attr_reader :module_dir, :acceptance_tests
+
+      # Initializes a new Fetcher object.
+      # @param config [CemAcpt::Config] the config object
+      def initialize(config)
+        @config = config
+        @module_dir = config.get('module_dir')
+        @acceptance_tests = find_acceptance_tests(config.get('module_dir'))
+      end
+
+      # Extracts, formats, and returns a test data hash.
+      # @return [Array<Hash>] an array of test data hashes
+      def acceptance_test_data
+        logger.info 'Gathering acceptance test data...'
+        acceptance_tests.each_with_object([]) do |t, a|
+          logger.debug("Processing #{t}...")
+          test_name = File.basename(t, '_spec.rb')
+          test_data = {
+            test_name: test_name,
+            test_file: File.expand_path(t),
+          }
+          next unless @config.has?('tests') && @config.get('tests').include?(test_name)
+
+          process_for_each(test_data).each do |test_data_i|
+            process_static_vars(test_data_i)
+            process_name_pattern_vars(test_name, test_data_i)
+            vars_post_processing!(test_data_i)
+            test_data_i.format!
+            a << test_data_i
+          end
+        end
+      end
+
+      private
+
+      # Locates acceptance tests in the module directory.
+      # @return [Array<String>] the list of acceptance test paths
+      def find_acceptance_tests(module_dir)
+        tests = Dir.glob(File.join(module_dir, 'spec', 'acceptance', '*_spec.rb'))
+        raise 'No acceptance tests found' if tests.empty?
+
+        logger.info "Found #{tests.size} acceptance tests"
+        tests
+      end
+
+      # Processes a for_each statement in the test data config.
+      # @param test_data [Hash] the test data hash
+      # @return [Array<Hash>] the list of test data hashes
+      def process_for_each(test_data)
+        return [test_data] unless @config.has?('test_data.for_each')
+
+        @config.get('test_data.for_each').each_with_object([]) do |(k, v), a|
+          v.each do |v_i|
+            test_data_i = test_data.dup
+            test_data_i[k] = v_i
+            a << test_data_i
+          end
+        end
+      end
+
+      def process_static_vars(test_data)
+        return unless @config.has?('test_data.vars')
+
+        logger.debug('Processing static variables...')
+        vars = @config.get('test_data.vars').each_with_object({}) do |(k, v), h|
+          logger.debug("Static variable: #{k}")
+          h[k] = v
+        end
+        test_data.merge!(vars)
+        test_data.format!
+      end
+
+      def process_name_pattern_vars(test_name, test_data)
+        logger.debug('Processing test name pattern...')
+        name_pattern_vars = name_pattern_matches(test_name) || {}
+        test_data.merge!(name_pattern_vars)
+        test_data.format!
+      end
+
+      def name_pattern_matches(test_name)
+        return test_name unless @config.has?('test_data.name_pattern_vars')
+
+        pattern = @config.get('test_data.name_pattern_vars')
+        logger.debug("Test name pattern: #{pattern.inspect}")
+        pattern_matches = test_name.match(pattern)&.named_captures
+        unless pattern_matches
+          logger.error("Test name #{test_name} does not match pattern #{pattern.inspect}")
+          return
+        end
+        logger.debug("Test name matches pattern: #{pattern_matches}")
+        pattern_matches
+      end
+
+      def vars_post_processing!(test_data)
+        return unless @config.has?('test_data.vars_post_processing')
+
+        logger.debug("Running test name pattern post processing with test data: #{test_data}")
+        post_processing_new_vars!(test_data)
+        post_processing_delete_vars!(test_data)
+      end
+
+      def post_processing_new_vars!(test_data)
+        new_vars = @config.get('test_data.vars_post_processing.new_vars')
+        return unless new_vars
+
+        logger.debug("Processing new variables: #{new_vars}")
+        new_vars.each do |var|
+          if var.has?('string_split')
+            test_data[var.dot_dig('name')] = op_string_split(test_data, var)
+          else
+            logger.error("Unknown post processing operation for new var #{var}")
+          end
+        end
+      end
+
+      def op_string_split(test_data, var)
+        logger.debug("Processing string split for new var #{var}")
+        from_var = var.dot_dig('string_split.from')
+        logger.debug("String split from var: #{from_var}")
+        from = test_data.dot_dig(from_var)
+        logger.debug("String split from value: #{from}")
+        parts = from.split(var.dot_dig('string_split.using'))
+        logger.debug("String split parts: #{parts}")
+        var.has?('string_split.part') ? parts[var.dot_dig('string_split.part')] : parts
+      end
+
+      def post_processing_delete_vars!(test_data)
+        delete_vars = @config.get('test_data.vars_post_processing.delete_vars')
+        return unless delete_vars
+
+        logger.debug('Processing delete variables...')
+        test_data.reject! { |k, _| delete_vars.include?(k.to_s) }
+      end
+    end
+  end
+end

data/lib/cem_acpt/utils.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'securerandom'
+
+module CemAcpt
+  # Utility methods and modules for CemAcpt.
+  module Utils
+    def self.os
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        :windows
+      else
+        :nix
+      end
+    end
+
+    module PuppetUtils
+      DEFAULT_PUPPET_PATH = {
+        nix: '/opt/puppetlabs/bin/puppet',
+        windows: 'C:/Program Files/Puppet Labs/Puppet/bin/puppet.bat',
+      }.freeze
+
+      def self.puppet_executable
+        this_os = CemAcpt::Utils.os
+        if File.file?(DEFAULT_PUPPET_PATH[this_os]) && File.executable?(DEFAULT_PUPPET_PATH[this_os])
+          return DEFAULT_PUPPET_PATH[this_os]
+        end
+
+        file_name = 'puppet'
+        if this_os == :windows
+          exts = ENV['PATHEXT'] ? ".{#{ENV['PATHEXT'].tr(';', ',').tr('.', '').downcase}}" : '.{exe,com,bat}'
+          file_name = "#{file_name}#{exts}"
+        end
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          if File.file?(File.join(path, file_name)) && File.executable?(File.join(path, file_name))
+            return File.join(path, file_name)
+          end
+        end
+        raise 'Could not find Puppet executable! Is Puppet installed?'
+      end
+    end
+
+    module NodeUtils
+      def self.random_instance_name(prefix: 'cem-acpt-', length: 24)
+        rand_length = length - prefix.length
+        "#{prefix}#{SecureRandom.hex(rand_length)}"
+      end
+
+      def self.ephemeral_ssh_key(type: 'ecdsa', bits: '521', comment: nil, keydir: '/tmp')
+        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',
+        ]
+        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
+    end
+  end
+end

data/lib/cem_acpt/version.rb

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

data/lib/cem_acpt.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CemAcpt
+  require_relative 'cem_acpt/logging'
+  require_relative 'cem_acpt/version'
+  require_relative 'cem_acpt/spec_helper_acceptance'
+
+  class << self
+    include CemAcpt::Logging
+  end
+
+  def self.run(params)
+    require_relative 'cem_acpt/runner'
+
+    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])
+    end
+
+    CemAcpt::RunHandler.new(params).run
+  end
+end

data/sample_config.yaml

@@ -0,0 +1,58 @@
+test_data:
+  for_each:
+    collection:
+      - puppet6
+      - puppet7
+  vars:
+    test_static_var: 'static_var_value'
+  name_pattern_vars: !ruby/regexp '/^(?<framework>[a-z]+)_(?<image_fam>[a-z0-9-]+)_(?<firewall>[a-z]+)_(?<framework_vars>[-_a-z0-9]+)$/'
+  vars_post_processing:
+    new_vars:
+      - name: 'profile'
+        string_split:
+          from: 'framework_vars'
+          using: '_'
+          part: 0
+      - name: 'level'
+        string_split:
+          from: 'framework_vars'
+          using: '_'
+          part: 1
+    delete_vars:
+      - 'framework_vars'
+
+platform: gcp
+
+node_data:
+  machine_type: 'e2-small'
+  project:
+    name: 'some-project'
+    zone: 'us-west1-b'
+  disk:
+    name: 'disk-1'
+    size: 20
+    type: 'pd-standard'
+  network_interface:
+    tier: 'STANDARD'
+    subnetwork: 'some-subnet'
+  metadata:
+    ephemeral_ssh_key:
+      lifetime: 2
+      keydir: '/tmp/acpt_test_keys'
+
+image_name_builder:
+  character_substitutions:
+    - ['_', '-']
+  parts:
+    - 'cem-acpt'
+    - '$image_fam'
+    - '$collection'
+    - '$firewall'
+  join_with: '-'    
+
+tests:
+  - cis_rhel-7_firewalld_server_1  
+  - cis_rhel-7_iptables_server_1
+  - cis_rhel-8_firewalld_server_1
+  - cis_rhel-8_firewalld_server_2
+  - cis_rhel-8_iptables_server_1

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: cem_acpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Heston Snodgrass
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-04 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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: puppet-modulebuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Litmus-like library focusing on CEM Acceptance Tests
+email:
+- hsnodgrass3@gmail.com
+executables:
+- cem_acpt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODEOWNERS
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cem_acpt.gemspec
+- exe/cem_acpt
+- lib/cem_acpt.rb
+- lib/cem_acpt/bootstrap.rb
+- lib/cem_acpt/bootstrap/bootstrapper.rb
+- lib/cem_acpt/bootstrap/operating_system.rb
+- lib/cem_acpt/bootstrap/operating_system/rhel_family.rb
+- lib/cem_acpt/context.rb
+- lib/cem_acpt/core_extensions.rb
+- lib/cem_acpt/image_name_builder.rb
+- lib/cem_acpt/logging.rb
+- lib/cem_acpt/platform.rb
+- lib/cem_acpt/platform/base.rb
+- lib/cem_acpt/platform/base/cmd.rb
+- lib/cem_acpt/platform/gcp.rb
+- lib/cem_acpt/platform/gcp/cmd.rb
+- 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/shared_objects.rb
+- lib/cem_acpt/spec_helper_acceptance.rb
+- lib/cem_acpt/test_data.rb
+- lib/cem_acpt/utils.rb
+- lib/cem_acpt/version.rb
+- sample_config.yaml
+homepage: https://github.com/puppetlabs/cem_acpt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/puppetlabs/cem_acpt
+  source_code_uri: https://github.com/puppetlabs/cem_acpt
+  changelog_uri: https://github.com/puppetlabs/cem_acpt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: CEM Acceptance Tests
+test_files: []