rspec-system 2.3.0 → 2.4.0

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+2.4.0
+=====
+
+This feature release contains a number of new features:
+
+* We now have an 'options' parameter for a node definition which allows customisation of the ip address, number of CPUs and amount of memory for a node. Currently this is only accepted for the Vagrant/Virtualbox provider.
+* Dynamic loading of node_set plugins is now provided. This drops the requirement for having to 'require' the plugin to load it.
+
+#### Detailed Changes
+
+* (GH-44) Add 'options' parameter to node definition (Justen Walker)
+* (GH-44) Support custom options for Vagrantfiles (Justen Walker)
+* Fix wrong reference in README. (Stefano Zanella)
+* Fix typo in example test code. (Stefano Zanella)
+* Add 'ip' option to the 'options' parameter for node definitions (Trey Dockendorf)
+* Add a simple plugin loading system for node_set plugins (Erik Dalén)
+
+-------------------------------
+
 2.3.0
 =====
 

data/README.md

@@ -18,7 +18,7 @@ For writing tests it uses the [rspec](https://www.relishapp.com/rspec) testing f
 
 #### Can this tool be used to test Puppet?
 
-Yes it can. Check out the plugin: [rspec-system-serverspec](http://rubygems.org/gems/rspec-system-serverspec).
+Yes it can. Check out the plugin: [rspec-system-puppet](http://rubygems.org/gems/rspec-system-puppet).
 
 #### How does this tool overlap with serverspec?
 
@@ -73,7 +73,7 @@ An example file would look like this:
         its(:exit_code) { should be_zero }
       end
 
-      it 'should cat /etc/resolv.conf' do
+      it 'should cat /etc/hosts' do
         # Here we run the shell command as a helper
         shell 'cat /etc/hosts' do |r|
           r.stdout.should =~ /localhost/
@@ -140,6 +140,38 @@ An example using the `shell` helper:
 
 This would execute the command `hostname` on node `second.mydomain.vm`.
 
+### Custom node options
+
+By default, `rspec-system` launches nodes with the settings that were baked into the prefab. This means that your node's physical properties like RAM and vCPU count depend on the prefab selected. If you need to customize these values, `rspec-system` provides node-level customization in `.nodeset.yml` under `options`.
+
+Currently supported options are:
+
+* *ip:* additional IP address
+* *cpus:* number of virtual cpus
+* *memory:* memory in MB
+
+Example:
+
+    ---
+    sets:
+      'centos-59-x64-multinode':
+        nodes:
+          default_node: 'first.mydomain.vm':
+          'first.mydomain.vm':
+            prefab: 'centos-59-x64'
+            options:
+              ip: '192.168.1.2'
+              cpus: 2
+              memory: 1024 #mb
+          'second.mydomain.vm':
+            prefab: 'centos-59-x64'
+            options:
+              ip: '192.168.1.3'
+              cpus: 1
+              memory: 512 #mb
+
+*Note:* These options are currently only supported on Vagrant + VirtualBox. On other providers they are ignored.
+
 ### Prefabs
 
 Prefabs are 'pre-rolled' virtual images, for now its the only way to specify a template.

data/lib/rspec-system/node.rb

@@ -18,7 +18,8 @@ module RSpecSystem
         :nodeset => nodeset,
         :custom_prefabs_path => custom_prefabs_path,
         :name => k,
-        :prefab => v['prefab']
+        :prefab => v['prefab'],
+        :options => v['options']
       )
     end
 
@@ -27,6 +28,7 @@ module RSpecSystem
     # @param options [Hash] options for new node
     # @option options [String] :name name of node. Mandatory.
     # @option options [String] :prefab prefab setting. Mandatory.
+    # @option options [String] :options options setting. Optional.
     # @option options [RSpecSystem::NodeSet] :nodeset the parent nodeset for
     #   this node. Mandatory.
     # @option options [String] :custom_prefabs_path path of custom prefabs
@@ -34,6 +36,7 @@ module RSpecSystem
     def initialize(options)
       @name = options[:name]
       prefab = options[:prefab]
+      @options = options[:options]
       @nodeset = options[:nodeset]
       @custom_prefabs_path = options[:custom_prefabs_path]
 
@@ -61,6 +64,13 @@ module RSpecSystem
       @prefab
     end
 
+    # Returns the custom object for this node (if any).
+    #
+    # @return [Hash] the options object used to customize the node
+    def options
+      @options
+    end
+
     # Retreives facts from the nodeset definition or prefab.
     #
     # @return [Hash] returns a hash of facter facts defined for this node

data/lib/rspec-system/node_set.rb

@@ -6,18 +6,12 @@ module RSpecSystem
     # @return [RSpecSystem::NodeSet::Base] returns an object based on the Base
     #   abstract class.
     def self.create(setname, config, virtual_env, custom_prefabs_path, options)
-      case(virtual_env)
-      when 'vagrant'
-        RSpecSystem::NodeSet::Vagrant.new(setname, config, custom_prefabs_path, options)
-      when 'vsphere'
-        RSpecSystem::NodeSet::Vsphere.new(setname, config, custom_prefabs_path, options)
-      else
-        raise "Unsupported virtual environment #{virtual_env}"
+      begin
+        require "rspec-system/node_set/#{virtual_env.downcase}"
+      rescue LoadError => e
+        raise "Unsupported virtual environment #{virtual_env}: #{e}"
       end
+      const_get(virtual_env.capitalize).new(setname, config, custom_prefabs_path, options)
     end
   end
 end
-
-require 'rspec-system/node_set/base'
-require 'rspec-system/node_set/vagrant'
-require 'rspec-system/node_set/vsphere'

data/lib/rspec-system/node_set/vagrant.rb

@@ -1,6 +1,8 @@
 require 'fileutils'
 require 'systemu'
 require 'net/ssh'
+require 'net/scp'
+require 'rspec-system/node_set/base'
 
 module RSpecSystem
   # A NodeSet implementation for Vagrant.
@@ -9,6 +11,7 @@ module RSpecSystem
     include RSpecSystem::Util
 
     ENV_TYPE = 'vagrant'
+    VALID_VM_OPTIONS = ['ip']
 
     # Creates a new instance of RSpecSystem::NodeSet::Vagrant
     #
@@ -119,13 +122,16 @@ module RSpecSystem
         f.write('Vagrant.configure("2") do |c|' + "\n")
         nodes.each do |k,v|
           ps = v.provider_specifics['vagrant']
+          default_options = { 'mac' => randmac }
+          options = default_options.merge(v.options || {})
 
           node_config = "  c.vm.define '#{k}' do |v|\n"
           node_config << "    v.vm.hostname = '#{k}'\n"
           node_config << "    v.vm.box = '#{ps['box']}'\n"
           node_config << "    v.vm.box_url = '#{ps['box_url']}'\n" unless ps['box_url'].nil?
+          node_config << customize_vm(k,options)
           node_config << "    v.vm.provider 'virtualbox' do |vbox|\n"
-          node_config << "      vbox.customize ['modifyvm',:id,'--macaddress1','#{randmac}']\n"
+          node_config << customize_virtualbox(k,options)
           node_config << "    end\n"
           node_config << "  end\n"
 
@@ -136,6 +142,47 @@ module RSpecSystem
       nil
     end
 
+    # Adds virtualbox customization to the Vagrantfile
+    # 
+    # @api private
+    # @param name [String] name of the node
+    # @param options [Hash] customization options
+    # @return [String] a series of vbox.customize lines
+    def customize_virtualbox(name,options)
+      custom_config = ""
+      options.each_pair do |key,value|
+        next if VALID_VM_OPTIONS.include?(key)
+        case key
+        when 'cpus','memory'
+          custom_config << "    vbox.customize ['modifyvm', :id, '--#{key}','#{value}']\n"
+        when 'mac'
+          custom_config << "    vbox.customize ['modifyvm', :id, '--macaddress1','#{value}']\n"
+        else
+          log.warn("Skipped invalid custom option for node #{name}: #{key}=#{value}")
+        end
+      end
+      custom_config
+    end
+
+    # Adds VM customization to the Vagrantfile
+    #
+    # @api private
+    # @param name [String] name of the node
+    # @param options [Hash] customization options
+    # @return [String] a series of v.vm lines
+    def customize_vm(name,options)
+      vm_config = ""
+      options.each_pair do |key,value|
+        case key
+        when 'ip'
+          vm_config << "    v.vm.network :private_network, :ip => '#{value}'\n"
+        else
+          next
+        end
+      end
+      vm_config
+    end
+
     # Here we get vagrant to drop the ssh_config its using so we can monopolize
     # it for transfers and custom stuff. We drop it into a single file, and
     # since its indexed based on our own node names its quite ideal.

data/lib/rspec-system/node_set/vsphere.rb

@@ -3,6 +3,7 @@ require 'systemu'
 require 'net/ssh'
 require 'net/scp'
 require 'rbvmomi'
+require 'rspec-system/node_set/base'
 
 module RSpecSystem
   # A NodeSet implementation for VSphere

data/resources/kwalify-schemas/nodeset_schema.yml

@@ -15,4 +15,10 @@ mapping:
                 type: map
                 mapping:
                   prefab: { type: str }
+                  options:
+                    type: map
+                    mapping:
+                      ip: { type: str }
+                      memory: { type: int }
+                      cpus: { type: int }
                   role: { type: str }

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "2.3.0"
+  s.version     = "2.4.0"
   s.authors     = ["Ken Barber"]
   s.email       = ["info@puppetlabs.com"]
   s.homepage    = "https://github.com/puppetlabs/rspec-system"

data/spec/fixtures/nodeset_example3.yml

@@ -0,0 +1,15 @@
+---
+default_set: 'centos-58-x64'
+sets:
+  'centos-58-x64':
+    nodes:
+      "master":
+        prefab: 'centos-58-x64'
+        options:
+          cpus: 2
+          memory: 4096 #mb
+      "agent":
+        prefab: 'centos-58-x64'
+        options:
+          cpus: 1
+          memory: 768 #mb

data/spec/fixtures/nodeset_example4.yml

@@ -0,0 +1,17 @@
+---
+default_set: 'centos-58-x64'
+sets:
+  'centos-58-x64':
+    nodes:
+      "master":
+        prefab: 'centos-58-x64'
+        options:
+          ip: '192.168.1.2'
+          cpus: 2
+          memory: 4096 #mb
+      "agent":
+        prefab: 'centos-58-x64'
+        options:
+          ip: '192.168.1.3'
+          cpus: 1
+          memory: 768 #mb

data/spec/fixtures/nodeset_example5.yml

@@ -0,0 +1,13 @@
+---
+default_set: 'centos-58-x64'
+sets:
+  'centos-58-x64':
+    nodes:
+      "master":
+        prefab: 'centos-58-x64'
+        options:
+          ip: '192.168.1.2'
+      "agent":
+        prefab: 'centos-58-x64'
+        options:
+          ip: '192.168.1.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -174,6 +174,9 @@ files:
 - spec/fixtures/example_dir/example_file
 - spec/fixtures/nodeset_example1.yml
 - spec/fixtures/nodeset_example2.yml
+- spec/fixtures/nodeset_example3.yml
+- spec/fixtures/nodeset_example4.yml
+- spec/fixtures/nodeset_example5.yml
 - spec/spec_helper.rb
 - spec/spec_helper_system.rb
 - spec/system/rcp_spec.rb