boxgrinder-build 0.7.1 → 0.8.0

data/spec/helpers/package-helper-spec.rb

@@ -16,9 +16,44 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'logger'
 require 'boxgrinder-build/helpers/package-helper'
 
 module BoxGrinder
   describe PackageHelper do
+    before(:each) do
+      @config = mock('Config')
+      @appliance_config = mock('ApplianceConfig')
+      @exec_helper = mock(ExecHelper)
+      @log = Logger.new('/dev/null')
+      @appliance_config.stub!(:name).and_return('jeos-f13')
+
+      @helper = PackageHelper.new(@config, @appliance_config, :log => @log, :exec_helper => @exec_helper)
+    end
+
+    it "should package deliverables" do
+      File.should_receive(:exists?).with('destination/package.tgz').and_return(false)
+      File.should_receive(:expand_path).with('a/dir').and_return('a/dir/expanded')
+      FileUtils.should_receive(:ln_s).with('a/dir/expanded', 'destination/package')
+      FileUtils.should_receive(:rm).with('destination/package')
+
+      @exec_helper.should_receive(:execute).with("tar -C 'destination' -hcvzf 'destination/package.tgz' 'package'")
+
+      @helper.package('a/dir', 'destination/package.tgz')
+    end
+
+    it "should NOT package deliverables if pacakge already exists" do
+      File.should_receive(:exists?).with('destination/package.tgz').and_return(true)
+
+      @exec_helper.should_not_receive(:execute)
+
+      @helper.package('a/dir', 'destination/package.tgz')
+    end
+
+    it "should raise if unsupported format is specified" do
+      lambda {
+        @helper.package('a/dir', 'destination/package.tgz', :xyz)
+      }.should raise_error("Specified format: 'xyz' is currently unsupported.")
+    end
   end
 end

data/spec/helpers/plugin-helper-spec.rb

@@ -16,49 +16,47 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'boxgrinder-core/helpers/log-helper'
 require 'boxgrinder-build/helpers/plugin-helper'
 require 'ostruct'
 
 module BoxGrinder
   describe PluginHelper do
     before(:all) do
-      @current_arch = (-1.size) == 8 ? "x86_64" : "i386"
-      @plugin_array = %w(boxgrinder-build-fedora-os-plugin boxgrinder-build-rhel-os-plugin boxgrinder-build-centos-os-plugin boxgrinder-build-ec2-platform-plugin boxgrinder-build-vmware-platform-plugin boxgrinder-build-s3-delivery-plugin boxgrinder-build-sftp-delivery-plugin boxgrinder-build-local-delivery-plugin boxgrinder-build-ebs-delivery-plugin)
+      @plugin_array = %w(boxgrinder-build-fedora-os-plugin boxgrinder-build-rhel-os-plugin boxgrinder-build-centos-os-plugin boxgrinder-build-ec2-platform-plugin boxgrinder-build-vmware-platform-plugin boxgrinder-build-virtualbox-platform-plugin boxgrinder-build-s3-delivery-plugin boxgrinder-build-sftp-delivery-plugin boxgrinder-build-local-delivery-plugin boxgrinder-build-ebs-delivery-plugin)
     end
 
     before(:each) do
-      @plugin_helper = PluginHelper.new(:options => OpenStruct.new)
+      @log = LogHelper.new(:level => :trace, :type => :stdout)
+      @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => []), :log => @log)
     end
 
-    it "should parse plugin list and return empty array when no plugins are provided" do
-      @plugin_helper.parse_plugin_list.should == []
-    end
+    it "should require default plugins" do
+      @plugin_array.each do |plugin|
+        @plugin_helper.should_receive(:require).once.with(plugin)
+      end
 
-    it "should parse plugin list with double quotes" do
-      @plugin_helper = PluginHelper.new(:options => OpenStruct.new(:plugins => '"abc,def"'))
-      @plugin_helper.parse_plugin_list.should == ['abc', 'def']
+      @plugin_helper.read_and_require
     end
 
-    it "should parse plugin list with single quotes" do
-      @plugin_helper = PluginHelper.new(:options => OpenStruct.new(:plugins => "'abc,def'"))
-      @plugin_helper.parse_plugin_list.should == ['abc', 'def']
-    end
+    it "should require default plugins and fail silently" do
+      @log = mock('Logger')
 
-    it "should parse plugin list with single quotes and clean up it" do
-      @plugin_helper = PluginHelper.new(:options => OpenStruct.new(:plugins => "'    abc ,    def'"))
-      @plugin_helper.parse_plugin_list.should == ['abc', 'def']
-    end
+      @plugin_helper.instance_variable_set(:@log, @log)
 
-    it "should require default plugins" do
       @plugin_array.each do |plugin|
-        @plugin_helper.should_receive(:require).once.with(plugin)
+        @log.should_receive(:trace).with("Loading plugin '#{plugin}'...")
+        @plugin_helper.should_receive(:require).once.with(plugin).and_raise(LoadError)
+        @log.should_receive(:trace).with("- Not found: LoadError")
       end
 
+      @log.should_not_receive(:warn)
+
       @plugin_helper.read_and_require
     end
 
     it "should read plugins specified in command line" do
-      @plugin_helper = PluginHelper.new(:options => OpenStruct.new(:plugins => 'abc,def'))
+      @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => ['abc', 'def']), :log => @log)
 
       @plugin_array.each do |plugin|
         @plugin_helper.should_receive(:require).once.with(plugin)
@@ -69,6 +67,52 @@ module BoxGrinder
 
       @plugin_helper.read_and_require
     end
+
+    it "should read plugins specified in command line and warn if plugin cannot be loaded" do
+      @log = mock('Logger')
+      @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => ['abc']), :log => @log)
+
+      @plugin_array.each do |plugin|
+        @log.should_receive(:trace).with("Loading plugin '#{plugin}'...")
+        @plugin_helper.should_receive(:require).once.with(plugin)
+        @log.should_receive(:trace).with("- OK")
+      end
+
+      @log.should_receive(:trace).with("Loading plugin 'abc'...")
+      @plugin_helper.should_receive(:require).ordered.with('abc').and_raise(LoadError)
+      @log.should_receive(:trace).with("- Not found: LoadError")
+      @log.should_receive(:warn).with("Specified plugin: 'abc' wasn't found. Make sure its name is correct, skipping...")
+
+      @plugin_helper.read_and_require
+    end
+
+    it "should print os plugins" do
+      @log = mock('Logger')
+
+      @plugin_helper.instance_variable_set(:@log, @log)
+
+      @log.should_receive(:debug).with('Loading os plugins...')
+      @log.should_receive(:debug).with('We have 1 os plugin(s) registered')
+      @log.should_receive(:debug).with("- fedora plugin for Fedora.")
+      @log.should_receive(:debug).with('Plugins loaded.')
+
+      @plugin_helper.print_plugins('os') { {'fedora' => {:full_name => "Fedora"}} }
+    end
+
+    it "should load all plugins" do
+      @plugin_helper.should_receive(:read_and_require)
+
+      plugin_manager = mock('PluginManager')
+      plugin_manager.stub!(:plugins).and_return({:os =>{}, :platform =>{}, :delivery =>{}})
+
+      PluginManager.stub!(:instance).and_return(plugin_manager)
+
+      @plugin_helper.should_receive(:print_plugins).with('os')
+      @plugin_helper.should_receive(:print_plugins).with('platform')
+      @plugin_helper.should_receive(:print_plugins).with('delivery')
+
+      @plugin_helper.load_plugins
+    end
   end
 end
 

data/spec/managers/plugin-manager-spec.rb

@@ -26,14 +26,14 @@ module BoxGrinder
     end
 
     it "should register simple plugin" do
-      @manager.register_plugin( { :class => PluginManager, :type => :delivery, :name => :abc, :full_name  => "Amazon Simple Storage Service (Amazon S3)" } )
+      @manager.register_plugin({:class => PluginManager, :type => :delivery, :name => :abc, :full_name => "Amazon Simple Storage Service (Amazon S3)"})
 
       @manager.plugins[:delivery].size.should == 1
       @manager.plugins[:delivery][:abc][:class].should == PluginManager
     end
 
     it "should register plugin with many types" do
-      @manager.register_plugin( { :class => PluginManager, :type => :delivery, :name => :s3, :full_name  => "Amazon Simple Storage Service (Amazon S3)", :types => [:s3, :cloudfront, :ami] } )
+      @manager.register_plugin({:class => PluginManager, :type => :delivery, :name => :s3, :full_name => "Amazon Simple Storage Service (Amazon S3)", :types => [:s3, :cloudfront, :ami]})
 
       @manager.plugins[:delivery].size.should == 4
       @manager.plugins[:delivery][:abc][:class].should == PluginManager
