vagrant-pe_build 0.6.0 → 0.7.0

data/CHANGELOG

@@ -1,6 +1,25 @@
 vagrant-pe_build
 ================
 
+0.7.0
+
+2013-10-14
+
+This is a backwards incompatible bugfix and feature release.
+
+### User notes:
+
+  * At long last, The pe_bootstrap `steps` option has been entirely removed.
+  * The pe_bootstrap role value is now normalized; users can specify a string
+    or symbol and the right thing will happen.
+
+### Developer notes:
+
+  * Error handling and messages around missing and unreadable archives have
+    been improved.
+
+Thanks to Charlie Sharpsteen for his contributions to this release.
+
 0.6.0
 -----
 

data/lib/pe_build/archive.rb

@@ -6,97 +6,108 @@ require 'pe_build/transfer'
 require 'pe_build/unpack'
 
 module PEBuild
+  class ArchiveNoInstallerSource < Vagrant::Errors::VagrantError
+    error_key(:no_installer_source, "pebuild.archive")
+  end
 
-class ArchiveNoInstallerSource < Vagrant::Errors::VagrantError
-  error_key(:no_installer_source, "pebuild.archive")
-end
+  class ArchiveMissing < Vagrant::Errors::VagrantError
+    error_key(:missing, "pebuild.archive")
+  end
 
-class Archive
-  # Represents a packed Puppet Enterprise archive
+  class ArchiveUnreadable < Vagrant::Errors::VagrantError
+    error_key(:unreadable, "pebuild.archive")
+  end
 
-  include PEBuild::Idempotent
+  # Represents a packed Puppet Enterprise archive
+  class Archive
 
-  # @!attribute [rw] version
-  #   @return [String] The version of Puppet Enterprise
-  attr_accessor :version
+    include PEBuild::Idempotent
 
-  # @!attribute [rw] filename
-  #   @return [String] The filename. Thing
-  attr_accessor :filename
+    # @!attribute [rw] version
+    #   @return [String] The version of Puppet Enterprise
+    attr_accessor :version
 
-  attr_accessor :env
+    # @!attribute [rw] filename
+    #   @return [String] The filename. Thing
+    attr_accessor :filename
 
-  # @param filename [String] The uninterpolated filename
-  # @param env [Hash]
-  def initialize(filename, env)
-    @filename = filename
-    @env      = env
+    attr_accessor :env
 
-    @archive_dir = PEBuild.archive_directory(@env)
+    # @param filename [String] The uninterpolated filename
+    # @param env [Hash]
+    def initialize(filename, env)
+      @filename = filename
+      @env      = env
 
-    @logger = Log4r::Logger.new('vagrant::pe_build::archive')
-  end
+      @archive_dir = PEBuild.archive_directory(@env)
 
-  # @param base_uri [String] A string representation of the download source URI
-  def fetch(str)
-    return if self.exist?
+      @logger = Log4r::Logger.new('vagrant::pe_build::archive')
+    end
 
-    if str.nil?
-      @env.ui.error "Cannot fetch installer #{versioned_path @filename}; no download source available."
-      @env.ui.error ""
-      @env.ui.error "Installers available for use:"
+    # @param base_uri [String] A string representation of the download source URI
+    def fetch(str)
+      return if self.exist?
 
-      collection = PEBuild::ArchiveCollection.new(@archive_dir, @env)
-      collection.display
+      if str.nil?
+        @env.ui.error "Cannot fetch installer #{versioned_path @filename}; no download source available."
+        @env.ui.error ""
+        @env.ui.error "Installers available for use:"
 
-      raise PEBuild::ArchiveNoInstallerSource, :filename => versioned_path(@filename)
-    end
+        collection = PEBuild::ArchiveCollection.new(@archive_dir, @env)
+        collection.display
 
-    uri = URI.parse(versioned_path(str + '/' + @filename))
-    dst = File.join(@archive_dir, versioned_path(@filename))
+        raise PEBuild::ArchiveNoInstallerSource, :filename => versioned_path(@filename)
+      end
 
-    transfer = PEBuild::Transfer.generate(uri, dst)
-    transfer.copy
-  end
+      uri = URI.parse(versioned_path(str + '/' + @filename))
+      dst = File.join(@archive_dir, versioned_path(@filename))
 
-  # @param fs_dir [String] The base directory to extract the installer to
-  def unpack_to(fs_dir)
-    unless exist?
-      raise "Tried to unpack #{@filename} but it was not downloaded!"
+      transfer = PEBuild::Transfer.generate(uri, dst)
+      transfer.copy
     end
 
-    archive = PEBuild::Unpack.generate(archive_path, fs_dir)
-    idempotent(archive.creates, "Unpacked archive #{versioned_path filename}") do
-      archive.unpack
+    # @param fs_dir [String] The base directory to extract the installer to
+    def unpack_to(fs_dir)
+      unless exist?
+        raise PEBuild::ArchiveMissing, :filename => @filename
+      end
+
+      archive = PEBuild::Unpack.generate(archive_path, fs_dir)
+      begin
+        idempotent(archive.creates, "Unpacked archive #{versioned_path filename}") do
+          archive.unpack
+        end
+      rescue Zlib::GzipFile::Error => e
+        raise PEBuild::ArchiveUnreadable, :filename => @filename, :message => e.message
+      end
     end
-  end
 
-  def exist?
-    File.exist? archive_path
-  end
+    def exist?
+      File.exist? archive_path
+    end
 
-  def to_s
-    versioned_path(@filename)
-  end
+    def to_s
+      versioned_path(@filename)
+    end
 
-  def installer_dir
-    versioned_path(@filename).gsub(/.tar(?:\.gz)?/, '')
-  end
+    def installer_dir
+      versioned_path(@filename).gsub(/.tar(?:\.gz)?/, '')
+    end
 
-  private
+    private
 
-  # @return [String] The interpolated archive path
-  def archive_path
-    path = File.join(@archive_dir, @filename)
-    versioned_path(path)
-  end
+    # @return [String] The interpolated archive path
+    def archive_path
+      path = File.join(@archive_dir, @filename)
+      versioned_path(path)
+    end
 
-  def versioned_path(path)
-    if @version
-      path.gsub(/:version/, @version)
-    else
-      path
+    def versioned_path(path)
+      if @version
+        path.gsub(/:version/, @version)
+      else
+        path
+      end
     end
   end
 end
-end

data/lib/pe_build/archive_collection.rb

@@ -1,43 +1,42 @@
 require 'pe_build/archive'
 
 module PEBuild
+  class ArchiveCollection
 
-class ArchiveCollection
+    #ARCHIVE_REGEX = %r[puppet-enterprise-([\d.])-(.*?)\.(?:tar\.gz|msi)]
 
-  #ARCHIVE_REGEX = %r[puppet-enterprise-([\d.])-(.*?)\.(?:tar\.gz|msi)]
+    attr_reader :path
 
-  attr_reader :path
+    def initialize(path, env)
+      @path, @env = path, env
+      @archives = []
 
-  def initialize(path, env)
-    @path, @env = path, env
-    @archives = []
-
-    load_archives
-  end
+      load_archives
+    end
 
-  def archives
-    @archives
-  end
+    def archives
+      @archives
+    end
 
-  include Enumerable
-  def each(&blk)
-    @archives.each { |archive| yield archive }
-  end
+    include Enumerable
+    def each(&blk)
+      @archives.each { |archive| yield archive }
+    end
 
-  def display
-    @archives.each do |archive|
-      @env.ui.info "  - #{archive.filename}"
+    def display
+      @archives.each do |archive|
+        @env.ui.info "  - #{archive.filename}"
+      end
     end
-  end
 
-  private
+    private
 
-  def load_archives
-    dir = File.join(path, '*')
-    Dir.glob(dir).sort.each do |path|
-      basename = File.basename(path)
-      @archives << PEBuild::Archive.new(basename, @env)
+    def load_archives
+      dir = File.join(path, '*')
+      Dir.glob(dir).sort.each do |path|
+        basename = File.basename(path)
+        @archives << PEBuild::Archive.new(basename, @env)
+      end
     end
   end
 end
-end

data/lib/pe_build/config/pe_bootstrap.rb

@@ -25,14 +25,6 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
   # @api private
   VALID_ROLES = [:agent, :master]
 
-  # @!attribute step
-  #   @return [Hash<Symbol, String>] a hash whose keys are step levels, and whose
-  #                                  keys are directories to optional steps.
-  #   @deprecated This duplicates the behavior of the shell provider and will
-  #               be removed in a future release.
-  #   @since 0.1.0
-  attr_accessor :step
-
   # @!attribute relocate_manifests
   #   @return [TrueClass, FalseClass] if the puppet master should use manifests
   #                                   out of the vagrant directory.
@@ -65,17 +57,21 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
     @relocate_manifests = UNSET_VALUE
 
     @autosign = UNSET_VALUE
-
-    @step    = {}
   end
 
   include PEBuild::ConfigDefault
 
+  # Finalize all configuration variables
+  #
+  # @note This does _not_ finalize values for config options inherited from the
+  #   global configuration; it's assumed that the late configuration merging in
+  #   the provisioner will handle that.
   def finalize!
-    # This does _not_ set default values for config options inherited from the
-    # global configuration. If configuration is not set for a value on the
-    # global config or here it will be passed through as `UNSET_VALUE`, which
-    # is not ideal.
+
+    # The value of role is normalized to a symbol so that users don't have to
+    # know the underlying representation, and we don't have to cast everything
+    # to a string and symbols later on.
+    @role &&= @role.intern
 
     set_default :@role,        :agent
     set_default :@verbose,     true
@@ -86,21 +82,10 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
     set_default :@relocate_manifests, false
   end
 
-  # @deprecated This duplicates the behavior of the shell provider and will
-  #             be removed in a future release.
-  def add_step(name, script_path)
-    name = (name.is_a?(Symbol)) ? name : name.intern
-    step[name] = script_path
-  end
-
   # @param machine [Vagrant::Machine]
   def validate(machine)
     h = super
 
-    unless @step.empty?
-      machine.ui.warn I18n.t('pebuild.config.pe_bootstrap.steps_deprecated')
-    end
-
     errors = []
 
     validate_role(errors, machine)
@@ -123,9 +108,9 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
   end
 
   def validate_role(errors, machine)
-    unless VALID_ROLES.any? {|sym| @role == sym}
+    unless VALID_ROLES.any? {|sym| @role == sym.intern}
       errors << I18n.t(
-        'pebuild.config.pe_bootstrap.errors.unhandled_role',
+        'pebuild.config.pe_bootstrap.errors.unknown_role',
         :role        => @role.inspect,
         :known_roles => VALID_ROLES,
       )

data/lib/pe_build/config_builder/pe_bootstrap.rb

@@ -28,6 +28,18 @@ class PEBuild::ConfigBuilder::PEBootstrap < ::PEBuild::ConfigBuilder::Global
   #     remounted on the guest.
   def_model_attribute :relocate_manifests
 
+  # @!attribute [rw] autosign
+  #   Configure the certificates that will be autosigned by the puppet master.
+  #
+  #   @return [TrueClass] All CSRs will be signed
+  #   @return [FalseClass] The autosign config file will be unmanaged
+  #   @return [Array<String>] CSRs with the given addresses
+  #
+  #   @see http://docs.puppetlabs.com/guides/configuring.html#autosignconf
+  #
+  #   @since 0.4.0
+  def_model_attribute :autosign
+
   def to_proc
     Proc.new do |vm_config|
       vm_config.provision :pe_bootstrap do |pe|
@@ -42,6 +54,7 @@ class PEBuild::ConfigBuilder::PEBootstrap < ::PEBuild::ConfigBuilder::Global
         pe.master             = attr(:master)             if attr(:master)
         pe.answer_file        = attr(:answer_file)        if attr(:answer_file)
         pe.relocate_manifests = attr(:relocate_manifests) if attr(:relocate_manifests)
+        pe.autosign           = attr(:autosign)           if attr(:autosign)
       end
     end
   end

data/lib/pe_build/config_default.rb

@@ -1,16 +1,16 @@
 require 'vagrant'
 
 module PEBuild
-module ConfigDefault
+  module ConfigDefault
 
-  # @param [Symbol] iv The instance variable to set the default value
-  # @param [Object] default The default value
-  def set_default(iv, default)
-    iv_val = instance_variable_get(iv)
-    if iv_val == Vagrant::Plugin::V2::Config::UNSET_VALUE
-      instance_variable_set(iv, default)
+    # @param [Symbol] iv The instance variable to set the default value
+    # @param [Object] default The default value
+    def set_default(iv, default)
+      iv_val = instance_variable_get(iv)
+      if iv_val == Vagrant::Plugin::V2::Config::UNSET_VALUE
+        instance_variable_set(iv, default)
+      end
     end
+    private :set_default
   end
-  private :set_default
-end
 end

data/lib/pe_build/idempotent.rb

@@ -1,16 +1,16 @@
 module PEBuild
-module Idempotent
+  module Idempotent
 
-  # @param fpath [String]
-  # @param desc [String, nil]
-  def idempotent(fpath, desc = nil, &block)
-    desc ||= fpath
+    # @param fpath [String]
+    # @param desc [String, nil]
+    def idempotent(fpath, desc = nil, &block)
+      desc ||= fpath
 
-    if File.exist? fpath
-      @logger.info "#{desc} is already present."
-    else
-      yield
+      if File.exist? fpath
+        @logger.info "#{desc} is already present."
+      else
+        yield
+      end
     end
   end
 end
-end

data/lib/pe_build/provisioner/pe_bootstrap.rb

@@ -52,13 +52,9 @@ module PEBuild
         load_archive
         fetch_installer
 
-        [:base, @config.role].each { |rolename| process_step rolename, :pre }
-
         @machine.guest.capability('run_install', @config, @archive)
 
         run_postinstall_tasks
-
-        [:base, @config.role].each { |rolename| process_step rolename, :post }
       end
 
       private
@@ -102,38 +98,6 @@ module PEBuild
         @archive.unpack_to(@work_dir)
       end
 
-      require 'pe_build/on_machine'
-      include PEBuild::OnMachine
-
-      def process_step(role, stepname)
-
-        if role != :base && config.step[stepname]
-          if File.file? config.step[stepname]
-            script_list = [*config.step[stepname]]
-          else
-            script_list = []
-            @machine.ui.warn "Cannot find defined step for #{role}/#{stepname.to_s} at \'#{config.step[stepname]}\'"
-          end
-        else
-          # We do not have a user defined step for this role or we're processing the :base step
-          script_dir  = File.join(PEBuild.source_root, 'bootstrap', role.to_s, stepname.to_s)
-          script_list = Dir.glob("#{script_dir}/*")
-        end
-
-        if script_list.empty?
-          @logger.info "No steps for #{role}/#{stepname}"
-        end
-
-        script_list.each do |template_path|
-          # A message to show which step's action is running
-          @machine.ui.info "Running action for #{role}/#{stepname}"
-          template = File.read(template_path)
-          contents = ERB.new(template).result(binding)
-
-          on_machine(@machine, contents)
-        end
-      end
-
       def run_postinstall_tasks
         postinstall = PostInstall.new(@machine, @config, @work_dir)
         postinstall.run

data/lib/pe_build/unpack.rb

@@ -25,6 +25,5 @@ module PEBuild
       raise UnknownInstallerType, :src => src unless klass
       klass.new(src, dst)
     end
-
   end
 end

data/lib/pe_build/unpack/copy.rb

@@ -1,8 +1,7 @@
+require 'pe_build/unpack'
 require 'fileutils'
 
-module PEBuild
-module Unpack
-class Copy
+class PEBuild::Unpack::Copy
 
   # @param src [String]
   # @param dst [String]
@@ -21,5 +20,3 @@ class Copy
   end
 
 end
-end
-end

data/lib/pe_build/unpack/tar.rb

@@ -1,8 +1,7 @@
+require 'pe_build/unpack'
 require 'archive/tar/minitar'
 
-module PEBuild
-module Unpack
-class Tar
+class PEBuild::Unpack::Tar
 
   # @param src [String]
   # @param dst [String]
@@ -38,5 +37,3 @@ class Tar
     File.open(@src, 'rb')
   end
 end
-end
-end

data/lib/pe_build/unpack/tar_gz.rb

@@ -3,9 +3,7 @@ require 'pe_build/unpack/tar'
 
 require 'zlib'
 
-module PEBuild
-module Unpack
-class TarGZ < PEBuild::Unpack::Tar
+class PEBuild::Unpack::TarGZ < PEBuild::Unpack::Tar
 
   private
 
@@ -13,5 +11,3 @@ class TarGZ < PEBuild::Unpack::Tar
     Zlib::GzipReader.new(super)
   end
 end
-end
-end

data/lib/pe_build/util/config.rb

@@ -1,29 +1,29 @@
 module PEBuild
-module Util
-module Config
+  module Util
+    module Config
 
-  # Merge configuration classes together with the "local" object overwriting any
-  # values set in the "other" object. This uses the default merging in the Vagrant
-  # plugin config class. The builtin merge function is not straight forward however.
-  # It needs to be called on the object being overwritten. When using a subclass of
-  # a global config for a provisioner config, the builtin merge method cannot actually
-  # merge them in the direction that would be needed.
-  #
-  # This function assumes that the "local" object is of the same class or at the very
-  # least a subclass of "other".
-  #
-  # @param local [Vagrant::Plugin::V2::Config] Local configuration class to merge
-  # @param other [Vagrant::Plugin::V2::Config] Other configuration class to merge
-  # @return [Vagrant::Plugin::V2::Config] New object of the same class as Local that represents the merged result
-  #
-  def self.local_merge(local, other)
-    if other.class >= local.class
-      result = local.class.new
+      # Merge configuration classes together with the "local" object overwriting any
+      # values set in the "other" object. This uses the default merging in the Vagrant
+      # plugin config class. The builtin merge function is not straight forward however.
+      # It needs to be called on the object being overwritten. When using a subclass of
+      # a global config for a provisioner config, the builtin merge method cannot actually
+      # merge them in the direction that would be needed.
+      #
+      # This function assumes that the "local" object is of the same class or at the very
+      # least a subclass of "other".
+      #
+      # @param local [Vagrant::Plugin::V2::Config] Local configuration class to merge
+      # @param other [Vagrant::Plugin::V2::Config] Other configuration class to merge
+      # @return [Vagrant::Plugin::V2::Config] New object of the same class as Local that represents the merged result
+      #
+      def self.local_merge(local, other)
+        if other.class >= local.class
+          result = local.class.new
 
-      result = result.merge(other)
-      result = result.merge(local)
+          result = result.merge(other)
+          result = result.merge(local)
+        end
+      end
     end
   end
 end
-end
-end

data/lib/pe_build/version.rb

@@ -1,3 +1,3 @@
 module PEBuild
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/templates/locales/en.yml

@@ -7,6 +7,12 @@ en:
         mirror, or add the installer yourself by using the `vagrant pe-build copy`
         command. Downloads for Puppet Enterprise are available for download at
         https://puppetlabs.com/puppet/puppet-enterprise/
+      missing: |-
+        Tried to unpack %{filename} but it was not downloaded!
+      unreadable: |-
+        Failed to unpack %{filename}.
+        Archive corrupted or otherwise unreadable. The error message generated was:
+        "%{message}"
     provisioner:
       pe_bootstrap:
         post_install: |-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-pe_build
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progressbar