cem_acpt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b8813ddfec58349a3ce7c587dbab4a4eae04d7fa24c0ed87896de41ba3d160
-  data.tar.gz: '099f6ed6a7570e2283a740d89bd3864638ff470c8d9a8456bd3eb64ca8d61217'
+  metadata.gz: a7ce3a10380b032387479fc85590e5a9ca59c2dc5cec33d71cb9d79eaf6938a7
+  data.tar.gz: d3d12c621ee070af7cab276e6887c45343519c51e9260a1c6e6fd0fc4ca64e80
 SHA512:
-  metadata.gz: ce3f4d2ec04e379cea66c728da7d9a0c8b54a339b4023d40bf47e787e96aaf91c4f6fcd4c5513e38b3c3459de32bf575ad2efbfd8c4e440fd60a16fee0a4ced7
-  data.tar.gz: 3f442bebaab6df3e75925ccfd4324a9b38d84c649805ef59a9af407ad097ca0154797d916c7039ae810f5e9db182e58ccd345049e3ad6c41b9fda97405e828c1
+  metadata.gz: d394053e259fb6d502a44d219b8dd056e1777d61a67a1a3da34360288ee6b623eadb842381900fe1d56d4944f0b9823c10c59f136f6ac486a8c0c47722dbfddf
+  data.tar.gz: c73ede8616dc75ab9da65573f5ad3a77c4ec604089183ede90e2a97a9fa2f5699ae012ba157935c0f7bdec9e2744f996d154958b40fde9271c545900f884de77

data/.gitignore

@@ -9,3 +9,10 @@
 
 # rspec failure tracking
 .rspec_status
+test.log
+
+# profiling
+profile.txt
+
+# local dev
+run_script.rb

data/Gemfile.lock

@@ -1,33 +1,39 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.1.0)
+    cem_acpt (0.2.0)
       concurrent-ruby (~> 1.1.9)
       deep_merge (~> 1.2.2)
-      net-scp (~> 3.0)
-      net-ssh (~> 6.1)
+      net-ssh (~> 7.0.0.beta1)
       puppet-modulebuilder (> 0.0.1)
-      rake (> 0.8)
-      rspec (> 0.1)
-      serverspec (> 0.1)
+      rake
+      rspec
+      serverspec-cem-acpt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.9)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
     deep_merge (1.2.2)
     diff-lcs (1.5.0)
     minitar (0.9)
     multi_json (1.15.0)
     net-scp (3.0.0)
       net-ssh (>= 2.6.5, < 7.0.0)
-    net-ssh (6.1.0)
+    net-ssh (7.0.0.beta1)
     net-telnet (0.1.1)
-    pathspec (1.1.3)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pathspec (1.0.0)
     puppet-modulebuilder (0.3.0)
       minitar (~> 0.9)
       pathspec (>= 0.2.1, < 2.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -40,29 +46,44 @@ GEM
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    serverspec (2.41.8)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    serverspec-cem-acpt (2.42.0)
       multi_json
       rspec (~> 3.0)
       rspec-its
-      specinfra (~> 2.72)
+      specinfra (~> 2.83.1)
     sfl (2.3)
-    specinfra (2.82.2)
+    specinfra (2.83.2)
       net-scp
       net-ssh (>= 2.7)
       net-telnet (= 0.1.1)
       sfl
+    unicode-display_width (2.1.0)
 
 PLATFORMS
-  ruby
+  universal-java-17
+  x86_64-darwin-19
 
 DEPENDENCIES
   cem_acpt!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.3.9

data/README.md

@@ -81,6 +81,14 @@ Much like `name_pattern_vars`, specifying the `image_name_builder` top-level key
 
 ## Installation
 
+### Installing from RubyGems
+
+To install the gem locally to use as a CLI tool:
+
+`gem install cem_acpt --prerelease`
+
+### Installing into a Puppet module
+
 Add this line to your module's Gemfile (usually under `group :development`):
 
 ```ruby
@@ -127,10 +135,6 @@ CemAcpt can use a config file (default path is `./cem_acpt_config.yaml`) to conf
 
 With CemAcpt, acceptance test names can have semantic meaning and influence how your acceptance test nodes are provisioned and how test data is created. The semantic meaning of the test names can be configured in the config file.
 
-#### Test data
-
-Test data can
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/cem_acpt.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'CEM Acceptance Tests'
   spec.description   = 'Litmus-like library focusing on CEM Acceptance Tests'
   spec.homepage      = 'https://github.com/puppetlabs/cem_acpt'
-  spec.license       = 'MIT'
+  spec.license       = 'proprietary'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
@@ -20,18 +20,18 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency 'concurrent-ruby', '~> 1.1.9'
-  spec.add_dependency 'deep_merge', '~> 1.2.2'
-  spec.add_dependency 'net-scp', '~> 3.0'
-  spec.add_dependency 'net-ssh', '~> 6.1'
-  spec.add_dependency 'puppet-modulebuilder', '> 0.0.1'
-  spec.add_dependency 'rake', '> 0.8'
-  spec.add_dependency 'rspec', '> 0.1'
-  spec.add_dependency 'serverspec', '> 0.1'
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.1.9'
+  spec.add_runtime_dependency 'deep_merge', '~> 1.2.2'
+  spec.add_runtime_dependency 'net-ssh', '~> 7.0.0.beta1'
+  spec.add_runtime_dependency 'puppet-modulebuilder', '> 0.0.1'
+  spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'rspec'
+  spec.add_runtime_dependency 'serverspec-cem-acpt'
+  spec.add_development_dependency 'rubocop'
 end

data/exe/cem_acpt

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env jruby
 # frozen_string_literal: true
 
 require 'deep_merge'
@@ -40,17 +40,43 @@ parser = OptionParser.new do |opts|
 
   opts.on('-I', '--CI', 'Run in CI mode') do
     options[:CI] = true
+    options[:log_format] = 'github_action'
   end
 
   opts.on('-E', '--no-destroy-nodes', 'Do not destroy nodes') do
     options[:no_destroy_nodes] = true
   end
+
+  opts.on('-q', '--quiet', 'Do not log to stdout') do
+    options[:quiet] = true
+  end
+
+  opts.on('-v', '--verbose', 'Enables verbose logging mode') do
+    options[:verbose] = true
+  end
+
+  opts.on('-V', '--version', 'Show the cem_acpt version') do
+    options[:show_version] = true
+  end
+
+  opts.on('-S', '--no-epehemeral-ssh-key', 'Do not generate an ephemeral SSH key for test suites') do
+    options[:no_ephemeral_ssh_key] = true
+  end
+
+  # NOT IMPLEMENTED
+  # opts.on('-R', '--reuse-nodes', 'Reuses test nodes if compatible node inventory exists') do
+  #   options[:reuse_nodes] = true
+  # end
 end
 
 parser.parse!
+if options[:show_version]
+  puts CemAcpt::VERSION
+  exit 0
+end
 options[:module_dir] = Dir.pwd unless options[:module_dir]
-options[:platforms] = ['gcp', 'vmpooler'] unless options[:platform]
-if options.key?(:log_level) && options[:log_level] == 'debug'
+options[:platforms] = %w[gcp vmpooler] unless options[:platform]
+if (options[:log_level] == 'debug' || options[:verbose]) && !options[:quiet]
   puts '#################### RUNNING ACCEPTANCE TEST SUITE ####################'
   puts "Using options from command line: #{options}"
   puts '#######################################################################'

data/lib/cem_acpt/context.rb

@@ -1,60 +1,153 @@
 # frozen_string_literal: true
 
-require 'concurrent-ruby'
+require_relative 'platform'
+require_relative 'utils'
+require_relative 'shared_objects'
+require_relative 'test_data'
+require_relative 'test_runner/run_handler'
+require_relative 'logging'
+
 module CemAcpt
   # Context provides the context in which the RunHandler creates and starts Runners.
   module Context
-    require_relative 'platform'
-    require_relative 'shared_objects'
-    require_relative 'test_data'
-    require_relative 'logging'
+    class ContextError < StandardError; end
 
     class << self
       include CemAcpt::Logging
+
+      KEY_PATH = File.join([ENV['HOME'], '.ssh', 'acpt_test_key']).freeze
+      KH_PATH = File.join([ENV['HOME'], '.ssh', 'acpt_test_known_hosts']).freeze
+
+      def log(msg, level = :info)
+        real_msg = "CONTEXT: #{msg}"
+        logger.send(level, real_msg)
+      end
+
+      # Builds the Puppet module package
+      # @param opts [Hash] config opts
+      # @return [String] The path to the Puppet module package
+      def build_module_package(opts = {})
+        module_dir = opts[:module_dir] || __dir__
+        pkg_path = CemAcpt::Utils::Puppet.build_module_package(module_dir)
+        log("Module package built at #{pkg_path}")
+        pkg_path
+      end
+
+      # Creates a SSH key and a SSH known hosts file for the acceptance test suite
+      def new_test_ssh_key
+        log('Creating ephemeral SSH key and known hosts file for acceptance test suites...')
+        @ssh_priv_key, @ssh_pub_key = CemAcpt::Utils::SSH.ephemeral_ssh_key
+        @ssh_known_hosts = CemAcpt::Utils::SSH.acpt_known_hosts
+        CemAcpt::Utils::SSH.set_ssh_file_permissions(@ssh_priv_key, @ssh_pub_key, @ssh_known_hosts)
+        log('Successfully created SSH files...')
+        log("SSH private key: #{@ssh_priv_key}", :debug)
+        log("SSH public key: #{@ssh_pub_key}", :debug)
+        log("SSH known hosts: #{@ssh_known_hosts}", :debug)
+      end
+
+      # Deletes acceptance test suite SSH files
+      def clean_test_ssh_key
+        log('Deleting ephemeral ssh keys and acpt_known_hosts if they exist...')
+        [@ssh_priv_key, @ssh_pub_key, @ssh_known_hosts].map { |f| File.delete(f) if File.exist?(f) }
+      end
+
+      # Prints a period to the terminal every 5 seconds in a single line to keep the terminal
+      # alive. This is used when running in CI mode. Does nothing unless the option `:CI` is
+      # `true`, or the environment variables CI or GITHUB_ACTION are set to a truthy value.
+      # @param opts [Hash] config opts
+      def keep_terminal_alive(opts = {})
+        @keep_terminal_alive = if opts[:CI] || ENV['CI'] || ENV['GITHUB_ACTION']
+                                 CemAcpt::Utils::Terminal.keep_terminal_alive
+                               end
+      end
+
+      def clean_up_test_suite(opts)
+        @ctx.node_inventory.clear!
+        @ctx.node_inventory.clean_local_files
+        clean_test_ssh_key unless opts[:no_ephemeral_ssh_key]
+        @run_handler&.destroy_test_nodes
+        @keep_terminal_alive&.kill
+      end
     end
 
-    # Creates a context for the RunHandler to create and start Runners.
+    # Creates a context (CemAcpt::Context::Ctx) object for the RunHandler to create and start Runners.
     # Provides the following objects for the Runners: a config object,
     # the test data hash, the node inventory, and the local port allocator.
     # Additionally, it creates the platform-specific node objects for each
     # test suite in the test data. It then calls the provided block with
     # the context objects nodes, config, test_data, and node_inventory.
     # @param config_opts [Hash] the config options
-    # @param config_file [String] the config file
-    def self.with(config_opts: nil, config_file: nil, &block)
-      logger.debug('In context with:')
-      logger.debug("config_opts: #{config_opts}")
-      logger.debug("config_file: #{config_file}")
-
-      config = CemAcpt::Config.new.load(opts: config_opts, config_file: config_file)
-      logger.debug("Loaded config: #{config.to_h}")
-
-      test_data = CemAcpt::TestData.acceptance_test_data(config)
-      logger.debug("Loaded test data: #{test_data}")
-
-      node_inventory = CemAcpt::NodeInventory.new
-      logger.debug("Initialized new node inventory: #{node_inventory}")
-
-      local_port_allocator = CemAcpt::LocalPortAllocator.new
-      logger.debug("Initialized new local port allocator: #{local_port_allocator}")
-
-      if config.has?('platform')
-        logger.debug("Using platform: #{config.get('platform')}")
-        nodes = CemAcpt::Platform.use(config.get('platform'), config, test_data, local_port_allocator)
-        block.call(nodes, config, test_data, node_inventory)
-      elsif config.has?('platforms')
-        config.get('platforms').each do |platform|
-          logger.debug("Using platform: #{platform}")
-          nodes = CemAcpt::Platform.use(platform, config, test_data, local_port_allocator)
-          block.call(nodes, config, test_data, node_inventory)
-        end
-      else
-        raise CemAcpt::Error, 'No platform(s) specified'
+    def self.with(**opts)
+      @opts = opts
+      @start_time = Time.now
+      raise CemAcpt::Context::ContextError, 'CemAcpt::Context.with requires a block' unless block_given?
+
+      config_file = @opts[:config_file] || File.expand_path('./cem_acpt_config.yaml')
+      logger.info("Running acceptance test suite at #{@start_time}")
+      logger.debug("Config opts: #{@opts}")
+      logger.debug("Config file: #{config_file}")
+      logger.info("Using module directory: #{@opts[:module_dir]}")
+      keep_terminal_alive(@opts)
+      Dir.chdir(opts[:module_dir]) do
+        new_test_ssh_key unless @opts[:no_ephemeral_ssh_key]
+        pkg_path = build_module_package(@opts)
+        @ctx = CemAcpt::Context::Ctx.new(opts: @opts, config_file: config_file, module_package_path: pkg_path)
+        logger.debug("Created Ctx object #{@ctx}")
+        @run_handler = CemAcpt::TestRunner::RunHandler.new(@ctx)
+        logger.debug("Created RunHandler object #{@run_handler}")
+        yield @run_handler
       end
+      @exit_code = @run_handler.exit_code
     rescue StandardError => e
-      logger.fatal("Fatal error: #{e.message}")
-      logger.debug(e.backtrace.join('; '))
-      exit(1)
+      logger.fatal("Acceptance test suite encountered an error: #{e.message}")
+      logger.fatal(e.backtrace.join("\n"))
+      @exit_code = 1
+    ensure
+      clean_up_test_suite(@opts)
+      total_minutes = ((Time.now - @start_time) / 60).round
+      logger.info("Test suite finished in ~#{total_minutes} minutes")
+      @exit_code || 1
+    end
+
+    # Ctx holds the context objects for the RunHandler to create and start Runners.
+    class Ctx
+      attr_reader :config, :test_data, :module_package_path, :node_inventory, :local_port_allocator
+
+      def initialize(opts: nil, config_file: nil, module_package_path: nil)
+        @config = CemAcpt::Config.new.load(opts: opts, config_file: config_file)
+        @test_data = CemAcpt::TestData.acceptance_test_data(@config)
+        @module_package_path = module_package_path
+        @node_inventory = CemAcpt::NodeInventory.new
+        @local_port_allocator = CemAcpt::LocalPortAllocator.new
+        prep_environment
+      end
+
+      def nodes
+        return @nodes if defined?(@nodes)
+
+        raise CemAcpt::Error, 'No platform(s) specified' unless @config.has?('platform') || @config.has?('platforms')
+
+        @nodes = nodes_from_platforms
+        @nodes
+      end
+
+      private
+
+      def prep_environment
+        @node_inventory.clean_local_files
+      end
+
+      def nodes_from_platforms
+        nodes = {}
+        if @config.has?('platform')
+          nodes[@config.get('platform')] = CemAcpt::Platform.use(@config.get('platform'), @config, @test_data, @local_port_allocator)
+        elsif @config.has?('platforms')
+          config.get('platforms').each do |platform|
+            nodes[platform] = CemAcpt::Platform.use(platform, @config, @test_data, @local_port_allocator)
+          end
+        end
+        nodes
+      end
     end
   end
 end

data/lib/cem_acpt/core_extensions.rb

@@ -45,14 +45,14 @@ module CemAcpt::CoreExtensions
     # Holds deep_freeze extensions to OpenStruct
     module OpenStruct
       def deep_freeze
-        return if deep_frozen?
-
-        @table.reduce({}) do |h, (key, value)|
-          fkey = key.respond_to?(:deep_freeze) ? key.deep_freeze : key
-          fval = value.respond_to?(:deep_freeze) ? value.deep_freeze : value
-          h.merge(fkey => fval)
-        end.freeze
-        @deep_frozen = true
+        unless deep_frozen?
+          @table.reduce({}) do |h, (key, value)|
+            fkey = key.respond_to?(:deep_freeze) ? key.deep_freeze : key
+            fval = value.respond_to?(:deep_freeze) ? value.deep_freeze : value
+            h.merge(fkey => fval)
+          end.freeze
+          @deep_frozen = true
+        end
       end
 
       def deep_frozen?
@@ -90,10 +90,7 @@ module CemAcpt::CoreExtensions
       #   hash = {a: {b: {c: 1}}}
       #   hash.dot_dig('a.b.c') # => 1
       def dot_dig(path)
-        result = dig(*path.split('.').map(&:to_sym))
-        return result unless result.nil?
-
-        dig(*path.split('.'))
+        dig(*path.split('.').map(&:to_sym)) || dig(*path.split('.'))
       end
 
       # Stores a value in a nested Hash using a dot-separated path