simp-beaker-helpers 1.11.2 → 1.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: bae36aadf14634267010bd774a210b9b9c493131acbfd615dfb863828f6fd357
-  data.tar.gz: 1ed635a000523d88d2bc912f01c39fd7e1b49eadd80317ab6fa17fa4b82a1880
+SHA1:
+  metadata.gz: b6e130fce3d3a8eee72398b70815453331916db8
+  data.tar.gz: a1b92623b2bae26cccf0c3563c143c71b46655ea
 SHA512:
-  metadata.gz: 31bb0095247c0a5fff39f822daf0a9d246c7c8cad14d2b2eaa97f169fac7f98d3526f9e63dba2758bc1bc2a154275d98f9aa2792a2fe7c087e649f4860a364a0
-  data.tar.gz: c00767d62bb2e611b091efe2739e5392e7fb7574249119b6217ee1abbdbfe37be84bb6a36062fa5b8eb7595da0c06ed7d31d17363c1e0797e44456d265c861c2
+  metadata.gz: 8526d0b9b7210537e2e9f2646e169d42befa0ce290072d54a60652ff106ad761ca8e34baeb0c594ca8edba944ea92d7ceb73a2ce5641eced574d77f5079112ce
+  data.tar.gz: af086c7b60267bdbfc730caa535ca1d04fd7e05dd05827ca028a2a4b303be0bfbc3e6be7894ff4cec9349a051d1e98b464b81158368e7bea8ce1da0b26a9b71f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.11.3 / 2018-10-22
+* Made the inspec report less confusing overall by noting where checks are
+  overridden
+* Fix errors in the previous ssh key copy
+
 ### 1.11.2 / 2018-10-11
 * Copy ssh keys in home directories to simp standard '/etc/ssh/local_keys/'
   to avoid error when certain simp puppet modules are applied

data/lib/simp/beaker_helpers/inspec.rb

@@ -1,8 +1,9 @@
 module Simp::BeakerHelpers
-
   # Helpers for working with Inspec
   class Inspec
 
+    require 'json'
+
     attr_reader :profile
     attr_reader :profile_dir
     attr_reader :deps_root
@@ -131,10 +132,19 @@ module Simp::BeakerHelpers
       HighLine.colorize_strings
 
       stats = {
-        :passed  => 0,
-        :failed  => 0,
-        :skipped => 0,
-        :report  => []
+        # Legacy metrics counters for backwards compatibility
+        :failed     => 0,
+        :passed     => 0,
+        :skipped    => 0,
+        :overridden => 0,
+        # End legacy stuff
+        :global   => {
+          :failed     => [],
+          :passed     => [],
+          :skipped    => [],
+          :overridden => []
+        },
+        :profiles => {}
       }
 
       if results.is_a?(String)
@@ -154,64 +164,104 @@ module Simp::BeakerHelpers
       end
 
       profiles.each do |profile|
-        stats[:report] << "Name: #{profile['name']}"
+        profile_name = profile['name']
+
+        next unless profile_name
+
+        stats[:profiles][profile_name] = {
+          :controls => {}
+        }
 
         profile['controls'].each do |control|
           title = control['title']
 
-          # Skip auto-generated material
           next unless title
 
-          if title.length > 72
-            title = title[0..71] + '(...)'
-          end
+          stats[:profiles][profile_name][:controls][title] = {}
 
-          title_chunks = control['title'].scan(/.{1,72}\W|.{1,72}/).map(&:strip)
+          formatted_title = title.scan(/.{1,72}\W|.{1,72}/).map(&:strip).join("\n           ")
 
-          stats[:report] << "\n  Control: #{title_chunks.shift}"
-          unless title_chunks.empty?
-            title_chunks.map!{|x| x = "           #{x}"}
-            stats[:report] << title_chunks.join("\n")
-          end
+          stats[:profiles][profile_name][:controls][title][:formatted_title] = formatted_title
 
           if control['results'] && !control['results'].empty?
             status = control['results'].first['status']
+
+            if status == /^fail/
+              status = :failed
+            else
+              status = :passed
+            end
           else
-            status = 'skipped'
+            status = :skipped
           end
 
-          status_str = "    Status: "
-          if status == 'skipped'
-            stats[:skipped] += 1
-
-            stats[:report] << status_str + status.yellow
-            stats[:report] << "    File: #{control['source_location']['ref']}"
-          elsif status =~ /^fail/
-            stats[:failed] += 1
+          stats[:global][status] << title
 
-            stats[:report] << status_str + status.red
-            stats[:report] << "    File: #{control['source_location']['ref']}"
-          else
-            stats[:passed] += 1
+          stats[:profiles][profile_name][:controls][title][:status] = status
+          stats[:profiles][profile_name][:controls][title][:source] = control['source_location']['ref']
+        end
+      end
 
-            stats[:report] << status_str + status.green
-          end
+      valid_checks = stats[:global][:failed] + stats[:global][:passed]
+      stats[:global][:skipped].dup.each do |skipped|
+        if valid_checks.include?(skipped)
+          stats[:global][:overridden] << skipped
+          stats[:global][:skipped].delete(skipped)
         end
+      end
+
+      status_colors = {
+        :failed     => 'red',
+        :passed     => 'green',
+        :skipped    => 'yellow',
+        :overridden => 'white'
+      }
+
+      report = []
+
+      stats[:profiles].keys.each do |profile|
+        report << "Profile: #{profile}"
 
-        stats[:report] << "\n  Statistics:"
-        stats[:report] << "    * Passed: #{stats[:passed].to_s.green}"
-        stats[:report] << "    * Failed: #{stats[:failed].to_s.red}"
-        stats[:report] << "    * Skipped: #{stats[:skipped].to_s.yellow}"
+        stats[:profiles][profile][:controls].each do |control|
+          control_info = control.last
 
-        score = 0
-        if (stats[:passed] + stats[:failed]) > 0
-          score = ((stats[:passed].to_f/(stats[:passed] + stats[:failed])) * 100.0).round(0)
+          report << "\n  Control: #{control_info[:formatted_title]}"
+
+          if control_info[:status] == :skipped && stats[:global][:overridden].include?(control.first)
+            control_info[:status] = :overridden
+          end
+
+          report << "    Status: #{control_info[:status].to_s.send(status_colors[control_info[:status]])}"
+          report << "    File: #{control_info[:source]}" if control_info[:source]
         end
 
-        stats[:report] << "    * Score:  #{score}%"
+        report << "\n"
       end
 
-      stats[:report] = stats[:report].join("\n")
+      num_passed     = stats[:global][:passed].count
+      num_failed     = stats[:global][:failed].count
+      num_skipped    = stats[:global][:skipped].count
+      num_overridden = stats[:global][:overridden].count
+
+      # Backwards compat values
+      stats[:passed]     = num_passed
+      stats[:failed]     = num_failed
+      stats[:skipped]    = num_skipped
+      stats[:overridden] = num_overridden
+
+      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)
+      end
+
+      report << "\n Score: #{score}%"
+
+      stats[:report] = report.join("\n")
 
       return stats
     end

data/lib/simp/beaker_helpers/version.rb

@@ -1,5 +1,5 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.11.2'
+  VERSION = '1.11.3'
 end

data/lib/simp/beaker_helpers.rb

@@ -365,14 +365,38 @@ module Simp::BeakerHelpers
       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'
 
-      # SIMP uses a central ssh key location, but some keys are only home dirs
-      on(sut, "mkdir -p /etc/ssh/local_keys")
-      on(sut, "for path in `find / -wholename '/home/*/.ssh/authorized_keys'`;"\
-              "do echo $path; user=`ls -l $path | awk '{print $3}'`;"\
-              "echo $user; cp --preserve=all -f $path /etc/ssh/local_keys/$user; done")
-      on(sut, "if [ -f /root/.ssh/authorized_keys ]; then cp --preserve=all -f /root/.ssh/authorized_keys /etc/ssh/local_keys/root; fi")
-      on(sut, "chown -R root:root /etc/ssh/local_keys")
-      on(sut, "chmod 644 /etc/ssh/local_keys/*")
+      # This may not exist in docker so just skip the whole thing
+      if sut.file_exist?('/etc/ssh')
+        # SIMP uses a central ssh key location so we prep that spot in case we
+        # flip to the SIMP SSH module.
+        on(sut, 'mkdir -p /etc/ssh/local_keys')
+        on(sut, 'chown -R root:root /etc/ssh/local_keys')
+        on(sut, 'chmod 755 /etc/ssh/local_keys')
+
+        user_info = on(sut, 'getent passwd').stdout.lines
+
+        cmd = []
+        # Hash of user => home_dir
+        # Exclude silly directories
+        #   * /
+        #   * /dev/*
+        #   * /s?bin
+        #   * /proc
+        user_info = Hash[
+          user_info.map do |u|
+            u.strip!
+            u = u.split(':')
+            u[5] =~ %r{^(/|/dev/.*|/s?bin/?.*|/proc/?.*)$} ? [nil] : [u[0], u[5]]
+          end
+        ]
+
+        user_info.keys.each do |user|
+          src_file = "#{user_info[user]}/.ssh/authorzed_keys"
+          tgt_file = "/etc/ssh/local_keys/#{user}"
+
+          on(sut, %{if [ -f "#{src_file}" ]; then cp -a -f "#{src_file}" "#{tgt_file}" && chmod 644 "#{tgt_file}"; fi}, :silent => true)
+        end
+      end
 
       # SIMP uses structured facts, therefore stringify_facts must be disabled
       unless ENV['BEAKER_stringify_facts'] == 'yes'

data/spec/acceptance/suites/puppet_collections/00_default_spec.rb

@@ -8,6 +8,10 @@ ENV['PUPPET_VERSION'] = '5.1'
 
 require 'spec_helper_acceptance'
 
+Bundler.with_clean_env{
+  %x{bundle exec rake spec_prep}
+}
+
 hosts.each do |host|
   describe 'make sure puppet version is valid' do
     context "on #{host}" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.11.3
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
@@ -204,8 +204,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: beaker helper methods for SIMP
-test_files: []
+test_files:
+- spec/acceptance/nodesets/default.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/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/puppet_collections/00_default_spec.rb
+- spec/acceptance/suites/puppet_collections/metadata.yml
+- spec/acceptance/suites/puppet_collections/nodesets/default.yml
+- spec/lib/simp/beaker_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_acceptance.rb