mbailey-ruby-xen 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.0.2 / 2008-09-11
+
+* Broke out classes into separate files
+* Added rspec outline
+
 === 0.0.1 / 2008-09-08
 
 * Initial import

data/Manifest.txt

@@ -6,3 +6,11 @@ bin/ruby-xen
 lib/ruby-xen.rb
 test/test_ruby-xen.rb
 lib/ruby-xen/domain.rb
+lib/xen/backup.rb
+lib/xen/command.rb
+lib/xen/config.rb
+lib/xen/slice.rb
+lib/xen/host.rb
+lib/xen/image.rb
+lib/xen/instance.rb
+lib/templates/domu.cfg.erb

data/README.rdoc

@@ -25,13 +25,12 @@ ruby-xen can also be used by ruby code or from irb.
   require 'rubygems'
   require 'ruby-xen'
 
-
-  domain = Xen::Domain.find(:example)
-  domain.running? # true
-  domain.stop
-  domain.running? # false
-  domain.start
-  domain.running? # true
+  slice = Xen::Slice.find(:example)
+  slice.running? # true
+  slice.stop
+  slice.running? # false
+  slice.start
+  slice.running? # true
 
 == REQUIREMENTS:
 
@@ -49,7 +48,7 @@ or open source applications. More details found here:
 http://www.gnu.org/licenses/gpl.html
 
 ruby-xen
-Copyright (C) 2008 Mike Bailey and Nick Markfleet
+Copyright (C) 2008 Mike Bailey and Nick Marfleet
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License

data/Rakefile

@@ -1,12 +1,12 @@
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
-require './lib/ruby-xen.rb'
-
-Hoe.new('ruby-xen', RubyXen::VERSION) do |p|
-  # p.rubyforge_name = 'ruby-xenx' # if different than lowercase project name
-  p.developer('Mike Bailey', 'mike@bailey.net.au')
-end
+# require 'rubygems'
+# require 'hoe'
+# require './lib/ruby-xen.rb'
+# 
+# Hoe.new('ruby-xen', Xen::VERSION) do |p|
+#   # p.rubyforge_name = 'ruby-xenx' # if different than lowercase project name
+#   p.developer('Mike Bailey', 'mike@bailey.net.au')
+# end
 
 # vim: syntax=Ruby

data/lib/ruby-xen.rb

@@ -23,18 +23,24 @@ module Xen
   # the object expires.
   INSTANCE_OBJECT_LIFETIME = 1
   
-  # DRY up some classes (children of Domain) with some module funkiness.
+  TEMPLATE_DIR = File.expand_path(File.dirname(__FILE__) + '/../lib/templates')
+  
+  # Extension for Xen domU config files
+  CONFIG_FILE_EXTENSION = '.cfg'
+  
+  # DRY up some classes (children of Slice) with some module funkiness.
   module Parentable
-    # Returns the parent Domain object (d) for a sub-object. 
+    # Returns the parent Slice object (d) for a sub-object. 
     # We ensure d.instance.object_id == self.object_id
     # 
     # ==== Example
     #   i = Xen::Instance.all[2]
-    #   d = i.domain
-    #   # i.object_id == d.instance.object_id
+    #   s = i.slice
+    #   i.object_id == s.instance.object_id # true
     #
-    def domain
-      d = Xen::Domain.new(name)
+    def slice
+      d = Xen::Slice.new(name)
+      # Insert the current object into the newly created Slice's attributes
       d.instance_variable_set("@#{self.class.to_s.sub('Xen::','').downcase}", self)
       d
     end
@@ -44,7 +50,7 @@ end
 require "#{File.dirname(__FILE__)}/xen/backup"
 require "#{File.dirname(__FILE__)}/xen/command"
 require "#{File.dirname(__FILE__)}/xen/config"
-require "#{File.dirname(__FILE__)}/xen/domain"
+require "#{File.dirname(__FILE__)}/xen/slice"
 require "#{File.dirname(__FILE__)}/xen/host"
 require "#{File.dirname(__FILE__)}/xen/image"
 require "#{File.dirname(__FILE__)}/xen/instance"

data/lib/templates/domu.cfg.erb

@@ -0,0 +1,40 @@
+#
+# Configuration file for the Xen instance <%= name %>, created
+# by ruby-xen on <%= Time.now %>.
+#
+
+#
+#  Kernel + memory size
+#
+kernel      = '<%= kernel %>'
+ramdisk     = '<%= ramdisk %>'
+memory      = '<%= memory %>'
+
+#
+#  Disk device(s).
+#
+root        = '<%= root %>'
+disk        = [ 
+	'<%= Array(vbds).collect{|d| d.to_str}.join("',\n\t'") %>' 
+]
+
+#
+#  Hostname
+#
+name        = '<%= name %>'
+
+#
+#  Networking
+#
+vif         = [
+	'<%= Array(vifs).collect{|v| v.to_str}.join("',\n\t'") %>'
+]
+
+#
+#  Behaviour
+#
+on_poweroff = '<%= on_poweroff %>'
+on_reboot   = '<%= on_reboot %>'
+on_crash    = '<%= on_crash %>'
+
+extra = '<%= extra %>'

data/lib/xen/command.rb

@@ -1,8 +1,30 @@
 class Xen::Command
-  def self.xm_list
-    `xm list`
+  # def self.xm_list
+  #   raw = `xm list`.scan(/(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)/)
+  #   headers = raw.delete_at(0)
+  #   raw.map do |row|
+  #     headers.enum_with_index.inject({}) { |m, (head, i)| m[head] = row[i]; m  }
+  #   end
+  # end
+  
+  def self.detailed_instance_list(name='')
+    raw_entries = `xm list --long #{name}`.split(/\n\(domain/)
+    raw_entries.collect do |entry|
+      attributes = entry.scan(/\((name|domid|memory|vcpus|state|cpu_time|start_time) (.*)\)/)
+      attributes.inject({}) { |m, (key, val)| m[key.to_sym] = val; m } 
+    end
   end
+  
+  def self.create(config_file)
+    `xm create #{config_file}`
+  end
+  
+  def self.shutdown(name, blocking=false)
+    `xm shutdown #{'-w' if blocking} #{name}`
+  end  
+    
   def self.xm_info
-    `xm info`
-  end 
-end
+    result = `xm info`
+    result.scan(/(\S+)\s*:\s*([^\n]+)/).inject({}){ |m, (i,j)| m[i.to_sym] = j; m }
+  end
+end

data/lib/xen/config.rb

@@ -1,7 +1,9 @@
+require 'erb'
+
 # The Xen config files on disk
 class Xen::Config
   include Xen::Parentable
-  attr_accessor :name, :kernel, :ramdisk, :memory, :root, :disk, :vif, :on_poweroff, :on_reboot, :on_crash, :extra
+  attr_accessor :name, :kernel, :ramdisk, :memory, :root, :vbds, :vifs, :on_poweroff, :on_reboot, :on_crash, :extra
 
   def initialize(*args)
     options = args.extract_options!
@@ -10,8 +12,8 @@ class Xen::Config
     @ramdisk = options[:ramdisk]
     @memory = options[:memory]
     @root = options[:root]
-    @disk = options[:disk]
-    @vif = options[:vif]
+    @vbds = options[:vbds]
+    @vifs = options[:vifs]
     @on_poweroff = options[:on_poweroff]
     @on_reboot = options[:on_reboot]
     @on_crash = options[:on_crash]
@@ -27,7 +29,7 @@ class Xen::Config
   end
 
   def self.all
-    config_files = Dir.glob("#{Xen::XEN_DOMU_CONFIG_DIR}/*.cfg")
+    config_files = Dir.glob("#{Xen::XEN_DOMU_CONFIG_DIR}/*#{Xen::CONFIG_FILE_EXTENSION}")
     config_files.collect do |filename|
       create_from_config_file(File.read(filename))
     end
@@ -35,18 +37,103 @@ class Xen::Config
 
   def self.find_by_name(name)
     return new('Domain-0') if name == 'Domain-0' 
-    filename = "#{Xen::XEN_DOMU_CONFIG_DIR}/#{name}.cfg"
+    filename = "#{Xen::XEN_DOMU_CONFIG_DIR}/#{name}#{Xen::CONFIG_FILE_EXTENSION}"
     create_from_config_file(File.read(filename))
   end
+    
+  def config_file
+    "#{Xen::XEN_DOMU_CONFIG_DIR}/#{name}#{Xen::CONFIG_FILE_EXTENSION}"
+  end
+  
+  def auto_file
+    "#{Xen::XEN_DOMU_CONFIG_DIR}/auto/#{name}#{Xen::CONFIG_FILE_EXTENSION}"
+  end
+  
+  def updated_at
+	  File.mtime(config_file)
+	end
+	
+	# Set to true|false to enable|disable autostart of slice
+	def auto=(value)
+    filename = File.basename(config_file)
+    if value == true
+      File.symlink("../#{filename}", auto_file)
+    else
+      File.unlink(auto_file)
+    end
+  end
+  
+  # Returns true|false depending on whether slice is set to start automatically
+  def auto
+    File.symlink?(auto_file) && File.expand_path(File.readlink(auto_file), File.dirname(auto_file)) == config_file
+  end
   
   def self.create_from_config_file(config)
     name, kernel, ramdisk, memory, root, disk, vif, on_poweroff, on_reboot, on_crash, extra = nil
     eval(config)
-    new(name, :disk => disk, :kernel => kernel, :ramdisk => ramdisk, :memory => memory, :root => root, :disk => disk, :vif => vif, :on_poweroff => on_poweroff, :on_reboot => on_reboot, :on_crash => on_crash, :extra => extra)
+    vifs = Array(vif).collect { |v| Xen::Vif.from_str(v) }
+    vbds = Array(disk).collect { |d| Xen::Vbd.from_str(d) }
+    new(name, :disk => disk, :kernel => kernel, :ramdisk => ramdisk, :memory => memory, :root => root, :vbds => vbds, :vifs => vifs, :on_poweroff => on_poweroff, :on_reboot => on_reboot, :on_crash => on_crash, :extra => extra)
   end
   
   def save
-    puts "I saved the config!"
+    template = ERB.new IO.read(Xen::TEMPLATE_DIR + '/domu.cfg.erb')
+    File.open(config_file, 'w'){ |f| f.write template.result(binding) }
   end
   
-end
+end
+
+
+# Virtual Network Interface
+#
+# http://wiki.xensource.com/xenwiki/XenNetworking
+#
+class Xen::Vif
+  attr_accessor :ip, :mac, :bridge, :vifname
+  def initialize(*args)
+    options = args.extract_options!
+    @ip = options[:ip] 
+    @mac = options[:mac]
+    @bridge = options[:bridge]
+    @vifname = options[:vifname]
+  end
+
+  def self.from_str(value)
+    options = value.scan(/(\w+)=([^,]+)/).inject({}){ |m, (k, v)| m[k.to_sym] = v; m }
+    new(options)
+  end
+
+  def to_str
+    %w(ip mac bridge vifname).collect { |key| 
+      "#{key}=#{instance_variable_get('@' + key)}" if !instance_variable_get('@'+key).nil?
+    }.compact.join(',')
+  end 
+end
+
+
+# Virtual Network Interface
+#
+# http://wiki.xensource.com/xenwiki/XenStorage
+#
+# == Example 
+#
+#   disk        = [ 'phy:xendisks/example-disk,sda1,w', 
+#                   'phy:xendisks/example-swap,sda2,w',
+#                   'phy:assets/example-assets,sdb1,w' ]
+class Xen::Vbd
+  attr_accessor :dom0, :domu, :mode
+  def initialize(dom0, domu, mode='w')
+    @dom0, @domu, @mode = dom0, domu, mode
+  end
+
+  def self.from_str(value)
+    dom0, domu, mode = value.split(',')
+    new(dom0, domu, mode)
+  end
+
+  def to_str
+    "#{dom0},#{domu},#{mode}"
+  end 
+end
+
+

data/lib/xen/host.rb

@@ -1,10 +1,9 @@
 class Xen::Host
   attr_reader :host, :machine, :total_memory, :free_memory
-  
+
   def initialize
-    result = Xen:Command.xm_info
-    result.scan(/(\S+)\s*:\s*([^\n]+)/).each do |i,j| 
+    Xen::Command.xm_info.each do |i,j|
       instance_variable_set("@#{i}", j)
     end
   end
-end
+end

data/lib/xen/instance.rb

@@ -9,7 +9,7 @@ class Xen::Instance
     @cpu_time   = options[:cpu_time]
     @vcpus      = options[:vcpus]
     @state      = options[:state]
-    @start_time = options[:start_time]
+    @start_time = Time.at(options[:start_time].to_f) if options[:start_time]
     @object_expires = Time.now + Xen::INSTANCE_OBJECT_LIFETIME
   end
 
@@ -22,37 +22,25 @@ class Xen::Instance
   end
 
   def self.all
-    result = Xen::Command.xm_list
-    # XXX check for failed command
-    result_array = result.split("\n")
-    result_array.shift
-    result_array.collect do |domain|
-      name, domid, memory, vcpus, state, cpu_time = domain.scan(/[^ ,]+/)
-      new(name, :domid => domid, :memory => memory, :cpu_time => cpu_time)
+    Xen::Command.detailed_instance_list.collect do |instance|
+      new(name, instance)
     end
   end
 
   def self.find_by_name(name)
-    all.detect{|domain| domain.name == name.to_s }
+    Xen::Command.detailed_instance_list(name).each do |instance|
+      return new(name, instance)
+    end
+    return false
   end
 
-  # XXX Rails version - we need some error checking! 
-  #
-  # def self.find_by_name(name, options)
-  #   if result = find_every(options)
-  #     result.detect{ |domain| domain.name == name }
-  #   else
-  #     raise RecordNotFound, "Couldn't find domain with name=#{name}"
-  #   end
-  # end
-
   def self.create(name)
-    output = `xm create #{name}.cfg`
+    output = Xen::Command.create(name.to_s + Xen::CONFIG_FILE_EXTENSION)
     $? == 0 ? true : false
   end
 
   def self.shutdown(name)
-    output = `xm shutdown #{name}`
+    output = Xen::Command.shutdown(name)
     $? == 0 ? true : false
   end
 
@@ -65,11 +53,6 @@ class Xen::Instance
     start_time ? Time.now - start_time : nil
   end
 
-  def running?
-    output = `xm list #{name}`
-    $? == 0 ? true : false
-  end
-
   def reboot
     `xm reboot #{name}`
     $? == 0 ? true : false

data/lib/xen/{domain.rb → slice.rb}

@@ -1,4 +1,4 @@
-class Xen::Domain
+class Xen::Slice
   attr_accessor :name, :image, :config
 
   def initialize(name)
@@ -19,9 +19,9 @@ class Xen::Domain
   def self.find(*args)
     options = args.extract_options!
     case args.first
-      when :all       then Xen::Config.find(:all, options).collect { |config| config.domain }
-      when :running   then Xen::Instance.find(:all, options).collect { |instance| instance.domain }
-      # Retrieve a Domain by name
+      when :all       then Xen::Config.find(:all, options).collect { |config| config.slice }
+      when :running   then Xen::Instance.find(:all, options).collect { |instance| instance.slice }
+      # Retrieve a Slice by name
       else            Xen::Config.find_by_name(args.first) && self.new(args.first)
     end
   end
@@ -30,6 +30,10 @@ class Xen::Domain
     self.find(:all, options)
   end
 
+  def state
+    self.instance ? :running : :stopped
+  end
+    
   def running?
     self.instance ? true : false
   end
@@ -44,4 +48,8 @@ class Xen::Domain
     @instance = Xen::Instance.find(@name)
   end
   
+  def config_newer_than_instance?
+	  instance && config.updated_at > instance.start_time 
+	end
+  
 end

data/test/test_ruby-xen.rb

@@ -0,0 +1,3 @@
+require '../lib/ruby-xen'
+c = Xen::Config.new
+c.save

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mbailey-ruby-xen
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Bailey
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 -07:00
+date: 2008-09-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -35,10 +35,11 @@ files:
 - lib/xen/backup.rb
 - lib/xen/command.rb
 - lib/xen/config.rb
-- lib/xen/domain.rb
+- lib/xen/slice.rb
 - lib/xen/host.rb
 - lib/xen/image.rb
 - lib/xen/instance.rb
+- lib/templates/domu.cfg.erb
 has_rdoc: true
 homepage: http://github.com/schacon/grit
 post_install_message: