boxgrinder-ovfcatalog-delivery-plugin 0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sergio Rubio <rubiojr@frameos.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Boxgrinder OVFCatalog
+
+Using Boxgrinder to build and upload appliances to the Abiquo OVFCatalog
+
+This tutorial will guide you to create an Ubuntu Oneiric appliance using [Boxgrinder](http://boxgrinder.org) and upload it to the Abiquo OVFCatalog (PlayRepo) service.
+
+**WARNNG**
+OVFCatalog is a brand new 2.0 service, not yet released.
+
+# Pre-requisites
+
+You need an Ubuntu based Boxgrinder meta-appliance (used to build other appliances). Get it from:
+
+    http://mirror.abiquo.com/appliances/boxgrinder-meta-ubuntu-oneiric-amd64.vmdk
+
+and deploy it.
+
+# Install the Boxgrinder ovfcatalog-delivery-plugin to the meta-appliance
+
+SSH to the boxgrinder meta-appliance. Default password for the root user is 'boxgrinder'.
+
+    $ ssh root@my-boxgrinder-meta-app
+
+Install required packages:
+
+    $ apt-get install libcurl4-openssl-dev build-essential git
+
+Install the plugin
+
+    $ gem install --no-ri --no-rdoc boxgrinder-ovfcatalog-delivery-plugin
+
+# Download sample appliance definitions
+
+You can download some Ubuntu based Boxgrinder appliance definitions from [here](http://github.com/rubiojr/boxgrinder-appliances). Let's check them out using git:
+
+    $ git clone http://github.com/rubiojr/boxgrinder-appliances
+
+We’ll use a Ubuntu appliance definition to generate a new appliance:
+
+    $ cd boxgrinder-appliances/ubuntu-jeos
+
+    $ boxgrinder-build -l boxgrinder-ubuntu-plugin,ovfcatalog-plugin \
+                               -d ovfcatalog \
+                               --delivery-config host:rs.bcn.abiquo.com,port:9000 \
+                               oneiric.appl
+
+This will build the Ubuntu Oneiric appliance and upload it to the OVFCatalog service installed in 'rs.bcn.abiquo.com' and  listening on port '9000'.
+
+
+
+Browse the OVFCatalog and you'll see a new appliance named 'ubuntu-oneiric' in QCOW2 format.
+
+#OVFCatalog plugin configuration parameters
+
+The ovfcatalog Boxgrinder plugin accepts the following list of config parameters:
+
+**host:** the OVFCatalog host.
+**port:** the OVFCatalog port.
+**category:** the OVFCatalog category the appliance will have.
+**icon_path:** the URL of the appliance icon.
+**host:** the OVFCatalog host
+**name:** the appliance name.
+**description:** the appliance description.
+**ram:** the amount of RAM the appliance will have.
+**cpu:** the number of CPUs the appliance will have.
+
+All the config parameters have default values and none of them are mandatory. Use the **--delivery-config** Boxgrinder parameter to configure the appliance upload to fit your needs.
+
+
+# Copyright
+
+Copyright (c) 2011 Abiquo Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = "0.1"
+  gem.name = "boxgrinder-ovfcatalog-delivery-plugin"
+  gem.homepage = "http://github.com/abiquo/boxgrinder-ovfcatalog-delivery-plugin"
+  gem.license = "MIT"
+  gem.summary = %Q{Deliver Boxgrider appliances to Abiquo OVFCatalog service}
+  gem.description = %Q{Deliver Boxgrider appliances to Abiquo OVFCatalog service}
+  gem.email = "rubiojr@frameos.org"
+  gem.authors = ["Sergio Rubio"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'diskid'
+  gem.add_runtime_dependency 'curb'
+  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :build
+

data/lib/ovfcatalog-plugin.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'diskid'
+require 'curb'
+require 'boxgrinder-build/plugins/base-plugin'
+
+module BoxGrinder
+  class OVFCatalog < BasePlugin
+    def validate
+      set_default_config_value('category', 'Misc')
+      set_default_config_value('name', @appliance_config.name)
+      set_default_config_value('description', "#{@appliance_config.name}-#{@appliance_config.version}.#{@appliance_config.release}-#{@appliance_config.os.name}-#{@appliance_config.os.version}-#{@appliance_config.hardware.arch}")
+      set_default_config_value('port', '9000')
+      set_default_config_value('ram', '512')
+      set_default_config_value('cpu', '1')
+      set_default_config_value('host', 'rs.bcn.abiquo.com')
+      set_default_config_value('icon_path', 'http://rs.bcn.abiquo.com:9000/public/icons/q.png')
+    end
+
+    def execute
+      @log.info "Uploading #{@appliance_config.name} to OVFCatalog..."
+      begin
+        #TODO move to a block
+        upload_files(@previous_deliverables[:disk])
+        @log.info "Appliance #{@appliance_config.name} uploaded."
+      rescue => e
+        @log.error e
+        @log.error "An error occurred while uploading files."
+      end
+    end
+    
+    def upload_files(disk_file)
+      server_host = @plugin_config['host']
+      server_port = @plugin_config['port']
+      name = @plugin_config['name']
+      ram = @plugin_config['ram']
+      cpu = @plugin_config['cpu']
+      category = @plugin_config['category']
+      icon_path = @plugin_config['icon_path']
+      description = "#{@appliance_config.name}-#{@appliance_config.version}.#{@appliance_config.release}-#{@appliance_config.os.name}-#{@appliance_config.os.version}-#{@appliance_config.hardware.arch}"
+      disk_info = DiskID::Client.identify(disk_file)
+      units = disk_info['virtual_size'].gsub(/[0-9]|\./,'')
+      virtual_size = disk_info['virtual_size'].gsub(/G|M/,'')
+      if units == 'G'
+        vsbytes = virtual_size.to_f * 1024 * 1024 * 1024
+      else
+        vsbytes = virtual_size.to_f * 1024 * 1024
+      end
+      puts "Name:".ljust(40) + name
+      puts "Description:".ljust(40) + description
+      puts "Category:".ljust(40) + category
+      puts "RAM:".ljust(40) + "#{ram} MB"
+      puts "CPU:".ljust(40) + cpu
+      puts "HD:".ljust(40) + "#{virtual_size} #{units} (#{vsbytes} bytes)"
+      puts "Filesize:".ljust(40) + "#{FileTest.size(disk_file)} bytes"
+      c = Curl::Easy.new "http://#{server_host}:#{server_port}/createOvf"
+      c.multipart_form_post = true
+      c.on_progress { |dt, dn, ut, un| print "\r\e[0KUploading disk: %.0f%" % ((un*100)/ut); true }
+      c.http_post Curl::PostField.content('object.diskFilePath', disk_file),
+                  Curl::PostField.content('object.diskFileSize', FileTest.size(disk_file).to_s),
+                  Curl::PostField.content('object.diskFileFormat', guess_format(disk_file)),
+                  Curl::PostField.content('object.name', name),
+                  Curl::PostField.content('object.description', description),
+                  Curl::PostField.content('object.categoryName', category),
+                  Curl::PostField.content('object.iconPath', icon_path),
+                  Curl::PostField.content('object.cpu', cpu),
+                  Curl::PostField.content('object.ram', ram),
+                  Curl::PostField.content('object.ramSizeUnit', "MB"),
+                  Curl::PostField.content('object.hd', virtual_size),
+                  Curl::PostField.content('object.hdSizeUnit', "#{units}B"),
+                  Curl::PostField.content('object.hdInBytes', vsbytes.to_s ),
+                  Curl::PostField.file('diskFile', disk_file)
+      puts
+    end
+
+    def guess_format(file)
+      format_map = {
+        "vmdk_streamOptimized" => "VMDK_STREAM_OPTIMIZED",
+        "qcow2" => "QCOW2_SPARSE",
+        "vmdk_monolithicSparse" => "VMDK_SPARSE"
+      }
+      f = DiskID::Client.identify(file)
+      fstring = ''
+      if f['format'] == 'vmdk'
+        fstring = format_map["vmdk_#{f['variant']}"]
+      elsif f['format'] == 'qcow2'
+        fstring = "QCOW2_SPARSE"
+      else
+      end
+      fstring
+    end
+
+  end
+end
+
+plugin :class => BoxGrinder::OVFCatalog, :type => :delivery, :name => :ovfcatalog, :full_name  => "Upload appliance to Abiquo OVFCatalog"

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rspec/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lib-here'
+
+module TestHelpersMod
+  
+  def data_dir 
+    File.join(File.dirname(__FILE__),"data")
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: boxgrinder-ovfcatalog-delivery-plugin
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Sergio Rubio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diskid
+  requirement: &23040360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23040360
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: &23039880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23039880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &23039400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: *23039400
+description: Deliver Boxgrider appliances to Abiquo OVFCatalog service
+email: rubiojr@frameos.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ovfcatalog-plugin.rb
+- spec/spec_helper.rb
+homepage: http://github.com/abiquo/boxgrinder-ovfcatalog-delivery-plugin
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Deliver Boxgrider appliances to Abiquo OVFCatalog service
+test_files: []