simp-beaker-helpers 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595569d32fa2838087255deae0d053e768bf419795f2ba6e5dc2eba10a36a925
-  data.tar.gz: 42b829bc3b86cabbfe51034f02e65d4bfea6e05e66f7a5d0fc21a9d19a29614b
+  metadata.gz: de20d90d702274ad89d7c0f4971cf392e7b9810dd81c19d2a18713e2094c2e8e
+  data.tar.gz: 98364f3ad80cb62f625e5b83fbe284e4b303a99e09bf2227d22f9e3adbf40603
 SHA512:
-  metadata.gz: c4e100cfb8b50c78604d4731498cc4508cd6ed5e396da7d6b426a6f3f2250f7aa5048a059d8ef52a8bc0ec8d40c4842e6eb8dccdd8dd8206cb48b33c413ade23
-  data.tar.gz: 3efbd63c6dff000c2de7fca7fef88afcf390249d7b17610ed5ee29b0b4a3a137c043a4dce520b74342693192e5e991feb6285b8f4984dea891ff045daf271549
+  metadata.gz: d94eb890371b09ce7f2bcaa315dc6fe723228364a5186a0d363d4f56a14a4c744e171307d53251abe23460290aabd96b6124f82d30e8f79bd350ff6b6a2ac599
+  data.tar.gz: 1cd900c931008350da80b0b13856538d01afcac2a9c912a7d546953321069ed3f4e915ab2b59052c1f413d651ce5bcc307cc3bf46d13b0d56c6edc4556e7dc69

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-### 1.11.0 / 2018-09-09
+### 1.11.1 / 2018-10-03
+* Deprecate the 'terminus' parameter in 'write_hieradata_to' and 'set_hieradata_on'
+* Add 'copy_hiera_data_to' method to replace the one from beaker-hiera
+* Add 'hiera_datadir' method to replace the one from beaker-hiera
+* Change InSpec to use the 'reporter' option instead of 'format'
+* Update the SSG to point to the new ComplianceAsCode repository
+
+### 1.11.0 / 2018-10-01
 * Add support for Beaker 4
 
 ### 1.10.14 / 2018-08-01

data/lib/simp/beaker_helpers.rb

@@ -83,9 +83,7 @@ module Simp::BeakerHelpers
 
   # Returns the modulepath on the SUT, as an Array
   def puppet_modulepath_on(sut, environment='production')
-    on(
-      sut, "puppet config print --section main modulepath --environment #{environment} 2>/dev/null"
-    ).output.lines.last.strip.split(':')
+    sut.puppet['modulepath'].split(':')
   end
 
   # Return the path to the 'spec/fixtures' directory
@@ -607,15 +605,15 @@ done
   # Writes a YAML file in the Hiera :datadir of a Beaker::Host.
   #
   # @note This is useless unless Hiera is configured to use the data file.
-  #   @see `Beaker::DSL::Helpers::Hiera#write_hiera_config_on`
+  #   @see `#write_hiera_config_on`
   #
   # @param sut  [Array<Host>, String, Symbol] One or more hosts to act upon.
   #
-  # @param heradata [Hash, String] The full hiera data structure to write to
+  # @param hieradata [Hash, String] The full hiera data structure to write to
   #   the system.
   #
-  # @param terminus [String] The basename of the YAML file minus the extension
-  #   to write to the system.
+  # @param terminus [String]  DEPRECATED - This will be removed in a future
+  #   release and currently has no effect.
   #
   # @return [Nil]
   #
@@ -623,12 +621,12 @@ done
   #   using `#clear_temp_hieradata` in the `after(:all)` hook.  It may also be
   #   retained for debugging purposes.
   #
-  def write_hieradata_to(sut, hieradata, terminus = 'default')
+  def write_hieradata_to(sut, hieradata, terminus = 'deprecated')
     @temp_hieradata_dirs ||= []
     data_dir = Dir.mktmpdir('hieradata')
     @temp_hieradata_dirs << data_dir
 
-    fh = File.open(File.join(data_dir, "#{terminus}.yaml"), 'w')
+    fh = File.open(File.join(data_dir, 'common.yaml'), 'w')
     if hieradata.is_a?(String)
       fh.puts(hieradata)
     else
@@ -636,10 +634,65 @@ done
     end
     fh.close
 
-    apply_manifest_on sut, "file { '#{hiera_datadir(sut)}': ensure => 'directory', force => true }"
-    copy_hiera_data_to sut, File.join(data_dir, "#{terminus}.yaml")
+    copy_hiera_data_to sut, File.join(data_dir, 'common.yaml')
+  end
+
+  # A shim to stand in for the now deprecated copy_hiera_data_to function
+  #
+  # @param sut [Host]  One host to act upon
+  #
+  # @param [Path] File containing hiera data
+  def copy_hiera_data_to(sut, path)
+    copy_to(sut, path, hiera_datadir(sut))
   end
 
+  # A shim to stand in for the now deprecated hiera_datadir function
+  #
+  # Note: This may not work if you've shoved data somewhere that is not the
+  # default and/or are manipulating the default hiera.yaml.
+  #
+  # @param sut  [Host] One host to act upon
+  #
+  # @returns [String] Path to the Hieradata directory on the target system
+  def hiera_datadir(sut)
+    # This output lets us know where Hiera is configured to look on the system
+    puppet_lookup_info = on(sut, 'puppet lookup --explain test__simp__test').output.strip.lines
+
+    if sut.puppet['manifest'].nil? || sut.puppet['manifest'].empty?
+      fail("No output returned from `puppet config print manifest` on #{sut}")
+    end
+
+    puppet_env_path = File.dirname(sut.puppet['manifest'])
+
+    # We'll just take the first match since Hiera will find things there
+    puppet_lookup_info = puppet_lookup_info.grep(/Path "/).grep(Regexp.new(puppet_env_path))
+
+    # Grep always returns an Array
+    if puppet_lookup_info.empty?
+      fail("Could not determine hiera data directory under #{puppet_env_path} on #{sut}")
+    end
+
+    # Snag the actual path without the extra bits
+    puppet_lookup_info = puppet_lookup_info.first.strip.split('"').last
+
+    # Make the parent directories exist
+    sut.mkdir_p(File.dirname(puppet_lookup_info))
+
+    # We just want the data directory name
+    datadir_name = puppet_lookup_info.split(puppet_env_path).last
+
+    # Grab the file separator to add back later
+    file_sep = datadir_name[0]
+
+    # Snag the first entry (this is the data directory)
+    datadir_name = datadir_name.split(file_sep)[1]
+
+    # Constitute the full path to the data directory
+    datadir_path = puppet_env_path + file_sep + datadir_name
+
+    # Return the path to the data directory
+    return datadir_path
+  end
 
   # Write the provided data structure to Hiera's :datadir and configure Hiera to
   # use that data exclusively.
@@ -652,14 +705,14 @@ done
   # @param heradata [Hash, String] The full hiera data structure to write to
   #   the system.
   #
-  # @param terminus [String] The basename of the YAML file minus the extension
-  #   to write to the system.
+  # @param terminus [String] DEPRECATED - Will be removed in a future release.
+  #        All hieradata is written to the first discovered path via 'puppet
+  #        lookup'
   #
   # @return [Nil]
   #
-  def set_hieradata_on(sut, hieradata, terminus = 'default')
-    write_hieradata_to sut, hieradata, terminus
-    write_hiera_config_on sut, Array(terminus)
+  def set_hieradata_on(sut, hieradata, terminus = 'deprecated')
+    write_hieradata_to sut, hieradata
   end
 
 

data/lib/simp/beaker_helpers/inspec.rb

@@ -56,7 +56,7 @@ module Simp::BeakerHelpers
     def run
       sut_inspec_results = '/tmp/inspec_results.json'
 
-      inspec_cmd = "inspec exec --format json #{@test_dir} > #{sut_inspec_results}"
+      inspec_cmd = "inspec exec '#{@test_dir}' --reporter json > #{sut_inspec_results}"
       result = on(@sut, inspec_cmd, :accept_all_exit_codes => true)
 
       tmpdir = Dir.mktmpdir

data/lib/simp/beaker_helpers/ssg.rb

@@ -5,7 +5,7 @@ module Simp::BeakerHelpers
     if ENV['BEAKER_ssg_repo']
       GIT_REPO = ENV['BEAKER_ssg_repo']
     else
-      GIT_REPO = 'https://github.com/OpenSCAP/scap-security-guide.git'
+      GIT_REPO = 'https://github.com/ComplianceAsCode/content.git'
     end
 
     # If this is not set, the closest tag to the default branch will be used
@@ -143,15 +143,15 @@ module Simp::BeakerHelpers
       if ssg_release
         copy_to(@sut, ssg_release, @scap_working_dir)
 
-        on(@sut, %(mkdir -p scap-security-guide && tar -xj -C scap-security-guide --strip-components 1 -f #{ssg_release} && cp scap-security-guide/*ds.xml #{@scap_working_dir}))
+        on(@sut, %(mkdir -p scap-content && tar -xj -C scap-content --strip-components 1 -f #{ssg_release} && cp scap-content/*ds.xml #{@scap_working_dir}))
       else
-        on(@sut, %(git clone #{GIT_REPO}))
+        on(@sut, %(git clone #{GIT_REPO} scap-content))
         if GIT_BRANCH
-          on(@sut, %(cd scap-security-guide; git checkout #{GIT_BRANCH}))
+          on(@sut, %(cd scap-content; git checkout #{GIT_BRANCH}))
         else
-          on(@sut, %(cd scap-security-guide; git checkout $(git describe --abbrev=0 --tags)))
+          on(@sut, %(cd scap-content; git checkout $(git describe --abbrev=0 --tags)))
         end
-        on(@sut, %(cd scap-security-guide/build; cmake ../; make -j4 #{OS_INFO[@os][@os_rel]['ssg']['build_target']}-content && cp *ds.xml #{@scap_working_dir}))
+        on(@sut, %(cd scap-content/build; cmake ../; make -j4 #{OS_INFO[@os][@os_rel]['ssg']['build_target']}-content && cp *ds.xml #{@scap_working_dir}))
       end
     end
   end

data/lib/simp/beaker_helpers/version.rb

@@ -1,5 +1,5 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.11.0'
+  VERSION = '1.11.1'
 end

data/spec/acceptance/suites/default/set_hieradata_on_spec.rb

@@ -4,54 +4,30 @@ hosts.each do |host|
   describe '#set_hieradata_on' do
     context 'when passed a YAML string' do
       before(:all) { set_hieradata_on(host, "---\n") }
-      after(:all) { on(host, "rm -rf #{host.puppet['hiera_config']} #{hiera_datadir(host)}") }
+      after(:all) { on(host, "rm -rf #{hiera_datadir(host)}") }
 
       it 'creates the datadir' do
         on host, "test -d #{hiera_datadir(host)}"
       end
 
-      it 'writes to the configuration file' do
-        stdout = on(host, "cat #{host.puppet['hiera_config']}").stdout
-        expect(stdout).to match(":hierarchy:\n- default")
-      end
-
       it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/default.yaml").stdout
+        stdout = on(host, "cat #{hiera_datadir(host)}/common.yaml").stdout
         expect(stdout).to eq("---\n")
       end
     end
 
     context 'when passed a hash' do
       before(:all) { set_hieradata_on(host, { 'foo' => 'bar' }) }
-      after(:all) { on(host, "rm -rf #{host.puppet['hiera_config']} #{hiera_datadir(host)}") }
+      after(:all) { on(host, "rm -rf #{hiera_datadir(host)}") }
 
       it 'creates the datadir' do
         on host, "test -d #{hiera_datadir(host)}"
       end
 
       it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/default.yaml").stdout
+        stdout = on(host, "cat #{hiera_datadir(host)}/common.yaml").stdout
         expect(stdout).to eq("---\nfoo: bar\n")
       end
     end
-
-    context 'when the terminus is set' do
-      before(:all) { set_hieradata_on(host, "---\n", 'not-default') }
-      after(:all) { on(host, "rm -rf #{host.puppet['hiera_config']} #{hiera_datadir(host)}") }
-
-      it 'creates the datadir' do
-        on host, "test -d #{hiera_datadir(host)}"
-      end
-
-      it 'writes the correct hierarchy to the configuration file' do
-        stdout = on(host, "cat #{host.puppet['hiera_config']}").stdout
-        expect(stdout).to match(":hierarchy:\n- not-default")
-      end
-
-      it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/not-default.yaml").stdout
-        expect(stdout).to eq("---\n")
-      end
-    end
   end
 end

data/spec/acceptance/suites/default/write_hieradata_to_spec.rb

@@ -11,7 +11,7 @@ hosts.each do |host|
       end
 
       it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/default.yaml").stdout
+        stdout = on(host, "cat #{hiera_datadir(host)}/common.yaml").stdout
         expect(stdout).to eq("---\n")
       end
     end
@@ -25,23 +25,9 @@ hosts.each do |host|
       end
 
       it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/default.yaml").stdout
+        stdout = on(host, "cat #{hiera_datadir(host)}/common.yaml").stdout
         expect(stdout).to eq("---\nfoo: bar\n")
       end
     end
-
-    context 'when the terminus is set' do
-      before(:all) { set_hieradata_on(host, "---\n", 'not-default') }
-      after(:all) { on(host, "rm -rf #{hiera_datadir(host)}") }
-
-      it 'creates the datadir' do
-        on host, "test -d #{hiera_datadir(host)}"
-      end
-
-      it 'writes the correct contents to the correct file' do
-        stdout = on(host, "cat #{hiera_datadir(host)}/not-default.yaml").stdout
-        expect(stdout).to eq("---\n")
-      end
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker