vagrant-puppetfile 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c916261b2d2647f4f3437eb35a7da808f3b4a55d
-  data.tar.gz: 45a8f76b44327825869b71869a12f88190287d37
+  metadata.gz: d630dfea4265619b7d7011cc3ca686893bd92159
+  data.tar.gz: ce55251db0c8d90e18aefb0cb01d43c465ba7e95
 SHA512:
-  metadata.gz: f98ab16b73ff66f6f742b8a30dc6c11e2689f64b33aa15b27e60971af84488530074e30ddd710515f1bb42cc85c18c68eb739c8a8b0d29a43e3c4d933879ee7e
-  data.tar.gz: 159fdbfb79d554ac9937730e5275d310149370d25d284939adf401f026607c0cb1f987f8e30ebd7dacc10ccddde7d65ab2ef3b2728ffb660b66b02b23ad1cf10
+  metadata.gz: bb7211571ab50f91db3b13ced038517a6b90c8e7844edaa0d327e13867b5d16fe07635bb8eedde310c3d59c1a562d3005a8d3479c79bf3643f470542906e05eb
+  data.tar.gz: 2979bf2e51e9ac37773a55c13d9b17b32553957939290f87b8ef8f1daf7048eeef40849b3192596028d2b65f7106f1cbc783d5852271256369d7af861e0709d3

data/lib/vagrant/puppetfile/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016 Catalyst.net Ltd
+# Copyright (c) 2016-2017 Catalyst.net Ltd
 #
 # This file is part of vagrant-puppetfile.
 #
@@ -21,6 +21,6 @@
 module Vagrant
   module Puppetfile
     NAME = 'vagrant-puppetfile'
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

data/lib/vagrant/puppetfile.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016 Catalyst.net Ltd
+# Copyright (c) 2016-2017 Catalyst.net Ltd
 #
 # This file is part of vagrant-puppetfile.
 #
@@ -25,13 +25,17 @@ require 'shellwords'
 
 module Vagrant
   module Puppetfile
+    DEFAULT_PUPPETFILE_PATH = 'Puppetfile'
+    DEFAULT_PUPPETFILE_EVALUATOR = 'autodetect'
+
     class Provisioner < Vagrant.plugin('2', :provisioner)
-      def initialize(machine, _)
+      def initialize(machine, config)
+        @config = config
         @logger = Vagrant::UI::Prefixed.new(machine.env.ui, machine.name)
       end
 
       def provision
-        Puppetfile.new.eval(@logger)
+        Puppetfile.new(@config.path).evaluator(@config.evaluator, @logger).install!
       rescue Exception => e
         @logger.error("Failed to evaluate Puppetfile: #{e.message}")
       end
@@ -39,25 +43,29 @@ module Vagrant
 
     class Command < Vagrant.plugin('2', :command)
       def execute
-        # FIXME use vagrant ui objects for these
-        stdout = Logger.new(STDOUT)
-        stderr = Logger.new(STDERR)
+        puppetfile = DEFAULT_PUPPETFILE_PATH
+        evaluator  = DEFAULT_PUPPETFILE_EVALUATOR
 
         options = OptionParser.new do |o|
           o.banner = 'Usage: vagrant puppetfile install'
           o.separator ''
           o.separator 'Options:'
           o.on('-h', '--help', 'Print this help') do
-            return stdout.info(o.help)
+            return @env.ui.info(o.help)
+          end
+          o.on('-e', '--evaluator TYPE', 'Specify the Puppetfile evaluator') do |type|
+            evaluator = type
+          end
+          o.on('-f', '--file PUPPETFILE', 'Specify an alternative Puppetfile') do |path|
+            puppetfile = path
           end
         end
 
         case parse_options(options)
         when ['install']
-          stdout.notice('Evaluating Puppetfile ...')
-          Puppetfile.new.eval(stdout)
+          Puppetfile.new(puppetfile).evaluator(evaluator, @env.ui).install!
         else
-          stderr.warn(options.help)
+          @env.ui.warn(options.help)
           exit 1
         end
       end
@@ -67,88 +75,179 @@ module Vagrant
       end
     end
 
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :path
+      attr_accessor :evaluator
+
+      def initialize
+        @path = UNSET_VALUE
+        @evaluator = UNSET_VALUE
+      end
+
+      def validate(*_)
+        errors = _detected_errors
+        errors << 'path must be a String' unless @path.is_a? String
+        errors << 'evaluator must be a String' unless @evaluator.is_a? String
+        Hash[Vagrant::Puppetfile::Plugin.name => errors]
+      end
+
+      def finalize!
+        @path = DEFAULT_PUPPETFILE_PATH if @path == UNSET_VALUE
+        @evaluator = DEFAULT_PUPPETFILE_EVALUATOR if @evaluator == UNSET_VALUE
+      end
+    end
+
     class Plugin < Vagrant.plugin('2')
       name 'puppetfile'
-      provisioner('puppetfile') { Provisioner }
-      command('puppetfile') { Command }
+      config(:puppetfile, :provisioner) { Config }
+      command(:puppetfile) { Command }
+      provisioner(:puppetfile) { Provisioner }
     end
 
     class Puppetfile < File
-      def initialize(*args)
-        super('Puppetfile', *args)
+      def evaluator(type, logger)
+        case File.basename(type)
+        when 'librarian-puppet'
+          Evaluators::Librarian.new(type, path, logger)
+        when 'r10k'
+          Evaluators::R10k.new(type, path, logger)
+        when 'puppet'
+          Evaluators::Puppet.new(type, path, logger)
+        when 'autodetect'
+          evaluator('librarian-puppet', logger) rescue
+          evaluator('r10k', logger) rescue
+          evaluator('puppet', logger)
+        else
+          fail Evaluators::ConfigurationError, type
+        end
       end
+    end
 
-      def eval(logger)
-        Evaluator.new(logger).instance_eval(Puppetfile.read(path))
+    module Evaluators
+      class InstallationError < Vagrant::Errors::VagrantError
+        def error_message
+          'Puppetfile module installation failed'
+        end
       end
-    end
 
-    class Logger < Logger
-      alias detail info
-      def initialize(*_)
-        super
-        self.formatter = Proc.new { |_, _, _, message| message }
+      class ConfigurationError < Vagrant::Errors::VagrantError
+        def error_message
+          'Invalid vagrant-puppetfile plugin configuration'
+        end
       end
 
-      def notice(message)
-        info("Notice: #{message}\n")
+      class NoEvaluatorError < Vagrant::Errors::VagrantError
+        def error_message
+          'No Puppetfile evaluator was found'
+        end
       end
-    end
 
-    class Evaluator
-      if defined? Vagrant
-        class Exception < Vagrant::Errors::VagrantError
-          def error_message
-            'Puppetfile module installation failed'
+      class Base
+        attr_reader :logger
+        attr_reader :path
+        attr_reader :puppetfile
+
+        ENV_CLEAN_KEYS = %w(GEM_HOME GEM_PATH)
+
+        def initialize(path, puppetfile, logger)
+          @logger = logger
+          @path = path
+          @puppetfile = puppetfile
+          fail NoEvaluatorError, path unless available?
+        end
+
+        def command(*args)
+          ::Bundler.with_clean_env do
+            ENV_CLEAN_KEYS.each { |k| ENV.delete(k) }
+            Open3.capture2e(path, *args.map(&:shellescape))
           end
         end
-      end
 
-      def unsupported(option, method, *args)
-        option = option.inspect
-        args = args.map(&:inspect).join(', ')
-        @logger.error "Unsupported option #{option} in `#{method} #{args}'"
-        raise Exception
+        def run(*args)
+          output, status = command(*args)
+          if status.success?
+            output.lines.each { |l| logger.detail(l.chomp) }
+          else
+            output.lines.each { |l| logger.error(l.chomp) }
+            fail InstallationError, output
+          end
+        end
       end
 
-      def initialize(logger)
-        @logger = logger
-        @moduledir = 'modules'
-      end
+      class R10k < Base
+        def available?
+          command('version').last.success?
+        rescue
+          false
+        end
 
-      def moduledir(path)
-        @moduledir = path
+        def install!
+          run('puppetfile', 'install', '--verbose')
+        end
       end
 
-      def forge(forge)
-        @forge = forge
+      class Librarian < Base
+        def available?
+          command('version').last.success?
+        rescue
+          false
+        end
+
+        def install!
+          run('install', '--verbose')
+        end
       end
 
-      def mod(name, version = :latest, options = {})
-        if version.is_a?(Hash)
-          options, version = version, :latest
+      class Puppet < Base
+        def initialize(path, puppetlabs, logger)
+          super
+          @moduledir = 'modules'
+        end
+
+        def available?
+          command('--version').last.success?
+        rescue
+          false
+        end
+
+        def install!
+          logger.detail("Notice: Evaluating #{puppetfile} ...")
+          instance_eval(File.read(puppetfile))
         end
 
-        unless options.is_a?(Hash) and options.empty?
-          unsupported options, 'mod', name, version, options
+        def unsupported(option, method, *args)
+          option = option.inspect
+          args = args.map(&:inspect).join(', ')
+          logger.error("Unsupported option #{option} in `#{method} #{args}'")
+          fail InstallationError, path
         end
 
-        unless version.is_a?(String) or version == :latest
-          unsupported version, 'mod', name, version
+        def moduledir(moduledir)
+          @moduledir = moduledir
         end
 
-        module_option  = '--target-dir', @moduledir
-        forge_option   = '--module_repository', @forge if @forge.is_a?(String)
-        version_option = '--version', version if version.is_a?(String)
+        def forge(forge)
+          @forge = forge
+        end
 
-        command = 'puppet', 'module', 'install', name, *module_option, *forge_option, *version_option
-        output, status = Open3.capture2e *command.map(&:shellescape)
+        def mod(name, version = :latest, options = {})
+          if version.is_a?(Hash)
+            options, version = version, :latest
+          end
 
-        if status.success?
-          output.lines.each { |l| @logger.detail(l) }
-        else
-          output.lines.each { |l| @logger.error(l) }
-          raise Exception, output
+          unless options.is_a?(Hash) and options.empty?
+            unsupported(options, 'mod', name, version, options)
+          end
+
+          unless version.is_a?(String) or version == :latest
+            unsupported(version, 'mod', name, version)
+          end
+
+          module_option  = '--target-dir', @moduledir
+          forge_option   = '--module_repository', @forge if @forge.is_a? String
+          version_option = '--version', version if version.is_a? String
+
+          run('module', 'install', '--verbose', name, *module_option, *forge_option, *version_option)
         end
       end
     end

data/lib/vagrant-puppetfile.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016 Catalyst.net Ltd
+# Copyright (c) 2016-2017 Catalyst.net Ltd
 #
 # This file is part of vagrant-puppetfile.
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-puppetfile
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies: []
 description: Automatically installs puppet modules from a Puppetfile during Vagrant
   provisioning
@@ -40,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Puppetfile provisioner