vagrant-config_builder 0.7.1 → 0.8.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGY5Y2JhMzAxMmUxMjU0NjIxMDIyNWFiYzUxY2Y3Y2NlYjg5OWYzZQ==
+    NzdiNDExYzFlYThhOWYwZDUyNGYzMWUzMDEwZDc3MTNmMDIwNjQ1NQ==
   data.tar.gz: !binary |-
-    MDVmMjllYTcwYjIwMzBhOTA4ZGQxZDMzM2EwN2QwMmRmMTdhZGNhNA==
+    MTk1ZDczYzU4ZjhlOGI5YjIwMjE2ZmMzMTVjZjk1MjcyMDMyOTgwOQ==
 SHA512:
   metadata.gz: !binary |-
-    ZGU3MjdjNGUwMmMwNmI0OGFkY2EzZWUxNTllNDRmZTIxMjVhNGJjMmJkMjE2
-    NWNlMzhlNzU5NmNhNWU5MTc5OGE3MzQ2ZmVjZmM4NTY4YjMwNjlmMTllZjc0
-    OTg1MTZmYzlmNzI2NmU2MDQxMmM1OTYwYzhlN2I4ZjBmYTE1OTc=
+    OWJiOGMxNzI1N2M2NmZhY2NhN2E5MWM4ZGQyZjdiYjhmOWU4YjY5OGI0MTUx
+    ODYxMmQ4MjFhOTA1NjU3NzZhM2VhYTUyYTAzMTczODUwODk3OTcxZjYyNjhm
+    ZTdkZDE5MGE2MDRlN2U0NjJiM2EwNzFhNmYzMGI1YWMwYmY0Mzg=
   data.tar.gz: !binary |-
-    NWZlNTA2ZGJkNDJiY2I2ZDZjMDE0Y2IyMjRmYmI1NjZhYzE3ZjM3ZDk5NmZh
-    NzIwMDVhYmQxZWZiNDI0OTY0MDkwZjI3YmI0MWZjNDNlMTI3ZTNhMDFkYjcz
-    YjExZjJiM2E3ZmYwNWM5YjY0MzMwZGI0YTAxNWUyM2JjYjY0YTY=
+    OGNjZGQ0MjRlOGUzMmQwODY2MGMyNDEyYmRjNWZjNWRhYjQ4MjVmYTBkNDcy
+    NTFiOWY0YjI2M2UzNTJhYjkzNmUwZjU2MDIxYWVjOTQ1MGZiYTkyM2U0Yzg3
+    OWIzNjg3NGQ3NWQxNDIzMzU1YmY2ZDZhY2EzOTU0NDUxYzMzMTg=

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+.yardoc
+doc

data/.yardopts

@@ -0,0 +1,5 @@
+-
+README.markdown
+docs/GettingStarted.markdown
+CHANGELOG
+LICENSE

data/CHANGELOG

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+0.8.0
+-----
+
+2014-05-02
+
+  * (GH-16) Add vmware_fusion provider implementation.
+
 0.7.1
 -----
 

data/Gemfile

@@ -7,6 +7,8 @@ group :development do
   # 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"
 end
 
 if File.exists? "#{__FILE__}.local"

data/docs/GettingStarted.markdown

@@ -0,0 +1,175 @@
+# @title Getting Started
+
+# Getting Started
+
+The vagrant-config_builder plugin is designed to ease the management of complex Vagrant setups.
+This goal is accomplished by moving configuration data out of the Vagrant DSL and into formats that excel at expressing hierarchical information.
+Moving the configuration to a dedicated data structure allows multiple VMs to be defined by composing and remixing a set of common components.
+This guide describes:
+
+  - How to transition a Vagrant configuration to a ConfigBuilder data structure.
+
+  - How vagrant-config_builder maps that structure back to a Vagrant configuration.
+
+  - The methodology that vagrant-config_builder uses to manage components of configuration shared by multiple VMs.
+
+
+## Expressing Configuration as Data
+
+This guide will walk through re-implementing the following Vagrantfile using vagrant-config_builder:
+
+```ruby
+# Vagrantfile
+
+# Requires the following plugins:
+#
+#   - vagrant-hosts
+#   - vagrant-auto_network
+#
+Vagrant.configure('2') do |config|
+
+  box_url = 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box'
+  box_name = 'centos-64-x64-vbox4210-nocm'
+
+  config.vm.define :puppetmaster do |node|
+    node.vm.box_url = box_url
+    node.vm.box = box_name
+
+    node.vm.hostname = 'puppetmaster.boxnet'
+
+    node.vm.network :private_network, :ip => '0.0.0.0', :auto_network => true
+    node.vm.provision :hosts
+
+    node.vm.provision :shell, :inline => <<-EOF
+    if which puppet > /dev/null 2>&1; then
+      echo 'Puppet Installed.'
+    else
+      echo 'Installing Puppet Master.'
+      rpm -ivh http://yum.puppetlabs.com/el/6/products/i386/puppetlabs-release-6-6.noarch.rpm
+      yum --nogpgcheck -y install puppet-server
+      echo '*.boxnet' > /etc/puppet/autosign.conf
+      /usr/bin/puppet resource service iptables ensure=stopped enable=false
+      /usr/bin/puppet resource service puppetmaster ensure=running enable=true
+    fi
+    EOF
+  end
+
+  config.vm.define :puppetagent do |node|
+    node.vm.box_url = box_url
+    node.vm.box = box_name
+
+    node.vm.hostname = 'puppetagent.boxnet'
+
+    node.vm.network :private_network, :ip => '0.0.0.0', :auto_network => true
+    node.vm.provision :hosts
+
+    node.vm.provision :shell, :inline => <<-EOF
+    if which puppet > /dev/null 2>&1; then
+      echo 'Puppet Installed.'
+    else
+      echo 'Installing Puppet Agent.'
+      rpm -ivh http://yum.puppetlabs.com/el/6/products/i386/puppetlabs-release-6-6.noarch.rpm
+      yum --nogpgcheck -y install puppet
+    fi
+    EOF
+  end
+
+end
+```
+
+The above listing showcases several examples of duplicated configuration: both VMs are using the same Vagrant box, both are configuring their networks in the same way and both are provisioned using nearly identical shell scripts.
+In fact, the only real difference between the VMs are the hostnames and the few lines of shell that install and configure the Puppet master instead or the Puppet agent.
+These little bits of shared configuration pop up constantly in multi-machine Vagrant environments and are commonly handled by a combination of copy-and-paste and factoring out bits of data and configuration into variables or methods (such as `box_name` and `box_url` used above).
+There are some significant drawbacks to this situation:
+
+  - Copy and paste quickly becomes expensive to maintain as the number of machines in the environment increases.
+
+  - Factoring configuration out to variables and methods can help, but requires care to produce something that is portable and reusable across environments.
+
+  - Determining which bits of configuration are shared among which machines is a challenging task to complete quickly and usually requires a careful reading of the Vagrantfile.
+
+vagrant-config_builder approaches this problem by storing every bit of configuration in a unified data structure.
+The structure can be loaded from any data source that is convertable to a hash such as YAML, JSON, XML (possibly [interpretive dance][oscar data sources]).
+Generation of configuration hashes from data sources is implemented through the `ConfigBuilder::Loader` module and is completely pluggable.
+This guide will use YAML as the configuration storage format as vagrant-config_builder includes a YAML Loader.
+
+If the Vagrantfile above were to be translated to YAML, it would look like this:
+
+```yaml
+# config/vms.yaml
+---
+vms:
+  - name: puppetmaster
+    box_url: http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box
+    box: centos-64-x64-vbox4210-nocm
+    hostname: puppetmaster.boxnet
+    private_networks:
+      - {ip: 0.0.0.0, auto_network: true}
+    provisioners:
+      - type: hosts
+      - type: shell
+        inline: |
+          if which puppet > /dev/null 2>&1; then
+            echo 'Puppet Installed.'
+          else
+            echo 'Installing Puppet Master.'
+            rpm -ivh http://yum.puppetlabs.com/el/6/products/i386/puppetlabs-release-6-6.noarch.rpm
+            yum --nogpgcheck -y install puppet-server
+            echo '*.boxnet' > /etc/puppet/autosign.conf
+            /usr/bin/puppet resource service iptables ensure=stopped enable=false
+            /usr/bin/puppet resource service puppetmaster ensure=running enable=true
+          fi
+
+  - name: puppetagent
+    box_url: http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box
+    box: centos-64-x64-vbox4210-nocm
+    hostname: puppetagent.boxnet
+    private_networks:
+      - {ip: 0.0.0.0, auto_network: true}
+    provisioners:
+      - type: hosts
+      - type: shell
+        inline: |
+          if which puppet > /dev/null 2>&1; then
+            echo 'Puppet Installed.'
+          else
+            echo 'Installing Puppet Master.'
+            rpm -ivh http://yum.puppetlabs.com/el/6/products/i386/puppetlabs-release-6-6.noarch.rpm
+            yum --nogpgcheck -y install puppet
+          fi
+```
+The YAML configuration above maps very closely to the original Vagrant DSL.
+The major differences are:
+
+  - Repetitive bits of syntax such as `config.vm.*` and `node.vm.*` are now expressed implicitly through the structure of the data.
+
+  - Operations that are executed multiple times are expressed as arrays. These are:
+
+    - Defining VMs.
+
+    - Defining network interfaces on VMs.
+
+    - Running provisioners on VMs.
+
+The mapping between the ConfigBuilder data and the original Vagrantfile will be covered in detail in the next section.
+With the YAML configuration saved in `config/vms.yaml`, the Vagrantfile can updated to invoke `ConfigBuilder.load`:
+
+```ruby
+# Vagrantfile
+
+# Requires the following plugins:
+#
+#  - vagrant-hosts
+#  - vagrant-auto_network
+#  - vagrant-config_builder
+#
+Vagrant.configure('2', &ConfigBuilder.load(
+  :yaml,
+  :yamldir,
+  File.expand_path('../config', __FILE__)
+))
+```
+
+This calls the `yamldir` method of the YAML Loader and passes a path to a `config` directory located adjacent to the Vagrantfile.
+
+  [oscar data sources]: http://www.youtube.com/watch?v=1TgGQjjLDXg&t=19m27s

data/lib/config_builder/model.rb

@@ -38,6 +38,7 @@ module ConfigBuilder
       end
 
       require 'config_builder/model/provider/virtualbox'
+      require 'config_builder/model/provider/vmware_fusion'
     end
 
     module Provisioner

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

@@ -0,0 +1,36 @@
+# @see http://docs.vagrantup.com/v2/vmware/configuration.html
+class ConfigBuilder::Model::Provider::VMwareFusion < ConfigBuilder::Model::Base
+
+  # @!attribute [rw] vmx
+  #   @return [Hash<String, String>] A hash of VMX options for the given VM
+  #   @example
+  #     model.vmx = {
+  #       'memsize'  => '1024',
+  #       'numvcpus' => '2',
+  #     }
+  def_model_attribute :vmx
+
+  # @!attribute [rw] gui
+  #   @return [Boolean] Whether the GUI should be launched when the VM is created
+  def_model_attribute :gui
+
+  def initialize
+    @defaults = {
+      :gui => false,
+      :vmx => {},
+    }
+  end
+
+  def to_proc
+    Proc.new do |vm_config|
+      vm_config.provider 'vmware_fusion' do |fusion_config|
+        fusion_config.gui = attr(:gui)
+        attr(:vmx).each_pair do |key, value|
+          fusion_config.vmx[key] = value
+        end
+      end
+    end
+  end
+
+  ConfigBuilder::Model::Provider.register('vmware_fusion', self)
+end

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/spec/config_builder/model/provider/vmware_fusion_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'config_builder/model'
+
+describe ConfigBuilder::Model::Provider::VMwareFusion do
+  describe "converting to a proc" do
+
+    let(:vmx) { Hash.new }
+    let(:fusion_config) { double('fusion provider config', :vmx => vmx) }
+    let(:vm_config) { double('vagrant VM config', :provider => fusion_config) }
+
+    before do
+      allow(vm_config).to receive(:provider).and_yield(fusion_config)
+    end
+
+    it "assigns the gui value to the fusion provider object" do
+      subject.attrs = {:gui => 'guivalue'}
+      expect(fusion_config).to receive(:gui=).with('guivalue')
+      p = subject.to_proc
+      p.call(vm_config)
+    end
+
+    it "assigns the vmx value to the fusion provider object" do
+      subject.attrs = {:vmx => {:hello => 'world'}}
+      allow(fusion_config).to receive(:gui=)
+      subject.call(vm_config)
+      expect(vmx).to eq({:hello => 'world'})
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-config_builder
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -44,10 +44,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .yardopts
 - CHANGELOG
 - Gemfile
 - LICENSE
 - README.markdown
+- docs/GettingStarted.markdown
 - examples/Vagrantfile
 - examples/roles.yaml
 - examples/vms.yaml
@@ -66,6 +69,7 @@ files:
 - lib/config_builder/model/network/forwarded_port.rb
 - lib/config_builder/model/network/private_network.rb
 - lib/config_builder/model/provider/virtualbox.rb
+- lib/config_builder/model/provider/vmware_fusion.rb
 - lib/config_builder/model/provisioner/puppet.rb
 - lib/config_builder/model/provisioner/puppet_server.rb
 - lib/config_builder/model/provisioner/shell.rb
@@ -81,6 +85,7 @@ files:
 - spec/config_builder/filter/boxes_spec.rb
 - spec/config_builder/filter/roles_spec.rb
 - spec/config_builder/loader/yaml_spec.rb
+- spec/config_builder/model/provider/vmware_fusion_spec.rb
 - spec/spec_helper.rb
 - templates/locales/en.yml
 - vagrant-config_builder.gemspec