@@ -41,5 +41,36 @@ module BoxGrinder
       @manager.plugins[:delivery][:s3][:class].should == PluginManager
       @manager.plugins[:delivery][:cloudfront][:class].should == PluginManager
     end
+
+    it "should initialize a plugin" do
+      plugin = mock('Plugin')
+
+      clazz = mock('Class')
+      clazz.should_receive(:new).and_return(plugin)
+
+      @manager.instance_variable_set(:@plugins, {:delivery => {}, :os => {:fedora => {:class => clazz}}, :platform => {}})
+      @manager.initialize_plugin(:os, :fedora).should == [plugin, {:class => clazz}]
+    end
+
+    it "should raise if plugin initialization cannot be finished" do
+      clazz = mock('Class')
+      clazz.should_receive(:new).and_raise("Something")
+      clazz.should_receive(:to_s).and_return("Fedora")
+
+      @manager.instance_variable_set(:@plugins, {:delivery => {}, :os => {:fedora => {:class => clazz}}, :platform => {}})
+
+      lambda {
+        @manager.initialize_plugin(:os, :fedora)
+      }.should raise_error("Error while initializing 'Fedora' plugin.")
+    end
+
+    it "should register the plugin with 'plugin' method" do
+      plugin_manager = mock(PluginManager)
+      plugin_manager.should_receive(:register_plugin).with(:class => String, :type => :platform, :name => :ec2, :full_name  => "Amazon Elastic Compute Cloud (Amazon EC2)")
+
+      PluginManager.should_receive(:instance).and_return(plugin_manager)
+
+      plugin :class => String, :type => :platform, :name => :ec2, :full_name  => "Amazon Elastic Compute Cloud (Amazon EC2)"
+    end
   end
 end

data/spec/plugins/base-plugin-spec.rb

@@ -18,6 +18,7 @@
 
 require 'rubygems'
 require 'boxgrinder-build/plugins/base-plugin'
+require 'boxgrinder-core/helpers/log-helper'
 require 'yaml'
 
 module BoxGrinder
@@ -27,13 +28,22 @@ module BoxGrinder
       @config.stub!(:name).and_return('BoxGrinder')
       @config.stub!(:version_with_release).and_return('0.1.2')
 
+      plugins = mock('Plugins')
+      plugins.stub!(:[]).with('plugin_name').and_return({})
+
+      @config.stub!(:[]).with(:plugins).and_return(plugins)
+      @config.stub!(:file).and_return('/home/abc/boxgrinder_config_file')
+
       @appliance_config = mock('ApplianceConfig')
 
       @appliance_config.stub!(:path).and_return(OpenCascade.new({:build => 'build/path'}))
-      @appliance_config.stub!(:os).and_return(OpenCascade.new({:name => 'fedora', :version => '11'}))
+      @appliance_config.stub!(:os).and_return(OpenCascade.new({:name => 'fedora', :version => '13'}))
+
+      @log = LogHelper.new(:level => :trace, :type => :stdout)
 
       @plugin = BasePlugin.new
-      @plugin.init(@config, @appliance_config, :plugin_info => {:name => :plugin_name}, :log => Logger.new('/dev/null'))
+      @plugin.should_receive(:merge_plugin_config)
+      @plugin.init(@config, @appliance_config, :plugin_info => {:name => :plugin_name, :full_name => "Amazon Simple Storage Service (Amazon S3)"}, :log => @log)
     end
 
     it "should be initialized after running init method" do
@@ -93,18 +103,28 @@ module BoxGrinder
       @plugin.deliverables_exists?.should == false
     end
 
-    it "should run the plugin" do
-      @plugin.register_deliverable(:disk => "disk")
+    describe ".run" do
+      it "should run the plugin" do
+        @plugin.register_supported_os('fedora', ['12', '13'])
+        @plugin.register_deliverable(:disk => "disk")
 
-      FileUtils.should_receive(:rm_rf).with("build/path/plugin_name-plugin/tmp")
-      FileUtils.should_receive(:mkdir_p).with("build/path/plugin_name-plugin/tmp")
+        FileUtils.should_receive(:rm_rf).with("build/path/plugin_name-plugin/tmp")
+        FileUtils.should_receive(:mkdir_p).with("build/path/plugin_name-plugin/tmp")
 
-      @plugin.should_receive(:execute).with('a', 3)
+        @plugin.should_receive(:execute).with('a', 3)
 
-      FileUtils.should_receive(:mv).with("build/path/plugin_name-plugin/tmp/disk", "build/path/plugin_name-plugin/disk")
-      FileUtils.should_receive(:rm_rf).with("build/path/plugin_name-plugin/tmp")
+        FileUtils.should_receive(:mv).with("build/path/plugin_name-plugin/tmp/disk", "build/path/plugin_name-plugin/disk")
+        FileUtils.should_receive(:rm_rf).with("build/path/plugin_name-plugin/tmp")
 
-      @plugin.run('a', 3)
+        @plugin.run('a', 3)
+      end
+
+      it "should fail if OS is not supported" do
+        @plugin.register_supported_os('fedora', ['12', '13'])
+        @appliance_config.stub!(:os).and_return(OpenCascade.new({:name => 'fedora', :version => '14'}))
+        @log.should_receive(:error).with('Amazon Simple Storage Service (Amazon S3) plugin supports following operating systems: fedora (versions: 12, 13). Your appliance contains fedora 14 operating system which is not supported by this plugin, sorry.')
+        @plugin.run
+      end
     end
 
     it "should register a supported os" do
@@ -120,7 +140,7 @@ module BoxGrinder
     it "should return that the OS is supported" do
       @plugin.register_supported_os('fedora', ['12', '13'])
 
-      @plugin.instance_variable_get(:@appliance_config).os.name    = 'fedora'
+      @plugin.instance_variable_get(:@appliance_config).os.name = 'fedora'
       @plugin.instance_variable_get(:@appliance_config).os.version = '12'
 
       @plugin.is_supported_os?.should == true
@@ -129,12 +149,16 @@ module BoxGrinder
     it "should return that the OS is not supported" do
       @plugin.register_supported_os('fedora', ['1223'])
 
-      @plugin.instance_variable_get(:@appliance_config).os.name    = 'fedora'
+      @plugin.instance_variable_get(:@appliance_config).os.name = 'fedora'
       @plugin.instance_variable_get(:@appliance_config).os.version = '12'
 
       @plugin.is_supported_os?.should == false
     end
 
+    it "should return false when no operating systems are specified" do
+      @plugin.is_supported_os?.should == true
+    end
+
     it "should return supported os string" do
       @plugin.register_supported_os('fedora', ['12', '13'])
       @plugin.register_supported_os('centos', ['5'])
@@ -148,29 +172,61 @@ module BoxGrinder
       @plugin.instance_variable_get(:@plugin_config)['key'].should == 'avalue'
     end
 
-    it "should read plugin config" do
-      @plugin.instance_variable_set(:@config_file, "configfile")
+    describe ".read_plugin_config" do
+      it "should read plugin config" do
+        plugins = mock('Plugins')
+        plugins.stub!(:[]).with('plugin_name').and_return({'abc' => 'def'})
+        @config.stub!(:[]).with(:plugins).and_return(plugins)
+
+        @plugin.read_plugin_config
+        @plugin.instance_variable_get(:@plugin_config)['abc'].should == 'def'
+      end
+
+      it "should read plugin config and exit early" do
+        @config.stub!(:[]).with(:plugins).and_return(nil)
+        @plugin.read_plugin_config
+      end
+    end
 
-      File.should_receive(:exists?).with('configfile').and_return(true)
-      YAML.should_receive(:load_file).with('configfile').and_return('abcdef')
+    describe ".current_platform" do
+      it "should return raw" do
+        @plugin.current_platform.should == 'raw'
+      end
 
-      @plugin.read_plugin_config
+      it "should return vmware" do
+        @plugin.instance_variable_set(:@previous_plugin_info, {:type => :platform, :name => :vmware})
 
-      @plugin.instance_variable_get(:@plugin_config).should == 'abcdef'
+        @plugin.current_platform.should == 'vmware'
+      end
     end
 
-    it "should read plugin config and raise an exception" do
-      @plugin.instance_variable_set(:@config_file, "configfile")
+    describe ".validate_plugin_config" do
+      it "should validate plugn config" do
+        @plugin.instance_variable_set(:@plugin_config, {'one' => :platform, 'two' => :vmware})
 
-      File.should_receive(:exists?).with('configfile').and_return(true)
-      YAML.should_receive(:load_file).with('configfile').and_raise('something')
+        @plugin.validate_plugin_config(['one', 'two'])
+      end
 
-      begin
-        @plugin.read_plugin_config
-        raise "Should raise"
-      rescue => e
-        e.message.should == "An error occurred while reading configuration file 'configfile' for BoxGrinder::BasePlugin. Is it a valid YAML file?"
+      it "should raise because some data isn't provided" do
+        @plugin.instance_variable_set(:@plugin_config, {'one' => :platform, 'two' => :vmware})
+
+        lambda {
+          @plugin.validate_plugin_config(['one', 'two', 'three'])
+        }.should raise_error(RuntimeError, "Please specify a valid 'three' key in BoxGrinder configuration file: '/home/abc/boxgrinder_config_file' or use CLI '---config three:DATA' argument. ")
       end
     end
+
+    it "should not allow to execute the plugin before initialization" do
+      @plugin = BasePlugin.new
+
+      lambda {
+        @plugin.execute
+      }.should raise_error(RuntimeError, "You can only execute the plugin after the plugin is initialized, please initialize the plugin using init method.")
+    end
+
+    it "should return target deliverables" do
+      @plugin.register_deliverable(:disk => "disk", :vmx => "vmx")
+      @plugin.deliverables.should == {:disk => "build/path/plugin_name-plugin/disk", :vmx => "build/path/plugin_name-plugin/vmx"}
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boxgrinder-build
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Marek Goldmann
@@ -15,23 +15,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-03 00:00:00 +01:00
+date: 2011-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: commander
+  name: thor
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 17
         segments: 
-        - 4
         - 0
-        - 3
-        version: 4.0.3
+        - 13
+        version: "0.13"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -42,25 +41,26 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 23
         segments: 
         - 0
-        - 1
-        - 5
-        version: 0.1.5
+        - 2
+        - 0
+        version: 0.2.0
   type: :runtime
   version_requirements: *id002
 description: A tool for creating appliances from simple plain text files for various virtual environments.
 email: info@boxgrinder.org
 executables: 
-- boxgrinder-build
+- boxgrinder
 extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
 - LICENSE
 - README
-- bin/boxgrinder-build
+- bin/boxgrinder
+- lib/boxgrinder-build.rb
 - lib/boxgrinder-build/appliance.rb
 - lib/boxgrinder-build/helpers/appliance-customize-helper.rb
 - lib/boxgrinder-build/helpers/augeas-helper.rb
@@ -69,6 +69,7 @@ extra_rdoc_files:
 - lib/boxgrinder-build/helpers/linux-helper.rb
 - lib/boxgrinder-build/helpers/package-helper.rb
 - lib/boxgrinder-build/helpers/plugin-helper.rb
+- lib/boxgrinder-build/helpers/thor-helper.rb
 - lib/boxgrinder-build/managers/plugin-manager.rb
 - lib/boxgrinder-build/plugins/base-plugin.rb
 files: 
@@ -77,8 +78,9 @@ files:
 - Manifest
 - README
 - Rakefile
-- bin/boxgrinder-build
+- bin/boxgrinder
 - boxgrinder-build.gemspec
+- lib/boxgrinder-build.rb
 - lib/boxgrinder-build/appliance.rb
 - lib/boxgrinder-build/helpers/appliance-customize-helper.rb
 - lib/boxgrinder-build/helpers/augeas-helper.rb
@@ -87,6 +89,7 @@ files:
 - lib/boxgrinder-build/helpers/linux-helper.rb
 - lib/boxgrinder-build/helpers/package-helper.rb
 - lib/boxgrinder-build/helpers/plugin-helper.rb
+- lib/boxgrinder-build/helpers/thor-helper.rb
 - lib/boxgrinder-build/managers/plugin-manager.rb
 - lib/boxgrinder-build/plugins/base-plugin.rb
 - rubygem-boxgrinder-build.spec
@@ -101,8 +104,6 @@ files:
 - spec/helpers/plugin-helper-spec.rb
 - spec/managers/plugin-manager-spec.rb
 - spec/plugins/base-plugin-spec.rb
-- spec/rspec/src/appliances/jeos-f13.appl
-- spec/rspec/src/appliances/jeos-f13.ks
 has_rdoc: true
 homepage: http://www.jboss.org/boxgrinder
 licenses: []