simp-beaker-helpers 1.22.1 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4dabba2a12366f3acb4e850cd1894df06f7ab2f1de040f384351c8a2fdc3a1
-  data.tar.gz: ee3ee574fbb0165bc5354cc5a5bc5a9355add5da3412f5e65d2e3d27274d1f4a
+  metadata.gz: 77288902c91655a0e3f5c7db8d5573375e3c341638a8bfc3be82b76f7753f3f6
+  data.tar.gz: ec02b6c05c5b1b69615b83b7ed5682d1e2ba9619d72752c4adfa5d48e3e3ec61
 SHA512:
-  metadata.gz: c11025a91bc2e4cb079531e9930c54e7540b759bc365bb7a676c90a1c6ce50b5af4f610fb22e3c74b54f8c1d858d71ff4f12b30ba136ef5d1788255727c0df91
-  data.tar.gz: 50696f976eba788b3ed287af8aab9925ff237ba8d1b524ea0eaf04dbd97b11192a350cde65004696f6b0d83c3ce0bae1561fd408dce6d334aab57745cc1e7f40
+  metadata.gz: 6c006e7df61eaeb23dce36101ae518d88f99f34778821402973cf5c9358226572beab46c319fafee6487bbf325dbe07f72f7343c49d023e3d9949dd695092b57
+  data.tar.gz: f0535c393d9a6b6b8e3e9484fcf52e78adc4892bd0eca8255479eb06185e9865ddad9af2c6c5f3cd67d55c537632f88e178c39e6ad4a48757e2b61d7b229b826

data/.github/workflows.local.json

@@ -0,0 +1,6 @@
+{
+  "gem_build_command": "bundle exec rake pkg:gem",
+  "gem_release_command": "gem push dist/*.gem",
+  "gem_pkg_dir": "dist"
+}
+

data/.github/workflows/tag_deploy_rubygem.yml

@@ -1,4 +1,6 @@
 # Build & Deploy RubyGem & GitHub release when a SemVer tag is pushed
+#
+# This workflow's jobs are only triggered in repos under the `simp` organization
 # ------------------------------------------------------------------------------
 #
 #             NOTICE: **This file is maintained with puppetsync**
@@ -21,6 +23,19 @@
 #
 # * The CHANGLOG text is altered to remove RPM-style date headers, which don't
 #   render well as markdown on the GitHub release pages
+#
+# * By default, the gem is built and released using the standard rake tasks
+#   from "bundler/gem_tasks".  To override these, create a JSON file at
+#   `.github/workflows.local.json`, using the following format:
+#
+#         {
+#           "gem_build_command": "bundle exec rake build",
+#           "gem_release_command": "bundle exec rake build release:rubygem_push",
+#           "gem_pkg_dir": "pkg"
+#         }
+#
+#   All keys are optional.
+#
 ---
 name: 'Tag: Release to GitHub & rubygems.org'
 
@@ -36,10 +51,12 @@ env:
 jobs:
   releng-checks:
     name: "RELENG checks"
+    if: github.repository_owner == 'simp'
     runs-on: ubuntu-18.04
     outputs:
       build_command: ${{ steps.commands.outputs.build_command }}
       release_command: ${{ steps.commands.outputs.release_command }}
+      pkg_dir: ${{ steps.commands.outputs.pkg_dir }}
     steps:
       - name: "Assert '${{ github.ref }}' is a tag"
         run: '[[ "$GITHUB_REF" =~ ^refs/tags/ ]] || { echo "::error ::GITHUB_REF is not a tag: ${GITHUB_REF}"; exit 1 ; }'
@@ -53,27 +70,45 @@ jobs:
           # By default, these are the standard tasks from "bundler/gem_tasks"
           # To override them in the LOCAL_WORKFLOW_CONFIG_FILE
           GEM_BUILD_COMMAND='bundle exec rake build'
