vagrant-pe_build 0.8.8 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26ad8e09d5195df162062a92008f936da3e1316e
-  data.tar.gz: 2067738932a5c776891cd8e5e1c91e2d04f0a776
+  metadata.gz: 269bf2fbb29c95381a0977397d40d4035c4a51e0
+  data.tar.gz: e50cff262ba84a0782fe50dedf575a3afc783574
 SHA512:
-  metadata.gz: 18a14310e0a59027daa2663ecc7f75cc7c43e10d686edaa0c4ef0b11dd1abda0d9edbff04e1f1b43741d4f8d176d11a0e01ca567364956345c46bbbe4b6c216c
-  data.tar.gz: 0b44acedc878665142f36a427f59fbd21073645d0da7a5b94490adfdedb0539b7d1ad40db24e6c37f302f0cdb63fbbd4363dd8df84a2b0814fe6963886b53f73
+  metadata.gz: b25346e8a16ddd1005c5e6bcec8e86a585b255227fff9b5266a732013d9d7dddee4a9c229867010af66fb7b1868b53bbea2236eab4522e5b8a814b5d23ed0809
+  data.tar.gz: 8064eaebceb1ec8e12d11bf9c9d4ad5e22e0cc1b3b4db9524f2d390e9953abf5013791042e440c104940e05c1e5629d1ea5b5f6c2aca0f3f90d15509ddfbe867

data/.gitignore

@@ -1 +1,9 @@
+.bundle
+.ruby-version
+.yardoc
 /doc
+/acceptance/artifacts
+Gemfile.lock
+Gemfile.local
+*.gem
+vagrant-spec.config.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG

@@ -1,6 +1,18 @@
 vagrant-pe_build
 ================
 
+0.9.0
+-----
+
+2014-07-09
+
+This is a backwards compatible feature release.
+
+  * Add two new config attributes, `version_file` and `series`, that add
+    flexibility to the installation location.
+  * Internal code cleanup and re-organization.
+  * Add unit and acceptance tests.
+
 0.8.8
 -----
 

data/Gemfile

@@ -1,19 +1,28 @@
 source 'https://rubygems.org'
+ruby '2.0.0' # Required by Vagrant 1.4 and newer.
 
-gemspec
+ENV['TEST_VAGRANT_VERSION'] ||= 'v1.6.3'
+
+# Wrapping gemspec in the :plugins group causes Vagrant 1.5 and newer to
+# automagically load this plugin during acceptance tests.
+group :plugins do
+  gemspec
+end
 
 group :doc do
   gem 'yard', '~> 0.8.7'
   gem 'redcarpet'
 end
 
-group :development do
-  # We depend on Vagrant for development, but we don't add it as a
-  # gem dependency because we expect to be installed within the
-  # Vagrant environment itself using `vagrant plugin`.
-  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git", :tag => 'v1.4.0'
-end
+group :test do
+  if ENV['TEST_VAGRANT_VERSION'] == 'HEAD'
+    gem 'vagrant', :github => 'mitchellh/vagrant', :branch => 'master'
+  else
+    gem 'vagrant', :github => 'mitchellh/vagrant', :tag => ENV['TEST_VAGRANT_VERSION']
+  end
 
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
+  # Pinned on 05/05/2014. Compatible with Vagrant 1.5.x and 1.6.x.
+  gem 'vagrant-spec', :github => 'mitchellh/vagrant-spec', :ref => 'aae28ee'
 end
+
+eval_gemfile "#{__FILE__}.local" if File.exists? "#{__FILE__}.local"

data/README.markdown

@@ -177,6 +177,8 @@ Requirements
 
 [vagranthosts]: https://github.com/adrienthebo/vagrant-hosts
 
+Ensure VMs have a FQDN set before installing PE. The easiest way to do this is by setting the `hostname` attribute of the VM configuration.
+
 Puppet Enterprise relies on SSL for security so you'll need to ensure that your
 SSL configuration isn't borked. [vagrant-hosts][vagranthosts] is recommended to
 configure VMs with semi-sane DNS.

data/Rakefile

@@ -0,0 +1,5 @@
+task_dir = File.expand_path('../tasks', __FILE__)
+
+Dir["#{task_dir}/**/*.rake"].each do |task_file|
+  load task_file
+end

data/acceptance/pe_build/pe_build_spec.rb

