simp-beaker-helpers 1.21.3 → 1.23.2

data/CHANGELOG.md

@@ -1,3 +1,59 @@
+### 1.23.2 / 2021-05-29
+* Fixed:
+  * Fail an acceptance test when an explicitly-specified nodeset for an
+    acceptance test suite does not exist and the suite is configured
+    to fail fast (default behavior).
+  * The usual way of registering RHEL systems had to be changed to activate
+    immediately when called to function properly.
+
+### 1.23.1 / 2021-05-19
+* Fixed:
+  * The SSG default branch is now the latest numeric tag instead of the one
+    closest to the head of the default branch. The tag closest to the default
+    branch has drifted over time.
+  * Removed direct call to `docker` when copying out inspec results
+  * Typos in `copy_in` when running against docker
+* Added:
+  * `Simp::BeakerHelpers::Inspec.enable_repo_on(suts)` to allow users to easily
+    enable the Chef repos for inspec
+  * Beaker tests for inspec and SSG basic functionality
+  * GitHub Actions for acceptance testing where possible
+
+### 1.23.0 / 2021-03-16
+* Added:
+  * For `podman` support:
+    * Bumped the required beaker-docker to between 0.8.3 and 2.0.0
+    * Added a dependency on docker-api between 2.1.0 and 3.0.0
+  * Make SSG failures have verbose output to make remediation easier
+* Fixed:
+  * Ensure that containers use the correct method for copying files
+
+### 1.22.1 / 2021-03-01
+* Fixed: enable_epel_on() now installs the correct EPEL repository
+  package on OracleLinux
+
+### 1.22.0 / 2021-01-27
+* Fixed:
+  * Ensure that the simp-crypto_policy module is installed when flipping to FIPS
+    mode
+  * Only attempt to install the simp repos once in case they are broken for some
+    reason
+* Added:
+  * Documentation for all of the beaker environment variables
+  * set_simp_repo_release() for setting the release and release_type of the
+    public SIMP yum repos
+  * set_yum_opts_on() method for setting bulk yum config options
+  * set_yum_opt_on() method for setting singular yum config options
+  * install_package_unless_present_on() method
+  * Allow users to set repos to disable using an environment variable
+  * A total run time summary for beaker suites
+
+### 1.21.4 / 2021-01-21
+* Fixed:
+  * Reverted the use of OpenStruct due to issues with seralization
+  * Hash objects have a 'dig' method as of Ruby 2.3 so pinned this gem to a
+    minimum version of Ruby 2.3
+
 ### 1.21.3 / 2021-01-20
 * Fixed:
   * Allow all methods that can safely take SUT arrays to do so

data/Gemfile

@@ -13,7 +13,7 @@ gem 'bundler'
 gem 'rake'
 
 group :system_tests do
-  beaker_gem_options = ENV.fetch('BEAKER_GEM_OPTIONS', ['>= 4.17.0', '< 5.0.0'])
+  beaker_gem_options = ENV.fetch('BEAKER_GEM_OPTIONS', ['>= 4.28.1', '< 5.0.0'])
 
   if "#{beaker_gem_options}".include?(':')
     # Just pass in BEAKER_GEM_OPTIONS as a string that would represent the usual

data/README.md

@@ -13,6 +13,8 @@ Methods to assist beaker acceptance tests for SIMP.
   * [`rake beaker:suites`](#rake-beakersuites)
   * [Suite Execution](#suite-execution)
     * [Environment Variables](#environment-variables)
+      * [Beaker Management](#beaker-management)
+      * [Beaker Helpers Adjustments](#beaker-helpers-adjustments)
     * [Global Suite Configuration](#global-suite-configuration)
       * [Supported Config:](#supported-config)
     * [Individual Suite Configuration](#individual-suite-configuration)
@@ -112,12 +114,68 @@ sensitive).
 
 #### Environment Variables
 
-* BEAKER_suite_runall
+##### Beaker Management
+
+* BEAKER_suite_runall [yes|no]
   * Run all Suites
 
-* BEAKER_suite_basedir
+* BEAKER_suite_basedir [String]
   * The base directory where suites will be defined
-  * Default: spec/acceptance
+  * Default: `spec/acceptance`
+
+##### Beaker Helpers Adjustments
+
+* BEAKER_SIMP_parallel [yes|no]
+  * `yes` => Run simp-beaker-helpers methods on SUTs in parallel if possible
+  * `no` => Do not run methods in parallel
+
+* BEAKER_docker_cmd [String]
+  * The specific command to use for performing `docker` operations
+
+* BEAKER_helpers_verbose [yes|no]
+  * `yes` => Enable verbose output
+  * `no` => Do not enable verbose output
+
+* BEAKER_copy_fixtures [yes|no]
+  * `yes` => Enable copying fixtures to the SUT
+  * `no` => Disable copying fixtures to the SUT
+
+* BEAKER_use_fixtures_dir_for_modules [yes|no]
+  * `yes` => Pull fixtures directly from `spec/fixtures/modules`
+  * `no` => Ignore `spec/fixtures/modules` content
+
+* BEAKER_stringify_facts [yes|no]
+  * `yes` => Enable fact stringification
+
+* BEAKER_fips_module_version [String]
+  * The specific version of the FIPS module to install from the puppet forge
+
+* BEAKER_RHSM_USER [String]
+  * The username for using with RHSM
+
+* BEAKER_RHSM_PASS [String]
+  * The password for using with RHSM
+
+* BEAKER_fips [yes|no]
+  * `yes` => Enable FIPS on the SUT
+  * `no` => Do not manage FIPS on the SUT (will not disable if enabled)
+
+* BEAKER_no_fix_interfaces [Boolean]
+  * If present, will not try to fix the interfaces on the SUT
+
+* BEAKER_SIMP_install_repos [yes|no]
+  * `yes` => Install the SIMP YUM repositories
+  * `no` => No not install the SIMP YUM repositories
+
+* BEAKER_SIMP_disable_repos [String]
+  * Comma delimited list of YUM repositories to disable on the SUT
+
+* BEAKER_SIMP_repo_release [String]
+  * The release of SIMP to target in the YUM repos (usually a number)
+
+* BEAKER_SIMP_repo_release_type [String]
+  * The release type of SIMP to target in the YUM repos
+    * Something like `stable`, `rolling`, or `unstable`
 
 #### Global Suite Configuration
 
@@ -406,7 +464,7 @@ might try to install packages before subscription manager is configured.
 The version of InSpec to use when running inspec tests. Currently hard-coded to
 `4.16.14` due to a bug introduced in `4.16.15`.
 
-Let to 'latest' to use the latest available in the upstream repos.
+Set to 'latest' to use the latest available in the upstream repos.
 
 ## Examples
 
@@ -510,7 +568,7 @@ underlying OS configuration.
 
 `Simp::BeakerHelpers::Snapshot.save(sut, '<name of snapshot>')` will save a
 snapshot with the given name. If the snapshot already exists, it will be
-forceably overwritten.
+forcibly overwritten.
 
 
 ##### Base Snapshots

data/lib/simp/beaker_helpers.rb

@@ -18,7 +18,53 @@ module Simp::BeakerHelpers
     "simp-beaker-helpers-#{t}-#{$$}-#{rand(0x100000000).to_s(36)}.tmp"
   end
 
-  def install_latest_package_on(suts, package_name, package_source=nil, opts={})
+  # Sets a single YUM option in the form that yum-config-manager/dnf
+  # config-manager would expect.
+  #
+  # If not prefaced with a repository, the option will be applied globally.
+  #
+  # Has no effect if yum or dnf is not present.
+  def set_yum_opt_on(suts, key, value)
+    parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
+    block_on(suts, :run_in_parallel => parallel) do |sut|
+      repo,target = key.split('.')
+
+      unless target
+        key = "\\*.#{repo}"
+      end
+
+      command = nil
+      if !sut.which('dnf').empty?
+        install_package_unless_present_on(sut, 'dnf-plugins-core', :accept_all_exit_codes => true)
+        command = 'dnf config-manager'
+      elsif !sut.which('yum').empty?
+        command = 'yum-config-manager'
+      end
+
+      on(sut, %{#{command} --save --setopt=#{key}=#{value}}, :silent => true) if command
+    end
+  end
+
+  # Takes a hash of YUM options to set in the form that yum-config-manager/dnf
+  # config-manager would expect.
+  #
+  # If not prefaced with a repository, the option will be applied globally.
+  #
+  # Example:
+  #   {
+  #     'skip_if_unavailable' => '1', # Applies globally
+  #     'foo.installonly_limit' => '5' # Applies only to the 'foo' repo
+  #   }
+  def set_yum_opts_on(suts, yum_opts={})
+    parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
+    block_on(suts, :run_in_parallel => parallel) do |sut|
+      yum_opts.each_pair do |k,v|
+        set_yum_opt_on(sut, k, v)
+      end
+    end
+  end
+
+  def install_package_unless_present_on(suts, package_name, package_source=nil, opts={})
     default_opts = {
       max_retries: 3,
       retry_interval: 10
@@ -28,19 +74,35 @@ module Simp::BeakerHelpers
     block_on(suts, :run_in_parallel => parallel) do |sut|
       package_source = package_name unless package_source
 
-      if sut.check_for_package(package_name)
-        sut.upgrade_package(
+      unless sut.check_for_package(package_name)
+        sut.install_package(
           package_source,
           '',
+          nil,
           default_opts.merge(opts)
         )
-      else
-        sut.install_package(
+      end
+    end
+  end
+
+  def install_latest_package_on(suts, package_name, package_source=nil, opts={})
+    default_opts = {
+      max_retries: 3,
+      retry_interval: 10
+    }
+
+    parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
+    block_on(suts, :run_in_parallel => parallel) do |sut|
+      package_source = package_name unless package_source
+
+      if sut.check_for_package(package_name)
+        sut.upgrade_package(
           package_source,
           '',
-          nil,
           default_opts.merge(opts)
         )
+      else
+        install_package_unless_present_on(sut, package_name, package_source, opts)
       end
     end
   end
@@ -124,13 +186,18 @@ module Simp::BeakerHelpers
         end
       end
 
-      unless directory_exists_on(sut, dest)
-        dest = File.dirname(dest)
-        sut.mkdir_p(dest)
-      end
+      sut.mkdir_p(File.dirname(dest)) unless directory_exists_on(sut, dest)
 
-      %x(tar #{exclude_list.join(' ')} -hcf - -C "#{File.dirname(src)}" "#{File.basename(src)}" | #{docker_cmd} exec -i "#{container_id}" tar -C "#{dest}" -xf -)
+      if File.file?(src)
+        cmd = %{#{docker_cmd} cp "#{src}" "#{container_id}:#{dest}"}
+      else
+        cmd = [
+          %{tar #{exclude_list.join(' ')} -hcf - -C "#{File.dirname(src)}" "#{File.basename(src)}"},
+          %{#{docker_cmd} exec -i "#{container_id}" tar -C "#{dest}" -xf -}
+        ].join(' | ')
+      end
 
+      %x(#{cmd})
     elsif rsync_functional_on?(sut)
       # This makes rsync_to work like beaker and scp usually do
       exclude_hack = %(__-__' -L --exclude '__-__)
@@ -166,8 +233,6 @@ module Simp::BeakerHelpers
 
   # use the `puppet fact` face to look up facts on an SUT
   def pfact_on(sut, fact_name)
-    require 'ostruct'
-
     found_fact = nil
     # If puppet is not installed, there are no puppet facts to fetch
     if sut.which('puppet').empty?
@@ -176,16 +241,15 @@ module Simp::BeakerHelpers
       facts_json = nil
       begin
         cmd_output = on(sut, 'facter -p --json', :silent => true)
-
         # Facter 4+
         raise('skip facter -p') if (cmd_output.stderr =~ /no longer supported/)
 
-        facts = JSON.parse(cmd_output.stdout, object_class: OpenStruct)
+        facts = JSON.parse(cmd_output.stdout)
       rescue StandardError
         # If *anything* fails, we need to fall back to `puppet facts`
 
         facts_json = on(sut, 'puppet facts find garbage_xxx', :silent => true).stdout
-        facts = JSON.parse(facts_json, object_class: OpenStruct).values
+        facts = JSON.parse(facts_json)['values']
       end
 
       found_fact = facts.dig(*(fact_name.split('.')))
@@ -437,13 +501,16 @@ module Simp::BeakerHelpers
 
         fips_enable_modulepath = '--modulepath=/root/.beaker_fips/modules'
 
-        module_install_cmd = 'puppet module install simp-fips --target-dir=/root/.beaker_fips/modules'
+        modules_to_install = {
+          'simp-fips' => ENV['BEAKER_fips_module_version'],
+          'simp-crypto_policy' => nil
+        }
 
-        if ENV['BEAKER_fips_module_version']
-          module_install_cmd += " --version #{ENV['BEAKER_fips_module_version']}"
+        modules_to_install.each_pair do |to_install, version|
+          module_install_cmd = "puppet module install #{to_install} --target-dir=/root/.beaker_fips/modules"
+          module_install_cmd += " --version #{version}" if version
+          on(sut, module_install_cmd)
         end
-
-        on(sut, module_install_cmd)
       end
 
       # Work around Vagrant and cipher restrictions in EL8+
@@ -472,7 +539,7 @@ module Simp::BeakerHelpers
     block_on(suts, :run_in_parallel => parallel) do |sut|
       if sut['yum_repos']
         sut['yum_repos'].each_pair do |repo, metadata|
-          repo_manifest = create_yum_resource( repo, metadata)
+          repo_manifest = create_yum_resource(repo, metadata)
 
           apply_manifest_on(sut, repo_manifest, :catch_failures => true)
         end
@@ -552,12 +619,13 @@ module Simp::BeakerHelpers
   def enable_epel_on(suts)
     parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
     block_on(suts, :run_in_parallel => parallel) do |sut|
-      if ONLINE && (ENV['BEAKER_stringify_facts'] != 'no')
+      if ONLINE
         os_info = fact_on(sut, 'os')
         os_maj_rel = os_info['release']['major']
 
         # This is based on the official EPEL docs https://fedoraproject.org/wiki/EPEL
-        if ['RedHat', 'CentOS'].include?(os_info['name'])
+        case os_info['name']
+        when 'RedHat','CentOS'
           install_latest_package_on(
             sut,
             'epel-release',
@@ -583,7 +651,11 @@ module Simp::BeakerHelpers
               on sut, %{dnf config-manager --set-enabled powertools || dnf config-manager --set-enabled PowerTools}
             end
           end
+        when 'OracleLinux'
+          package_name = "oracle-epel-release-el#{os_maj_rel}"
+          install_latest_package_on(sut,package_name)
         end
+
       end
     end
   end
@@ -600,6 +672,9 @@ module Simp::BeakerHelpers
   def linux_errata( suts )
     parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
     block_on(suts, :run_in_parallel => parallel) do |sut|
+      # Set the locale if not set
+      sut.set_env_var('LANG', 'en_US.UTF-8') unless sut.get_env_var('LANG')
+
       # We need to be able to flip between server and client without issue
       on sut, 'puppet resource group puppet gid=52'
       on sut, 'puppet resource user puppet comment="Puppet" gid="52" uid="52" home="/var/lib/puppet" managehome=true'
@@ -675,11 +750,9 @@ module Simp::BeakerHelpers
       if os_info['family'] == 'RedHat'
         # OS-specific items
         if os_info['name'] == 'RedHat'
-          RSpec.configure do |c|
-            c.before(:all) do
-              rhel_rhsm_subscribe(sut)
-            end
+          rhel_rhsm_subscribe(sut)
 
+          RSpec.configure do |c|
             c.after(:all) do
               rhel_rhsm_unsubscribe(sut)
             end
@@ -1400,49 +1473,79 @@ module Simp::BeakerHelpers
   #    * 'simp-community-postgres'
   #    * 'simp-community-puppet'
   #
-  def install_simp_repos(sut, disable = [])
+  #
+  # Environment Variables:
+  #   * BEAKER_SIMP_install_repos
+  #     * 'no' => disable the capability
+  #   * BEAKER_SIMP_disable_repos
+  #     * Comma delimited list of active yum repo names to disable
+  def install_simp_repos(suts, disable = [])
     # NOTE: Do *NOT* use puppet in this method since it may not be available yet
 
-    install_latest_package_on(sut, 'yum-utils')
-    install_latest_package_on(
-      sut,
-      'simp-release-community',
-      "https://download.simp-project.com/simp-release-community.rpm",
-    )
+    return if (ENV.fetch('SIMP_install_repos', 'yes') == 'no')
 
-    to_disable = disable.dup
+    parallel = (ENV['BEAKER_SIMP_parallel'] == 'yes')
+    block_on(suts, :run_in_parallel => parallel) do |sut|
+      install_package_unless_present_on(sut, 'yum-utils')
 
-    unless to_disable.empty?
-      if to_disable.include?('simp')
-        to_disable.delete('simp')
-        to_disable << 'simp-community-simp'
-      end
+      install_package_unless_present_on(
+        sut,
+        'simp-release-community',
+        "https://download.simp-project.com/simp-release-community.rpm",
+      )
 
-      if to_disable.include?('simp_deps')
-        to_disable.delete('simp_deps')
-        to_disable << 'simp-community-epel'
-        to_disable << 'simp-community-postgres'
-        to_disable << 'simp-community-puppet'
-      end
+      to_disable = disable.dup
+      to_disable += ENV.fetch('BEAKER_SIMP_disable_repos', '').split(',').map(&:strip)
 
-      # NOTE: This --enablerepo enables the repos for listing and is inherited
-      # from YUM. This does not actually "enable" the repos, that would require
-      # the "--enable" option (from yum-config-manager) :-D.
-      #
-      # Note: Certain versions of EL8 do not dump by default and EL7 does not
-      # have the '--dump' option.
-      available_repos = on(sut, %{yum-config-manager --enablerepo="*" || yum-config-manager --enablerepo="*" --dump}).stdout.lines.grep(/\A\[(.+)\]\Z/){|x| $1}
+      unless to_disable.empty?
+        if to_disable.include?('simp')
+          to_disable.delete('simp')
+          to_disable << 'simp-community-simp'
+        end
 
-      invalid_repos = (to_disable - available_repos)
+        if to_disable.include?('simp_deps')
+          to_disable.delete('simp_deps')
+          to_disable << 'simp-community-epel'
+          to_disable << 'simp-community-postgres'
+          to_disable << 'simp-community-puppet'
+        end
 
-      # Verify that the repos passed to disable are in the list of valid repos
-      unless invalid_repos.empty?
-        logger.warn(%{WARN: install_simp_repo - requested repos to disable do not exist on the target system '#{invalid_repos.join("', '")}'.})
-      end
+        # NOTE: This --enablerepo enables the repos for listing and is inherited
+        # from YUM. This does not actually "enable" the repos, that would require
+        # the "--enable" option (from yum-config-manager) :-D.
+        #
+        # Note: Certain versions of EL8 do not dump by default and EL7 does not
+        # have the '--dump' option.
+        available_repos = on(sut, %{yum-config-manager --enablerepo="*" || yum-config-manager --enablerepo="*" --dump}).stdout.lines.grep(/\A\[(.+)\]\Z/){|x| $1}
+
+        invalid_repos = (to_disable - available_repos)
 
-      (to_disable - invalid_repos).each do |repo|
-        on(sut, %{yum-config-manager --disable "#{repo}"})
+        # Verify that the repos passed to disable are in the list of valid repos
+        unless invalid_repos.empty?
+          logger.warn(%{WARN: install_simp_repo - requested repos to disable do not exist on the target system '#{invalid_repos.join("', '")}'.})
+        end
+
+        (to_disable - invalid_repos).each do |repo|
+          on(sut, %{yum-config-manager --disable "#{repo}"})
+        end
       end
     end
+
+    set_yum_opts_on(suts, {'simp*.skip_if_unavailable' => '1' })
+  end
+
+  # Set the release and release type of the SIMP yum repos
+  #
+  # Environment variables may be used to set either one
+  #   * BEAKER_SIMP_repo_release => The actual release (version number)
+  #   * BEAKER_SIMP_repo_release_type => The type of release (stable, unstable, rolling, etc...)
+  def set_simp_repo_release(sut, simp_release_type='stable', simp_release='6')
+    simp_release = ENV.fetch('BEAKER_SIMP_repo_release', simp_release)
+    simp_release_type = ENV.fetch('BEAKER_SIMP_repo_release_type', simp_release_type)
+
+    simp_release_type = 'releases' if (simp_release_type == 'stable')
+
+    create_remote_file(sut, '/etc/yum/vars/simprelease', simp_release)
+    create_remote_file(sut, '/etc/yum/vars/simpreleasetype', simp_release_type)
   end
 end