simp-beaker-helpers 1.34.3 → 1.35.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.35.0 / 2024-12-19
+* Fixed:
+  * Clean up for rubocop
+
 ### 1.34.3 / 2024-12-20
 * Fixed:
   * Update /etc/hosts on all nodes when hostname changes (#227)

data/Gemfile

@@ -40,8 +40,11 @@ group :system_tests do
   gem 'beaker-windows'
   gem 'ed25519'
   gem 'net-ssh'
+  gem 'pry-byebug', '~> 3.10.0'
   gem 'puppet', ENV.fetch('PUPPET_VERSION', ['>= 7.0.0', '< 9.0.0'])
   gem 'puppetlabs_spec_helper', '>= 4.0.0', '< 8.0.0'
-  gem 'rubocop'
-  gem 'rubocop-rspec'
+  gem 'rubocop', '~> 1.69.2'
+  gem 'rubocop-performance', '~> 1.23.0'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 3.3.0'
 end

data/lib/simp/beaker_helpers/constants.rb

@@ -1,17 +1,19 @@
+# SIMP namespace
 module Simp; end
 
+# SIMP Beaker helper methods for testing
 module Simp::BeakerHelpers
   # This is the *oldest* puppet-agent version that the latest release of SIMP supports
   #
   # This is done so that we know if some new thing that we're using breaks the
   # oldest system that we support
-  DEFAULT_PUPPET_AGENT_VERSION = '~> 8.0'
+  DEFAULT_PUPPET_AGENT_VERSION = '~> 8.0'.freeze
 
   SSG_REPO_URL = ENV['BEAKER_ssg_repo'] || 'https://github.com/ComplianceAsCode/content.git'
 
-  if ['true','yes'].include?(ENV['BEAKER_online'])
+  if ['true', 'yes'].include?(ENV['BEAKER_online'])
     ONLINE = true
-  elsif ['false','no'].include?(ENV['BEAKER_online'])
+  elsif ['false', 'no'].include?(ENV['BEAKER_online'])
     ONLINE = false
   else
     require 'open-uri'
@@ -19,8 +21,8 @@ module Simp::BeakerHelpers
     begin
       if URI.respond_to?(:open)
         ONLINE = true if URI.open('http://google.com')
-      else
-        ONLINE = true if open('http://google.com')
+      elsif open('http://google.com')
+        ONLINE = true
       end
     rescue
       ONLINE = false

data/lib/simp/beaker_helpers/inspec.rb

@@ -1,9 +1,9 @@
+# SIMP Beaker helper methods for testing
 module Simp::BeakerHelpers
   require 'simp/beaker_helpers/constants'
 
   # Helpers for working with Inspec
   class Inspec
-
     require 'json'
 
     attr_reader :profile
@@ -12,16 +12,16 @@ module Simp::BeakerHelpers
 
     def self.enable_repo_on(suts)
       parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
-      block_on(suts, :run_in_parallel => parallel) do |sut|
+      block_on(suts, run_in_parallel: parallel) do |sut|
         repo_manifest = create_yum_resource(
           'chef-current',
           {
-            :baseurl => "https://packages.chef.io/repos/yum/current/el/#{fact_on(sut,'os.release.major')}/$basearch",
-            :gpgkeys => ['https://packages.chef.io/chef.asc']
-          }
+            baseurl: "https://packages.chef.io/repos/yum/current/el/#{fact_on(sut, 'os.release.major')}/$basearch",
+            gpgkeys: ['https://packages.chef.io/chef.asc']
+          },
         )
 
-        apply_manifest_on(sut, repo_manifest, :catch_failures => true)
+        apply_manifest_on(sut, repo_manifest, catch_failures: true)
       end
     end
 
@@ -85,13 +85,13 @@ module Simp::BeakerHelpers
       inspec_version = Gem::Version.new(on(@sut, 'inspec --version').output.lines.first.strip)
 
       # See: https://github.com/inspec/inspec/pull/3935
-      if inspec_version <= Gem::Version.new('3.9.0')
-        inspec_cmd = "inspec exec '#{@test_dir}' --reporter json > #{sut_inspec_results}"
-      else
-        inspec_cmd = "inspec exec '#{@test_dir}' --chef-license accept --reporter json > #{sut_inspec_results}"
-      end
+      inspec_cmd = if inspec_version <= Gem::Version.new('3.9.0')
+                     "inspec exec '#{@test_dir}' --reporter json > #{sut_inspec_results}"
+                   else
+                     "inspec exec '#{@test_dir}' --chef-license accept --reporter json > #{sut_inspec_results}"
+                   end
 
-      result = on(@sut, inspec_cmd, :accept_all_exit_codes => true)
+      result = on(@sut, inspec_cmd, accept_all_exit_codes: true)
 
       tmpdir = Dir.mktmpdir
       begin
@@ -110,7 +110,7 @@ module Simp::BeakerHelpers
                 line.start_with?('{') && line.end_with?('}')
               end
 
-              @results = JSON.load(inspec_json) if inspec_json
+              @results = JSON.parse(inspec_json) if inspec_json
             rescue JSON::ParserError, JSON::GeneratorError
               @results = nil
             end
@@ -120,16 +120,15 @@ module Simp::BeakerHelpers
         FileUtils.remove_entry_secure tmpdir
       end
 
-      if @results.nil? || @results.empty?
-        File.open(@result_file + '.err', 'w') do |fh|
-          fh.puts(result.stderr.strip)
-        end
+      return unless @results.nil? || @results.empty?
+      File.open(@result_file + '.err', 'w') do |fh|
+        fh.puts(result.stderr.strip)
+      end
 
-        err_msg = ["Error running inspec command #{inspec_cmd}"]
-        err_msg << "Error captured in #{@result_file}" + '.err'
+      err_msg = ["Error running inspec command #{inspec_cmd}"]
+      err_msg << "Error captured in #{@result_file}" + '.err'
 
-        fail(err_msg.join("\n"))
-      end
+      raise(err_msg.join("\n"))
     end
 
     # Output the report
@@ -162,36 +161,34 @@ module Simp::BeakerHelpers
 
       stats = {
         # Legacy metrics counters for backwards compatibility
-        :failed     => 0,
-        :passed     => 0,
-        :skipped    => 0,
-        :overridden => 0,
+        failed: 0,
+        passed: 0,
+        skipped: 0,
+        overridden: 0,
         # End legacy stuff
-        :global   => {
-          :failed     => [],
-          :passed     => [],
-          :skipped    => [],
-          :overridden => []
+        global: {
+          failed: [],
+          passed: [],
+          skipped: [],
+          overridden: []
         },
-        :score    => 0,
-        :report   => nil,
-        :profiles => {}
+        score: 0,
+        report: nil,
+        profiles: {}
       }
 
       if results.is_a?(String)
-        if File.readable?(results)
-          profiles = JSON.load(File.read(results))['profiles']
-        else
-          fail("Error: Could not read results file at #{results}")
-        end
+        raise("Error: Could not read results file at #{results}") unless File.readable?(results)
+        profiles = JSON.parse(File.read(results))['profiles']
+
       elsif results.is_a?(Hash)
         profiles = results['profiles']
       else
-        fail("Error: first argument must be a String path to a file or a Hash")
+        raise('Error: first argument must be a String path to a file or a Hash')
       end
 
       if !profiles || profiles.empty?
-        fail("Error: Could not find 'profiles' in the passed results")
+        raise("Error: Could not find 'profiles' in the passed results")
       end
 
       profiles.each do |profile|
@@ -200,7 +197,7 @@ module Simp::BeakerHelpers
         next unless profile_name
 
         stats[:profiles][profile_name] = {
-          :controls => {}
+          controls: {}
         }
 
         profile['controls'].each do |control|
@@ -208,7 +205,7 @@ module Simp::BeakerHelpers
 
           next unless title
 
-          base_title = title.scan(/.{1,60}\W|.{1,60}/).map(&:strip).join("\n           ")
+          base_title = title.scan(%r{.{1,60}\W|.{1,60}}).map(&:strip).join("\n           ")
 
           if control['results'] && (control['results'].size > 1)
             control['results'].each do |result|
@@ -221,12 +218,12 @@ module Simp::BeakerHelpers
 
               stats[:profiles][profile_name][:controls][full_title][:formatted_title] = formatted_title
 
-              if result['status'] =~ /^fail/
+              if %r{^fail}.match?(result['status'])
                 status = :failed
-                color = 'red'
+                'red'
               else
                 status = :passed
-                color = 'green'
+                'green'
               end
 
               stats[:global][status] << formatted_title.color
@@ -245,8 +242,8 @@ module Simp::BeakerHelpers
               status = :passed
               color = 'green'
 
-              control['results'].each do |result|
-                if results['status'] =~ /^fail/
+              control['results'].each do |_result|
+                if %r{^fail}.match?(results['status'])
                   status = :failed
                   color = 'red'
                 end
@@ -273,15 +270,15 @@ module Simp::BeakerHelpers
       end
 
       status_colors = {
-        :failed     => 'red',
-        :passed     => 'green',
-        :skipped    => 'yellow',
-        :overridden => 'white'
+        failed: 'red',
+        passed: 'green',
+        skipped: 'yellow',
+        overridden: 'white'
       }
 
       report = []
 
-      stats[:profiles].keys.each do |profile|
+      stats[:profiles].each_key do |profile|
         report << "Profile: #{profile}"
 
         stats[:profiles][profile][:controls].each do |control|
@@ -311,14 +308,14 @@ module Simp::BeakerHelpers
       stats[:skipped]    = num_skipped
       stats[:overridden] = num_overridden
 
-      report << "Statistics:"
+      report << 'Statistics:'
       report << "  * Passed: #{num_passed.to_s.green}"
       report << "  * Failed: #{num_failed.to_s.red}"
       report << "  * Skipped: #{num_skipped.to_s.yellow}"
 
       score = 0
       if (stats[:global][:passed].count + stats[:global][:failed].count) > 0
-        score = ((stats[:global][:passed].count.to_f/(stats[:global][:passed].count + stats[:global][:failed].count)) * 100.0).round(0)
+        score = ((stats[:global][:passed].count.to_f / (stats[:global][:passed].count + stats[:global][:failed].count)) * 100.0).round(0)
       end
 
       report << "\n Score: #{score}%"
@@ -326,7 +323,7 @@ module Simp::BeakerHelpers
       stats[:score] = score
       stats[:report] = report.join("\n")
 
-      return stats
+      stats
     end
   end
 end

data/lib/simp/beaker_helpers/snapshot.rb

@@ -1,156 +1,148 @@
-module Simp::BeakerHelpers
-  # Helpers for managing Vagrant snapshots
-  class Snapshot
-    # The name of the base snapshot that is created if no snapshots currently exist
-    BASE_NAME = '_simp_beaker_base'
-
-    # Save a snapshot
-    #
-    # @param host [Beaker::Host]
-    #   The SUT to work on
-    #
-    # @param snapshot_name [String]
-    #   The string to add to the snapshot
-    #
-    def self.save(host, snapshot_name)
-      if enabled?
-        vdir = vagrant_dir(host)
-
-        if vdir
-          Dir.chdir(vdir) do
-            save(host, BASE_NAME) unless exist?(host, BASE_NAME)
-
-            snap = "#{host.name}_#{snapshot_name}"
-
-            output = %x(vagrant snapshot save --force #{host.name} "#{snap}")
-
-            logger.notify(output)
-
-            retry_on(
-              host,
-              %(echo "saving snapshot '#{snap}'" > /dev/null),
-              :max_retries => 30,
-              :retry_interval => 1
-            )
-          end
-        end
-      end
+# Helpers for managing Vagrant snapshots
+class Simp::BeakerHelpers::Snapshot
+  # The name of the base snapshot that is created if no snapshots currently exist
+  BASE_NAME = '_simp_beaker_base'.freeze
+
+  # Save a snapshot
+  #
+  # @param host [Beaker::Host]
+  #   The SUT to work on
+  #
+  # @param snapshot_name [String]
+  #   The string to add to the snapshot
+  #
+  def self.save(host, snapshot_name)
+    return unless enabled?
+    vdir = vagrant_dir(host)
+
+    return unless vdir
+    Dir.chdir(vdir) do
+      save(host, BASE_NAME) unless exist?(host, BASE_NAME)
+
+      snap = "#{host.name}_#{snapshot_name}"
+
+      output = `vagrant snapshot save --force #{host.name} "#{snap}"`
+
+      logger.notify(output)
+
+      retry_on(
+        host,
+        %(echo "saving snapshot '#{snap}'" > /dev/null),
+        max_retries: 30,
+        retry_interval: 1,
+      )
     end
+  end
 
-    # Whether or not a named snapshot exists
-    #
-    # @param host [Beaker::Host]
-    #   The SUT to work on
-    #
-    # @param snapshot_name [String]
-    #   The string to add to the snapshot
-    #
-    # @return [Boolean]
-    def self.exist?(host, name)
-      list(host).include?(name)
-    end
+  # Whether or not a named snapshot exists
+  #
+  # @param host [Beaker::Host]
+  #   The SUT to work on
+  #
+  # @param snapshot_name [String]
+  #   The string to add to the snapshot
+  #
+  # @return [Boolean]
+  def self.exist?(host, name)
+    list(host).include?(name)
+  end
 
-    # List all snapshots for the given host
-    #
-    # @parma host [Beaker::Host]
-    #   The SUT to work on
-    #
-    # @return [Array[String]]
-    #   A list of snapshot names for the host
-    def self.list(host)
-      output = []
-      vdir = vagrant_dir(host)
-
-      if vdir
-        Dir.chdir(vdir) do
-          output = %x(vagrant snapshot list #{host.name}).lines
-          output.map! do |x|
-            x.split(/^#{host.name}_/).last.split(':').first.delete('==>').strip
-          end
+  # List all snapshots for the given host
+  #
+  # @parma host [Beaker::Host]
+  #   The SUT to work on
+  #
+  # @return [Array[String]]
+  #   A list of snapshot names for the host
+  def self.list(host)
+    output = []
+    vdir = vagrant_dir(host)
+
+    if vdir
+      Dir.chdir(vdir) do
+        output = `vagrant snapshot list #{host.name}`.lines
+        output.map! do |x|
+          x.split(%r{^#{host.name}_}).last.split(':').first.delete('==>').strip
         end
       end
-
-      output
     end
 
-    # Restore a snapshot
-    #
-    # @param host [Beaker::Host]
-    #   The SUT to work on
-    #
-    # @param snapshot_name [String]
-    #   The name that was added to the snapshot
-    #
-    def self.restore(host, snapshot_name)
-      if enabled?
-        vdir = vagrant_dir(host)
-
-        if vdir
-          Dir.chdir(vdir) do
-            snap = "#{host.name}_#{snapshot_name}"
-
-            output = %x(vagrant snapshot restore #{host.name} "#{snap}" 2>&1)
-
-            if (output =~ /error/i) && (output =~ /child/)
-              raise output
-            end
-
-            if (output =~ /snapshot.*not found/)
-              raise output
-            end
-
-            logger.notify(output)
-
-            retry_on(
-              host,
-              %(echo "restoring snapshot '#{snap}'" > /dev/null),
-              :max_retries => 30,
-              :retry_interval => 1
-            )
-          end
-        end
+    output
+  end
+
+  # Restore a snapshot
+  #
+  # @param host [Beaker::Host]
+  #   The SUT to work on
+  #
+  # @param snapshot_name [String]
+  #   The name that was added to the snapshot
+  #
+  def self.restore(host, snapshot_name)
+    return unless enabled?
+    vdir = vagrant_dir(host)
+
+    return unless vdir
+    Dir.chdir(vdir) do
+      snap = "#{host.name}_#{snapshot_name}"
+
+      output = `vagrant snapshot restore #{host.name} "#{snap}" 2>&1`
+
+      if (output =~ %r{error}i) && output.include?('child')
+        raise output
       end
-    end
 
-    # Restore all the way back to the base image
-    #
-    # @param host [Beaker::Host]
-    #   The SUT to work on
-    #
-    def self.restore_to_base(host)
-      if exist?(host, BASE_NAME)
-        restore(host, BASE_NAME)
-      else
-        save(host, BASE_NAME)
+      if %r{snapshot.*not found}.match?(output)
+        raise output
       end
-    end
 
-    private
+      logger.notify(output)
 
-    def self.enabled?
-      enabled = ENV['BEAKER_simp_snapshot'] == 'yes'
+      retry_on(
+        host,
+        %(echo "restoring snapshot '#{snap}'" > /dev/null),
+        max_retries: 30,
+        retry_interval: 1,
+      )
+    end
+  end
 
-      unless enabled
-        logger.warn('Snapshotting not enabled, set BEAKER_simp_snapshot=yes to enable')
-      end
+  # Restore all the way back to the base image
+  #
+  # @param host [Beaker::Host]
+  #   The SUT to work on
+  #
+  def self.restore_to_base(host)
+    if exist?(host, BASE_NAME)
+      restore(host, BASE_NAME)
+    else
+      save(host, BASE_NAME)
+    end
+  end
+
+  def self.enabled?
+    enabled = ENV['BEAKER_simp_snapshot'] == 'yes'
 
-      return enabled
+    unless enabled
+      logger.warn('Snapshotting not enabled, set BEAKER_simp_snapshot=yes to enable')
     end
 
-    def self.vagrant_dir(host)
-      tgt_dir = nil
+    enabled
+  end
 
-      if host && host.options && host.options[:hosts_file]
-        vdir = File.join('.vagrant', 'beaker_vagrant_files', File.basename(host.options[:hosts_file]))
+  def self.vagrant_dir(host)
+    tgt_dir = nil
 
-        if File.directory?(vdir)
-          tgt_dir = vdir
-        else
-          logger.notify("Could not find local vagrant dir at #{vdir}")
-        end
-      end
+    if host&.options && host.options[:hosts_file]
+      vdir = File.join('.vagrant', 'beaker_vagrant_files', File.basename(host.options[:hosts_file]))
 
-      return tgt_dir
+      if File.directory?(vdir)
+        tgt_dir = vdir
+      else
+        logger.notify("Could not find local vagrant dir at #{vdir}")
+      end
     end
+
+    tgt_dir
   end
 end