rspec-system 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+1.4.0
+=====
+
+This release adds the ability to provide a custom prefabs.yml.
+
+To define custom prefabs you can now place a `.prefabs.yml` file in your projects root directory.
+
+    ---
+    'scientific-64-x64':
+      description: ""
+      facts:
+        kernelrelease: "2.6.32-358.el6.x86_64"
+        operatingsystem: Scientific
+        kernelmajversion: "2.6"
+        architecture: x86_64
+        facterversion: "1.7.0"
+        kernelversion: "2.6.32"
+        operatingsystemrelease: "6.4"
+        osfamily: RedHat
+        kernel: Linux
+        rubyversion: "1.8.7"
+      provider_specifics:
+        vagrant:
+          box: 'scientific-64-x64-vb4210-nocm'
+          box_url: 'http://example.com/path/to/scientific-64-x64-vb4210-nocm.box'
+
+This also supports overriding the built-in prefabs as well, in case you wish to use your own image files - or use a cache host for example.
+
+#### Detailed Changes
+
+* Allow overriding prefabs including using boxes on local system (Trey Dockendorf)
+
+-------------------------------
+
 1.3.0
 =====
 

data/README.md

@@ -86,7 +86,7 @@ The file must adhere to the Kwalify schema supplied in `resources/kwalify-schema
 
 ### Prefabs
 
-Prefabs are 'pre-rolled' virtual images, for now its the only way to specify a template. In the future we will probably allow you to specify your own prefab file, and override prefab settings in a nodeset file as well.
+Prefabs are 'pre-rolled' virtual images, for now its the only way to specify a template.
 
 The current built-in prefabs are defined in `resources/prefabs.yml`. The current set are based on boxes hosted on <http://puppet-vagrant-boxes.puppetlabs.com> as they have been built by myself and are generally trusted and have a reproducable build cycle (they aren't just 'golden images'). In the future I'll probably expand that list, but attempt to stick to boxes that we have control over.
 
@@ -96,6 +96,42 @@ For this reason there are various `provider_specific` settings that apply to dif
 
 `facts` in the prefab are literally dumps of `facter -p` on the host stored in the prefab file so you can look them up without addressing the machine. These are accessed using the `system_node#facts` method on the helper results and can be used in conditional logic during test runs and setup tasks. Not all the facts are supplied, only the more interesting ones.
 
+#### Custom Prefabs
+
+To define custom prefabs place a `.prefabs.yml` file in your project's root directory.
+
+    ---
+    'scientific-64-x64':
+      description: ""
+      facts:
+        kernelrelease: "2.6.32-358.el6.x86_64"
+        operatingsystem: Scientific
+        kernelmajversion: "2.6"
+        architecture: x86_64
+        facterversion: "1.7.0"
+        kernelversion: "2.6.32"
+        operatingsystemrelease: "6.4"
+        osfamily: RedHat
+        kernel: Linux
+        rubyversion: "1.8.7"
+      provider_specifics:
+        vagrant:
+          box: 'scientific-64-x64-vb4210-nocm'
+          box_url: 'http://example.com/path/to/scientific-64-x64-vb4210-nocm.box'
+
+#### Overriding Prefabs
+
+The custom prefab file, `.prefabs.yml` can also be used to override any of the built-in Prefabs.
+
+For example, to use a different box for CentOS 6.4 x64, you can override the `box_url`.  The example below overrides the URL to use the box with configuration management already installed.
+
+    ---
+    'centos-64-x64':
+      provider_specifics:
+        vagrant:
+          box: 'centos-64-x64-vbox4210'
+          box_url: 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box'
+
 ### Running tests
 
 There are two providers at the moment you can use to launch your nodes for testing:

data/lib/rspec-system/node.rb

@@ -7,10 +7,12 @@ module RSpecSystem
     # @param nodeset [RSpecSystem::Node] nodeset that this node belongs to
     # @param k [String] name of node
     # @param v [Hash<String,String>] hash configuration as given from the nodeset yaml file
+    # @param custom_prefabs_path [String] path of custom prefabs yaml file
     # @return [RSpecSystem::Node] returns a new node object
-    def self.node_from_yaml(nodeset, k, v)
+    def self.node_from_yaml(nodeset, k, v, custom_prefabs_path)
       RSpecSystem::Node.new(
         :nodeset => nodeset,
+        :custom_prefabs_path => custom_prefabs_path,
         :name => k,
         :prefab => v['prefab']
       )
@@ -23,16 +25,19 @@ module RSpecSystem
     # @option options [String] :prefab prefab setting. Mandatory.
     # @option options [RSpecSystem::NodeSet] :nodeset the parent nodeset for
     #   this node. Mandatory.
+    # @option options [String] :custom_prefabs_path path of custom prefabs
+    #   yaml file. Optional.
     def initialize(options)
       @name = options[:name]
       prefab = options[:prefab]
       @nodeset = options[:nodeset]
+      @custom_prefabs_path = options[:custom_prefabs_path]
 
       if prefab.nil?
         # TODO: do not support not prefabs yet
         raise "No prefab defined, bailing"
       else
-        @prefab = RSpecSystem::Prefab.prefab(prefab)
+        @prefab = RSpecSystem::Prefab.prefab(prefab, custom_prefabs_path)
         @facts = @prefab.facts
         @provider_specifics = @prefab.provider_specifics
       end

data/lib/rspec-system/node_set.rb

@@ -5,12 +5,12 @@ module RSpecSystem
     #
     # @return [RSpecSystem::NodeSet::Base] returns an object based on the Base
     #   abstract class.
-    def self.create(setname, config, virtual_env, options)
+    def self.create(setname, config, virtual_env, custom_prefabs_path, options)
       case(virtual_env)
       when 'vagrant'
-        RSpecSystem::NodeSet::Vagrant.new(setname, config, options)
+        RSpecSystem::NodeSet::Vagrant.new(setname, config, custom_prefabs_path, options)
       when 'vsphere'
-        RSpecSystem::NodeSet::Vsphere.new(setname, config, options)
+        RSpecSystem::NodeSet::Vsphere.new(setname, config, custom_prefabs_path, options)
       else
         raise "Unsupported virtual environment #{virtual_env}"
       end

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

@@ -6,18 +6,20 @@ module RSpecSystem
   class NodeSet::Base
     attr_reader :config
     attr_reader :setname
+    attr_reader :custom_prefabs_path
     attr_reader :nodes
     attr_reader :destroy
 
     # Create new NodeSet, populating necessary data structures.
-    def initialize(setname, config, options)
+    def initialize(setname, config, custom_prefabs_path, options)
       @setname = setname
       @config = config
+      @custom_prefabs_path = custom_prefabs_path
       @destroy = options[:destroy]
 
       @nodes = {}
       config['nodes'].each do |k,v|
-        @nodes[k] = RSpecSystem::Node.node_from_yaml(self, k, v)
+        @nodes[k] = RSpecSystem::Node.node_from_yaml(self, k, v, custom_prefabs_path)
       end
     end
 

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

@@ -14,8 +14,9 @@ module RSpecSystem
     #
     # @param setname [String] name of the set to instantiate
     # @param config [Hash] nodeset configuration hash
+    # @param custom_prefabs_path [String] path of custom prefabs yaml file
     # @param options [Hash] options Hash
-    def initialize(setname, config, options)
+    def initialize(setname, config, custom_prefabs_path, options)
       super
       @vagrant_path = File.expand_path(File.join(RSpec.configuration.system_tmp, 'vagrant_projects', setname))
     end
@@ -134,16 +135,16 @@ module RSpecSystem
 
           ps = v.provider_specifics['vagrant']
 
-          f.write(<<-EOS)
-  c.vm.define '#{k}' do |v|
-    v.vm.host_name = '#{k}'
-    v.vm.box = '#{ps['box']}'
-    v.vm.box_url = '#{ps['box_url']}'
-    v.vm.base_mac = '#{randmac}'
-  end
-          EOS
+          node_config = "  c.vm.define '#{k}' do |v|\n"
+          node_config << "    v.vm.host_name = '#{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 << "    v.vm.base_mac = '#{randmac}'\n"
+          node_config << "  end\n"
+
+          f.write(node_config)
         end
-        f.write('end')
+        f.write("end\n")
       end
       log.debug "[Vagrant#create_vagrantfile] Finished creating vagrant file"
       nil

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

@@ -15,8 +15,9 @@ module RSpecSystem
     #
     # @param setname [String] name of the set to instantiate
     # @param config [Hash] nodeset configuration hash
+    # @param custom_prefabs_path [String] path of custom prefabs yaml file
     # @param options [Hash] options Hash
-    def initialize(setname, config, options)
+    def initialize(setname, config, custom_prefabs_path, options)
       super
       @vim = RbVmomi::VIM.connect(
         :host => ENV["RSPEC_VSPHERE_HOST"],

data/lib/rspec-system/prefab.rb

@@ -7,8 +7,15 @@ module RSpecSystem
     attr_reader :provider_specifics
 
     # Return prefab object based on name
-    def self.prefab(name)
+    def self.prefab(name, custom_prefabs_path)
+      if File.exists?(custom_prefabs_path)
+        custom_prefabs = YAML.load_file(custom_prefabs_path)
+      else
+        custom_prefabs = {}
+      end
+
       prefabs = YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'resources', 'prefabs.yml'))
+      prefabs.merge!(custom_prefabs)
       raise "No such prefab" unless pf = prefabs[name]
 
       RSpecSystem::Prefab.new(

data/lib/rspec-system/spec_helper.rb

@@ -22,6 +22,10 @@ RSpec.configure do |c|
     Pathname.new(File.join(File.basename(__FILE__), '..', '.nodeset.yml'))
   end
 
+  def custom_prefabs_path
+    File.expand_path(File.join(File.basename(__FILE__), '..', '.prefabs.yml'))
+  end
+
   def rspec_system_config
     YAML.load_file('.nodeset.yml')
   end
@@ -42,7 +46,7 @@ RSpec.configure do |c|
     config = rspec_system_config['sets'][setname]
     options = {}
     options[:destroy] = rspec_destroy
-    RSpecSystem::NodeSet.create(setname, config, rspec_virtual_env, options)
+    RSpecSystem::NodeSet.create(setname, config, rspec_virtual_env, custom_prefabs_path, options)
   end
 
   def start_nodes

data/rspec-system.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec