cem_acpt 0.1.0 → 0.2.2

data/lib/cem_acpt/utils.rb

@@ -15,15 +15,24 @@ 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])
+        if ::File.file?(DEFAULT_PUPPET_PATH[this_os]) && ::File.executable?(DEFAULT_PUPPET_PATH[this_os])
           return DEFAULT_PUPPET_PATH[this_os]
         end
 
@@ -32,39 +41,102 @@ module CemAcpt
           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)
+        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
+
+      # 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)}"
+        "#{prefix}#{::SecureRandom.hex(rand_length)}"
+      end
+    end
+
+    # SSH-related utilities
+    module SSH
+      def self.ssh_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')
-        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',
-        ]
+      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 = ::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.2'
 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,130 +1,130 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
-- Heston Snodgrass
+- puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-06-24 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
+- abide-team@puppet.com
 executables:
 - cem_acpt
 extensions: []
@@ -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
@@ -181,14 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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