-          GEM_RELEASE_COMMAND='gem push pkg/*.gem'
+          GEM_RELEASE_COMMAND='bundle exec rake build release:rubygem_push'
+          GEM_PKG_DIR='pkg'
+          if jq -r '. | keys' "$LOCAL_WORKFLOW_CONFIG_FILE" 2>/dev/null | \
+              grep -w '"gem_pkg_dir"' &> /dev/null; then
+            GEM_PKG_DIR="$(jq -r .gem_pkg_dir "$LOCAL_WORKFLOW_CONFIG_FILE" )"
+          fi
           if jq -r '. | keys' "$LOCAL_WORKFLOW_CONFIG_FILE" 2>/dev/null | \
               grep -w '"gem_build_command"' &> /dev/null; then
-            GEM_BUILD_COMMAND="$(jq .gem_build_command "$LOCAL_WORKFLOW_CONFIG_FILE" )"
+            GEM_BUILD_COMMAND="$(jq -r .gem_build_command "$LOCAL_WORKFLOW_CONFIG_FILE" )"
           fi
           if jq -r '. | keys' "$LOCAL_WORKFLOW_CONFIG_FILE" 2>/dev/null | \
               grep -w '"gem_release_command"' &> /dev/null; then
-            GEM_RELEASE_COMMAND="$(jq .gem_release_command "$LOCAL_WORKFLOW_CONFIG_FILE" )"
+            GEM_RELEASE_COMMAND="$(jq -r .gem_release_command "$LOCAL_WORKFLOW_CONFIG_FILE" )"
           fi
           echo "::set-output name=build_command::${GEM_BUILD_COMMAND}"
+          echo "::set-output name=pkg_dir::${GEM_PKG_DIR}"
           echo "::set-output name=release_command::${GEM_RELEASE_COMMAND}"
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.5
           bundler-cache: true
       - name: Test build the package
-        run: "${{ steps.commands.outputs.build_command }}"
+        env:
+          GEM_BUILD_COMMAND: ${{ steps.commands.outputs.build_command }}
+        run: "$GEM_BUILD_COMMAND"
+      - name: "Assert '${{ github.ref }}' matches the package version"
+        run: |
+          tag="${GITHUB_REF/refs\/tags\//}"
+          [ -d  "${{ steps.commands.outputs.pkg_dir }}" ] || \
+             { echo "::error ::No directory found at ${{ steps.commands.outputs.pkg_dir }}/" ; exit 3 ; }
+          ls -1 "${{ steps.commands.outputs.pkg_dir }}"/*.gem || \
+             {  echo "::error ::No gem file found at ${{ steps.commands.outputs.pkg_dir }}/*.gem" ; exit 2 ; }
+          [ -f "${{ steps.commands.outputs.pkg_dir }}"/*-${tag}.gem ] || \
+             { echo "::error ::tag '${tag}' does not match package $(ls -1 ${{ steps.commands.outputs.pkg_dir }}/*.gem)"; exit 1 ; }
 
   create-github-release:
     name: Deploy GitHub Release
     needs: [ releng-checks ]
+    if: github.repository_owner == 'simp'
     runs-on: ubuntu-18.04
     steps:
       - name: Checkout code
@@ -117,11 +152,13 @@ jobs:
   deploy-rubygem:
     name: Deploy RubyGem Release
     needs: [ releng-checks ]
+    if: github.repository_owner == 'simp'
     runs-on: ubuntu-18.04
     env:
       RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
       BUILD_COMMAND: ${{ needs.releng-checks.outputs.build_command }}
       RELEASE_COMMAND: ${{ needs.releng-checks.outputs.release_command }}
+      PKG_DIR: ${{ needs.releng-checks.outputs.pkg_dir }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -133,7 +170,12 @@ jobs:
           ruby-version: 2.5
           bundler-cache: true
       - name: Build RubyGem
-        run: '$BUILD_COMMAND'
+        run: |
+          echo "Setting up file permissions..."
+          chmod -R go=u-w .
+
+          echo "Running '$BUILD_COMMAND'..."
+          $BUILD_COMMAND
 
       - name: Release RubyGem
         run: |
@@ -146,7 +188,5 @@ jobs:
           EOF
           chmod 0600 ~/.gem/credentials
 
-          chmod -R go=u-w .
-
           echo "Running '$RELEASE_COMMAND'..."
           $RELEASE_COMMAND

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 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

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/lib/simp/beaker_helpers.rb

@@ -186,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 "#{File.dirname(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 '__-__)

data/lib/simp/beaker_helpers/ssg.rb

@@ -79,7 +79,7 @@ module Simp::BeakerHelpers
         '7' => {
           'required_packages' => EL_PACKAGES,
           'ssg' => {
-            'profile_target' => 'rhel7',
+            'profile_target' => 'centos7',
             'build_target'   => 'centos7',
             'datastream'     => 'ssg-centos7-ds.xml'
           }
@@ -87,7 +87,7 @@ module Simp::BeakerHelpers
         '8' => {
           'required_packages' => EL8_PACKAGES,
           'ssg' => {
-            'profile_target' => 'rhel8',
+            'profile_target' => 'centos8',
             'build_target'   => 'centos8',
             'datastream'     => 'ssg-centos8-ds.xml'
           }
@@ -299,8 +299,26 @@ module Simp::BeakerHelpers
         result_id = rule_result.attributes['idref'].value.to_s
         result_value = [
           'Title: ' + doc.xpath("//Rule[@id='#{result_id}']/title/text()").first.to_s,
-          '  ID: ' + result_id
-        ].join("\n")
+          '  ID: ' + result_id,
+        ]
+
+        if result.child.content == 'fail'
+          references = {}
+
+          doc.xpath("//Rule[@id='#{result_id}']/reference").each do |ref|
+            references[ref['href']] ||= []
+            references[ref['href']] << ref.text
+          end
+
+          result_value << '  References:'
+          references.each_pair do |src, items|
+            result_value << "    *  #{src}"
+            result_value << "      * #{items.join(', ')}"
+          end
+          result_value << '  Description: ' + doc.xpath("//Rule[@id='#{result_id}']/description").text.gsub("\n","\n    ")
+        end
+
+        result_value = result_value.join("\n")
 
         if result.child.content == 'fail'
           stats[:failed] << result_value.red

data/lib/simp/beaker_helpers/version.rb

@@ -1,5 +1,5 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.22.1'
+  VERSION = '1.23.0'
 end

data/simp-beaker-helpers.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'beaker'                      , ['>= 4.17.0', '< 5.0.0']
   s.add_runtime_dependency 'beaker-rspec'                , '~> 6.2'
   s.add_runtime_dependency 'beaker-puppet'               , ['>= 1.18.14', '< 2.0.0']
-  s.add_runtime_dependency 'beaker-docker'               , '~> 0.3'
+  s.add_runtime_dependency 'beaker-docker'               , ['>= 0.8.3', '< 2.0.0']
+  s.add_runtime_dependency 'docker-api'                  , ['>= 2.1.0', '< 3.0.0']
   s.add_runtime_dependency 'beaker-vagrant'              , ['>= 0.6.4', '< 2.0.0']
   s.add_runtime_dependency 'beaker-puppet_install_helper', '~> 0.9'
   s.add_runtime_dependency 'highline'                    , '~> 2.0'

data/spec/acceptance/nodesets/docker.yml

@@ -1,29 +1,53 @@
 HOSTS:
-  el7:
+  el7.test.net:
     roles:
       - el7
       - master
-    platform: el-7-x86_64
+    platform:   el-7-x86_64
     hypervisor: docker
-    image: simpproject/simp_build_centos7
-    docker_cmd: '/usr/sbin/sshd -D -E /var/log/sshd.log'
+    image: simpproject/simp_beaker_el7
+    docker_cmd: '["/sbin/init"]'
 
-  el8:
+  el8.test.net:
     roles:
       - el8
-    platform: el-8-x86_64
+    platform:   el-8-x86_64
     hypervisor: docker
-    image: simpproject/simp_build_centos8
+    image: simpproject/simp_beaker_el8
     docker_cmd: '["/sbin/init"]'
 
 CONFIG:
-  docker_preserve_image: true
   log_level: verbose
   type: aio
-<% if ENV['BEAKER_PUPPET_COLLECTION'] -%>
-  puppet_collection: <%= ENV['BEAKER_PUPPET_COLLECTION'] %>
+<% if ENV['BEAKER_PUPPET_ENVIRONMENT'] -%>
+  puppet_environment: <%= ENV['BEAKER_PUPPET_ENVIRONMENT'] %>
+<% end -%>
+  # This is necessary for pretty much all containers
+  docker_cap_add:
+    - AUDIT_WRITE
+<%
+  require 'docker-api'
+  unless ::Docker.podman?
+-%>
+  # All items below this point are required for systemd
+  mount_folders:
+    cgroup:
+      host_path: /sys/fs/cgroup
+      container_path: /sys/fs/cgroup
+      opts: 'ro'
+  dockeropts:
+    HostConfig:
+      Tmpfs:
+        '/run': 'rw,noexec,nosuid,nodev,size=65536k'
+        '/run/lock': 'rw,noexec,nosuid,nodev,size=65536k'
+        '/tmp': 'rw,exec,nosuid,nodev,size=65536k'
+        '/sys/fs/cgroup/systemd': 'rw,size=65536k'
+        '/var/log/journal': 'rw,noexec,nodev,nosuid,size=65536k'
 <% end -%>
   ssh:
+    password: root
+    auth_methods:
+      - password
     keepalive: true
     keepalive_interval: 10
     host_key:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.23.0
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
@@ -69,16 +69,42 @@ dependencies:
   name: beaker-docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: beaker-vagrant
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +189,7 @@ extra_rdoc_files: []
 files:
 - ".fips_fixtures"
 - ".fixtures.yml"
+- ".github/workflows.local.json"
 - ".github/workflows/pr_glci.yml"
 - ".github/workflows/pr_glci_cleanup.yml"
 - ".github/workflows/pr_glci_manual.yml"
@@ -241,38 +268,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: beaker helper methods for SIMP
-test_files:
-- spec/acceptance/nodesets/default.yml
-- spec/acceptance/nodesets/docker.yml
-- spec/acceptance/nodesets/ubuntu.yml
-- spec/acceptance/suites/default/check_puppet_version_spec.rb
-- spec/acceptance/suites/default/enable_fips_spec.rb
-- spec/acceptance/suites/default/fixture_modules_spec.rb
-- spec/acceptance/suites/default/install_simp_deps_repo_spec.rb
-- spec/acceptance/suites/default/nodesets
-- spec/acceptance/suites/default/pki_tests_spec.rb
-- spec/acceptance/suites/default/set_hieradata_on_spec.rb
-- spec/acceptance/suites/default/write_hieradata_to_spec.rb
-- spec/acceptance/suites/fips_from_fixtures/00_default_spec.rb
-- spec/acceptance/suites/fips_from_fixtures/metadata.yml
-- spec/acceptance/suites/fips_from_fixtures/nodesets
-- spec/acceptance/suites/offline/00_default_spec.rb
-- spec/acceptance/suites/offline/README
-- spec/acceptance/suites/offline/nodesets/default.yml
-- spec/acceptance/suites/puppet_collections/00_default_spec.rb
-- spec/acceptance/suites/puppet_collections/metadata.yml
-- spec/acceptance/suites/snapshot/00_snapshot_test_spec.rb
-- spec/acceptance/suites/snapshot/10_general_usage_spec.rb
-- spec/acceptance/suites/snapshot/nodesets
-- spec/acceptance/suites/windows/00_default_spec.rb
-- spec/acceptance/suites/windows/metadata.yml
-- spec/acceptance/suites/windows/nodesets/default.yml
-- spec/acceptance/suites/windows/nodesets/win2016.yml
-- spec/acceptance/suites/windows/nodesets/win2019.yml
-- spec/lib/simp/beaker_helpers_spec.rb
-- spec/spec_helper.rb
-- spec/spec_helper_acceptance.rb
+test_files: []