vagrant-pe_build 0.2.0 → 0.3.0

data/CHANGELOG

@@ -1,6 +1,65 @@
 vagrant-pe_build
 ================
 
+0.3.0
+-----
+
+2013-08-14
+
+This is a backwards compatible feature and bugfix release.
+
+### User notes:
+
+#### Enhancements:
+
+  * Puppet Enterprise 3 is now fully supported and should have answers that
+    work out of the box.
+  * (GH-25) The installer for a given platform will be detected based on the
+    guest platform, which means that the most precise installer will be used
+    instead of the `all` installer.
+  * pe_build.download_root now fully supports a local directory with URIs using
+    the "file" URI.
+  * As part of GH-25 pe_build.suffix defaults to detect, which will auto-select
+    the correct installer name
+
+#### Fixes:
+
+  * (GH-23) Removed double expansion of files when running `vagrant pe-build copy`
+  * (GH-24) Installer files are downloaded at provision time instead of before
+    VMs are constructed
+
+#### Deprecations:
+
+  * Shell scripts run with the `add_step` hash are deprecated and will be
+    removed in the next 'major development' release (either 0.4.0, 0.5.0,
+    or 1.0.0). This behavior is effectively provided by the `shell` provisioner.
+
+### Developer notes (AKA the gory details):
+
+  * Informational logging has been expanded and is directed to the Vagrant
+    internal loggers.
+  * Answers file generation has been extracted out of the pe_bootstrap
+    provisioner and into an independent class to respect the single
+    responsibility principle.
+  * New guest capability: "detect_installer" detects the correct installer
+    for the given guest platform. Initial supported platforms are Debian,
+    Ubuntu, and Redhat.
+  * New guest capability: "run_install" extracts the actual command generation
+    and execution to install PE on a guest. Initial supported platforms are
+    Linux and Solaris.
+  * Installer file transfer has been fully extracted from the PEBuild::Archive
+    class and pushed into pe_build/transfer classes.
+  * File transfer behavior has been abstracted behind the PEBuild::Transfer
+    module and the implementing class is selected based on the scheme of the
+    requested URI.
+  * Almost everything ever has been beaten with the refactor hammer.
+
+### Thanks
+
+  * Thanks to Tom Linkin as always for his awesome work and contributions to
+    this plugin.
+  * Thanks to Jon Mosco for reporting GH-23.
+
 0.2.0
 -----
 

data/README.markdown

@@ -9,25 +9,168 @@ Synopsis
 `vagrant-pe_build` manages the downloading and installation of Puppet Enterprise
 on Vagrant boxes to rapidly build a functioning Puppet environment.
 
-Usage
------
+Vagrantfile Settings
+-------------------
+
+#### Config Namespace `config.pe_build`
+
+These settings go in the config object namespace and act as defaults in
+the event multiple machines are being provisioned. These settings are
+optional and can be overridden in a VM's individual provisioner config.
+
+  * `config.pe_build.version`
+    * Description: The version of Puppet Enterprise to install.
+  * `config.pe_build.suffix` - Suffix of the Puppet Enterprise installer to use.
+    * Description: The distribution specifix suffix of the Puppet Enterprise
+      installer to use.
+    * Default: `:detect`
+  * `config.pe_build.filename`
+    * Description: The filename of the Puppet Enterprise installer.
+    * Default: this will use the version and suffix provided to guess a filename
+      of the form `puppet-enterprise-<version>-<suffix>.tar.gz`.
+  * `config.pe_build.download_root`
+    * Description: The URI to the directory containing Puppet Enterprise
+      installers if the installer is not yet cached. This setting is optional.
+    * Supported URI schemes:
+      * http
+      * https
+      * ftp
+      * file
+      * A blank URI will default to `file`.
+
+#### Provisioner Namespace
+
+These settings are on a per provisioner basis. They configure the individual
+behaviors of the provisioner. All of the `config.pe_build` options can be
+overridden at this point.
+
+  * `role`
+    * Description: The role of the Puppet Enterprise install.
+    * Options: `:agent`, `:master`
+    * Default: `:agent`
+  * `verbose`
+    * Description: Whether or not to show the verbose output of the Puppet
+      Enterprise install.
+    * Options: `true`, `false`
+    * Default: `true`
+  * `master`
+    * Description: The address of the puppet master
+    * Default: `master`
+  * `answer_file`
+    * Description: The location of alternate answer file for PE installation.
+      Values can be paths relative to the Vagrantfile's project directory.
+    * Default: The default answer file for the Puppet Enterprise version and
+      role.
+  * `relocate_manifests`
+    * Description: Whether or not to change the PE master to use a config of
+      `manifestdir=/manifests` and `modulepath=/modules`. This is meant to be
+      used when the vagrant working directory manifests and modules are
+      remounted on the guest.
+    * Options: `true`, `false`
+    * Default: `false`
+
+Commands
+--------
+
+Usage Example
+-------------
+
+### Minimal configuration
+
+This requires that the necessary installers have already been downloaded and
+added with `vagrant pe-build copy`.
 
     Vagrant.configure('2') do |config|
+      config.pe_build.version = '3.0.0'
+
+      config.vm.define 'master' do |node|
+        node.vm.box = 'centos-6-i386'
+
+        node.vm.provision :pe_bootstrap do |provisioner|
+          provisioner.role = :master
+        end
+      end
+
+      config.vm.define 'agent1' do |node|
+        node.vm.box = 'centos-6-i386'
+        node.vm.provision :pe_bootstrap
+        end
+      end
+    end
+
+### Specifying a download root
+
+    Vagrant.configure('2') do |config|
+      config.pe_build.version = '3.0.0'
       config.pe_build.download_root = 'http://my.pe.download.mirror/installers'
-      config.pe_build.version       = '2.7.0'
-      config.pe_build.filename      = 'puppet-enterprise-2.7.0-all.tar.gz'
+
+      # Alternately, a local directory can be specified
+      #config.pe_build.download_root = 'file://Users/luke/Downloads'
 
       config.vm.define 'master' do |node|
+        node.vm.box = 'centos-6-i386'
+
         node.vm.provision :pe_bootstrap do |provisioner|
           provisioner.role = :master
         end
       end
 
       config.vm.define 'agent1' do |node|
+        node.vm.box = 'centos-6-i386'
+
+        node.vm.provision :pe_bootstrap
+      end
+    end
+
+### Using a manual answers file
+
+    Vagrant.configure('2') do |config|
+      config.pe_build.version = '3.0.0'
+      config.pe_build.download_root = 'http://my.pe.download.mirror/installers'
+
+      # Alternately, a local directory can be specified
+      #config.pe_build.download_root = 'file://Users/luke/Downloads'
+
+      config.vm.define 'master' do |node|
+        node.vm.box = 'centos-6-i386'
+
+        node.vm.provision :pe_bootstrap do |provisioner|
+          provisioner.role = :master
+          provisioner.answer_file = 'answers/vagrant_master.answers.txt'
+        end
+      end
+
+      config.vm.define 'agent1' do |node|
+        node.vm.box = 'centos-6-i386'
+
+        node.vm.provision :pe_bootstrap
+      end
+    end
+
+### Manually setting a filename
+
+    Vagrant.configure('2') do |config|
+      config.pe_build.version  = '3.0.0'
+      config.pe_build.filename = 'puppet-enterprise-3.0.0-all.tar.gz'
+
+      # Alternately, a local directory can be specified
+      #config.pe_build.download_root = 'file://Users/luke/Downloads'
+
+      config.vm.define 'master' do |node|
+        node.vm.box = 'centos-6-i386'
+
         node.vm.provision :pe_bootstrap do |provisioner|
-          provisioner.role = :agent
+          provisioner.role = :master
+          provisioner.answer_file = 'answers/vagrant_master.answers.txt'
         end
       end
+
+      config.vm.define 'agent1' do |node|
+        node.vm.box = 'centos-6-i386'
+
+        node.vm.provision :pe_bootstrap do |provisioner|
+          provisioner.role = :agent end
+      end
     end
 
 Requirements

data/lib/pe_build.rb

@@ -2,6 +2,11 @@ require 'vagrant'
 
 module PEBuild
 
+  require 'pe_build/plugin'
+  require 'pe_build/version'
+
+  WORK_DIR = '.pe_build'
+
   # Return the path to the archived PE builds
   #
   # @param env [Vagrant::Environment]
@@ -20,6 +25,3 @@ end
 
 # I18n to load the en locale
 I18n.load_path << File.expand_path("locales/en.yml", PEBuild.template_dir)
-
-require 'pe_build/plugin'
-require 'pe_build/version'

data/lib/pe_build/action.rb

@@ -0,0 +1,5 @@
+module PEBuild
+  module Action
+    require 'pe_build/action/pe_build_dir'
+  end
+end

data/lib/pe_build/action/pe_build_dir.rb

@@ -0,0 +1,18 @@
+# Set up the PE build cache dir
+class PEBuild::Action::PEBuildDir
+
+  def initialize(app, env)
+    @app, @env = app, env
+
+    @build_dir = @env[:home_path].join('pe_builds')
+  end
+
+  def call(env)
+    @env = env
+
+    @build_dir.mkpath unless @build_dir.exist?
+    @env[:pe_build_dir] = @build_dir
+
+    @app.call(@env)
+  end
+end

data/lib/pe_build/archive.rb

@@ -2,13 +2,10 @@ require 'pe_build'
 require 'pe_build/idempotent'
 require 'pe_build/archive_collection'
 
-require 'pe_build/transfer/file'
-require 'pe_build/transfer/uri'
+require 'pe_build/transfer'
 
 require 'pe_build/unpack/tar'
 
-require 'fileutils'
-
 module PEBuild
 
 class ArchiveNoInstallerSource < Vagrant::Errors::VagrantError
@@ -35,69 +32,65 @@ class Archive
   def initialize(filename, env)
     @filename = filename
     @env      = env
-  end
 
-  # @param fs_dir [String] The base directory to extract the installer to
-  def unpack_to(fs_dir)
-    tar  = PEBuild::Unpack::Tar.new(archive_path, fs_dir)
-    path = File.join(fs_dir, tar.dirname)
+    @archive_dir = PEBuild.archive_directory(@env)
 
-    idempotent(path, "Unpacked archive #{versioned_path filename}") do
-      tar.unpack
-    end
+    @logger = Log4r::Logger.new('vagrant::pe_build::archive')
   end
 
-  # @param fs_dir [String] The base directory holding the archive
-  def copy_from(fs_dir)
-    file_path = versioned_path(File.join(fs_dir, filename))
+  # @param base_uri [String] A string representation of the download source URI
+  def fetch(str)
+    return if self.exist?
+
+    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:"
 
-    idempotent(archive_path, "Installer #{versioned_path @filename}") do
-      prepare_for_copy!
-      transfer = PEBuild::Transfer::File.new(file_path, archive_path)
-      transfer.copy
+      collection = PEBuild::ArchiveCollection.new(@archive_dir, @env)
+      collection.display
+
+      raise PEBuild::ArchiveNoInstallerSource, :filename => versioned_path(@filename)
     end
-  end
 
-  # @param download_dir [String] The URL base containing the archive
-  def download_from(download_dir)
-    idempotent(archive_path, "Installer #{versioned_path @filename}") do
-      if download_dir.nil?
-        @env.ui.error "Installer #{versioned_path @filename} is not available."
+    uri = URI.parse(versioned_path(str + '/' + @filename))
+    dst = File.join(@archive_dir, versioned_path(@filename))
 
-        archive_dir = PEBuild.archive_directory(@env)
+    transfer = PEBuild::Transfer.generate(uri, dst)
+    transfer.copy
+  end
 
-        collection = PEBuild::ArchiveCollection.new(archive_dir, @env)
-        collection.display
+  # @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!"
+    end
 
-        raise PEBuild::ArchiveNoInstallerSource
-      else
-        str = versioned_path("#{download_dir}/#{@filename}")
+    tar  = PEBuild::Unpack::Tar.new(archive_path, fs_dir)
+    path = File.join(fs_dir, tar.dirname)
 
-        prepare_for_copy!
-        transfer = PEBuild::Transfer::URI.new(str, archive_path)
-        transfer.copy
-      end
+    idempotent(path, "Unpacked archive #{versioned_path filename}") do
+      tar.unpack
     end
   end
 
-  private
+  def exist?
+    File.exist? archive_path
+  end
 
-  # Initialize the PE directory
-  #
-  # @todo respect Vagrant home setting
-  def prepare_for_copy!
-    archive_dir = PEBuild.archive_directory(@env)
+  def to_s
+    versioned_path(@filename)
+  end
 
-    if not File.directory? archive_dir
-      FileUtils.mkdir_p archive_dir
-    end
+  def installer_dir
+    versioned_path(@filename).gsub('.tar.gz', '')
   end
 
+  private
 
   # @return [String] The interpolated archive path
   def archive_path
-    archive_dir = PEBuild.archive_directory(@env)
-    path = File.join(archive_dir, @filename)
+    path = File.join(@archive_dir, @filename)
     versioned_path(path)
   end
 

data/lib/pe_build/cap.rb

@@ -0,0 +1,17 @@
+module PEBuild
+  module Cap
+    module DetectInstaller
+      require 'pe_build/cap/detect_installer/base'
+      require 'pe_build/cap/detect_installer/posix'
+
+      require 'pe_build/cap/detect_installer/redhat'
+      require 'pe_build/cap/detect_installer/debian'
+      require 'pe_build/cap/detect_installer/ubuntu'
+      #require 'pe_build/cap/detect_installer/suse'
+    end
+
+    module RunInstall
+      require 'pe_build/cap/run_install/posix'
+    end
+  end
+end

data/lib/pe_build/cap/detect_installer/base.rb

@@ -0,0 +1,15 @@
+class PEBuild::Cap::DetectInstaller::Base
+
+  def self.detect_installer(machine, version)
+    new(machine, version).detect
+  end
+
+  def initialize(machine, version)
+    @machine, @version = machine, version
+  end
+
+  # @!method detect
+  #   Return the installer for the given operating system
+  #   @abstract
+  #   @return [String] The installer for the given operating system
+end

data/lib/pe_build/cap/detect_installer/debian.rb

@@ -0,0 +1,23 @@
+class PEBuild::Cap::DetectInstaller::Debian < PEBuild::Cap::DetectInstaller::POSIX
+
+  def name
+    'debian'
+  end
+
+  def release_file
+    '/etc/debian_version'
+  end
+
+  def release_file_format
+    %r[^(\d+)\.]
+  end
+
+  def supported_releases
+    %w[6 7]
+  end
+
+  def arch
+    retval = super
+    (retval == 'x86_64') ? 'amd64' : retval
+  end
+end