cem_acpt 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4936d14749b4fc458a1eb938299c091e45c28c69a838efe947edb1510a10f151
-  data.tar.gz: 52b205f0be2bffa478a474c50bd0686e4ba32f2cec69d710b2a89ecde94c45c3
+  metadata.gz: 1e2aaf3de96bb10c9091d11e8d5e2e9680cd07bd601fa349be1c75db15e7428e
+  data.tar.gz: 3ac23bcddfd8ebd461d437de6b77454a19bf6e72ebd7e1986b76c5601f8e87c2
 SHA512:
-  metadata.gz: 96d81ee34960856f0accf22efec6aa3a12f34abf6b9137c43f886102d8a210eca2e907ff2cd2d0d01f6ce37026f9bf6b70c1ba07fd495ff3ad247ae6c3f713fb
-  data.tar.gz: 46a2f685ede232a010f26e8968666011c8ddfdf690f26df1fc11d3aa3e062d021db56df42854964a8b114b2a2d046127c47dba9b1f87334dd18160aeb2ff7367
+  metadata.gz: 8eeb0684612c1df4d7d1087bc411a351906c475b5ad9d32b61221023efc806a4137c74bb926e700cbe21ee36d1d0f5d1dd2915e7f006102ac9b5c872de82d97b
+  data.tar.gz: f7fce1e31b862cabfb19aba1e3ce8c0c32e9e99b80ca892dba64f7cfd711ebf6a64a253470803ce0dac9b65da3af2a7e02d2f8597c552e891e785cc4960fc27e

data/.github/workflows/spec.yml

@@ -15,14 +15,22 @@ jobs:
   tests:
     name: RSpec tests
     runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby:
+          - 2.7
+          - 3.2
     steps:
       - name: Checkout Source
         uses: actions/checkout@v3
 
+      - name: Delete Gemfile.lock
+        run: rm -f Gemfile.lock
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
       - name: Run RSpec

data/Gemfile.lock

@@ -1,17 +1,13 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.6.0)
+    cem_acpt (0.6.2)
       async-http (>= 0.60, < 0.70)
       bcrypt_pbkdf (>= 1.0, < 2.0)
-      concurrent-ruby (>= 1.1, < 2.0)
       deep_merge (>= 1.2, < 2.0)
       ed25519 (>= 1.2, < 2.0)
-      net-ssh (>= 7.1, < 7.2)
-      parallel (~> 1.22)
       puppet-modulebuilder (>= 0.0.1)
       ruby-terraform (~> 1.7)
-      serverspec (~> 2.42)
 
 GEM
   remote: https://rubygems.org/
@@ -52,11 +48,6 @@ GEM
       open4 (~> 1.3)
     method_source (1.0.0)
     minitar (0.9)
-    multi_json (1.15.0)
-    net-scp (4.0.0)
-      net-ssh (>= 2.6.5, < 8.0.0)
-    net-ssh (7.1.0)
-    net-telnet (0.1.1)
     open4 (1.3.4)
     parallel (1.22.1)
     parser (3.2.1.1)
@@ -88,9 +79,6 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.12.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
@@ -111,17 +99,6 @@ GEM
     ruby-terraform (1.7.0)
       immutable-struct (~> 2.4)
       lino (~> 3.0)
-    serverspec (2.42.2)
-      multi_json
-      rspec (~> 3.0)
-      rspec-its
-      specinfra (~> 2.72)
-    sfl (2.3)
-    specinfra (2.85.0)
-      net-scp
-      net-ssh (>= 2.7)
-      net-telnet (= 0.1.1)
-      sfl
     timers (4.3.5)
     traces (0.9.1)
     unicode-display_width (2.4.2)

data/cem_acpt.gemspec

@@ -26,17 +26,13 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  #spec.platform = Gem::Platform.local
+  # spec.platform = Gem::Platform.local
   spec.add_runtime_dependency 'async-http', '>= 0.60', '< 0.70'
-  spec.add_runtime_dependency 'concurrent-ruby', '>= 1.1', '< 2.0'
+  spec.add_runtime_dependency 'bcrypt_pbkdf', '>= 1.0', '< 2.0'
   spec.add_runtime_dependency 'deep_merge', '>= 1.2', '< 2.0'
   spec.add_runtime_dependency 'ed25519', '>= 1.2', '< 2.0'
-  spec.add_runtime_dependency 'bcrypt_pbkdf', '>= 1.0', '< 2.0'
-  spec.add_runtime_dependency 'net-ssh', '>= 7.1', '< 7.2'
-  spec.add_runtime_dependency 'parallel', '~> 1.22'
   spec.add_runtime_dependency 'puppet-modulebuilder', '>= 0.0.1'
   spec.add_runtime_dependency 'ruby-terraform', '~> 1.7'
-  spec.add_runtime_dependency 'serverspec', '~> 2.42'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop'
 end

data/lib/cem_acpt/config.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'digest'
 require 'json'
 require 'yaml'
 require_relative 'core_extensions'
@@ -118,10 +119,6 @@ module CemAcpt
     end
     alias to_h config
 
-    def user_config_dir
-      @user_config_dir ||= @config.dget('user_config.dir')
-    end
-
     def explain
       explanation = {}
       %i[defaults env_vars user_config config_from_file options].each do |source|
@@ -207,6 +204,14 @@ module CemAcpt
       @terraform_dir ||= File.join(user_config_dir, 'terraform')
     end
 
+    def module_terraform_checksum_file
+      @module_terraform_checksum_file ||= File.join(user_config_dir, 'terraform_checksum.txt')
+    end
+
+    def module_terraform_checksum
+      @module_terraform_checksum ||= new_module_terraform_checksum
+    end
+
     def valid_env_var?(env_var)
       env_var.start_with?('CEM_ACPT_') && ENV[env_var]
     end
@@ -297,6 +302,7 @@ module CemAcpt
 
       conf_file = find_option('config_file')
       return {} if conf_file.nil? || conf_file.empty?
+
       unless conf_file
         warn "Invalid config_file type '#{conf_file.class}'. Must be a String."
         return {}
@@ -321,11 +327,19 @@ module CemAcpt
     def load_config_file(config_file)
       return {} if config_file.nil? || config_file.empty? || !File.exist?(File.expand_path(config_file))
 
-      loaded = YAML.safe_load_file(File.expand_path(config_file), permitted_classes: [Regexp])
+      loaded = load_yaml(config_file)
       loaded.format!
       loaded
     end
 
+    def load_yaml(config_file)
+      if YAML.respond_to?(:safe_load_file) # Ruby 3.0+
+        YAML.safe_load_file(File.expand_path(config_file), permitted_classes: [Regexp])
+      else
+        YAML.safe_load(File.read(File.expand_path(config_file)), permitted_classes: [Regexp])
+      end
+    end
+
     def validate_config!
       @config.each do |key, _value|
         warn "Unknown config key: #{key}" unless KEYS.include?(key)
@@ -333,8 +347,33 @@ module CemAcpt
     end
 
     def create_config_dirs!
-      FileUtils.mkdir_p(user_config_dir) unless Dir.exist?(user_config_dir)
+      FileUtils.mkdir_p(user_config_dir)
+      create_terraform_dir!
+    end
+
+    def create_terraform_dir!
+      raise 'Cannot create terraform dir without a user config dir' unless Dir.exist? user_config_dir
+
+      if File.exist?(module_terraform_checksum_file)
+        checksum = File.read(module_terraform_checksum_file).strip
+        return if checksum == module_terraform_checksum
+      end
       FileUtils.cp_r(File.expand_path(File.join(__dir__, '..', 'terraform')), user_config_dir)
+      @module_terraform_checksum = new_module_terraform_checksum
+      File.write(module_terraform_checksum_file, module_terraform_checksum)
+    end
+
+    def new_module_terraform_checksum
+      sha256 = Digest::SHA256.new
+      files_and_dirs = Dir.glob(File.join(__dir__, '..', 'terraform', '**', '*'))
+      files_and_dirs.each do |file|
+        sha256 << if File.directory?(file)
+                    File.basename(file)
+                  else
+                    File.read(file)
+                  end
+      end
+      sha256.hexdigest
     end
   end
 end

data/lib/cem_acpt/platform/base.rb

@@ -15,12 +15,14 @@ module CemAcpt::Platform
 
     # @param conf [CemAcpt::Config] the config object.
     # @param single_test_data [Hash] the test data for the current test.
-    def initialize(config, single_test_data)
+    # @param run_data [Hash] the run data for the current run minus the test data key.
+    def initialize(config, single_test_data, **run_data)
       raise ArgumentError, 'single_test_data must be a Hash' unless single_test_data.is_a?(Hash)
 
       @config = config
       @test_data = single_test_data
       @node_name = @test_data[:node_name] || random_node_name
+      @run_data = run_data
     end
 
     def to_h

data/lib/cem_acpt/platform/gcp.rb

@@ -54,11 +54,11 @@ module Platform
   end
 
   def gcp_private_key
-    @gcp_private_key ||= (@test_data[:private_key] || File.join(Dir.home, '.ssh', 'google_compute_engine'))
+    @gcp_private_key ||= (@run_data[:private_key] || File.join(Dir.home, '.ssh', 'google_compute_engine'))
   end
 
   def gcp_public_key
-    @gcp_public_key ||= (@test_data[:public_key] || File.join(Dir.home, '.ssh', 'google_compute_engine.pub'))
+    @gcp_public_key ||= (@run_data[:public_key] || File.join(Dir.home, '.ssh', 'google_compute_engine.pub'))
   end
 
   def gcp_machine_type

data/lib/cem_acpt/platform.rb

@@ -17,16 +17,16 @@ module CemAcpt::Platform
     # item in the test data.
     # @param platform [String] the name of the platform
     # @param config [CemAcpt::Config] the config object
-    # @param test_data [Hash] the test data
-    def use(platform, config, test_data)
+    # @param run_data [Hash] the current run data. Must include a :test_data key
+    def use(platform, config, run_data)
       raise Error, "Platform #{platform} is not supported" unless platforms.include?(platform)
-      raise Error, 'test_data must be an Array' unless test_data.is_a?(Array)
+      raise Error, 'run_data must be an Hash' unless run_data.is_a?(Hash)
+      raise Error, 'run_data must include a :test_data key' unless run_data.key?(:test_data)
+      raise Error, 'run_data[:test_data] must be an Array' unless run_data[:test_data].is_a?(Array)
 
-      logger.info "Using #{platform} for #{test_data.length} tests..."
-      test_data.each_with_object([]) do |single_test_data, ary|
-        #local_port = local_port_allocator.allocate
-        #logger.debug("Allocated local port #{local_port} for test #{single_test_data[:test_name]}")
-        ary << new_platform_object(platform, config, single_test_data)
+      logger.info "Using #{platform} for #{run_data[:test_data].length} tests..."
+      run_data[:test_data].dup.each_with_object([]) do |single_test_data, ary|
+        ary << new_platform_object(platform, config, single_test_data, **run_data.except(:test_data))
       end
     end
 
@@ -62,10 +62,10 @@ module CemAcpt::Platform
     # @param config [CemAcpt::Config] the config object.
     # @param single_test_data [Hash] the test data for a single test.
     # @return [CemAcpt::Platform::Base] an initialized platform class.
-    def new_platform_object(platform, config, single_test_data)
+    def new_platform_object(platform, config, single_test_data, **run_data)
       raise Error, 'single_test_data must be a Hash' unless single_test_data.is_a?(Hash)
 
-      platform_class(platform).new(config, single_test_data)
+      platform_class(platform).new(config, single_test_data, **run_data)
     end
 
     # Creates a new platform-specific Class object for the given platform.

data/lib/cem_acpt/provision/terraform.rb

@@ -134,7 +134,7 @@ module CemAcpt
       end
 
       def new_working_dir
-        logger.debug('Terraform') { "Creating new working directory" }
+        logger.debug('Terraform') { 'Creating new working directory' }
         base_dir = File.join(@config.get('terraform.dir'), @config.get('platform.name'))
         logger.verbose('Terraform') { "Base directory defined as #{base_dir}" }
         @backend.base_provision_directory = base_dir
@@ -157,6 +157,7 @@ module CemAcpt
         logger.verbose('Terraform') { "Content of #{working_dir}:\n#{Dir.glob(File.join(working_dir, '*')).join("\n")}" }
         raise "Terraform working directory #{working_dir} does not exist" unless File.directory?(working_dir)
         raise "Terraform working directory #{working_dir} does not contain a Terraform file" unless Dir.glob(File.join(working_dir, '*.tf')).any?
+
         logger.info('Terraform') { "Using working directory: #{working_dir}" }
       rescue StandardError => e
         logger.error('Terraform') { 'Error validating working directory' }
@@ -165,13 +166,15 @@ module CemAcpt
 
       def provision_node_data
         node_data = @provision_data[:nodes].each_with_object({}) do |node, h|
-          h[node.node_name] = node.node_data.merge({
-            goss_file: node.test_data[:goss_file],
-            puppet_manifest: node.test_data[:puppet_manifest],
-            provision_dir_source: @backend.provision_directory,
-            provision_dir_dest: @backend.destination_provision_directory,
-            provision_commands: @backend.provision_commands,
-          })
+          h[node.node_name] = node.node_data.merge(
+            {
+              goss_file: node.test_data[:goss_file],
+              puppet_manifest: node.test_data[:puppet_manifest],
+              provision_dir_source: @backend.provision_directory,
+              provision_dir_dest: @backend.destination_provision_directory,
+              provision_commands: @backend.provision_commands,
+            }
+          )
         end
         node_data.to_json
       rescue StandardError => e
@@ -180,10 +183,14 @@ module CemAcpt
       end
 
       def formatted_vars
-        @provision_data[:nodes].first.platform_data.merge({
-          puppet_module_package: @provision_data[:module_package_path],
-          node_data: provision_node_data,
-        })
+        @provision_data[:nodes].first.platform_data.merge(
+          {
+            puppet_module_package: @provision_data[:module_package_path],
+            private_key: @provision_data[:private_key],
+            public_key: @provision_data[:public_key],
+            node_data: provision_node_data,
+          }
+        )
       rescue StandardError => e
         logger.error('Terraform') { 'Error creating formatted vars' }
         raise e

data/lib/cem_acpt/test_runner.rb

@@ -44,7 +44,7 @@ module CemAcpt
         logger.info('CemAcpt') { "Using module directory: #{config.get('module_dir')}..." }
         Dir.chdir(config.get('module_dir')) do
           keep_terminal_alive
-          @run_data[:priv_key], @run_data[:pub_key], @run_data[:known_hosts] = new_ephemeral_ssh_keys
+          @run_data[:private_key], @run_data[:public_key], @run_data[:known_hosts] = new_ephemeral_ssh_keys
           logger.info('CemAcpt') { 'Created ephemeral SSH key pair...' }
           @run_data[:module_package_path] = build_module_package
           logger.info('CemAcpt') { "Created module package: #{@run_data[:module_package_path]}..." }
@@ -67,9 +67,8 @@ module CemAcpt
       end
 
       def clean_up(trap_context = false)
-        unless trap_context
-          kill_keep_terminal_alive
-        end
+        kill_keep_terminal_alive unless trap_context
+
         clean_ephemeral_ssh_keys
         destroy_test_nodes
       end
@@ -114,7 +113,7 @@ module CemAcpt
       end
 
       def new_node_data
-        CemAcpt::Platform.use(config.get('platform.name'), config, @run_data[:test_data])
+        CemAcpt::Platform.use(config.get('platform.name'), config, @run_data)
       end
 
       def provision_test_nodes

data/lib/cem_acpt/version.rb

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

data/lib/cem_acpt.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'cem_acpt/config'
-require_relative 'cem_acpt/logging'
-require_relative 'cem_acpt/test_runner'
-require_relative 'cem_acpt/version'
-
 module CemAcpt
+  require_relative 'cem_acpt/config'
+  require_relative 'cem_acpt/logging'
+  require_relative 'cem_acpt/test_runner'
+  require_relative 'cem_acpt/version'
+
   class << self
     include CemAcpt::Logging
 

data/lib/terraform/gcp/linux/main.tf

@@ -173,9 +173,9 @@ resource "google_compute_instance" "acpt-test-node" {
     }
 
     metadata = {
-        oslogin = "TRUE"
-        ssh-keys = "${var.username}:${file(var.public_key)}"
-        cem-acpt-test = each.value.test_name
+        "enable-oslogin" = "FALSE"
+        "ssh-keys" = "${var.username}:${file(var.public_key)}"
+        "cem-acpt-test" = each.value.test_name
     }
 
     tags = [ "cem-acpt-test-node" ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -31,12 +31,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.70'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -90,60 +90,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: bcrypt_pbkdf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: net-ssh
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
-- !ruby/object:Gem::Dependency
-  name: parallel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
@@ -172,20 +118,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: serverspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.42'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.42'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement