vagrant-puppet-modules 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95c691b79233fe1f8344243c6046b70c96bc6886
+  data.tar.gz: d984b14d6dd35209a3b434d131aec621dd3a8529
+SHA512:
+  metadata.gz: 50ab4a52be71af2aafe8e2cf6afa66ab08bbbcc0d912d29e51c222729f4eb41b30e9dcb8fb6ef6e9163657dbcd85fcd0e667445761bebe9bfa7108bd68bd38a2
+  data.tar.gz: a11f2fe571c456b7f9eb51713e7d204f6157511dbac3ccddfd33a5b00947f5a659374168cd98e1829b9594dfec981c22015a207ca95cf57e43544c96df75334a

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'vagrant', git: 'git://github.com/mitchellh/vagrant.git', tag: 'v1.7.2'
+end
+
+group :plugins do
+    gem "vagrant-puppet-modules", path: "."
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anis Safine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,41 @@
+# vagrant-puppet-modules
+A [Vagrant][1] plugin to install [Puppet][2] modules on the guest machine using [Librarian-Puppet][3].
+
+## Requirements
+* Vagrant 1.1.0 or greater
+* Any version of puppet installed on your guest machine (you can use the plugin [vagrant-puppet-install][4])
+
+## Installation
+
+```sh
+vagrant plugin install vagrant-puppet-modules
+```
+
+## Usage
+In your Vagrantfile, add:
+
+```ruby
+Vagrant.configure("2") do |config|
+    # Version number of librarian-puppet that should be installed on your guest machine
+    # config.puppet_modules.librarian_version = "1.2.0" # specific version of librarian-puppet
+    config.puppet_modules.librarian_version = :latest
+    
+    # Path to the folder that contains your Puppetfile (relative to the Vagrantfile folder)
+    config.puppet_modules.puppetfile_dir = "puppet"
+end
+```
+
+This configuration will : 
+* install the latest version of librarian-puppet on your guest machine
+* install the puppet modules defined in "puppet/Puppetfile" in "/etc/puppet/modules" via librarian-puppet
+
+Feel free to learn more about [Librarian-Puppet][3] to know what to put in your Puppetfile.
+
+## Acknowledgements
+A huge thanks to both [vagrant-librarian-puppet][5] and [vagrant-puppet-install][4] that inspired this plugin.
+
+[1]: http://www.vagrantup.com
+[2]: https://puppetlabs.com/
+[3]: https://github.com/rodjek/librarian-puppet
+[4]: https://github.com/petems/vagrant-puppet-install
+[5]: https://github.com/mhahn/vagrant-librarian-puppet

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/lib/vagrant-puppet-modules/action/install_librarian_puppet.rb

@@ -0,0 +1,139 @@
+require 'shellwords'
+require 'vagrant/util/downloader'
+
+module VagrantPlugins
+    module PuppetModules
+        module Action
+            class InstallLibrarianPuppet
+
+                def initialize(app, env)
+                    @app = app
+                    @machine = env[:machine]
+                    @logger = Log4r::Logger.new('vagrantplugins::puppet_modules::action::installlibrarian')
+                end
+
+                def call(env)
+                    if @machine.communicate.ready? && provision_enabled?(env)
+                        @machine.config.puppet_modules.validate!
+
+                        desired_version = @machine.config.puppet_modules.librarian_version
+                        if desired_version.nil? || installed_version == desired_version
+                            env[:ui].info "Librarian-puppet is installed or not required"
+                            return
+                        end
+
+                        fetch_or_create_install_script(env)
+                        install(desired_version, env)
+                    end
+
+                    @app.call(env)
+                end
+
+                private
+
+                def provision_enabled?(env)
+                    env.fetch(:provision_enabled, true)
+                end
+
+                def windows_guest?
+                    @machine.config.vm.guest.eql?(:windows)
+                end
+
+                def installed_version
+                    version = nil
+                    opts = nil
+
+                    if windows_guest?
+                        # todo
+                    else
+                        command = 'echo $(librarian-puppet --version)'
+                    end
+
+                    @machine.communicate.sudo(command, opts) do |type, data|
+                        if [:stderr, :stdout].include?(type)
+                            version_match = data.match(/^(.+)/)
+                            version = version_match.captures[0].strip if version_match
+                        end
+                    end
+
+                    version
+                end
+
+                def fetch_or_create_install_script(env)
+                    @script_tmp_path = env[:tmp_path].join("#{Time.now.to_i.to_s}-#{install_script_name}")
+
+                    msg = "Generating install script at: #{@script_tmp_path}"
+                    env[:ui].info(msg)
+                    @logger.info(msg)
+
+                    url = find_install_script
+
+                    begin
+                        if windows_guest?
+                            # todo
+                        else
+                            downloader = Vagrant::Util::Downloader.new(url, @script_tmp_path, {})
+                            downloader.download!
+                        end
+                    rescue Vagrant::Errors::DownloaderInterrupted
+                        msg = 'The download of the librarian-puppet install script was interrupted'
+                        env[:ui].info(msg)
+                        @logger.info(msg)
+                        return
+                    end
+                end
+
+                def find_install_script
+                    config_install_url || default_install_url
+                end
+
+                def config_install_url
+                    @machine.config.puppet_modules.install_url
+                end
+
+                def default_install_url
+                    if windows_guest?
+                        # todo
+                    else
+                        'https://raw.githubusercontent.com/anis/vagrant-puppet-modules/master/shell/librarian_puppet_install.sh'
+                    end
+                end
+
+                def install_script_name
+                    if windows_guest?
+                        # todo
+                    else
+                        'librarian_puppet_install.sh'
+                    end
+                end
+
+                def install(version, env)
+                    msg = "Installing librarian-puppet at version #{version}"
+                    env[:ui].info(msg)
+                    @logger.info(msg)
+
+                    shell_escaped_version = Shellwords.escape(version)
+
+                    @machine.communicate.tap do |comm|
+                        comm.upload(@script_tmp_path, install_script_name)
+
+                        if windows_guest?
+                            # todo
+                        else
+                            install_cmd = "sh #{install_script_name}"
+                            install_cmd << " -v #{version}"
+                            install_cmd << ' 2>&1'
+                        end
+
+                        comm.sudo(install_cmd) do |type, data|
+                            if [:stderr, :stdout].include?(type)
+                                next if data =~ /stdin: is not a tty/
+                                env[:ui].info(data)
+                            end
+                        end
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/vagrant-puppet-modules/action/install_puppet_modules.rb

@@ -0,0 +1,74 @@
+module VagrantPlugins
+    module PuppetModules
+        module Action
+            class InstallPuppetModules
+
+                def initialize(app, env)
+                    @app = app
+                    @machine = env[:machine]
+                    @logger = Log4r::Logger.new('vagrantplugins::puppet_modules::action::installmodules')
+                end
+
+                def call(env)
+                    if @machine.communicate.ready? && provision_enabled?(env)
+                        if @machine.config.puppet_modules.puppetfile_dir.nil?
+                            env[:ui].info "Puppetfile is not defined, puppet modules won't be installed"
+                            return
+                        end
+
+                        install_modules(env)
+                    end
+
+                    @app.call(env)
+                end
+
+                private
+
+                def provision_enabled?(env)
+                    env.fetch(:provision_enabled, true)
+                end
+
+                def windows_guest?
+                    @machine.config.vm.guest.eql?(:windows)
+                end
+
+                def install_modules(env)
+                    msg = "Installing puppet modules via librarian"
+                    env[:ui].info(msg)
+                    @logger.info(msg)
+
+                    @puppetfile_path = File.join(
+                        env[:root_path],
+                        @machine.config.puppet_modules.puppetfile_dir,
+                        "Puppetfile"
+                    )
+
+                    if !File.file?(@puppetfile_path)
+                        msg = "The file '" << @puppetfile_path << "' does not exist"
+                        @logger.error(msg)
+                        env[:ui].info msg
+
+                        return
+                    end
+
+                    @machine.communicate.tap do |comm|
+                        comm.upload(@puppetfile_path, "Puppetfile")
+
+                        if windows_guest?
+                            # todo
+                        else
+                            install_cmd = "librarian-puppet install --path=/etc/puppet/modules"
+                        end
+
+                        comm.sudo(install_cmd) do |type, data|
+                            if [:stderr, :stdout].include?(type)
+                                next if data =~ /stdin: is not a tty/
+                                env[:ui].info(data)
+                            end
+                        end
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/vagrant-puppet-modules/config.rb

@@ -0,0 +1,83 @@
+require 'log4r'
+require 'rubygems/dependency'
+require 'rubygems/dependency_installer'
+
+module VagrantPlugins
+    module PuppetModules
+        class Config < Vagrant.plugin('2', :config)
+            attr_accessor :librarian_version, :install_url, :puppetfile_dir
+
+            def initialize
+                @librarian_version = UNSET_VALUE
+                @install_url = UNSET_VALUE
+                @puppetfile_dir = UNSET_VALUE
+                @logger = Log4r::Logger.new('vagrantplugins::puppet_modules::config')
+            end
+
+            def finalize!
+                if @librarian_version == UNSET_VALUE
+                    @librarian_version = nil
+                elsif @librarian_version.to_s == 'latest'
+                    @librarian_version = retrieve_latest_librarian_version
+                end
+
+                @install_url = nil if @install_url == UNSET_VALUE
+                @puppetfile_dir = nil if @puppetfile_dir == UNSET_VALUE
+            end
+
+            def validate!()
+                finalize!
+
+                if !librarian_version.nil? && !valid_librarian_version?(librarian_version)
+                    errors = Vagrant::Util::TemplateRenderer.render(
+                        'config/validation_failed',
+                        errors: {
+                            'vagrant-puppet-modules' => [
+                                "#{librarian_version} is not a valid version of librarian-puppet."
+                            ]
+                        }
+                    )
+                    fail Vagrant::Errors::ConfigInvalid, errors: errors
+                end
+            end
+
+            private
+
+            def retrieve_latest_librarian_version
+                available_gems = dependency_installer.find_gems_with_sources(librarian_gem_dependency)
+
+                spec, _source =
+                if available_gems.respond_to?(:last)
+                    spec_with_source = available_gems.last
+                    spec_with_source
+                else
+                    available_gems.pick_best!
+                    best_gem = available_gems.set.first
+                    best_gem && [best_gem.spec, best_gem.source]
+                end
+
+                spec && spec.version.to_s
+            end
+
+            def valid_librarian_version?(version)
+                is_valid = false
+                begin
+                    available = dependency_installer.find_gems_with_sources(librarian_gem_dependency(version))
+                    is_valid = true unless available.empty?
+                rescue ArgumentError => e
+                    @logger.debug("#{version} is not a valid librarian-puppet version: #{e}")
+                end
+
+                is_valid
+            end
+
+            def dependency_installer
+                @dependency_installer ||= Gem::DependencyInstaller.new
+            end
+
+            def librarian_gem_dependency(version = nil)
+                Gem::Dependency.new('librarian-puppet', version)
+            end
+        end
+    end
+end

data/lib/vagrant-puppet-modules/plugin.rb

@@ -0,0 +1,49 @@
+module VagrantPlugins
+    module PuppetModules
+        class Plugin < Vagrant.plugin('2')
+            name 'vagrant-puppet-modules'
+            description <<-DESC
+            This plugin installs the appropriate Puppet modules on your guest machine, via librarian-puppet.
+            DESC
+
+            VAGRANT_VERSION_REQUIREMENT = '>= 1.1.0'
+
+            # Returns true if the Vagrant version fulfills the requirements
+            #
+            # @param requirements [String, Array<String>] the version requirement
+            # @return [Boolean]
+            def self.check_vagrant_version(*requirements)
+                Gem::Requirement.new(*requirements).satisfied_by?(
+                    Gem::Version.new(Vagrant::VERSION)
+                )
+            end
+
+            # Verifies that the Vagrant version fulfills the requirements
+            #
+            # @raise [VagrantPlugins::ProxyConf::VagrantVersionError] if this plugin is incompatible with the Vagrant
+            # version
+            def self.check_vagrant_version!
+                unless check_vagrant_version(VAGRANT_VERSION_REQUIREMENT)
+                    msg = "vagrant-puppet-modules requires Vagrant version " << VAGRANT_VERSION_REQUIREMENT
+                    $stderr.puts msg
+                    fail msg
+                end
+            end
+
+            action_hook(:install_librarian_puppet, Plugin::ALL_ACTIONS) do |hook|
+                require_relative 'action/install_puppet_modules'
+                require_relative 'action/install_librarian_puppet'
+
+                hook.after(Vagrant::Action::Builtin::Provision, Action::InstallLibrarianPuppet)
+                hook.after(Action::InstallLibrarianPuppet, Action::InstallPuppetModules)
+            end
+
+            check_vagrant_version!
+
+            config(:puppet_modules) do
+                require_relative 'config'
+                Config
+            end
+        end
+    end
+end

data/lib/vagrant-puppet-modules/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+    module PuppetModules
+        VERSION = '0.0.1'
+    end
+end

data/lib/vagrant-puppet-modules.rb

@@ -0,0 +1,3 @@
+require 'vagrant'
+require 'vagrant-puppet-modules/config'
+require 'vagrant-puppet-modules/plugin'

data/shell/librarian_puppet_install.sh

@@ -0,0 +1,109 @@
+#!/bin/sh
+
+# No need to go further if librarian-puppet is already installed
+$(which librarian-puppet > /dev/null 2>&1)
+
+if [ "$?" -eq '0' ]; then
+  exit 0
+fi
+
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Library
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+# Installs puppet-librarian
+InstallLibrarianPuppet () {
+  echo 'Attempting to install librarian-puppet'
+
+  gem install librarian-puppet --version "$version"
+
+  if [ "$?" -ne '0' ]; then
+    echo 'Failed to install librarian-puppet'
+    exit $?
+  fi
+}
+
+# Installs ruby-dev
+InstallRubyDev () {
+  # ensure it is not already installed
+  $(dpkg -s ruby-dev > /dev/null 2>&1)
+
+  if [ "$?" -eq '0' ]; then
+    return
+  fi
+
+  # try to install it with the appropriate package manager
+  echo 'Attempting to install Ruby devkit...'
+
+  if [ "${FOUND_YUM}" -eq '0' ]; then
+    yum -q -y makecache
+    yum -q -y install ruby-dev
+  elif [ "${FOUND_APT}" -eq '0' ]; then
+    apt-get -q -y install ruby-dev
+  fi
+
+  if [ "$?" -ne '0' ]; then
+    echo 'Failed to install Ruby devkit...'
+    exit $?
+  fi
+}
+
+#Installs git
+InstallGit () {
+  # ensure git is not already installed
+  $(which git > /dev/null 2>&1)
+
+  if [ "$?" -eq '0' ]; then
+    return
+  fi
+
+  # try to install git with the appropriate package manager
+  echo 'Attempting to install Git...'
+
+  if [ "${FOUND_YUM}" -eq '0' ]; then
+    yum -q -y makecache
+    yum -q -y install git
+  elif [ "${FOUND_APT}" -eq '0' ]; then
+    apt-get -q -y install git
+  fi
+
+  if [ "$?" -ne '0' ]; then
+    echo 'Failed to install Git...'
+    exit $?
+  fi
+}
+
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Script
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+# Ensure we have one supported package manager, up to date
+$(which apt-get > /dev/null 2>&1)
+FOUND_APT=$?
+
+$(which yum > /dev/null 2>&1)
+FOUND_YUM=$?
+
+if [ "${FOUND_YUM}" -ne '0' -a "${FOUND_APT}" -ne '0' ]; then
+  echo 'No supported package installer available. You may need to install git and librarian-puppet manually.'
+  exit 1
+fi
+
+if [ "${FOUND_APT}" -eq '0' ]; then
+  apt-get -q -y update
+fi
+
+# Collect the parameters
+while getopts :v: opt; do
+  case "$opt" in
+    v) version="$OPTARG"
+    ;;
+    \?) echo "Unknown option -$OPTARG. Usage: $0 -v version" >&2
+    ;;
+  esac
+done
+
+# Install the appropriate packages
+InstallGit
+InstallRubyDev
+InstallLibrarianPuppet

data/vagrant-puppet-modules.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-puppet-modules/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-puppet-modules'
+  spec.version       = VagrantPlugins::PuppetModules::VERSION
+  spec.authors       = ['Anis Safine']
+  spec.email         = ['anis@poensis.fr']
+  spec.description   = 'A Vagrant plugin that installs the appropriate Puppet modules on your guest machine, via' \
+                       ' librarian-puppet.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/anis/vagrant-puppet-modules'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-puppet-modules
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anis Safine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Vagrant plugin that installs the appropriate Puppet modules on your
+  guest machine, via librarian-puppet.
+email:
+- anis@poensis.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vagrant-puppet-modules.rb
+- lib/vagrant-puppet-modules/action/install_librarian_puppet.rb
+- lib/vagrant-puppet-modules/action/install_puppet_modules.rb
+- lib/vagrant-puppet-modules/config.rb
+- lib/vagrant-puppet-modules/plugin.rb
+- lib/vagrant-puppet-modules/version.rb
+- shell/librarian_puppet_install.sh
+- vagrant-puppet-modules.gemspec
+homepage: https://github.com/anis/vagrant-puppet-modules
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Vagrant plugin that installs the appropriate Puppet modules on your guest
+  machine, via librarian-puppet.
+test_files: []