vagrant-config_builder 0.14.0 → 0.15.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjEwNDk3M2NkM2E5NTgxYTZjMDYxMTM1N2RmNTQ0OThlMTk0N2ZmZQ==
-  data.tar.gz: !binary |-
-    NWNiOTliNWQ5OGY0MTVlNjgxMDhhNDA5ZTg4OWU3NzlkZjE3YmNmYg==
+SHA1:
+  metadata.gz: d53eab1334c50f0eccc2a30de20a9d785d46ef74
+  data.tar.gz: 82124ae8e8c9a5e74d57f037893b6bdf51bfb9a3
 SHA512:
-  metadata.gz: !binary |-
-    YzNhNjdhYTcxZDE2NjY1MDQwZDcwZmYwZWZmN2I1NmFhOGJhM2Q1NjFkZWUz
-    OWEwNjRkYTkyMDA3ZGVkZDJiODUxNjJmNGIzYTk2YWRhZDA2NjZhNTFkNTVh
-    ZWM1YmYzYjc3YzQ1N2Q1ZmM2YzQ4MjdiYjFiZjA4ZGZjYTgzM2I=
-  data.tar.gz: !binary |-
-    ZTdhNmNlNjAzOTY3ZTc4NDg5ZTMwYjhmNGFmYzkwNDA5ZDYwMjI0MDdiZmY3
-    NWU3MWFlNDJkMmE3ZTk2OWQ3NDU0N2QyODI4N2FiOTQ3NmZhYjE5YWM4ODI1
-    NzYxMTEwMzJjZmUyMmQxOWFhOTMyOWIzZTNjZmJhYTNiYzMyOGM=
+  metadata.gz: 91415ac8554fd80f0535eaab83c3fa34da9fecd3481f585fc8a4ffdb8e8c255d0887ab0bce537b8137d1319e1c40c7161cafd73e2411c377b89836fc3d285ccf
+  data.tar.gz: 13ade488a6f40f246339cb4246fc9a909997006b2e9068bc1b197af45e3b8812893143c5fc81465adf81ffdb611b46156aeaae2087ddd167fbb2edfdbab6ee8d

data/.gitignore

@@ -1,3 +1,5 @@
 .bundle
 .yardoc
 doc
+Gemfile.local
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+sudo: false
+install: bundle install --without development
+script: bundle exec rake spec
+notifications:
+  email: false
+rvm:
+  - 2.0.0
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/CHANGELOG

@@ -1,6 +1,25 @@
 CHANGELOG
 =========
 
+0.15.0
+------
+
+2015-09-28
+
+This is a feature release with an incompatible bugfix.
+
+  * (GH-44) Roles no longer preempt specific VM configuration.  This means that
+    roles no longer override values explicitly set on VMs and provisioners set
+    by VMs run after those set by roles. This change is considered to be a bug
+    fix, but will break any configuration that relies on existing behavior.
+
+  * (GH-43) Add basic support for the vagrant-aws provider.
+
+  * (GH-42) The Puppet provisioner now supports Hiera configuration options.
+
+  * (GH-47) The single `provisioner` setting for VMs is now deprecated and will
+    be removed in version 1.0.0. Use the `provisioners` setting instead.
+
 0.14.0
 ------
 

data/Gemfile

@@ -1,16 +1,28 @@
 source 'https://rubygems.org'
+ruby '2.0.0' # Required by Vagrant 1.4 and newer.
 
-gemspec
+ENV['TEST_VAGRANT_VERSION'] ||= 'v1.7.4'
+
+# 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 :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"
-  gem "yard"
-  gem "redcarpet"
+  gem 'yard', '~> 0.8.7'
+  gem 'redcarpet'
 end
 
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
+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
+
+  # Pinned on 12/10/2014. Compatible with Vagrant 1.5.x, 1.6.x and 1.7.x.
+  gem 'vagrant-spec', :github => 'mitchellh/vagrant-spec', :ref => '1df5a3a'
 end
+
+eval_gemfile "#{__FILE__}.local" if File.exists? "#{__FILE__}.local"

data/README.markdown

@@ -3,6 +3,8 @@ Vagrant Config Builder
 
 Configure and manage your Vagrant environments with data.
 
