kitchen-puppet 1.0.33 → 1.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35ff34e5f2d431f879e03f1ef78f663b5cb2035
-  data.tar.gz: 8ec9e89202b63c503cffe34ccc2b9a9f34a0490a
+  metadata.gz: 4ff25034f7a7dfe7a6f9af8c8d5d91d33f9cc6b1
+  data.tar.gz: 676912db95788783bf3bfb4ac22eae57baa4a72c
 SHA512:
-  metadata.gz: f19631f93680c0152e4f0a570478eaa63cc49fd450e82e5dfb93673e3351bd05a5f1e73982ef13b2db54848c0b78cf104b5a1a36df0bc40751dc4668f8b78281
-  data.tar.gz: f69ba6210b184cfe83e9d63173e706ee475ec434dabe9509552ce20cc55af86073a9f8f66e3f9356faf90eddd5544600f0bd242a7cf463755d07b0a6470b9a0c
+  metadata.gz: 52630ad4ceb29ffae31ce66be9bd2140be2de49d2b10f1b384e72bde9233c998d01d7b59c6a21c6de5ae84efccd7b39d78409f08e6b890d6d4ba25f85f32a2e3
+  data.tar.gz: 0a7e9b3ed085fa7048eb35e231629188c5bbf97ef01736dcaf7862ed6fee219c56bd85d4ae2a0daef4e6568edfc8f3e573a83968924e4f50a9fb8b68fba9adcd

data/README.md

@@ -17,7 +17,7 @@ The PuppetAgent provider works by passing the puppetmaster and other attributes
 This provider has been tested against the Ubuntu 1204 and Centos 6.5 boxes running in vagrant/virtualbox as well as various docker .
 
 ## Windows Workstation Install
-You need to download the puppet msi and install it and run everything inside the puppet window. 
+You need to download the puppet msi and install it and run everything inside the puppet window.
 
 1. Download and install puppet from the windows msi file from https://downloads.puppetlabs.com/windows
   * I recommend the using the 32 bit version as not all ruby gems works with the 64 bit version.
@@ -37,7 +37,7 @@ You need to download the puppet msi and install it and run everything inside the
   * gem install librarian-puppet
   * gem install test-kitchen
   * gem install kitchen-puppet
-  
+
 ## Mac-OSX Workstation Install
 
 1. Download and install the mac packages from https://downloads.puppetlabs.com/mac/
@@ -52,21 +52,129 @@ You need to download the puppet msi and install it and run everything inside the
   * gem install kitchen-puppet
 
 ## Requirements
+It is recommended to have a metadata.json file of your puppet module. It is used by kitchen-puppet to configure the module path.
+The puppet docs describe (https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file) how to create one.
+
 You'll need a driver box without a chef installation so puppet can be installed. Puppet have one at http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box or http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box.
 
 For PuppetAgent a server with a puppet master is required that can resolve the hostname ip address of the server. The server must also be able to resolve the hostname ip address of the puppet master.
 
 You can also use the PuppetApply driver with a docker container, provided the necessary box requirements to install puppet are included inside the container. The easiest way to do this is to supply Kitchen-Docker with a custom dockerfile to install the needed dependencies for puppet installation.
 
+## Test-Kitchen Serverspec
+
+To run the verify step with the test-kitchen serverspec setup your puppet repository as follows:
+
+In the root directory for your puppet repository:
+
+Create a `.kitchen.yml`, much like one the described above:
+
+```yaml
+    ---
+    driver:
+      name: vagrant
+
+    provisioner:
+      name: puppet_apply
+      manifests_path: /repository/puppet_repo/manifests
+      modules_path: /repository/puppet_repo/modules-mycompany
+      hiera_data_path: /repository/puppet_repo/hieradata
+
+    platforms:
+    - name: nocm_ubuntu-12.04
+      driver_plugin: vagrant
+      driver_config:
+        box: nocm_ubuntu-12.04
+        box_url: http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box
+
+    suites:
+     - name: default
+```
+
+Then for serverspec:
+
+```bash
+  mkdir -p test/integration/default/serverspec/localhost
+  echo "require 'serverspec'" >> test/integration/default/serverspec/spec_helper.rb
+  echo "set :backend, :exec" >> test/integration/default/serverspec/spec_helper.rb
+```
+
+Create your serverspec tests in `test/integration/default/serverspec/localhost/xxxxxx_spec.rb`:
+
+```ruby
+  require 'spec_helper'
+
+  if os[:family] == 'ubuntu'
+        describe '/etc/lsb-release' do
+          it "exists" do
+              expect(file('/etc/lsb-release')).to be_file
+          end
+        end
+  end
+
+  if os[:family] == 'redhat'
+    describe '/etc/redhat-release' do
+      it "exists" do
+          expect(file('/etc/redhat-release')).to be_file
+      end
+    end
+  end
+```
+
+## Test-Kitchen Beaker
+
+test-kitchen normally uses tests setup in `test/integration/....` directory. Beaker format puts the tests with the
+`spec/acceptance` directory in the puppet repository and the `spec_helper_acceptance.rb` under the `spec` directory.
+
+For examples see:
+* https://gitlab.com/joshbeard/puppet-module-test
+* https://github.com/puppetlabs/puppetlabs-mysql/tree/master/spec
+
+To implement this with test-kitchen setup the puppet repository with:
+
+* the spec files with the spec/acceptance directory.
+
+* the spec_helper_acceptance in the spec folder.
+
+* a dummy `test/integration/<suite>/beaker/localhost/<suite>_spec.rb` containing just a dummy comment.
+
+See example [https://github.com/neillturner/puppet_repo](https://github.com/neillturner/puppet_repo)
+
+```
+.
++-- spec
+¦   +-- acceptance
+¦   ¦   +-- mariadb_spec.rb
+¦   ¦   +-- nginx_spec.rb
+¦   ¦
+¦   +-- spec_helper_acceptance.rb
++-- test
+    +-- integration
+        +-- default      # name of test-kitchen suite
+            +-- beaker
+                +-- localhost
+                    +-- default_spec.rb   # <suite>_spec.rb
+```
+
+In the root directory for your puppet repository create a `.kitchen.yml`, the same as for test-kitchen serverspec above.
+
+When test-kitchen runs the verify step will
+* detect the dummy `/test/integration/<suite>/beaker` directory
+* install the busser-beaker plugin instead of the normal busser-serverspec plugin
+* serverspec will be called using the beaker conventions.
+
+See [busser-beaker](https://github.com/neillturner/busser-beaker)
+
+
 ## Provisioner Options
 Please see the Provisioner Options (https://github.com/neillturner/kitchen-puppet/blob/master/provisioner_options.md).
 
 ## Contributing
-To contriubute to the repository, please follow the Fork / PR model:
+To contribute to the repository, please follow the Fork / PR model:
 
 1. Fork The Repository
 2. Work on epic changes
-3. Write tests for your changes
+3. Write tests for your changes, see [TESTING](TESTING.md)
 4. Update Documentation
 5. Commit
 6. Push

data/lib/kitchen-puppet/version.rb

@@ -2,6 +2,6 @@
 
 module Kitchen
   module Puppet
-    VERSION = '1.0.33'
+    VERSION = '1.0.34'
   end
 end

data/lib/kitchen/provisioner/puppet_apply.rb

@@ -58,7 +58,6 @@ module Kitchen
       default_config :require_chef_for_busser, true
       default_config :resolve_with_librarian_puppet, true
       default_config :puppet_environment, nil
-      default_config :install_custom_facts, false
       default_config :puppet_apt_repo, 'http://apt.puppetlabs.com/puppetlabs-release-precise.deb'
       default_config :puppet_yum_repo, 'https://yum.puppetlabs.com/puppetlabs-release-el-6.noarch.rpm'
       default_config :chef_bootstrap_url, 'https://www.getchef.com/chef/install.sh'
@@ -136,6 +135,7 @@ module Kitchen
       default_config :platform, &:platform_name
       default_config :update_package_repos, true
       default_config :remove_puppet_repo, false
+      default_config :install_custom_facts, false
       default_config :custom_facts, {}
       default_config :facterlib, nil
       default_config :puppet_detailed_exitcodes, nil
@@ -382,7 +382,7 @@ module Kitchen
       end
 
       def init_command
-        dirs = %w(modules manifests files hiera hiera.yaml spec)
+        dirs = %w(modules manifests files hiera hiera.yaml facter spec)
         .map { |dir| File.join(config[:root_path], dir) }.join(' ')
         cmd = "#{sudo('rm')} -rf #{dirs} #{hiera_data_remote_path} \
               /etc/hiera.yaml #{puppet_dir}/hiera.yaml \
@@ -401,6 +401,7 @@ module Kitchen
         prepare_modules
         prepare_manifests
         prepare_files
+        prepare_facter_file
         prepare_facts
         prepare_puppet_config
         prepare_hiera_config
@@ -519,16 +520,16 @@ module Kitchen
         if !config[:puppet_apply_command].nil?
           return config[:puppet_apply_command]
         else
-          [
+          result = [
             facterlib,
             custom_facts,
-            facter_facts,
+            puppet_manifestdir,
             puppet_cmd,
             'apply',
             File.join(config[:root_path], 'manifests', manifest),
             "--modulepath=#{File.join(config[:root_path], 'modules')}",
-            puppet_manifestdir,
             "--fileserverconfig=#{File.join(config[:root_path], 'fileserver.conf')}",
+            custom_options,
             puppet_environment_flag,
             puppet_noop_flag,
             puppet_detailed_exitcodes_flag,
@@ -537,6 +538,8 @@ module Kitchen
             puppet_logdest_flag,
             remove_repo
           ].join(' ')
+          info("Going to invoke puppet apply with: #{result}")
+          result
         end
       end
 
@@ -674,7 +677,15 @@ module Kitchen
       end
 
       def puppet_manifestdir
-        config[:puppet_environment] ? nil : "--manifestdir=#{File.join(config[:root_path], 'manifests')}"
+        return nil if config[:require_puppet_collections]
+        return nil if config[:puppet_environment]
+        bash_vars = "export MANIFESTDIR='#{File.join(config[:root_path], 'manifests')}';"
+        debug(bash_vars)
+        bash_vars
+      end
+
+      def custom_options
+        config[:custom_options] || ''
       end
 
       def puppet_noop_flag
@@ -702,17 +713,6 @@ module Kitchen
         config[:platform].gsub(/-.*/, '')
       end
 
-      def facter_facts
-        return nil unless config[:facter_file]
-        fact_vars = 'export '
-        fact_hash = YAML.load_file(config[:facter_file])
-        fact_hash.each do |key, value|
-          fact_vars << "FACTER_#{key}=#{value} "
-        end
-        fact_vars << ';'
-        fact_vars
-      end
-
       def update_packages_debian_cmd
         config[:update_package_repos] ? "#{sudo_env('apt-get')} update" : nil
       end
@@ -740,15 +740,22 @@ module Kitchen
         config[:spec_files_remote_path]
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def facterlib
-        return nil if config[:facterlib].nil?
-        bash_vars = "export FACTERLIB='#{config[:facterlib]}';"
+        factpath = nil
+        factpath = "#{File.join(config[:root_path], 'facter')}" if config[:install_custom_facts] && !config[:custom_facts].none?
+        factpath = "#{File.join(config[:root_path], 'facter')}" if config[:facter_file]
+        factpath = "#{factpath}:" if config[:facterlib] && !factpath.nil?
+        factpath = "#{factpath}#{config[:facterlib]}" if config[:facterlib]
+        return nil if factpath.nil?
+        bash_vars = "export FACTERLIB='#{factpath}';"
         debug(bash_vars)
         bash_vars
       end
 
       def custom_facts
         return nil if config[:custom_facts].none?
+        return nil if config[:install_custom_facts]
         bash_vars = config[:custom_facts].map { |k, v| "FACTER_#{k}=#{v}" }.join(' ')
         bash_vars = "export #{bash_vars};"
         debug(bash_vars)
@@ -763,7 +770,6 @@ module Kitchen
         remove_puppet_repo ? "; #{sudo('rm')} -rf /tmp/kitchen #{hiera_data_remote_path} #{hiera_eyaml_key_remote_path} #{puppet_dir}/* " : nil
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       def puppet_apt_repo
         platform_version = config[:platform].partition('-')[2]
         case puppet_platform
@@ -863,16 +869,30 @@ module Kitchen
         FileUtils.cp_r(Dir.glob("#{files}/*"), tmp_files_dir)
       end
 
+      def prepare_facter_file
+        return unless config[:facter_file]
+        info 'Copying facter file'
+        facter_dir = File.join(sandbox_path, 'facter')
+        FileUtils.mkdir_p(facter_dir)
+        FileUtils.cp_r(config[:facter_file], facter_dir)
+      end
+
       def prepare_facts
         return unless config[:install_custom_facts]
         return unless config[:custom_facts]
         info 'Installing custom facts'
         facter_dir = File.join(sandbox_path, 'facter')
         FileUtils.mkdir_p(facter_dir)
-        tmp_facter_file = File.join(facter_dir, 'kitchen.yaml')
+        tmp_facter_file = File.join(facter_dir, 'kitchen.rb')
         facter_facts = Hash[config[:custom_facts].map { |k, v| [k.to_s, v.to_s] }]
-        File.open(tmp_facter_file, 'w') do |out|
-          YAML.dump(facter_facts, out)
+        File.open(tmp_facter_file, 'a') do |out|
+          facter_facts.each do |k, v|
+            out.write "\nFacter.add(:#{k}) do\n"
+            out.write "  setcode do\n"
+            out.write "    \"#{v}\"\n"
+            out.write "  end\n"
+            out.write "end\n"
+          end
         end
       end
 

data/provisioner_options.md

@@ -11,14 +11,14 @@ install_hiera | false | Installs `hiera-puppet` package. Not needed for puppet >
 hiera_package | 'hiera-puppet' | Only used if `install_hiera` is set
 require_puppet_repo | true | Set if using a puppet install from yum or apt repo
 puppet_apt_repo | "http://apt.puppetlabs.com/puppetlabs-release-precise.deb"| apt repo Ubuntu12
-_for Ubuntu15 change to_ | "http://apt.puppetlabs.com/puppetlabs-release-jessie.deb" | 
+_for Ubuntu15 change to_ | "http://apt.puppetlabs.com/puppetlabs-release-jessie.deb" |
 puppet_yum_repo | "https://yum.puppetlabs.com/puppetlabs-release-el-6.noarch.rpm"| yum repo RH/Centos6
-_for RH/Centos7 change to_ | "https://yum.puppetlabs.com/puppetlabs-release-el-7.noarch.rpm" | 
+_for RH/Centos7 change to_ | "https://yum.puppetlabs.com/puppetlabs-release-el-7.noarch.rpm" |
 require_puppet_collections | false | Set if using puppet collections install (Puppet v4)
 puppet_yum_collections_repo | "http://yum.puppetlabs.com/puppetlabs-release-pc1-el-6.noarch.rpm" | yum collections repo RH/Centos6
-_for RH/Centos7 change to_ | "https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm" | 
+_for RH/Centos7 change to_ | "https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm" |
 puppet_apt_collections_repo | "http://apt.puppetlabs.com/puppetlabs-release-pc1-wheezy.deb" | apt collections repo
-_for Ubuntu15 change to_ | "http://apt.puppetlabs.com/puppetlabs-release-pc1-jessie.deb" | 
+_for Ubuntu15 change to_ | "http://apt.puppetlabs.com/puppetlabs-release-pc1-jessie.deb" |
 puppet_coll_remote_path | "/opt/puppetlabs" | Server Installation location of a puppet collections install.
 puppet_detailed_exitcodes | nil | Provide transaction information via exit codes.
 manifests_path | | puppet repo manifests directory
@@ -36,7 +36,8 @@ puppet_git_init | nil | initialize puppet from GIT repository, e.g. "git@github.
 puppet_git_pr | nil | checkout specific Pull Request from repository specified in puppet_git_init, e.g. "324"
 update_package_repos| true| update OS repository metadata
 custom_facts| Hash.new | Hash to set the puppet facts before running puppet apply
-install_custom_facts| false | Install custom facts to yaml file at "/tmp/kitchen/facter/kitchen.yaml"
+install_custom_facts| false | Install custom facts to yaml file at "/tmp/kitchen/facter/kitchen.rb"
+facter_file | nil | yaml file of custom facter_files to be provided to the puppet-apply command
 chef_bootstrap_url |"https://www.getchef.com/chef/install.sh"| the chef (needed for busser to run tests) NOTE: kitchen 1.4 only requires ruby to run busser so this is not required.
 puppetfile_path | | Path to Puppetfile
 puppet_apply_command | nil | Overwrite the puppet apply command. Needs "sudo -E puppet apply" as a prefix.
@@ -50,10 +51,10 @@ hiera_eyaml | false | use hiera-eyaml to encrypt hiera data
 hiera_eyaml_key_remote_path | "/etc/puppet/secure/keys" | directory of hiera-eyaml keys on server
 hiera_eyaml_key_path  | "hiera_keys" | directory of hiera-eyaml keys on workstation
 hiera_deep_merge | false | install the deep_merge gem to support hiera deep merge mode
-facter_file | nil | yaml file of custom facter_files to be provided to the puppet-apply command
 http_proxy | nil | use http proxy when installing puppet, packages and running puppet
 https_proxy | nil | use https proxy when installing puppet, packages and running puppet
 puppet_logdest | nil | _Array_ of log destinations. Include 'console' if wanted
+custom_options | | custom options to add to puppet apply command.
 custom_install_command | nil | Custom shell command to be used at install stage. Can be multiline. See examples below.
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-puppet
 version: !ruby/object:Gem::Version
-  version: 1.0.33
+  version: 1.0.34
 platform: ruby
 authors:
 - Neill Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen