mbailey-ruby-xen 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2008-09-08
+
+* Initial import
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/ruby-xen
+lib/ruby-xen.rb
+test/test_ruby-xen.rb
+lib/ruby-xen/domain.rb

data/README.rdoc

@@ -0,0 +1,66 @@
+= ruby-xen
+
+# Warning! Not ready yet - project started Sep 2008
+
+http://github.com/mbailey/ruby-xen
+
+
+== DESCRIPTION:
+
+ruby-xen is a ruby library for managing Xen virtual servers. It currently 
+wraps the command line tools provided by Xen (xm) as well as Steve Kemps 
+excellent Xen-tools [http://www.xen-tools.org/software/xen-tools/].
+
+ruby-xen is packaged as a Rails Gem which means you can require it from
+a Ruby on Rails project and make use of the classes it provides.
+
+ruby-xen can also be used by ruby code or from irb.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'ruby-xen'
+
+
+  domain = Xen::Domain.find(:example)
+  domain.running? # true
+  domain.stop
+  domain.running? # false
+  domain.start
+  domain.running? # true
+
+== REQUIREMENTS:
+
+ruby-xen must be run as root as it uses Xen's 'xm' command.
+xen-tools must be installed (http://www.xen-tools.org/software/xen-tools/)
+
+== INSTALL:
+
+sudo gem install ruby-xen
+
+== LICENSE:
+
+ruby-xen is licenced under the GPL. This means that you can use it in commercial 
+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
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/Rakefile

@@ -0,0 +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
+
+# vim: syntax=Ruby

data/lib/ruby-xen.rb

@@ -0,0 +1,50 @@
+class Array #:nodoc:
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)           # => {}
+  #   options(1, 2, :a => :b) # => {:a=>:b}
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+module Xen
+  # Location of Xen config files
+  XEN_DOMU_CONFIG_DIR = '/etc/xen'
+  # XEN_DOMU_CONFIG_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '/spec/fixtures/xen_domu_configs'))
+  
+  # We don't want out library to hit Xen too often (premature optimization perhaps?)
+  # so we keep information about Xen instances in an object. Specify how long before
+  # the object expires.
+  INSTANCE_OBJECT_LIFETIME = 1
+  
+  # DRY up some classes (children of Domain) with some module funkiness.
+  module Parentable
+    # Returns the parent Domain 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
+    #
+    def domain
+      d = Xen::Domain.new(name)
+      d.instance_variable_set("@#{self.class.to_s.sub('Xen::','').downcase}", self)
+      d
+    end
+  end
+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/host"
+require "#{File.dirname(__FILE__)}/xen/image"
+require "#{File.dirname(__FILE__)}/xen/instance"

data/lib/xen/backup.rb

@@ -0,0 +1,3 @@
+class Xen::Backup
+  include Xen::Parentable
+end

data/lib/xen/command.rb

@@ -0,0 +1,8 @@
+class Xen::Command
+  def self.xm_list
+    `xm list`
+  end
+  def self.xm_info
+    `xm info`
+  end 
+end

data/lib/xen/config.rb

@@ -0,0 +1,52 @@
+# 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
+
+  def initialize(*args)
+    options = args.extract_options!
+    @name = args.first
+    @kernel = options[:kernel]
+    @ramdisk = options[:ramdisk]
+    @memory = options[:memory]
+    @root = options[:root]
+    @disk = options[:disk]
+    @vif = options[:vif]
+    @on_poweroff = options[:on_poweroff]
+    @on_reboot = options[:on_reboot]
+    @on_crash = options[:on_crash]
+    @extra = options[:extra]
+  end
+
+  def self.find(*args)
+    options = args.extract_options!
+    case args.first
+      when :all       then all
+      else            find_by_name(args.first)
+    end
+  end
+
+  def self.all
+    config_files = Dir.glob("#{Xen::XEN_DOMU_CONFIG_DIR}/*.cfg")
+    config_files.collect do |filename|
+      create_from_config_file(File.read(filename))
+    end
+  end    
+
+  def self.find_by_name(name)
+    return new('Domain-0') if name == 'Domain-0' 
+    filename = "#{Xen::XEN_DOMU_CONFIG_DIR}/#{name}.cfg"
+    create_from_config_file(File.read(filename))
+  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)
+  end
+  
+  def save
+    puts "I saved the config!"
+  end
+  
+end

data/lib/xen/domain.rb

@@ -0,0 +1,47 @@
+class Xen::Domain
+  attr_accessor :name, :image, :config
+
+  def initialize(name)
+    @name = name
+    @config = Xen::Config.find(name)
+    @instance = Xen::Instance.find(name)
+    @image = Xen::Image.find(name)
+  end
+
+  def instance
+    if @instance && @instance.object_expires > Time.now
+      @instance
+    else
+      @instance = Xen::Instance.find(@name)
+    end
+  end
+  
+  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
+      else            Xen::Config.find_by_name(args.first) && self.new(args.first)
+    end
+  end
+  
+  def all(options={})
+    self.find(:all, options)
+  end
+
+  def running?
+    self.instance ? true : false
+  end
+  
+  def start
+    Xen::Instance.create(@name)
+    @instance = Xen::Instance.find(@name)
+  end
+  
+  def stop
+    Xen::Instance.shutdown(@name)
+    @instance = Xen::Instance.find(@name)
+  end
+  
+end

data/lib/xen/host.rb

@@ -0,0 +1,10 @@
+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| 
+      instance_variable_set("@#{i}", j)
+    end
+  end
+end

data/lib/xen/image.rb

@@ -0,0 +1,12 @@
+class Xen::Image
+  include Xen::Parentable
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def self.find(name)
+    new name
+  end
+end

data/lib/xen/instance.rb

@@ -0,0 +1,84 @@
+class Xen::Instance
+  include Xen::Parentable
+  attr_reader :name, :domid, :memory, :cpu_time, :vcpus, :state, :start_time, :object_expires
+
+  def initialize(name, options={})
+    @name       = name
+    @domid      = options[:domid]
+    @memory     = options[:memory]
+    @cpu_time   = options[:cpu_time]
+    @vcpus      = options[:vcpus]
+    @state      = options[:state]
+    @start_time = options[:start_time]
+    @object_expires = Time.now + Xen::INSTANCE_OBJECT_LIFETIME
+  end
+
+  def self.find(*args)
+    options = args.extract_options!
+    case args.first
+    when :all       then all
+    else            find_by_name(args.first)
+    end
+  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)
+    end
+  end
+
+  def self.find_by_name(name)
+    all.detect{|domain| domain.name == name.to_s }
+  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`
+    $? == 0 ? true : false
+  end
+
+  def self.shutdown(name)
+    output = `xm shutdown #{name}`
+    $? == 0 ? true : false
+  end
+
+  # A convenience wrapper for <tt>find(:dom0)</tt>.</tt>.
+  def self.dom0(*args)
+    find_by_name(:dom0)
+  end
+
+  def uptime
+    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
+  end
+
+  def destroy
+  end
+
+  def pause
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: mbailey-ruby-xen
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Bailey
+- Nick Marfleet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ruby-xen allows you to manage Xen virtual servers via Ruby. It currently  wraps the command line tools provided by Xen (xm) as well as Steve Kemps  excellent Xen-tools (http://www.xen-tools.org/software/xen-tools/).
+email: mike@bailey.net.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/ruby-xen
+- lib/ruby-xen.rb
+- test/test_ruby-xen.rb
+- lib/xen/backup.rb
+- lib/xen/command.rb
+- lib/xen/config.rb
+- lib/xen/domain.rb
+- lib/xen/host.rb
+- lib/xen/image.rb
+- lib/xen/instance.rb
+has_rdoc: true
+homepage: http://github.com/schacon/grit
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby library for managing Xen virtual hosts
+test_files: []
+