+[![Build Status](https://travis-ci.org/oscar-stack/vagrant-config_builder.svg?branch=master)](https://travis-ci.org/oscar-stack/vagrant-config_builder)
+
 Synopsis
 --------
 
@@ -59,6 +61,7 @@ roles:
         manifests_path: 'tests'
         module_path: 'spec/fixtures/modules'
         manifest_file: <%= ENV['VAGRANT_MANIFEST'] || 'init.pp' %>
+        hiera_config_path: "hiera.yaml"
 ```
 
 #### config/roles.yaml

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/lib/config_builder.rb

@@ -1,4 +1,5 @@
 require 'vagrant'
+require 'log4r'
 
 module ConfigBuilder
   require 'config_builder/loader'
@@ -12,6 +13,10 @@ module ConfigBuilder
     runner.run(identifier, method, value)
   end
 
+  def self.logger
+    @logger ||= setup_logger
+  end
+
   def self.source_root
     @source_root ||= File.expand_path('..', __FILE__)
   end
@@ -19,6 +24,14 @@ module ConfigBuilder
   def self.template_root
     @template_root ||= File.expand_path('../templates', source_root)
   end
+
+  def self.setup_logger
+    logger = Log4r::Logger.new('config_builder')
+    logger.outputters = Log4r::Outputter.stderr
+
+    logger
+  end
+  private_class_method :setup_logger
 end
 
 I18n.load_path << File.join(ConfigBuilder.template_root, 'locales/en.yml')

data/lib/config_builder/filter/roles.rb

@@ -57,17 +57,12 @@ class ConfigBuilder::Filter::Roles
   # @param old_vm [Hash]
   #
   # @return [Hash] The filtered VM
-  def filter_vm(old_vm)
-    role_list  = old_vm.delete('roles')
-    node_stack = roles_by_name(role_list)
+  def filter_vm(vm)
+    node_stack = roles_by_name(vm.delete('roles'))
 
-    node_stack << old_vm
-
-    new_vm = node_stack.inject({}) do |accumulator, role|
-      merge_nodes(accumulator, role)
+    node_stack.inject(vm) do |accumulator, role|
+      merge_nodes!(accumulator, role)
     end
-
-    new_vm
   end
 
   # Fetch the role associated with the given name
@@ -110,16 +105,18 @@ class ConfigBuilder::Filter::Roles
 
   private
 
-  # Merge two node hash structures, with values in `right` overwriting values
-  # in `left`.
+  # Merge two hashes of VM settings
+  #
+  # This function merges all settings from `right` into `left` and returns
+  # `left` as a mutated value. Any scalar settings, such as `box`, present in
+  # `left` will be preserved. Array settings, such as `provisioners` present in
+  # `right` will be prepended to `left` such that they are run earlier.
   #
   # @param left  [Hash]
   # @param right [Hash]
   #
-  # @return [Hash]
-  def merge_nodes(left, right)
-    retval = right.clone
-
+  # @return [Hash] The left hash, mutated.
+  def merge_nodes!(left, right)
     array_keys = %w[
       providers
       provisioners
@@ -131,19 +128,20 @@ class ConfigBuilder::Filter::Roles
     ]
 
     array_keys.each do |key|
-      if (left[key] and right[key])
-        retval[key] += left[key]
-      elsif left[key]
-        retval[key] = left[key].clone
-      end
+      next unless right.has_key?(key)
+
+      left[key] ||= []
+      left[key].unshift(*right[key])
     end
 
     single_keys = %w[provider box name communicator]
 
     single_keys.each do |key|
-      retval[key] = left[key] if left[key]
+      next unless right.has_key?(key)
+
+      left[key] ||= right[key]
     end
 
-    retval
+    left
   end
 end

data/lib/config_builder/model.rb

@@ -45,6 +45,7 @@ module ConfigBuilder
       require 'config_builder/model/provider/libvirt'
       require 'config_builder/model/provider/vsphere'
       require 'config_builder/model/provider/azure'
+      require 'config_builder/model/provider/aws'
     end
 
     module Provisioner

data/lib/config_builder/model/provider/aws.rb

@@ -0,0 +1,70 @@
+# Provider support for Vagrant-AWS
+#
+# @see https://github.com/mitchellh/vagrant-aws/blob/master/README.md#configuration
+# @since 0.15.0
+class ConfigBuilder::Model::Provider::Aws < ConfigBuilder::Model::Base
+
+  def_model_attribute :access_key_id
+  def_model_attribute :ami
+  def_model_attribute :availability_zone
+  def_model_attribute :instance_ready_timeout
+  def_model_attribute :instance_check_interval
+  def_model_attribute :instance_package_timeout
+  def_model_attribute :instance_type
+  def_model_attribute :keypair_name
+  def_model_attribute :session_token
+  def_model_attribute :private_ip_address
+  def_model_attribute :elastic_ip
+  def_model_attribute :region
+  def_model_attribute :secret_access_key
+  def_model_attribute :security_groups
+  def_model_attribute :iam_instance_profile_arn
+  def_model_attribute :subnet_id
+  def_model_attribute :associate_public_ip
+  def_model_attribute :ssh_host_attribute
+  def_model_attribute :tags
+  def_model_attribute :package_tags
+  def_model_attribute :use_iam_profile
+  def_model_attribute :block_device_mapping
+  def_model_attribute :elb
+  def_model_attribute :unregister_elb_from_az
+  def_model_attribute :terminate_on_shutdown
+
+  def initialize
+    @defaults = {}
+  end
+
+  def to_proc
+    Proc.new do |vm_config|
+      vm_config.provider 'aws' do |config|
+        with_attr(:access_key_id)             { |val| config.access_key_id = val }
+        with_attr(:ami)                       { |val| config.ami = val }
+        with_attr(:availability_zone)         { |val| config.availability_zone = val }
+        with_attr(:instance_ready_timeout)    { |val| config.instance_ready_timeout = val }
+        with_attr(:instance_check_interval)   { |val| config.instance_check_interval = val }
+        with_attr(:instance_package_timeout)  { |val| config.instance_package_timeout = val }
+        with_attr(:instance_type)             { |val| config.instance_type = val }
+        with_attr(:keypair_name)              { |val| config.keypair_name = val }
+        with_attr(:session_token)             { |val| config.session_token = val }
+        with_attr(:private_ip_address)        { |val| config.private_ip_address = val }
+        with_attr(:elastic_ip)                { |val| config.elastic_ip = val }
+        with_attr(:region)                    { |val| config.region = val }
+        with_attr(:secret_access_key)         { |val| config.secret_access_key = val }
+        with_attr(:security_groups)           { |val| config.security_groups = val }
+        with_attr(:iam_instance_profile_arn)  { |val| config.iam_instance_profile_arn = val }
+        with_attr(:subnet_id)                 { |val| config.subnet_id = val }
+        with_attr(:associate_public_ip)       { |val| config.associate_public_ip = val }
+        with_attr(:ssh_host_attribute)        { |val| config.ssh_host_attribute = val }
+        with_attr(:tags)                      { |val| config.tags = val }
+        with_attr(:package_tags)              { |val| config.package_tags = val }
+        with_attr(:use_iam_profile)           { |val| config.use_iam_profile = val }
+        with_attr(:block_device_mapping)      { |val| config.block_device_mapping = val }
+        with_attr(:elb)                       { |val| config.elb = val }
+        with_attr(:unregister_elb_from_az)    { |val| config.unregister_elb_from_az = val }
+        with_attr(:terminate_on_shutdown)     { |val| config.terminate_on_shutdown = val }
+      end
+    end
+  end
+
+  ConfigBuilder::Model::Provider.register('aws', self)
+end

data/lib/config_builder/model/provisioner/puppet.rb

@@ -21,14 +21,26 @@ class ConfigBuilder::Model::Provisioner::Puppet < ConfigBuilder::Model::Base
   #   @return [String] An arbitrary set of arguments for the `puppet` command
   attr_accessor :options
 
+  # @!attribute [rw] hiera_config_path
+  #   @return [String] Path to the Hiera configuration file stored on the host
+  #   @since 0.15.0
+  attr_accessor :hiera_config_path
+
+  # @!attribute [rw] working_directory
+  #   @return [String] Path in the guest that will be the working directory when Puppet is executed
+  #   @since 0.15.0
+  attr_accessor :working_directory
+
   def to_proc
     Proc.new do |vm_config|
       vm_config.provision :puppet do |puppet_config|
-        with_attr(:manifests_path) { |val| puppet_config.manifests_path = val }
-        with_attr(:manifest_file)  { |val| puppet_config.manifest_file  = val }
-        with_attr(:module_path)    { |val| puppet_config.module_path    = val }
-        with_attr(:facter)         { |val| puppet_config.facter         = val }
-        with_attr(:options)        { |val| puppet_config.options        = val }
+        with_attr(:manifests_path)    { |val| puppet_config.manifests_path    = val }
+        with_attr(:manifest_file)     { |val| puppet_config.manifest_file     = val }
+        with_attr(:module_path)       { |val| puppet_config.module_path       = val }
+        with_attr(:facter)            { |val| puppet_config.facter            = val }
+        with_attr(:options)           { |val| puppet_config.options           = val }
+        with_attr(:hiera_config_path) { |val| puppet_config.hiera_config_path = val }
+        with_attr(:working_directory) { |val| puppet_config.working_directory = val }
       end
     end
   end

data/lib/config_builder/model/vm.rb

@@ -13,6 +13,8 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
   #           :name => 'tiny-tina',
   #           :gui  => false,
   #        }
+  #
+  #   @deprecated Use {#providers} instead.
   def_model_delegator :provider
 
   # @!attribute [rw] providers
@@ -214,6 +216,10 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
 
   def eval_provider(vm_config)
     if attr(:provider)
+      ConfigBuilder.logger.warn {
+        I18n.t('config_builder.model.vm.provider_is_deprecated', :name => attr(:name))
+      }
+
       p = ConfigBuilder::Model::Provider.new_from_hash(attr(:provider))
       p.call(vm_config)
     end

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/spec/config_builder/filter/roles_spec.rb

@@ -40,7 +40,10 @@ describe ConfigBuilder::Filter::Roles do
         'private_networks' => [
           {'ip' => '1.2.3.4'}
         ]
-      }
+      },
+      'windows' => {
+        'communicator' => 'winrm',
+      },
     }
   end
 
@@ -70,7 +73,7 @@ describe ConfigBuilder::Filter::Roles do
     end
   end
 
-  describe 'removing the role' do
+  describe 'loading configured roles' do
     let(:config) do
       {
         'vms' => [{'name' => 'master'}],
@@ -82,14 +85,20 @@ describe ConfigBuilder::Filter::Roles do
       subject.set_config(dup(config))
     end
 
-    it 'strips out the roles key' do
+    it 'strips out the roles from top-level configuration' do
       output = subject.run
       expect(output).to_not have_key 'roles'
     end
   end
 
-  describe 'and a vm with no roles' do
-    let(:vms) { [{'name' => 'master'}] }
+  describe 'operating on a single vm' do
+    let(:vms) do
+      [{
+        'name'  => 'master',
+        'foo'   => 'bar',
+        'roles' => [ 'shell-provisioner', 'folders-12' ],
+      }]
+    end
 
     let(:config) do
       {
@@ -98,39 +107,34 @@ describe ConfigBuilder::Filter::Roles do
       }
     end
 
+    let(:filtered_vm) do
+      output = subject.run
+      output['vms'][0]
+    end
+
     before do
       subject.set_config(dup(config))
     end
 
-    it "doesn't alter the vm" do
-      output = subject.run
-      expect(output['vms']).to eq vms
+    it "removes the 'roles' key if present" do
+      expect(filtered_vm).to_not have_key 'roles'
     end
-  end
-
-  describe 'and one vm' do
-    describe 'with one role' do
-      let(:vms) { [{'name' => 'master', 'roles' => 'shell-provisioner'}] }
 
-      let(:config) do
-        {
-          'vms'   => vms,
-          'roles' => roles,
-        }
-      end
+    it 'preserves top-level configuration' do
+      expect(filtered_vm).to have_key 'foo'
+    end
 
-      before do
-        subject.set_config(dup(config))
-      end
+    context 'with no roles' do
+      let(:vms) { [{'name' => 'master'}] }
 
-      let(:filtered_vm) do
+      it "doesn't alter the vm" do
         output = subject.run
-        output['vms'][0]
+        expect(output['vms']).to eq vms
       end
+    end
 
-      it "removes the 'roles' key" do
-        expect(filtered_vm).to_not have_key 'roles'
-      end
+    context 'with roles set to a single string' do
+      let(:vms) { [{'name' => 'master', 'roles' => 'shell-provisioner'}] }
 
       it 'applies the role' do
         expected = [{
@@ -142,45 +146,60 @@ describe ConfigBuilder::Filter::Roles do
       end
     end
 
-    describe 'with two roles' do
+    context 'with roles set to an array' do
       let(:vms) do
         [{
           'name'  => 'master',
-          'roles' => ['shell-provisioner', 'folders-12'],
+          'roles' => [
+            'folders-12',
+            'puppet-provisioner',
+            'shell-provisioner',
+          ]
         }]
       end
 
-      let(:config) do
-        {
-          'vms'   => vms,
-          'roles' => roles,
-        }
+      it 'applies all of the roles' do
+        expect(filtered_vm).to have_key 'provisioners'
+        expect(filtered_vm).to have_key 'synced_folders'
       end
 
-      before do
-        subject.set_config(dup(config))
-      end
+      it 'merges attribute arrays in reverse order' do
+        expected_prov = [
+          {'type'   => 'shell', 'inline' => '/usr/bin/sl'},
+          {'type' => 'puppet', 'manifest' => 'sl.pp'},
+          {'type' => 'puppet', 'manifest' => 'starwars.pp'},
+        ]
 
-      let(:filtered_vm) do
-        output = subject.run
-        output['vms'][0]
+        expect(filtered_vm['provisioners']).to eq expected_prov
       end
+    end
 
-      it 'applies all of the roles' do
-        expected_prov = [{
-          'type'   => 'shell',
-          'inline' => '/usr/bin/sl',
+    context 'when vm configuration overlaps with roles' do
+      let(:vms) do
+        [{
+          'name'         => 'master',
+          'roles'        => [ 'shell-provisioner', 'windows' ],
+          'communicator' => 'ssh',
+          'provisioners' => [
+            {'type' => 'foo', 'parameter' => 'bar', }
+          ],
         }]
+      end
 
-        expected_folder = [
-          {'guest_path' => '/guest-1', 'host_path' => './host-1'},
-          {'guest_path' => '/guest-2', 'host_path' => './host-2'},
-        ]
+      it 'preserves single_keys set on the vm' do
+        expect(filtered_vm['communicator']).to eq 'ssh'
+      end
 
-        expect(filtered_vm['provisioners']).to eq expected_prov
-        expect(filtered_vm['synced_folders']).to eq expected_folder
+      it 'merges array_keys set on the vm last' do
+        expected_prov = {
+          'type'      => 'foo',
+          'parameter' => 'bar',
+        }
+
+        expect(filtered_vm['provisioners'].last).to eq expected_prov
       end
     end
+
   end
 
   describe "with multiple VMs and shared roles" do

data/tasks/spec.rake

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

data/templates/locales/en.yml

@@ -9,3 +9,7 @@ en:
       duplicate_entry: |-
         The class registry %{registry} already has a class registered with identifier %{identifier}
         and cannot replace the existing entry.
+    model:
+      vm:
+        provider_is_deprecated: |-
+          The provider attribute, set on vm %{name}, is deprecated and will be removed in an upcoming release. Use the providers attribute instead.

data/vagrant-config_builder.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |gem|
   gem.files        = %x{git ls-files -z}.split("\0")
   gem.require_path = 'lib'
 
+  gem.add_runtime_dependency 'rake', '>= 0'
   gem.add_runtime_dependency 'deep_merge', '~> 1.0.0'
 
+  # Pin to 2.14.x for compatibility with vagrant-spec.
   gem.add_development_dependency 'rspec', '~> 2.14.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-config_builder
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -45,11 +59,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - .yardopts
 - CHANGELOG
 - Gemfile
 - LICENSE
 - README.markdown
+- Rakefile
 - docs/GettingStarted.markdown
 - examples/Vagrantfile
 - examples/roles.yaml
@@ -69,6 +86,7 @@ files:
 - lib/config_builder/model/base.rb
 - lib/config_builder/model/network/forwarded_port.rb
 - lib/config_builder/model/network/private_network.rb
+- lib/config_builder/model/provider/aws.rb
 - lib/config_builder/model/provider/azure.rb
 - lib/config_builder/model/provider/libvirt.rb
 - lib/config_builder/model/provider/virtualbox.rb
@@ -95,6 +113,7 @@ files:
 - spec/config_builder/loader/yaml_spec.rb
 - spec/config_builder/model/provider/vmware_fusion_spec.rb
 - spec/spec_helper.rb
+- tasks/spec.rake
 - templates/locales/en.yml
 - vagrant-config_builder.gemspec
 homepage: https://github.com/adrienthebo/vagrant-config_builder
@@ -107,17 +126,17 @@ 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.4.6
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Generate Vagrant configurations from arbitrary data