simp-beaker-helpers 1.5.5 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ba9384c22def9cd5c3e88c7298533a61e9d8277
-  data.tar.gz: 4e7cba748d9a2cb2293c0eddc5cc021d636dcf7a
+  metadata.gz: 8f3ff792835639c1d173825e4d7ad5a29e0340a3
+  data.tar.gz: 88c6466aa066ec0cb670de639329dad0f72c5870
 SHA512:
-  metadata.gz: 9bdb0cb88a262d8e2cfc44ce412a7d1b4de292db036fc503a7e4776259aa49f15e892255857b9f7ab7bb3624ff238938fa32b9b58ed3678bb8d5b4893c97059b
-  data.tar.gz: f206d78e24d4f5a46dc13d4369c45c9fa2cff961da229c198d9e041776bdf2960369f780116831dff9ecf6e96229cf4613b4cedd30833459c019ed67d3d9ce0e
+  metadata.gz: 3d302c7b7af35a327f39e1b8dc8e6958fa73a7afb918a12f4d4078b9b12ae1251da15cf62a6592626ea385c31d741cda1ed935e00e77c7353e1726b699fe1439
+  data.tar.gz: d3999f5dc684959e1a188a21c93d30583dc7f5a097b132187c229d1720cf6eca74231a4d1e25b9cbb7d12e4c8d5d6599cafc82659e2f2a0778cf9b0df7003c35

data/Gemfile

@@ -17,6 +17,7 @@ group :system_tests do
   gem 'pry'
   gem 'beaker'
   gem 'beaker-rspec'
+  gem 'vagrant-wrapper'
   # NOTE: Workaround because net-ssh 2.10 is busting beaker
   # lib/ruby/1.9.1/socket.rb:251:in `tcp': wrong number of arguments (5 for 4) (ArgumentError)
   gem 'net-ssh', '~> 2.9.0'

data/README.md

@@ -21,6 +21,7 @@ Methods to assist beaker acceptance tests for SIMP.
       * [`pfact_on`](#pfact_on)
       * [`pluginsync_on`](#pluginsync_on)
     * Hiera
+      * [`write_hieradata_to`](#write_hieradata_to)
       * [`set_hieradata_on`](#set_hieradata_on)
       * [`clear_temp_hieradata`](#clear_temp_hieradata)
 6. [Environment variables](#environment-variables)
@@ -232,18 +233,30 @@ Simulates a `pluginsync` (useful for deploying custom facts) on given SUTs.
 
 `pluginsync_on( suts = hosts )`
 
+#### `write_hieradata_to`
+
+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.
+`Beaker::DSL::Helpers::Hiera#write_hiera_config_on` from [beaker-hiera](https://github.com/puppetlabs/beaker-hiera) may be used to configure Hiera.
+
+`write_hieradata_to(host, hieradata, terminus = 'default')`
+
+ - **`host`**      = _(Array,String,Symbol)_ One or more hosts to act upon
+ - **`hieradata`** = _(Hash)_ The full hiera data structure to write to the system
+ - **`terminus`**  = _(String)_ The file basename minus the file extension in which to write the Hiera data
 
 #### `set_hieradata_on`
 
-Set the hiera data file on the provided host to the passed data structure
+Writes a YAML file in the Hiera :datdir of a Beaker::Host, then configures the host to use that file exclusively.
 
-**NOTE**: This is authoritative; you cannot mix this with other hieradata copies
+**NOTE**: This is authoritative; you cannot mix this with other Hiera data sources.
 
-`set_hieradata_on(host, hieradata, data_file='default')`
+`set_hieradata_on(host, hieradata, terminus = 'default')`
 
  - **`host`**      = _(Array,String,Symbol)_ One or more hosts to act upon
  - **`hieradata`** = _(Hash)_ The full hiera data structure to write to the system
- - **`data_file`** = _(String)_ The filename (not path) of the hiera data
+ - **`terminus`**  = _(String)_ The file basename minus the file extension in which to write the Hiera data
 
 ####  `clear_temp_hieradata`
 

data/lib/simp/beaker_helpers.rb

@@ -1,7 +1,7 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.5.5'
+  VERSION = '1.5.6'
 
   # use the `puppet fact` face to look up facts on an SUT
   def pfact_on(sut, fact_name)
@@ -289,6 +289,10 @@ DEFAULT_KERNEL_TITLE=`/sbin/grubby --info=\\\${DEFAULT_KERNEL_INFO} | grep -m1 t
   def fix_errata_on( suts = hosts )
 
     suts.each do |sut|
+      # 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'
+
       # SIMP uses structured facts, therefore stringify_facts must be disabled
       unless ENV['BEAKER_stringify_facts'] == 'yes'
         on sut, 'puppet config set stringify_facts false'
@@ -440,51 +444,62 @@ done
   end
 
 
-  # Set the hiera data file on the provided host to the passed data structure
+  # Writes a YAML file in the Hiera :datadir of a Beaker::Host.
   #
-  # Note: This is authoritative, you cannot mix this with other hieradata copies
+  # @note This is useless unless Hiera is configured to use the data file.
+  #   @see `Beaker::DSL::Helpers::Hiera#write_hiera_config_on`
   #
-  # @param[sut, Array<Host>, String, Symbol] One or more hosts to act upon.
+  # @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 the system.
+  # @param heradata [Hash, String] The full hiera data structure to write to
+  #   the system.
   #
-  # @param[data_file, String] The filename (not path) of the hiera data
-  #                           YAML file to write to the system.
+  # @param terminus [String] The basename of the YAML file minus the extension
+  #   to write to the system.
   #
-  # @param[hiera_config, Array<String>] The hiera config array to write
-  #                                     to the system. Must contain the
-  #                                     Data_file name as one element.
-  def set_hieradata_on(sut, hieradata, data_file='default')
-    # Keep a record of all temporary directories that are created
-    #
-    # Should be cleaned by calling `clear_temp_hiera data` in after(:all)
-    #
-    # Omit this call to be able to delve into the hiera data that is
-    # being created
-    @temp_hieradata_dirs = @temp_hieradata_dirs || []
-
+  # @return [Nil]
+  #
+  # @note This creates a tempdir on the host machine which should be removed
+  #   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')
+    @temp_hieradata_dirs ||= []
     data_dir = Dir.mktmpdir('hieradata')
     @temp_hieradata_dirs << data_dir
 
-    fh = File.open(File.join(data_dir,"#{data_file}.yaml"),'w')
-    if hieradata.kind_of? String
+    fh = File.open(File.join(data_dir, "#{terminus}.yaml"), 'w')
+    if hieradata.is_a?(String)
       fh.puts(hieradata)
     else
       fh.puts(hieradata.to_yaml)
     end
-
     fh.close
 
-    # If there is already a directory on the system, the SCP below will
-    # add the local directory to the existing directory instead of
-    # replacing the contents.
-    apply_manifest_on(
-      sut,
-      "file { '#{hiera_datadir(sut)}': ensure => 'absent', force => true, recurse => true }"
-    )
+    apply_manifest_on sut, "file { '#{hiera_datadir(sut)}': ensure => 'directory', force => true }"
+    copy_hiera_data_to sut, File.join(data_dir, "#{terminus}.yaml")
+  end
+
 
-    copy_hiera_data_to(sut, data_dir)
-    write_hiera_config_on(sut, Array(data_file))
+  # Write the provided data structure to Hiera's :datadir and configure Hiera to
+  # use that data exclusively.
+  #
+  # @note This is authoritative.  It manages both Hiera data and configuration,
+  #   so it may not be used with other Hiera data sources.
+  #
+  # @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
+  #   the system.
+  #
+  # @param terminus [String] The basename of the YAML file minus the extension
+  #   to write to the system.
+  #
+  # @return [Nil]
+  #
+  def set_hieradata_on(sut, hieradata, terminus = 'default')
+    write_hieradata_to sut, hieradata, terminus
+    write_hiera_config_on sut, Array(terminus)
   end
 
 

data/spec/acceptance/set_hieradata_on_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper_acceptance'
+
+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)}") }
+
+      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
+        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)}") }
+
+      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
+        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/write_hieradata_to_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper_acceptance'
+
+hosts.each do |host|
+  describe '#write_hieradata_to' do
+    context 'when passed a YAML string' do
+      before(:all) { set_hieradata_on(host, "---\n") }
+      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
+        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 #{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
+        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.5.5
+  version: 1.5.6
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 description: |2
@@ -32,10 +32,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".fixtures.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .fixtures.yml
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -53,6 +53,8 @@ files:
 - spec/acceptance/nodesets/centos-combined-x64.yaml
 - spec/acceptance/nodesets/default.yml
 - spec/acceptance/pki_tests_spec.rb
+- spec/acceptance/set_hieradata_on_spec.rb
+- spec/acceptance/write_hieradata_to_spec.rb
 - spec/spec_helper_acceptance.rb
 homepage: https://github.com/simp/rubygem-simp-beaker-helpers
 licenses:
@@ -65,12 +67,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -86,4 +88,6 @@ test_files:
 - spec/acceptance/nodesets/centos-combined-x64.yaml
 - spec/acceptance/nodesets/default.yml
 - spec/acceptance/pki_tests_spec.rb
+- spec/acceptance/set_hieradata_on_spec.rb
+- spec/acceptance/write_hieradata_to_spec.rb
 - spec/spec_helper_acceptance.rb