kitchen-puppet 0.0.7

data/README.md

@@ -0,0 +1,15 @@
+# kitchen-puppet
+A Test Kitchen Provisioner for Puppet
+
+The provider works by passing the puppet repository based on attributes in .kitchen.yml & calling puppet apply.
+
+This provider has been tested against the Ubuntu 1204 and Centos 6.5 boxes running in vagrant/virtualbox.
+
+## Requirements
+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.
+
+
+## Installation & Setup
+You'll need the test-kitchen & kitchen-puppet gem's installed in your system, along with kitchen-vagrant or some ther suitable driver for test-kitchen. 
+
+Please see the Provisioner Options (https://github.com/neillturner/kitchen-puppet/blob/master/provisioner_options.md).

data/kitchen-puppet.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'kitchen-puppet/version'
+
+Gem::Specification.new do |s|
+  s.name          = "kitchen-puppet"
+  s.version       = Kitchen::Puppet::VERSION
+  s.authors       = ["Neill Turner"]
+  s.email         = ["neillwturner@gmail.com"]
+  s.homepage      = "https://github.com/neillturner/kitchen-puppet"
+  s.summary       = "puppet provisioner for test-kitchen"
+  candidates = Dir.glob("{lib}/**/*") +  ['README.md', 'provisioner_options.md', 'kitchen-puppet.gemspec']
+  s.files = candidates.sort
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.rubyforge_project = '[none]'
+  s.description = <<-EOF
+== DESCRIPTION:
+
+Puppet Provisioner for Test Kitchen
+
+== FEATURES:
+
+Supports puppet apply, hiera and custom facts
+
+EOF
+
+end

data/lib/kitchen-puppet/version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module Puppet
+    VERSION = "0.0.7"
+  end
+end

data/lib/kitchen/provisioner/puppet/librarian.rb

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>) Neill Turner (<neillwturner@gmail.com>)
+#
+# Copyright (C) 2013, Fletcher Nichol, 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 'kitchen/errors'
+require 'kitchen/logging'
+
+module Kitchen
+
+  module Provisioner
+
+    module Puppet
+
+      # Puppet module resolver that uses Librarian-Puppet and a Puppetfile to
+      # calculate # dependencies.
+      #
+       class Librarian
+
+        include Logging
+
+
+        def initialize(puppetfile, path, logger = Kitchen.logger)
+          @puppetfile   = puppetfile
+          @path       = path
+          @logger     = logger
+        end
+
+        def self.load!(logger = Kitchen.logger)
+          load_librarian!(logger)
+        end
+
+        def resolve
+          version = ::Librarian::Puppet::VERSION
+          info("Resolving module dependencies with Librarian-Puppet #{version}...")
+          debug("Using Puppetfile from #{puppetfile}")
+
+          env = ::Librarian::Puppet::Environment.new(
+            :project_path => File.dirname(puppetfile))
+          env.config_db.local["path"] = path
+          ::Librarian::Action::Resolve.new(env).run
+          ::Librarian::Action::Install.new(env).run
+        end
+
+        attr_reader :puppetfile, :path, :logger
+
+        def self.load_librarian!(logger)
+          first_load = require 'librarian/puppet/environment'
+          require 'librarian/action/resolve'
+          require 'librarian/action/install'
+
+          version = ::Librarian::Puppet::VERSION
+          if first_load
+            logger.debug("Librarian-Puppet #{version} library loaded")
+          else
+            logger.debug("Librarian-Puppet #{version} previously loaded")
+          end
+        rescue LoadError => e
+          logger.fatal("The `librarian-puppet' gem is missing and must be installed" +
+            " or cannot be properly activated. Run" +
+            " `gem install librarian-puppet` or add the following to your" +
+            " Gemfile if you are using Bundler: `gem 'librarian-puppet'`.")
+          raise UserError,
+            "Could not load or activate Librarian-Puppet (#{e.message})"
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/puppet_apply.rb

@@ -0,0 +1,385 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Chris Lundquist (<chris.lundquist@github.com>) Neill Turner (<neillwturner@gmail.com>)
+#
+# Copyright (C) 2013,2014 Chris Lundquist, 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.
+#
+# See https://github.com/neillturner/kitchen-puppet/blob/master/provisioner_options.md
+# for documentation configuration parameters with puppet_apply provisioner.
+#
+
+require 'kitchen/provisioner/base'
+require 'kitchen/provisioner/puppet/librarian'
+
+module Kitchen
+
+  module Provisioner
+    #
+    # Puppet Apply provisioner.
+    #
+    class PuppetApply < Base
+      attr_accessor :tmp_dir
+
+      default_config :require_puppet_omnibus, false
+      # TODO use something like https://github.com/fnichol/omnibus-puppet
+      default_config :puppet_omnibus_url, nil
+      default_config :puppet_omnibus_remote_path, '/opt/puppet'
+      default_config :puppet_version, nil
+      default_config :require_puppet_repo, true
+      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"
+
+      default_config :hiera_data_remote_path, '/var/lib/hiera'
+      default_config :manifest, 'site.pp'
+
+      default_config :manifests_path do |provisioner|
+        provisioner.calculate_path('manifests') or
+          raise 'No manifests_path detected. Please specify one in .kitchen.yml'
+      end
+
+      default_config :modules_path do |provisioner|
+        provisioner.calculate_path('modules') or
+          raise 'No modules_path detected. Please specify one in .kitchen.yml'
+      end
+
+      default_config :hiera_data_path do |provisioner|
+        provisioner.calculate_path('hiera')
+      end
+
+      default_config :hiera_config_path do |provisioner|
+        provisioner.calculate_path('hiera.yaml', :file)
+      end
+
+      default_config :puppetfile_path do |provisioner|
+        provisioner.calculate_path('Puppetfile', :file)
+      end
+
+      default_config :puppet_debug, false
+      default_config :puppet_verbose, false
+      default_config :puppet_noop, false
+      default_config :puppet_platform, ''
+      default_config :update_package_repos, true
+      default_config :custom_facts, {}
+
+      def calculate_path(path, type = :directory)
+        base = File.join(config[:kitchen_root], 'puppet')
+        candidates = []
+        candidates << File.join(base, instance.suite.name, path)
+        candidates << File.join(base, path)
+        candidates << File.join(Dir.pwd, path)
+
+        candidates.find do |c|
+          type == :directory ? File.directory?(c) : File.file?(c)
+        end
+      end
+
+      def install_command
+        return unless config[:require_puppet_omnibus] or config[:require_puppet_repo]
+        if config[:require_puppet_omnibus]
+          info("Installing puppet using puppet omnibus")
+          version = if !config[:puppet_version].nil?
+            "-v #{config[:puppet_version]}"
+          else
+            ""
+          end
+          <<-INSTALL
+          if [ ! -d "#{config[:puppet_omnibus_remote_path]}" ]; then
+            echo "-----> Installing Puppet Omnibus"
+            curl -o /tmp/puppet_install.sh #{config[:puppet_omnibus_url]}
+            #{sudo('sh')} /tmp/puppet_install.sh #{version}
+          fi
+          #{install_busser}
+          INSTALL
+        else
+          case puppet_platform
+          when "debian", "ubuntu"
+          info("Installing puppet on #{puppet_platform}")
+          <<-INSTALL
+          if [ ! $(which puppet) ]; then
+            #{sudo('wget')} #{puppet_apt_repo}
+            #{sudo('dpkg')} -i #{puppet_apt_repo_file}
+            #{update_packages_debian_cmd}
+            #{sudo('apt-get')} -y install puppet#{puppet_debian_version}
+          fi
+          #{install_busser}
+          INSTALL
+                 when "redhat", "centos", "fedora"
+                  info("Installing puppet on #{puppet_platform}")
+          <<-INSTALL
+          if [ ! $(which puppet) ]; then
+            #{sudo('rpm')} -ivh #{puppet_yum_repo}
+                    #{update_packages_redhat_cmd}
+            #{sudo('yum')} -y install puppet#{puppet_redhat_version}
+          fi
+          #{install_busser}
+          INSTALL
+         else
+          info("Installing puppet, will try to determine platform os")
+          <<-INSTALL
+          if [ ! $(which puppet) ]; then
+            if [ -f /etc/centos-release ] || [ -f /etc/redhat-release ]; then
+               #{sudo('rpm')} -ivh #{puppet_yum_repo}
+               #{update_packages_redhat_cmd}
+               #{sudo('yum')} -y install puppet#{puppet_redhat_version}
+            else
+               #{sudo('wget')} #{puppet_apt_repo}
+               #{sudo('dpkg')} -i #{puppet_apt_repo_file}
+               #{update_packages_debian_cmd}
+               #{sudo('apt-get')} -y install puppet#{puppet_debian_version}
+            fi
+          fi
+          #{install_busser}
+          INSTALL
+         end
+        end
+      end
+
+      def install_busser
+          <<-INSTALL
+          # install chef omnibus so that busser works as this is needed to run tests :(
+          # TODO: work out how to install enough ruby
+          # and set busser: { :ruby_bindir => '/usr/bin/ruby' } so that we dont need the
+          # whole chef client
+          if [ ! -d "/opt/chef" ]
+          then
+            echo "-----> Installing Chef Omnibus to install busser to run tests"
+            curl -o /tmp/install.sh #{chef_url}
+            #{sudo('sh')} /tmp/install.sh
+          fi
+          INSTALL
+          end
+
+        def init_command
+          dirs = %w{modules manifests hiera hiera.yaml}.
+            map { |dir| File.join(config[:root_path], dir) }.join(" ")
+          cmd = "#{sudo('rm')} -rf #{dirs} #{hiera_data_remote_path} /etc/hiera.yaml /etc/puppet/hiera.yaml;"
+          cmd = cmd+" mkdir -p #{config[:root_path]}"
+          debug(cmd)
+          cmd
+        end
+
+        def create_sandbox
+          super
+          debug("Creating local sandbox in #{sandbox_path}")
+
+          yield if block_given?
+
+          prepare_modules
+          prepare_manifests
+          prepare_hiera_config
+          prepare_hiera_data
+          info('Finished Preparing files for transfer')
+
+        end
+
+        def cleanup_sandbox
+          return if sandbox_path.nil?
+          debug("Cleaning up local sandbox in #{sandbox_path}")
+          FileUtils.rmtree(sandbox_path)
+        end
+
+        def prepare_command
+          commands = []
+
+          if hiera_config
+            commands << [
+              sudo('cp'), File.join(config[:root_path],'hiera.yaml'), '/etc/',
+            ].join(' ')
+
+            commands << [
+              sudo('cp'), File.join(config[:root_path],'hiera.yaml'), '/etc/puppet/',
+            ].join(' ')
+          end
+
+          if hiera_data and hiera_data_remote_path == '/var/lib/hiera'
+            commands << [
+              sudo('cp -r'), File.join(config[:root_path], 'hiera'), '/var/lib/'
+            ].join(' ')
+          end
+
+          if hiera_data and hiera_data_remote_path != '/var/lib/hiera'
+            commands << [
+              sudo('mkdir -p'), hiera_data_remote_path
+            ].join(' ')
+                        commands << [
+              sudo('cp -r'), File.join(config[:root_path], 'hiera/*'), hiera_data_remote_path
+            ].join(' ')
+          end
+
+          command = commands.join(' && ')
+          debug(command)
+          command
+        end
+
+        def run_command
+          [
+            custom_facts,
+            sudo('puppet'),
+            'apply',
+            File.join(config[:root_path], 'manifests', manifest),
+            "--modulepath=#{File.join(config[:root_path], 'modules')}",
+            "--manifestdir=#{File.join(config[:root_path], 'manifests')}",
+            puppet_noop_flag,
+            puppet_verbose_flag,
+            puppet_debug_flag,
+          ].join(" ")
+        end
+
+        protected
+
+        def load_needed_dependencies!
+          if File.exists?(puppetfile)
+            debug("Puppetfile found at #{puppetfile}, loading Librarian-Puppet")
+            Puppet::Librarian.load!(logger)
+          end
+        end
+
+        def tmpmodules_dir
+          File.join(sandbox_path, 'modules')
+        end
+
+        def puppetfile
+          config[:puppetfile_path] or ''
+        end
+
+        def manifest
+          config[:manifest]
+        end
+
+        def manifests
+          config[:manifests_path]
+        end
+
+        def modules
+          config[:modules_path]
+        end
+
+        def hiera_config
+          config[:hiera_config_path]
+        end
+
+        def hiera_data
+          config[:hiera_data_path]
+        end
+
+        def hiera_data_remote_path
+          config[:hiera_data_remote_path]
+        end
+
+        def puppet_debian_version
+          config[:puppet_version] ? "=#{config[:puppet_version]}" : nil
+        end
+
+        def puppet_redhat_version
+          config[:puppet_version] ? "-#{config[:puppet_version]}" : nil
+        end
+
+        def puppet_noop_flag
+          config[:puppet_noop] ? '--noop' : nil
+        end
+
+        def puppet_debug_flag
+          config[:puppet_debug] ? '-d' : nil
+        end
+
+        def puppet_verbose_flag
+          config[:puppet_verbose] ? '-v' : nil
+        end
+
+        def puppet_platform
+          config[:puppet_platform].to_s.downcase
+        end
+
+        def update_packages_debian_cmd
+          config[:update_package_repos] ? "#{sudo('apt-get')} update" : nil
+        end
+
+        def update_packages_redhat_cmd
+          config[:update_package_repos] ? "#{sudo('yum')} makecache" : nil
+        end
+
+        def custom_facts
+          return nil if config[:custom_facts].none?
+          bash_vars = config[:custom_facts].map { |k,v| "FACTER_#{k}=#{v}" }.join(" ")
+          bash_vars = "export #{bash_vars};"
+          debug(bash_vars)
+          bash_vars
+        end
+
+        def puppet_apt_repo
+          config[:puppet_apt_repo]
+        end
+
+        def puppet_apt_repo_file
+          config[:puppet_apt_repo].split('/').last
+        end
+
+        def puppet_yum_repo
+          config[:puppet_yum_repo]
+        end
+
+        def chef_url
+          config[:chef_bootstrap_url]
+        end
+
+        def prepare_manifests
+          info('Preparing manifests')
+          debug("Using manifests from #{manifests}")
+
+          tmp_manifests_dir = File.join(sandbox_path, 'manifests')
+          FileUtils.mkdir_p(tmp_manifests_dir)
+          FileUtils.cp_r(Dir.glob("#{manifests}/*"), tmp_manifests_dir)
+        end
+
+        def prepare_modules
+          info('Preparing modules')
+          if File.exists?(puppetfile)
+            resolve_with_librarian
+          end
+          debug("Using modules from #{modules}")
+
+          tmp_modules_dir = File.join(sandbox_path, 'modules')
+          FileUtils.mkdir_p(tmp_modules_dir)
+          FileUtils.cp_r(Dir.glob("#{modules}/*"), tmp_modules_dir)
+        end
+
+        def prepare_hiera_config
+          return unless hiera_config
+
+          info('Preparing hiera')
+          debug("Using hiera from #{hiera_config}")
+
+          FileUtils.cp_r(hiera_config, File.join(sandbox_path, 'hiera.yaml'))
+        end
+
+        def prepare_hiera_data
+          return unless hiera_data
+          info('Preparing hiera data')
+          debug("Using hiera data from #{hiera_data}")
+
+          tmp_hiera_dir = File.join(sandbox_path, 'hiera')
+          FileUtils.mkdir_p(tmp_hiera_dir)
+          FileUtils.cp_r(Dir.glob("#{hiera_data}/*"), tmp_hiera_dir)
+        end
+
+        def resolve_with_librarian
+          Kitchen.mutex.synchronize do
+            Puppet::Librarian.new(puppetfile, tmpmodules_dir, logger).resolve
+          end
+        end
+    end
+  end
+end

data/lib/kitchen/provisioner/puppet_apply_spec.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Chris Lundquist (<chris.lundquist@github.com>) Neill Turner (<neillwturner@gmail.com>)
+#
+# Copyright (C) 2013,2014 Chris Lundquist, 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_relative '../../spec_helper'
+require 'kitchen'
+
+# Work around for lazy loading
+require 'kitchen/provisioner/puppet_apply'
+
+describe Kitchen::Provisioner::PuppetApply do
+  let(:provisioner) do
+    Kitchen::Provisioner.for_plugin("puppet_apply", {})
+  end
+
+  it "should give a sane run_command" do
+    provisioner.run_command.must_match /puppet apply/
+  end
+end

data/provisioner_options.md

@@ -0,0 +1,68 @@
+
+# Provisioner Options
+
+key | default value | Notes
+----|---------------|--------
+puppet_version | "latest"| desired version, affects apt installs
+puppet_platform | naively tries to determine | OS platform of server
+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
+puppet_yum_repo | "https://yum.puppetlabs.com/puppetlabs-release-el-6.noarch.rpm"| yum repo
+require_puppet_omnibus | false | Set if using omnibus puppet install
+puppet_omnibus_url | | omnibus puppet install location.
+puppet_omnibus_remote_path | "/opt/puppet" | Server Installation location of an omnibus puppet install.
+manifests_path | | puppet repo manifests directory
+manifest | 'site.pp' | manifest for puppet apply to run
+modules_path | | puppet repo manifests directory
+hiera_data_path | | puppet repo hiera data directory
+hiera_data_remote_path | "/var/lib/hiera" | Hiera data directory on server
+puppet_debug| false| Enable full debugging logging
+puppet_verbose| false| Extra information logging
+puppet_noop| false| puppet runs in a no-op or dry-run mode
+update_package_repos| true| update OS repository metadata
+custom_facts| Hash.new | Hash to set the puppet facts before running puppet apply
+chef_bootstrap_url |"https://www.getchef.com/chef/install.sh"| the chef (needed for busser to run tests)
+puppetfile_path | | Path to Puppetfile
+
+## Configuring Provisioner Options
+
+The provisioner can be configured globally or per suite, global settings act as defaults for all suites, you can then customise per suite, for example:
+
+    ---
+    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
+
+
+in this example, vagrant will download a box for ubuntu 1204 with no configuration management installed, then install the latest puppet and puppet apply against a puppet repo from the /repository/puppet_repo directory using the defailt manifest site.pp
+
+To override a setting at the suite-level, specify the setting name under the suite:
+
+    suites:
+     - name: default
+       manifest: foobar.pp
+
+### Per-suite Structure
+
+It can be beneficial to keep different Puppet layouts for different suites. Rather than having to specify the manifest, modules, etc for each suite, you can create the following directory structure and they will automatically be found:
+
+    $kitchen_root/puppet/$suite_name/manifests
+    $kitchen_root/puppet/$suite_name/modules
+    $kitchen_root/puppet/$suite_name/hiera
+    $kitchen_root/puppet/$suite_name/hiera.yaml
+    $kitchen_root/puppet/$suite_name/Puppetfile

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-puppet
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Neill Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies: []
+description: ! '== DESCRIPTION:
+
+
+  Puppet Provisioner for Test Kitchen
+
+
+  == FEATURES:
+
+
+  Supports puppet apply, hiera and custom facts
+
+
+'
+email:
+- neillwturner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- kitchen-puppet.gemspec
+- lib/kitchen-puppet/version.rb
+- lib/kitchen/provisioner/puppet/librarian.rb
+- lib/kitchen/provisioner/puppet_apply.rb
+- lib/kitchen/provisioner/puppet_apply_spec.rb
+- provisioner_options.md
+homepage: https://github.com/neillturner/kitchen-puppet
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ! '[none]'
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: puppet provisioner for test-kitchen
+test_files: []