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,53 @@
+= ruby-xen
+
+* FIX (url)
+
+== 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:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+xen-tools (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,4 @@
+class RubyXen
+  VERSION = '1.0.0'
+end
+require "#{File.dirname(__FILE__)}/ruby-xen/domain"

data/lib/ruby-xen/domain.rb

@@ -0,0 +1,229 @@
+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
+  class Host
+  
+    attr_reader :host, :machine, :total_memory, :free_memory
+    def initialize
+      result = `xm info`
+      result.scan(/(\S+)\s*:\s*([^\n]+)/).each do |i,j| 
+        instance_variable_set("@#{i}", j)
+      end
+    end
+    
+  end
+
+
+  class Domain
+  
+    attr_accessor :name, :image, :config, :instance
+  
+    def initialize(name)
+      @name = name
+      @config = Xen::Config.find(name)
+      @instance = Xen::Instance.find(name)
+      @image = Xen::Image.find(name)
+    end
+  
+    def self.find(*args)
+      options = args.extract_options!
+      case args.first
+        when :all       then Xen::Config.find(:all, options).collect { |config| Xen::Domain.new(config.name) }
+        when :running   then Xen::Instance.find(:all, options).collect { |instance| Xen::Domain.new(instance.name) }
+        # Retrieve a Domain by name
+        else            Xen::Config.find_by_name(args.first) && self.new(args.first)
+      end
+    end
+  
+    def running?
+      @instance
+    end
+    
+  end
+
+
+  class Config
+  
+    attr_reader :name, :memory, :ip
+  
+    def initialize(*args)
+      options = args.extract_options!
+      @name = args.first
+      @memory = options[:memory] || nil
+      @ip = options[:ip] || nil
+    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-list-images`
+      configs = result.scan(/Name: (\w+)\nMemory: (\w+)\nIP: (\S+)/)
+      configs.collect do |config|
+        name, memory, ip = config
+        new(name, :memory => memory, :ip => ip)
+      end
+    end    
+  
+    def self.find_by_name(name)
+      return new('Domain-0') if name == 'Domain-0' 
+      all.detect {|config| puts config; config.name == name.to_s}
+    end
+  
+  end
+
+
+  class Image
+  
+    attr_accessor :name
+  
+    def initialize(name)
+      @name = name
+    end
+  
+    def self.find(name)
+      new name
+    end
+  
+    def find_one(name, options)
+      if result = find_every(options).first
+        result
+      else
+        raise RecordNotFound, "Couldn't find domain with name=#{name}"
+      end
+    end
+  end
+
+
+  class Instance
+  
+    attr_reader :name, :domid, :memory, :cpu_time, :vcpus, :state, :start_time
+  
+    def initialize(name, options={})
+      @name       = name
+      @domid      = options[:domid] || nil 
+      @memory     = options[:memory] || nil
+      @cpu_time   = options[:cpu_time] || nil
+      @vcpus      = options[:vcpus] || nil
+      @state      = options[:state] || nil
+      @start_time = options[:start_time] || nil
+    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 = `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
+  
+    # A convenience wrapper for <tt>find(:dom0)</tt>.</tt>.
+    def dom0(*args)
+      find_by_name(:dom0)
+    end
+
+    # This is an alias for find(:all).  You can pass in all the same arguments to this method as you can
+    # to find(:all)
+    def all(*args)
+      find(:all, *args)
+    end
+  
+    def uptime
+      start_time ? Time.now - start_time : nil
+    end
+  
+    def running?
+      output = `xm list #{name}`
+      $? == 0 ? true : false
+    end
+  
+    def start
+      output = `xm create #{name}.cfg`
+      $? == 0 ? true : false
+    end
+  
+    def shutdown
+      output = `xm shutdown #{name}`
+      $? == 0 ? true : false
+    end
+  
+    def reboot
+      `xm reboot #{name}`
+      $? == 0 ? true : false
+    end
+  
+    def destroy
+    end
+  
+    def pause
+    end
+  
+  end
+
+  class Backup
+  end
+  
+  # class XenTools
+  # 
+  #   def self.xen_list_images
+  #     puts "returning list of images"
+  #   end
+  # 
+  #   def xen_create_image
+  #     puts "creating image"
+  #   end
+  # 
+  #   def xen_delete_image
+  #     puts "creating image"
+  #   end
+  # 
+  #   def xen_archive_image
+  #     puts "archiving image"
+  #   end
+  # 
+  # end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: 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 +10: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/ruby-xen/domain.rb
+has_rdoc: true
+homepage: http://github.com/schacon/grit
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: []
+