@@ -0,0 +1,50 @@
+shared_examples 'provider/provisioner/pe_build' do |provider, options|
+  if !File.file?(options[:box])
+    raise ArgumentError,
+      "A box file must be downloaded for provider: #{provider}. Try: rake acceptance:setup"
+  end
+
+  include_context 'acceptance'
+
+  before(:each) do
+    environment.skeleton('pe_build')
+    assert_execute('vagrant', 'box', 'add', 'box', options[:box])
+  end
+
+  after(:each) do
+    # Ensure any VMs that survived tests are cleaned up.
+    assert_execute('vagrant', 'destroy', '--force', log: false)
+  end
+
+  context 'when download_root is set to a local directory' do
+    let(:extra_env) do
+      vars = options[:env_vars].dup
+      vars['PE_BUILD_DOWNLOAD_ROOT'] = options[:archive_path]
+
+      vars
+    end
+
+    it 'provisions with pe_build' do
+      assert_execute('vagrant', 'up', "--provider=#{provider}", 'explicit-version')
+      assert_execute('vagrant', 'up', "--provider=#{provider}", 'latest-version')
+    end
+  end
+
+  context 'when download_root is set to a webserver' do
+    let(:webserver_port) { 3838 }
+    let(:webserver_path) { options[:archive_path] }
+    include_context 'webserver'
+
+    let(:extra_env) do
+      vars = options[:env_vars].dup
+      vars['PE_BUILD_DOWNLOAD_ROOT'] = "http://localhost:#{webserver_port}/"
+
+      vars
+    end
+
+    it 'provisions with pe_build' do
+      assert_execute('vagrant', 'up', "--provider=#{provider}", 'explicit-version')
+      assert_execute('vagrant', 'up', "--provider=#{provider}", 'latest-version')
+    end
+  end
+end

data/acceptance/skeletons/pe_build/Vagrantfile

@@ -0,0 +1,24 @@
+Vagrant.configure('2') do |config|
+  config.pe_build.download_root = ENV['PE_BUILD_DOWNLOAD_ROOT']
+  config.vm.box = 'box'
+
+  config.vm.define 'explicit-version' do |node|
+    node.vm.provision :pe_bootstrap do |p|
+      p.version = '3.2.3'
+      p.role = :agent
+      # Basically the stock answer file with:
+      #   q_fail_on_unsuccessful_master_lookup=n
+      p.answer_file = File.join(File.dirname(__FILE__), 'agent-3.x.txt.erb')
+    end
+  end
+
+  config.vm.define 'latest-version' do |node|
+    node.vm.provision :pe_bootstrap do |p|
+      p.version_file = 'LATEST'
+      p.role = :agent
+      # Basically the stock answer file with:
+      #   q_fail_on_unsuccessful_master_lookup=n
+      p.answer_file = File.join(File.dirname(__FILE__), 'agent-3.x.txt.erb')
+    end
+  end
+end

data/acceptance/skeletons/pe_build/agent-3.x.txt.erb

@@ -0,0 +1,17 @@
+q_fail_on_unsuccessful_master_lookup=y
+q_install=y
+q_puppet_cloud_install=n
+q_puppet_enterpriseconsole_install=n
+q_puppet_symlinks_install=y
+q_puppetagent_certname=<%= machine_hostname %>
+q_puppetagent_install=y
+q_puppetagent_server=<%= @config.master %>
+q_puppetca_install=n
+q_puppetdb_hostname=
+q_puppetdb_install=n
+q_puppetdb_port=
+q_puppetmaster_install=n
+q_vendor_packages_install=y
+q_continue_or_reenter_master_hostname=c
+q_verify_packages=y
+q_fail_on_unsuccessful_master_lookup=n

data/lib/pe_build/archive.rb

@@ -27,6 +27,11 @@ module PEBuild
     #   @return [String] The version of Puppet Enterprise
     attr_accessor :version
 
+    # (see PEBuild::Config::Global#series)
+    #
+    # @see PEBuild::Config::Global#series
+    attr_accessor :series
+
     # @!attribute [rw] filename
     #   @return [String] The filename. Thing
     attr_accessor :filename
@@ -62,8 +67,7 @@ module PEBuild
       uri = URI.parse(versioned_path("#{str}/#{@filename}"))
       dst = File.join(@archive_dir, versioned_path(@filename))
 
-      transfer = PEBuild::Transfer.generate(uri, dst)
-      transfer.copy
+      PEBuild::Transfer.copy(uri, dst)
     end
 
     # @param fs_dir [String] The base directory to extract the installer to
@@ -103,11 +107,11 @@ module PEBuild
     end
 
     def versioned_path(path)
-      if @version
-        path.gsub(/:version/, @version)
-      else
-        path
-      end
+      result = path.dup
+      result.gsub!(/:version/, @version) if @version
+      result.gsub!(/:series/, @series) if @series
+
+      result
     end
   end
 end

data/lib/pe_build/config/global.rb

@@ -6,20 +6,49 @@ require 'uri'
 class PEBuild::Config::Global < Vagrant.plugin('2', :config)
 
   # @!attribute download_root
+  #   @return [String] The root URI from which to download packages. The URI
+  #     scheme must be one of the values listed in {PEBuild::Transfer::IMPLEMENTATIONS}.
+  #   @since 0.1.0
   attr_accessor :download_root
 
   # @!attribute version
+  #   @return [String] The version of PE to install. Must conform to
+  #     `x.y.x[-optional-arbitrary-stuff]`. Used to determine the name of the
+  #     PE installer archive if {#filename} is unset.
+  #   @since 0.1.0
   attr_accessor :version
 
+  # @!attribute version_file
+  #   @return [String] The path to a file relative to {#download_root}. The
+  #     contents of this file will be read and used to specify {#version}.
+  #   @since 0.9.0
+  attr_accessor :version_file
+
+  # @!attribute series
+  #   @return [String] The release series of PE. Completely optional and
+  #     currently has no effect other than being an interpolation token
+  #     available for use in {#download_root}.
+  #
+  #   @since 0.9.0
+  attr_accessor :series
+
   # @!attribute suffix
+  #   @return [String] The distribution specifix suffix of the Puppet
+  #     Enterprise installer to use.
+  #   @since 0.1.0
   attr_accessor :suffix
 
   # @!attribute filename
+  #   @return [String] The exact name of the PE installer archive. If missing,
+  #     a name will be constructed from {#version}.
+  #   @since 0.1.0
   attr_accessor :filename
 
   def initialize
     @download_root = UNSET_VALUE
     @version       = UNSET_VALUE
+    @version_file  = UNSET_VALUE
+    @series        = UNSET_VALUE
     @suffix        = UNSET_VALUE
     @filename      = UNSET_VALUE
   end
@@ -27,12 +56,14 @@ class PEBuild::Config::Global < Vagrant.plugin('2', :config)
   include PEBuild::ConfigDefault
 
   def finalize!
+    set_default :@version, nil
+    set_default :@version_file, nil
+    set_default :@series, nil
     set_default :@suffix, :detect
     set_default :@download_root, nil
     set_default :@filename, nil
   end
 
-  # @todo Convert error strings to I18n
   def validate(machine)
     errors = []
 
@@ -61,7 +92,7 @@ class PEBuild::Config::Global < Vagrant.plugin('2', :config)
       if !(@version.match PE_VERSION_REGEX)
         errors << errmsg
       end
-    elsif @version != UNSET_VALUE
+    elsif @version != nil
       errors << errmsg
     end
   end

data/lib/pe_build/config/pe_bootstrap.rb

@@ -68,6 +68,10 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
   #   the provisioner will handle that.
   def finalize!
 
+    # NOTE: The version default is copied from Config::Global. Can't call
+    # `super` here as it does weird things to `download_root`.
+    set_default :@version,     nil
+
     set_default :@role,        :agent
     set_default :@verbose,     true
     set_default :@master,      'master'
@@ -83,7 +87,6 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
     # We also need to run this after a default was set, otherwise we'll try to
     # normalize UNSET_VALUE
     @role = @role.intern
-
   end
 
   # @param machine [Vagrant::Machine]
@@ -105,12 +108,6 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
 
   private
 
-  def validate_version(errors, machine)
-    if @version == UNSET_VALUE and global_config_from(machine).pe_build.version == UNSET_VALUE
-      errors << I18n.t('pebuild.config.pe_bootstrap.errors.unset_version')
-    end
-  end
-
   def validate_role(errors, machine)
     unless VALID_ROLES.any? {|sym| @role == sym.intern}
       errors << I18n.t(
@@ -164,21 +161,4 @@ class PEBuild::Config::PEBootstrap < PEBuild::Config::Global
       )
     end
   end
-
-  # Safely access the global config
-  def global_config_from(machine)
-    case Vagrant::VERSION
-    when /^1\.[1234]/
-      # If we try to access the global config object directly from a validating
-      # machine, horrible things happen. To avoid this we access the environment's
-      # global config which should already be finalized.
-      env = machine.env.config_global
-    else # Vagrant 1.5.x and above
-      # This kinda seemed like the most direct replacement for config_global,
-      # but turned out not to really work. Returned a dummy object of some
-      # kind.
-      #env = vagrantfile.config
-      env = machine.config
-    end
-  end
 end

data/lib/pe_build/config_builder/global.rb

@@ -6,6 +6,20 @@ class PEBuild::ConfigBuilder::Global < ::ConfigBuilder::Model::Base
   #   @return [String] The version of Puppet Enterprise to install.
   def_model_attribute :version
 
+  # @!attribute [rw] version_file
+  #   @return [String] The path to a file relative to {#download_root}. The
+  #     contents of this file will be read and used to specify {#version}.
+  #   @since 0.9.0
+  def_model_attribute :version_file
+
+  # @!attribute [rw] series
+  #   @return [String] The release series of PE. Completely optional and
+  #     currently has no effect other than being an interpolation token
+  #     available for use in {#download_root}.
+  #
+  #   @since 0.9.0
+  def_model_attribute :series
+
   # @!attribute [rw] suffix
   #   @return [String] The distribution specifix suffix of the Puppet
   #     Enterprise installer to use.
@@ -24,6 +38,8 @@ class PEBuild::ConfigBuilder::Global < ::ConfigBuilder::Model::Base
     Proc.new do |global_config|
       global_config.pe_build.download_root = attr(:download_root) if attr(:download_root)
       global_config.pe_build.version       = attr(:version)       if attr(:version)
+      global_config.pe_build.version_file  = attr(:version_file)  if attr(:version_file)
+      global_config.pe_build.series        = attr(:series)        if attr(:series)
       global_config.pe_build.suffix        = attr(:suffix)        if attr(:suffix)
       global_config.pe_build.filename      = attr(:filename)      if attr(:filename)
     end

data/lib/pe_build/config_builder/pe_bootstrap.rb

@@ -46,6 +46,8 @@ class PEBuild::ConfigBuilder::PEBootstrap < ::PEBuild::ConfigBuilder::Global
         # Globally settable attributes
         pe.download_root = attr(:download_root) if attr(:download_root)
         pe.version       = attr(:version)       if attr(:version)
+        pe.version_file  = attr(:version_file)  if attr(:version_file)
+        pe.series        = attr(:series)        if attr(:series)
         pe.suffix        = attr(:suffix)        if attr(:suffix)
         pe.filename      = attr(:filename)      if attr(:filename)
 

data/lib/pe_build/provisioner/pe_bootstrap.rb

@@ -2,6 +2,7 @@ require 'vagrant'
 
 require 'pe_build/archive'
 require 'pe_build/util/config'
+require 'pe_build/util/versioned_path'
 
 require 'log4r'
 require 'fileutils'
@@ -13,6 +14,10 @@ module PEBuild
       require 'pe_build/provisioner/pe_bootstrap/answers_file'
       require 'pe_build/provisioner/pe_bootstrap/post_install'
 
+      class UnsetVersionError < Vagrant::Errors::VagrantError
+        error_key(:unset_version, 'pebuild.provisioner.pe_bootstrap.errors')
+      end
+
       # @!attribute [r] work_dir
       #   @return [String] The path to the machine pe_build working directory
 
@@ -81,6 +86,15 @@ module PEBuild
       end
 
       def load_archive
+        # If a version file is set, use its contents to specify the PE version.
+        unless @config.version_file.nil?
+          path = "#{@config.download_root}/#{@config.version_file}"
+          path = PEBuild::Util::VersionedPath.versioned_path(path, @config.version, @config.series)
+          @config.version = PEBuild::Transfer.read(URI.parse(path))
+        end
+
+        raise UnsetVersionError if @config.version.nil?
+
         if @config.suffix == :detect and @config.filename.nil?
           filename = @machine.guest.capability('detect_installer', @config.version)
         else
@@ -88,6 +102,7 @@ module PEBuild
         end
 
         @archive = PEBuild::Archive.new(filename, @machine.env)
+        @archive.series = @config.series
         @archive.version = @config.version
       end
 

data/lib/pe_build/transfer.rb

@@ -16,11 +16,31 @@ module PEBuild
       nil     => PEBuild::Transfer::File, # Assume that URIs without a scheme are files
     }
 
-    def self.generate(src, dst)
+    # @param src [URI] The local file path path to the file to copy
+    # @param dst [String] The path to destination of the copied file
+    def self.copy(src, dst)
       scheme = src.scheme
 
-      if (klass = IMPLEMENTATIONS[scheme])
-        klass.new(src, dst)
+      if (mod = IMPLEMENTATIONS[scheme])
+        mod.copy(src, dst)
+      else
+        raise UnhandledURIScheme, :scheme => scheme,
+                                  :supported => IMPLEMENTATIONS.keys
+      end
+    end
+
+    # Return the contents of a local or remote file.
+    #
+    # @param src [URI] The URI of the source file.
+    # @raises [UnhandledURIScheme] If the URI uses an unsupported scheme.
+    # @return [String] The contents of the source file.
+    #
+    # @since 0.9.0
+    def self.read(src)
+      scheme = src.scheme
+
+      if (mod = IMPLEMENTATIONS[scheme])
+        mod.read(src)
       else
         raise UnhandledURIScheme, :scheme => scheme,
                                   :supported => IMPLEMENTATIONS.keys
@@ -28,4 +48,3 @@ module PEBuild
     end
   end
 end
-

data/lib/pe_build/transfer/file.rb

@@ -1,20 +1,26 @@
 require 'fileutils'
 require 'pe_build/idempotent'
 
-class PEBuild::Transfer::File
+# @todo These methods fail in a messy way if something goes wrong. They should
+#   be refactored to raise proper errors.
+# @api private
+module PEBuild::Transfer::File
+  extend PEBuild::Idempotent
 
   # @param src [URI] The local file path path to the file to copy
   # @param dst [String] The path to destination of the copied file
-  def initialize(uri, dst)
-    @src = uri.path
-    @dst = dst
-
-    @logger = Log4r::Logger.new('vagrant::pe_build::transfer::file')
+  def self.copy(src, dst)
+    idempotent(dst) { FileUtils.cp src.path, dst }
   end
 
-  include PEBuild::Idempotent
-
-  def copy
-    idempotent(@dst) { FileUtils.cp @src, @dst }
+  # @param src [URI] The local file path path to the file to read
+  # @return [String] The contents of the file with leading and trailing
+  #   whitespace removed.
+  #
+  # @since 0.9.0
+  def self.read(src)
+    File.read(src.path).strip
   end
+
+  # TODO: Raise an appropriate exception when files do not exist.
 end

data/lib/pe_build/transfer/open_uri.rb

@@ -4,7 +4,11 @@ require 'pe_build/idempotent'
 require 'open-uri'
 require 'progressbar'
 
-class PEBuild::Transfer::OpenURI
+# @api private
+module PEBuild::Transfer::OpenURI
+  extend PEBuild::Idempotent
+
+  HEADERS = {'User-Agent' => "Vagrant/PEBuild (v#{PEBuild::VERSION})"}
 
   class DownloadFailed < Vagrant::Errors::VagrantError
     error_key(:download_failed, 'pebuild.transfer.open_uri')
@@ -12,36 +16,37 @@ class PEBuild::Transfer::OpenURI
 
   # @param uri [URI]    The http(s) URI to the file to copy
   # @param dst [String] The path to destination of the copied file
-  def initialize(uri, dst)
-    @uri, @dst = uri, dst
-
-    @logger = Log4r::Logger.new('vagrant::pe_build::transfer::open_uri')
-  end
-
-  include PEBuild::Idempotent
-
-  def copy
-    idempotent(@dst) do
-      tmpfile = download_file
-      FileUtils.mv(tmpfile, @dst)
+  def self.copy(uri, dst)
+    idempotent(dst) do
+      tmpfile = download_file(uri)
+      FileUtils.mv(tmpfile, dst)
     end
   rescue StandardError => e
-    raise DownloadFailed, :uri => @uri, :msg => e.message
+    raise DownloadFailed, :uri => uri, :msg => e.message
   end
 
-  HEADERS = {'User-Agent' => "Vagrant/PEBuild (v#{PEBuild::VERSION})"}
-
-  private
+  # @param uri [URI] The http(s) URI to the file to copy
+  # @return [String] The contents of the file with leading and trailing
+  #   whitespace removed.
+  #
+  # @since 0.9.0
+  def self.read(uri)
+    uri.read(HEADERS.merge({'Accept' => 'text/plain'})).strip
+  rescue StandardError => e
+    raise DownloadFailed, :uri => uri, :msg => e.message
+  end
 
   # Open a open-uri file handle for the given URL
   #
+  # @param uri [URI]
   # @return [IO]
-  def download_file
+  def self.download_file(uri)
     progress = nil
 
     content_length_proc = lambda do |length|
       if length and length > 0
-        progress = ProgressBar.new('Fetching file', length)
+        STDERR.puts "Fetching: #{uri}"
+        progress = ProgressBar.new("Fetching file", length, STDERR)
         progress.file_transfer_mode
       end
     end
@@ -55,8 +60,6 @@ class PEBuild::Transfer::OpenURI
       :progress_proc       => progress_proc,
     })
 
-    @logger.info "Fetching file from #{@uri}"
-
-    @uri.open(options)
+    uri.open(options)
   end
 end

data/lib/pe_build/util/versioned_path.rb

@@ -0,0 +1,33 @@
+module PEBuild
+  module Util
+    # @api private
+    #
+    # @since 0.9.0
+    module VersionedPath
+
+      # Substitute release information into a path.
+      #
+      # @param path [String] A path.
+      # @param version [String, nil] A string that will be substituted for any
+      #   `:version` token in `path`.
+      # @param series [String, nil] A string that will be substituted for any
+      #   `:series` token in `path`.
+      #
+      # @return [String]
+      def self.versioned_path(path, version = nil, series = nil)
+        result = path.dup
+        result.gsub!(/:version/, version) unless version.nil?
+        result.gsub!(/:series/, series) unless series.nil?
+
+        result
+      end
+
+      # FIXME: This code is basically lifted from:
+      #
+      #     PEBuild::Archive#versioned_path
+      #
+      # These two uses need to be cleaned up and consolidated.
+
+    end
+  end
+end

data/lib/pe_build/version.rb

@@ -1,3 +1,3 @@
 module PEBuild
-  VERSION = '0.8.8'
+  VERSION = '0.9.0'
 end

data/spec/shared/helpers/webserver_context.rb

@@ -0,0 +1,30 @@
+require 'webrick'
+
+# This context runs a WEBRick server that is accessible to tests.
+# The `webserver_port` and `webserver_path` will need to be specified before
+# this context is included:
+#
+#     let(:webserver_port) { ... }
+#     let(:webserver_path) { ... }
+#     include 'webserver'
+shared_context 'webserver' do
+  before(:each) do
+    mime_types = {
+      'gz'  => 'application/gzip',
+      'zip' => 'application/zip',
+      'tar' => 'application/x-tar',
+    }
+
+    @server = WEBrick::HTTPServer.new(
+      AccessLog: [],
+      Port: webserver_port,
+      DocumentRoot: webserver_path,
+      MimeTypes: mime_types)
+    @thr = Thread.new { @server.start }
+  end
+
+  after(:each) do
+    @server.shutdown rescue nil
+    @thr.join rescue nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+# Disable Vagrant autoloading so that other plugins defined in the Gemfile for
+# Acceptance tests are not loaded.
+ENV['VAGRANT_NO_PLUGINS'] = '1'
+
+require 'vagrant-spec/unit'
+require 'pe_build'

data/spec/unit/config/global_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+require 'pe_build/config'
+
+describe PEBuild::Config::Global do
+  # The `machine` is a required argument to the validation routine, but
+  # currently is not used by the Global config validation checks.
+  let(:machine) { double('machine') }
+
+  context 'when finalized with default values' do
+    before(:each) { subject.finalize! }
+
+    it 'passes validation' do
+      errors = subject.validate(machine)
+
+      expect(errors).to include('PE build global config' => [])
+    end
+  end
+
+  describe 'version' do
+    it 'may be of the form x.y.z' do
+      subject.version = '3.0.0'
+
+      subject.finalize!
+      errors = subject.validate(machine)
+
+      expect(errors).to include('PE build global config' => [])
+    end
+
+    it 'may be of the form x.y.z[-other-arbitrary-stuff]' do
+      subject.version = '2.8.0-42-gsomesha'
+
+      subject.finalize!
+      errors = subject.validate(machine)
+
+      expect(errors).to include('PE build global config' => [])
+    end
+
+    it 'may not be x.y' do
+      subject.version = '3.1'
+
+      subject.finalize!
+      errors = subject.validate(machine)
+
+      # Casting the array to a string and using a regex matcher gives a nice
+      # diff in the case of failure.
+      expect(errors['PE build global config'].to_s).to match(/String is malformed/)
+    end
+  end
+
+  describe 'download_root' do
+    PEBuild::Transfer::IMPLEMENTATIONS.keys.compact.each do |scheme|
+      it "accepts #{scheme}://" do
+        subject.download_root = "#{scheme}://foo"
+
+        subject.finalize!
+        errors = subject.validate(machine)
+
+        expect(errors).to include('PE build global config' => [])
+      end
+    end
+
+    it 'accepts a raw path' do
+      subject.download_root = 'foo/bar'
+
+      subject.finalize!
+      errors = subject.validate(machine)
+
+      expect(errors).to include('PE build global config' => [])
+    end
+
+    it 'rejects foo://' do
+      subject.download_root = 'foo://bar'
+
+      subject.finalize!
+      errors = subject.validate(machine)
+
+      expect(errors['PE build global config'].to_s).to match(/cannot be handled by any file transferrers/)
+    end
+  end
+
+end

data/spec/unit/config/pe_bootstrap_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+require 'pe_build/config'
+
+describe PEBuild::Config::PEBootstrap do
+  let(:machine)  { double('machine') }
+
+  context 'when finalized with default values' do
+    before(:each) { subject.finalize! }
+
+    it 'passes validation' do
+      errors = subject.validate(machine)
+
+      expect(errors).to include('PE Bootstrap' => [])
+    end
+  end
+
+  # TODO: Spec test the validation functions. Not critical right now since it
+  # is pretty much testing tests. But, having specs is a good way for people to
+  # see precisely _what_ is allowed.
+
+end

data/spec/unit/provisioner/pe_bootstrap_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+require 'pe_build/provisioner/pe_bootstrap'
+
+describe PEBuild::Provisioner::PEBootstrap do
+  include_context 'vagrant-unit'
+
+  let(:test_env) do
+    test_env = isolated_environment
+    test_env.vagrantfile <<-EOF
+Vagrant.configure('2') do |config|
+  config.vm.define :test
+end
+EOF
+
+    test_env
+  end
+  let(:env)              { test_env.create_vagrant_env }
+  let(:machine)          { env.machine(:test, :dummy) }
+  let(:bootstrap_config) { PEBuild::Config::PEBootstrap.new }
+
+  # Mock the communicator to prevent SSH commands for being executed.
+  let(:communicator)     { double('communicator') }
+  # Mock the guest operating system.
+  let(:guest)            { double('guest') }
+
+  before (:each) do
+    machine.stub(:guest => guest)
+    machine.stub(:communicator => communicator)
+  end
+
+  after(:each) { test_env.close }
+
+  subject(:provisioner) { described_class.new(machine, bootstrap_config) }
+
+
+  describe 'when configured' do
+    context 'and no version is set' do
+      it 'raises an error' do
+        pending 'This is now done in the `provision` method which is difficult to isolate for a test'
+        expect { subject.configure(machine.config) }.to raise_error(
+          PEBuild::Provisioner::PEBootstrap::UnsetVersionError,
+          /version must be set/ )
+      end
+    end
+  end
+end

data/tasks/acceptance.rake

@@ -0,0 +1,25 @@
+namespace :acceptance do
+  ARTIFACT_DIR = File.join('acceptance', 'artifacts')
+  TEST_BOXES = %w[
+    https://vagrantcloud.com/puppetlabs/centos-6.5-64-nocm/version/2/provider/virtualbox.box
+  ]
+
+  directory ARTIFACT_DIR
+  TEST_BOXES.each do |box_url|
+    file File.join(ARTIFACT_DIR, File.basename(box_url)) => ARTIFACT_DIR do |path|
+      puts 'Downloading: ' + box_url
+      Kernel.system 'curl', '-L', '-o', path.to_s, box_url
+    end
+  end
+
+  desc 'downloads test boxes and other artifacts'
+  task :setup => TEST_BOXES.map {|box_url| File.join(ARTIFACT_DIR, File.basename(box_url))}
+
+  desc 'runs acceptance tests'
+  task :run => :setup do
+    command = 'vagrant-spec test'
+    puts command
+    puts
+    exec(command)
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/templates/locales/en.yml

@@ -17,6 +17,10 @@ en:
       pe_bootstrap:
         post_install: |-
           Applying post-install configuration to Puppet Enterprise.
+        errors:
+          unset_version: |-
+            The Puppet Enterprise version must be set either on the global pe_build config
+            object or specified on a per-provisioner basis, but both were unset.
     transfer:
       open_uri:
         download_failed: |-
@@ -48,9 +52,6 @@ en:
           information on the shell provisioner can be found on the Vagrant website at
           http://docs.vagrantup.com/v2/provisioning/shell.html
         errors:
-          unset_version: |-
-            The Puppet Enterprise version must be set either on the global pe_build config
-            object or specified on a per-provisioner basis, but both were unset.
           unknown_role: |-
             The specified role %{role} is unhandled, must be one of %{known_roles}.
           invalid_autosign_role: |-

data/vagrant-pe_build.gemspec

@@ -13,11 +13,15 @@ Gem::Specification.new do |gem|
 
   gem.summary     = "Vagrant provisioner for installing Puppet Enterprise"
 
-  gem.add_dependency 'progressbar'
-  gem.add_dependency 'minitar'
-
   gem.files        = %x{git ls-files -z}.split("\0")
   gem.require_path = 'lib'
 
   gem.license = 'Apache 2.0'
+
+  gem.add_runtime_dependency 'progressbar'
+  gem.add_runtime_dependency 'minitar'
+
+  gem.add_development_dependency 'rake'
+  # Pin to 2.14.x for compatibility with vagrant-spec.
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
 end

data/vagrant-spec.config.example.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+require 'vagrant-spec/acceptance'
+
+require_relative 'spec/shared/helpers/webserver_context'
+
+Vagrant::Spec::Acceptance.configure do |c|
+  acceptance_dir = Pathname.new File.expand_path('../acceptance', __FILE__)
+
+  c.component_paths = [acceptance_dir.to_s]
+  c.skeleton_paths = [(acceptance_dir + 'skeletons').to_s]
+
+  c.provider 'virtualbox',
+    box: (acceptance_dir + 'artifacts' + 'virtualbox.box').to_s,
+    # This folder should be filled with PE tarballs for CentOS.
+    archive_path: (acceptance_dir + 'artifacts' + 'pe_archives').to_s,
+    env_vars: {
+      'VBOX_USER_HOME' => '{{homedir}}',
+    }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-pe_build
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progressbar
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 description: 
 email: adrien@somethingsinistral.net
 executables: []
@@ -45,10 +73,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .yardopts
 - CHANGELOG
 - Gemfile
 - LICENSE
 - README.markdown
+- Rakefile
+- acceptance/pe_build/pe_build_spec.rb
+- acceptance/skeletons/pe_build/Vagrantfile
+- acceptance/skeletons/pe_build/agent-3.x.txt.erb
 - doc/answers/README.markdown
 - doc/answers/agent.txt
 - doc/answers/master-1.1.txt
@@ -108,8 +142,16 @@ files:
 - lib/pe_build/unpack/tar.rb
 - lib/pe_build/unpack/tar_gz.rb
 - lib/pe_build/util/config.rb
+- lib/pe_build/util/versioned_path.rb
 - lib/pe_build/version.rb
 - lib/vagrant-pe_build.rb
+- spec/shared/helpers/webserver_context.rb
+- spec/spec_helper.rb
+- spec/unit/config/global_spec.rb
+- spec/unit/config/pe_bootstrap_spec.rb
+- spec/unit/provisioner/pe_bootstrap_spec.rb
+- tasks/acceptance.rake
+- tasks/spec.rake
 - templates/answers/agent-1.x.txt.erb
 - templates/answers/agent-2.0.x.txt.erb
 - templates/answers/agent-2.x.txt.erb
@@ -120,6 +162,7 @@ files:
 - templates/answers/master-3.x.txt.erb
 - templates/locales/en.yml
 - vagrant-pe_build.gemspec
+- vagrant-spec.config.example.rb
 homepage: https://github.com/adrienthebo/vagrant-pe_build
 licenses:
 - Apache 2.0
@@ -145,3 +188,4 @@ signing_key:
 specification_version: 4
 summary: Vagrant provisioner for installing Puppet Enterprise
 test_files: []
+has_rdoc: