kitchen-puppet 3.2.1 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '042347429c02f1702cd07b8d5f0e7b8b615a3e7e'
-  data.tar.gz: 91d9a4094ad08cd687390ea65caabd8be65af9e1
+  metadata.gz: 5fd3f0255598eccfa42487ea777dcc84ea1b1115
+  data.tar.gz: a880703ff969cafa64c25a1e8d60f7b61b3fd5d5
 SHA512:
-  metadata.gz: 140cd72e439d2bcf86d4ba93afe607b400464b1fb492245037af98b284bff39b26a5cf2b790a424b857c18adf809310e8857c841ce96839483ba72d5a4021787
-  data.tar.gz: 789d4e8e0b610fd903882287ff7b658a326af371945e3d47b450616c71da60688483746b7449a869f394b25f42363e5dd0126e948144c4beb8429358404d9395
+  metadata.gz: a7d4e20212b16e6dc6491eabddc791d1c56a13448f8d767d94e912d1deb3533d9c454c41e616c17aeed1004e98e80b23038530465abe3264cbfd7fb6181ccc85
+  data.tar.gz: 9ed8a833172fea17feb6f210fa9eedf4e2b7e539363b361801f5aaff110c8bf06ff601a7186a041287d25cc36c28d4499b33fb2834396cd6745632b1f80f6fb3

data/README.md

@@ -7,14 +7,17 @@
 # kitchen-puppet
 A Test Kitchen Provisioner for Puppet
 
-The providers supports both puppet apply and puppet agent clients
+The providers supports both puppet apply and puppet agent clients and puppet bolt.
 
 The PuppetApply provider works by passing the puppet repository based on attributes in .kitchen.yml & calling puppet apply.
 
 The PuppetAgent provider works by passing the puppetmaster and other attributes in .kitchen.yml & calling puppet agent.
 
+The PuppetBolt provider works by passing the puppet bolt commands based on attributes in .kitchen.yml & calling puppet bolt.
 
-This provider has been tested against the Ubuntu 1204 and Centos 6.5 boxes running in vagrant/virtualbox as well as various docker.
+
+
+This provider has been tested against the Ubuntu 1604 and Centos 7 boxes running in docker and vagrant/virtualbox.
 
 ## Resources
 * http://ehaselwanter.com/en/blog/2014/05/08/using-test-kitchen-with-puppet
@@ -90,8 +93,10 @@ Create a `.kitchen.yml`, much like one the described above:
 ```
 
 Sample Puppet Repositories
+  * A sample hello world example puppet repository with docker : https://github.com/neillturner/puppet_docker_repo
   * A sample hello world example puppet repository without environents : https://github.com/neillturner/puppet_vagrant_repo
   * A sample hello world example puppet repository with environents : https://github.com/neillturner/puppet_vagrant_environment_repo
+  * A sample puppet bolt example puppet repository with docker : https://github.com/neillturner/bolt_docker_repo
 
 ## Test-Kitchen Serverspec
 

data/kitchen-puppet.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   == FEATURES:
 
-  Supports puppet apply, puppet agent, hiera, hiera-eyaml, hiera-eyaml-gpg, custom facts, librarian-puppet, puppet collections (v4)
+  Supports puppet apply, puppet agent, puppet bolt, hiera, hiera-eyaml, hiera-eyaml-gpg, custom facts, librarian-puppet, puppet collections
 
 TEXT
 end

data/lib/kitchen-puppet/version.rb

@@ -2,6 +2,6 @@
 
 module Kitchen
   module Puppet
-    VERSION = '3.2.1'.freeze
+    VERSION = '3.3.1'.freeze
   end
 end

data/lib/kitchen/provisioner/puppet_apply.rb

@@ -76,6 +76,7 @@ module Kitchen
       default_config :custom_install_command, nil
       default_config :custom_pre_install_command, nil
       default_config :custom_pre_apply_command, nil
+      default_config :custom_post_apply_command, nil
       default_config :puppet_whitelist_exit_code, nil
       default_config :require_puppet_omnibus, false
       default_config :puppet_omnibus_url, 'https://raw.githubusercontent.com/petems/puppet-install-shell/master/install_puppet_5_agent.sh'

data/lib/kitchen/provisioner/puppet_bolt.rb

@@ -0,0 +1,304 @@
+# -*- encoding: utf-8 -*-
+
+#
+# Author:: Neill Turner (<neillwturner@gmail.com>
+#
+# Copyright (C) 2017 Neill Turner
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+
+require 'uri'
+require 'json'
+require 'kitchen'
+
+module Kitchen
+  module Configurable
+    def platform_name
+      instance.platform.name
+    end
+  end
+
+  module Provisioner
+    #
+    # Puppet Bolt provisioner.
+    #
+    class PuppetBolt < Base
+      attr_accessor :tmp_dir
+
+      default_config :bolt_version, nil
+      default_config :require_bolt_repo, true
+      default_config :remove_bolt_repo, false
+      default_config :custom_install_command, nil
+      default_config :custom_pre_install_command, nil
+      default_config :custom_pre_bolt_command, nil
+      default_config :custom_post_bolt_command, nil
+      default_config :require_bolt_omnibus, false
+      default_config :bolt_commands, []
+      default_config :platform, &:platform_name
+      default_config :http_proxy, nil
+      default_config :https_proxy, nil
+      default_config :no_proxy, nil
+      # for future use
+      default_config :bolt_cmd, nil        # bolt command run <COMMAND>, bolt script run, bolt task run, bolt plan run, bolt file upload
+      default_config :bolt_nodes, nil      # REQUIRED
+      default_config :bolt_user, nil       # BOLT_USER env variable
+      default_config :bolt_password, nil
+      default_config :bolt_modulepath, [] # Required for tasks and plans. The path to the module containing the task. Separate multiple paths with a semicolon (;) on Windows or a colon (:) on all other platforms.
+      default_config :bolt_params, nil
+      default_config :bolt_tty, false
+      default_config :bolt_insecure, true
+      default_config :bolt_transport, nil
+
+      # Install the dependencies for your platform.
+      # On CentOS 7 or Red Hat Enterprise Linux 7, run yum install -y make gcc ruby-devel
+      # On Fedora 25, run dnf install -y make gcc redhat-rpm-config ruby-devel rubygem-rdoc
+      # On Debian 9 or Ubuntu 16.04, run apt-get install -y make gcc ruby-dev
+      # On Mac OS X, run xcode-select --install
+      # Install Bolt as a gem by running gem install bolt
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def install_command
+        return unless config[:require_bolt_repo] || config[:require_bolt_omnibus]
+        if config[:require_bolt_omnibus]
+          install_omnibus_command
+        else
+          case bolt_platform
+          when 'debian', 'ubuntu'
+            info("Installing puppet on #{config[:platform]}")
+            # need to add a CR to avoid trouble with proxy settings concatenation
+            <<-INSTALL
+
+              #{custom_pre_install_command}
+              if [ ! $(which bolt) ]; then
+                #{sudo('apt-get')} install -y make gcc ruby-dev
+                #{install_bolt}
+              fi
+              #{custom_install_command}
+            INSTALL
+          when 'redhat', 'centos', 'oracle', 'amazon'
+            info("Installing puppet from yum on #{bolt_platform}")
+            # need to add a CR to avoid trouble with proxy settings concatenation
+            <<-INSTALL
+
+              #{custom_pre_install_command}
+              if [ ! $(which bolt) ]; then
+                #{sudo('yum')} install -y make gcc ruby-devel
+                #{install_bolt}
+              fi
+              #{custom_install_command}
+            INSTALL
+          when 'fedora'
+            info("Installing bolt from dnf on #{bolt_platform}")
+            # need to add a CR to avoid trouble with proxy settings concatenation
+            <<-INSTALL
+
+              #{custom_pre_install_command}
+              if [ ! $(which bolt) ]; then
+                #{sudo('dnf')} install -y make gcc redhat-rpm-config ruby-devel rubygem-rdoc
+                #{install_bolt}
+              fi
+              #{custom_install_command}
+            INSTALL
+          when /^windows.*/
+            info("Installing puppet on #{bolt_platform}")
+            info('Powershell is not recognised by core test-kitchen assuming it is present') unless powershell_shell?
+            <<-INSTALL
+              if(Get-Command bolt -ErrorAction 0) { return; }
+              Write-Host "Disabling UAC..."
+              New-ItemProperty -Path HKLM:Software\\Microsoft\Windows\\CurrentVersion\\Policies\\System -Name EnableLUA -PropertyType DWord -Value 0 -Force
+              New-ItemProperty -Path HKLM:Software\\Microsoft\\Windows\\CurrentVersion\\Policies\System -Name ConsentPromptBehaviorAdmin -PropertyType DWord -Value 0 -Force
+              Write-Host "Install Chocolatey...."
+              iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1'))
+              Write-Host "Install Ruby...."
+              choco install ruby
+              refreshenv
+              Write-Host "Install Bolt...."
+              gem install bolt
+            INSTALL
+          else
+            info('Installing bolt, will try to determine platform os')
+            # need to add a CR to avoid trouble with proxy settings concatenation
+            <<-INSTALL
+
+              #{custom_pre_install_command}
+              if [ ! $(which bolt) ]; then
+                if [ -f  /etc/fedora-release ]; then
+                    #{sudo('dnf')} install -y make gcc redhat-rpm-config ruby-devel rubygem-rdoc
+                else
+                  if [ -f /etc/centos-release ] || [ -f /etc/redhat-release ] || [ -f /etc/oracle-release ]; then
+                      #{sudo('yum')} install -y make gcc ruby-devel
+                  else
+                    if [ -f /etc/system-release ] || [ grep -q 'Amazon Linux' /etc/system-release ]; then
+                       #{sudo('yum')} install -y make gcc ruby-devel
+                    else
+                      #{sudo('apt-get')} install -y make gcc ruby-dev
+                    fi
+                  fi
+                fi
+                #{install_bolt}
+              fi
+              #{custom_install_command}
+            INSTALL
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def install_omnibus_command
+        error('Installing bolt using an omnibus install script not currently supported')
+      end
+
+      def custom_pre_install_command
+        <<-INSTALL
+          #{config[:custom_pre_install_command]}
+        INSTALL
+      end
+
+      def custom_install_command
+        <<-INSTALL
+          #{config[:custom_install_command]}
+        INSTALL
+      end
+
+      def install_bolt
+        if config[:bolt_version]
+          <<-INSTALL
+            #{sudo('gem')} install --no-rdoc --no-ri bolt -v #{config[:bolt_version]}
+          INSTALL
+        else
+          <<-INSTALL
+            #{sudo('gem')} install --no-rdoc --no-ri bolt
+          INSTALL
+        end
+      end
+
+      def init_command
+        debug('Init Command')
+      end
+
+      def create_sandbox
+        super
+        debug("Creating local sandbox in #{sandbox_path}")
+      end
+
+      def cleanup_sandbox
+        return if sandbox_path.nil?
+        debug("Cleaning up local sandbox in #{sandbox_path}")
+        FileUtils.rmtree(sandbox_path)
+        return if remove_repo.nil?
+        debug("Cleaning up remote sandbox: #{remove_repo}")
+        instance.remote_exec remove_repo
+      end
+
+      def run_command
+        if config[:custom_post_bolt_command]
+          custom_post_bolt_trap = <<-TRAP
+            function custom_post_bolt_command {
+              #{config[:custom_post_bolt_command]}
+            }
+            trap custom_post_bolt_command EXIT
+          TRAP
+        end
+        result = <<-RUN
+          #{config[:custom_pre_bolt_command]}
+          #{custom_post_bolt_trap}
+        RUN
+        bolt_commands_to_run.each do |a|
+          result = <<-RUN
+          #{result}
+          #{a}
+          RUN
+        end
+        info("Going to invoke bolt with: #{result}")
+        result
+      end
+
+      protected
+
+      def bolt_commands_to_run
+        if config[:bolt_commands]
+          config[:bolt_commands].is_a?(Array) ? config[:bolt_commands] : [config[:bolt_commands]]
+        else
+          []
+        end
+      end
+
+      def bolt_platform
+        config[:platform].gsub(/-.*/, '')
+      end
+
+      def remove_repo
+        config[:remove_bolt_repo] ? "#{sudo('rm')} -rf /tmp/kitchen " : nil
+      end
+
+      def sudo_env(pm)
+        s = https_proxy ? "https_proxy=#{https_proxy}" : nil
+        p = http_proxy ? "http_proxy=#{http_proxy}" : nil
+        n = no_proxy ? "no_proxy=#{no_proxy}" : nil
+        p || s ? "#{sudo('env')} #{p} #{s} #{n} #{pm}" : sudo(pm).to_s
+      end
+
+      def proxy_parm
+        http_proxy ? "--httpproxy #{URI.parse(http_proxy).host.downcase} --httpport #{URI.parse(http_proxy).port} " : nil
+      end
+
+      def gem_proxy_parm
+        p = http_proxy ? "--http-proxy #{http_proxy}" : nil
+        n = no_proxy ? "--no-http-proxy #{no_proxy}" : nil
+        p || n ? "#{p} #{n}" : nil
+      end
+
+      def wget_proxy_parm
+        p = http_proxy ? "-e http_proxy=#{http_proxy}" : nil
+        s = https_proxy ? "-e https_proxy=#{https_proxy}" : nil
+        n = no_proxy ? "-e no_proxy=#{no_proxy}" : nil
+        p || s ? "-e use_proxy=yes #{p} #{s} #{n}" : nil
+      end
+
+      def posh_proxy_parm
+        http_proxy ? "-Proxy #{http_proxy}" : nil
+      end
+
+      def powershell?
+        return true if powershell_shell?
+        return true if bolt_platform =~ /^windows.*/
+        false
+      end
+
+      def export_http_proxy_parm
+        http_proxy ? "export http_proxy=#{http_proxy}" : nil
+      end
+
+      def export_https_proxy_parm
+        https_proxy ? "export https_proxy=#{https_proxy}" : nil
+      end
+
+      def export_no_proxy_parm
+        no_proxy ? "export no_proxy=#{no_proxy}" : nil
+      end
+
+      def http_proxy
+        config[:http_proxy]
+      end
+
+      def https_proxy
+        config[:https_proxy]
+      end
+
+      def no_proxy
+        config[:no_proxy]
+      end
+    end
+  end
+end

data/provisioner_options.md

@@ -346,3 +346,63 @@ provisioner:
     - 0
     - 2
 ```
+
+# Puppet Bolt Provisioner Options
+
+key | default value | Notes
+----|---------------|--------
+bolt_commands | nil | array of bolt commands to run.
+bolt_version | | desired puppet bolt version, defaults to latest.
+custom_pre_install_command | nil | Custom shell command to be used at beginning of install stage. Can be multiline.
+custom_install_command | nil | Custom shell command to be used at end of install stage. Can be multiline. See examples below.
+custom_pre_bolt_command | nil | Custom shell command to be used before the puppet bolt stage. Can be multiline.
+custom_post_bolt_command | nil | Custom shell command to be used after the puppet bolt stage. Can be multiline.
+http_proxy | nil | use http proxy when installing bolt, packages and running bolt
+https_proxy | nil | use https proxy when installing bolt, packages and running bolt
+no_proxy | nil | list of URLs or IPs that should be excluded from proxying
+platform | platform_name kitchen.yml parameter | OS platform of server
+require_bolt_omnibus | false | Set if using omnibus bolt install. (for future use)
+require_bolt_repo | true | Set if using a puppet bolt from yum or apt repo
+remove_bolt_repo | false | remove copy of bolt configuration on server after running bolt
+
+## Puppet Bolt Configuring Provisioner Options
+
+The Bolt provisioner can be configured globally or per suite, global settings act as defaults for all suites, you can then customise per suite, for example:
+
+```yaml
+---
+driver:
+  name: docker
+  use_sudo: false
+  privileged: true
+
+provisioner:
+  name: puppet_bolt
+  bolt_commands:
+    - bolt --help
+    - bolt --version
+
+platforms:
+- name: ubuntu-16.04
+  driver_config:
+    image: ubuntu:16.04
+    platform: ubuntu
+- name: centos-6.6
+  driver_config:
+    image: centos:6.6
+    platform: centos
+- name: centos-7
+  driver_config:
+    image: centos:latest
+    platform: centos
+    run_command: /usr/sbin/init
+- name: 'centos'
+  driver_plugin: docker
+  driver:
+    use_sudo: false
+    image: centos:7
+    run_command: /usr/sbin/init
+
+suites:
+  - name: base
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-puppet
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.1
 platform: ruby
 authors:
 - Neill Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -45,7 +45,7 @@ description: |2+
 
     == FEATURES:
 
-    Supports puppet apply, puppet agent, hiera, hiera-eyaml, hiera-eyaml-gpg, custom facts, librarian-puppet, puppet collections (v4)
+    Supports puppet apply, puppet agent, puppet bolt, hiera, hiera-eyaml, hiera-eyaml-gpg, custom facts, librarian-puppet, puppet collections
 
 email:
 - neillwturner@gmail.com
@@ -59,6 +59,7 @@ files:
 - lib/kitchen/provisioner/puppet/librarian.rb
 - lib/kitchen/provisioner/puppet_agent.rb
 - lib/kitchen/provisioner/puppet_apply.rb
+- lib/kitchen/provisioner/puppet_bolt.rb
 - provisioner_options.md
 homepage: https://github.com/neillturner/kitchen-puppet
 licenses: