xen-ruby 0.7

data/README

@@ -0,0 +1,74 @@
+A simple ruby module to admin xen instances
+This gem includes a log mechanism (log4r) with various modes (DEBUG, INFO, WARN ...).
+
+
+How to use it :
+
+###########################
+# To get instance informations
+instance = Xen::Instance.find_by_name(name)
+
+# To get all instaces
+puts Xen::Instance.all
+
+###########################
+# To start an instance
+
+instance.start(name)
+
+# or
+instance = Xen::Instance.find_by_name(name)
+instance.start
+
+# or
+instance = Xen::Instance.new(name)
+instance.start
+
+###########################
+# To create a new instance 
+# attributes includes {:mem => "", :size => "", :name => "", :ip => "", :vcpus: => "",
+# :arch => "", :dist => ""}
+# mem   = Memory
+# size  = HDD size
+# name  = Hostname
+# ip    = Ip address
+# vcpus = Virtual cpu's
+# arch  = System architecture [i386|amd64]
+# dist  = distribution [lucid, hardy, etc.]
+Xen::Instance.create(attributes)
+
+##########################
+# Instance actions
+instance = Xen::Instance.find_by_name(name)
+
+# start
+instance.start
+
+# stop
+instance.shutdown
+
+# reboot
+instance.reboot
+
+# pause
+instance.pause
+
+# unpause
+instance.unpause
+
+# kill
+instance.destroy
+
+
+
+##################################
+Creating & installing the gem :
+
+gem build xen.gemspec
+sudo gem install xen-<version>.gem
+
+
+todo:
+- Xen::Instance.create have a small bug (timeout)
+- Tests
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "xen-ruby"
+  gem.homepage = "http://github.com/foexle/ruby-xen"
+  gem.license = "GPL"
+  gem.summary = %Q{simple gem to controle xen dom0}
+  gem.description = %Q{simple gem to controle xen dom0}
+  gem.email = "kraemer@avarteq.de"
+  gem.authors = ["Heiko Krämer","Clemens Kofler"]
+  gem.version = "#{version}"
+  # 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 'jabber4r', '> 0.1'
+  #  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
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : "0.7"
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xen-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.7

data/lib/log/logger.rb

@@ -0,0 +1,53 @@
+require 'log4r'
+
+module Log
+  # Singleton Class to logging debugging and error states in logfile
+  class Logger
+    attr_accessor :log
+
+
+    # Check if exists a logging class. If not i'll be create
+    # ==Params
+    # * +filename+  : Path and filename of logdatei
+    # * +log_level+ : Which loglevel are using
+    def self.log(options = {:log_level => 1}, filename = "/tmp/xen-gem.log")
+      if @log
+        return @log
+      else
+        initialize_logger(filename, options[:log_level])
+        return @log
+      end
+    end
+
+    # Initializing and configuring the logger object
+    def self.initialize_logger(file_name, log_level)
+      @log = Log4r::Logger.new("xen_log")
+
+      @log.outputters = Log4r::Outputter.stdout
+
+      file = Log4r::FileOutputter.new('fileOutputter', :filename => file_name, :trunc => true)
+
+
+      @log.add(file)
+      @log.level = self.convert_loglevel(log_level)
+      format = Log4r::PatternFormatter.new(:pattern => "[%l] %d :: %m")
+      file.formatter = format
+    end
+
+    private
+
+    # Converting loglevel configurations for log4r
+    def self.convert_loglevel(log_level)
+      case log_level
+      when 1
+        return Log4r::DEBUG
+      when 2
+        return Log4r::INFO
+      when 3
+        return Log4r::ERROR
+      else
+        return Log4r::INFO
+      end
+    end
+  end
+end

data/lib/system/command.rb

@@ -0,0 +1,50 @@
+require 'log/logger'
+
+module System
+  class Command
+    LEVEL_WARN  = 1
+    LEVEL_FATAL = 2
+
+    attr_reader :command, :expected_exit_status, :message, :command_level, :output, :exit_status
+
+    class << self
+      def logger
+        @@logger ||= Log::Logger.log
+      end
+    end
+
+    def initialize(command, options = {})
+      @command       = command
+      @expected_exit = options[:expected_exit_status] || 0
+      @message       = options[:message] unless options[:message].nil? || options[:message].empty?
+      @command_level = options[:command_level] || LEVEL_WARN
+    end
+
+    def execute
+      @output = `#{command} 2>&1`
+      @exit_status  = $?.exitstatus
+      log if error?
+    end
+
+    def error?
+      ![0, expected_exit_status].include?(exit_status)
+    end
+
+    def error_message
+      message || output
+    end
+
+    def log
+      case @command_level
+      when LEVEL_WARN: logger.warn(error_message)
+      when LEVEL_FATAL: logger.fatal(error_message)
+      end
+    end
+
+    def logger
+      self.class.logger
+    end
+
+
+  end
+end

data/lib/xen/instance.rb

@@ -0,0 +1,194 @@
+require 'log/logger'
+require 'system/command'
+require 'xen/server'
+require 'xen/util'
+
+# TODO extract sudo to be used as an option
+module Xen
+  class Instance
+    STATE_RUNNING  = 'r'
+    STATE_BLOCKED  = 'b'
+    STATE_SHUTDOWN = 's'
+    STATE_CRASHED  = 'c'
+    STATE_DYING    = 'd'
+    STATE_PAUSED   = 'p'
+
+    attr_accessor :dom_id, :name, :memory, :vcpus, :state, :time
+
+    class << self
+
+      # Gets all running instances on dom0
+      def all
+        get_all = System::Command.new("sudo xm list" , :command_level => 1)
+        get_all.execute
+        return [] unless get_all.exit_status == 0
+
+        instances_from_output(get_all.output)
+      end
+
+      # Gets an instance object
+      # ==Params:
+      # => +name+:  Name of instance
+      def find_by_name(name)
+        find = System::Command.new("sudo xm list #{name}", :command_level => 1)
+        find.execute
+        instance_from_output(find.output.split("\n").last)
+      end
+      alias :[] :find_by_name
+
+      # Gets all attributs of an instance
+      
+      def find_attributes_by_name(name)
+        find = System::Command.new("sudo xm list #{name}", :command_level => 1)
+        find.execute
+        attributes_from_output(find.output)
+      end
+
+      # Vars = :id, :name, :memory, :hdd, :cpus, :status
+      # Note: debootstrap installation is the slowest, better are copy in xen
+      def create(attributes = {})
+        logger.info("Creating new Xen instance with name #{attributes[:name]} ...")
+
+        exist_instance = find_by_name(attributes[:name])
+        if exist_instance
+          Logger.info("Running instance detected. Shutting down to create a new one")
+          exist_instance.shutdown
+        end
+        
+        password = Xen::Util.generate_root_password
+
+        if password.exit_status == 0
+          command = <<-cmd.split("\n").map { |l| l.strip }.join(' ').squeeze(' ')
+            sudo xen-create-image --hostname=#{attributes[:name]} --ip=#{attributes[:ip]} --password=#{password[:stdout].strip}
+                             --vcpus=#{attributes[:vcpus]} --memory=#{attributes[:memory]} --size=#{attributes[:size]}
+                             --arch=#{attributes[:arch]} --dist=#{attributes[:dist]} --force &
+          cmd
+
+          create_image = System::Command.new(command, :command_level => 2)
+          create_image.execute
+          attributes.merge(:password => password.output.strip)
+        end
+      end
+
+      def start(name)
+        instance = new(name)
+        instance.start
+        return instance
+      end
+
+      def instances_from_output(output)
+        output.split("\n")[1..-1].map do |line|
+          instance_from_output(line)
+        end
+      end
+
+      def instance_from_output(output)
+        logger.debug("Finding #{output} ...")
+
+        attributes = attributes_from_output(output)
+        return unless attributes
+
+        Instance.new(attributes[:name], attributes) #:time => $6.strip)
+      end
+
+      def attributes_from_output(output)
+        return unless output.match(/(.*)\s+(\d+)\s+(\d+)\s+(\d+)\s+(.*?)\s+(\d+.\d)/)
+
+        { :name => $1.strip, :dom_id => $2.strip, :memory => $3.strip, :vcpus => $4.strip, :state => $5.strip.gsub("-","") }
+      end
+
+      def logger
+        @@logger ||= Log::Logger.log(:log_level => Xen::Server::LOG_LEVEL)
+      end
+    end
+
+
+
+    
+
+    def initialize(name, options = {})
+      @name = name
+      @memory, @dom_id, @vcpus, @state, @time = options.values_at(:memory, :dom_id, :vcpus, :state, :time)
+    end
+
+    def start
+      start = System::Command.new("sudo xm create #{name}.cfg", :command_level => 2)
+      start.execute
+      update_info
+    end
+
+
+    def reboot
+      reboot = System::Command.new("sudo xm reboot #{dom_id}", :command_level => 2)
+      reboot.execute
+    end
+
+    def shutdown
+      shutdown = System::Command.new("sudo xm shutdown #{dom_id}", :command_level => 2)
+      shutdown.execute
+    end
+
+    def migrate(destination)
+      migrate = System::Command.new("sudo xm migrate --live #{name} #{destination}", :command_level => 2)
+      migrate.execute
+    end
+
+    def destroy
+      destroy = System::Command.new("sudo xm destroy #{dom_id}", :command_level => 1)
+      destroy.execute
+    end
+
+    def pause
+      unless paused?
+        pause = System::Command.new("sudo xm pause #{dom_id}", :command_level => 1)
+        pause.execute
+      end
+    end
+
+    def unpause
+      if paused?
+        unpause = System::Command.new("sudo xm unpause #{dom_id}", :command_level => 1)
+        unpause.execute
+      end
+    end
+
+    def state_text
+      case state
+      when STATE_RUNNING: 'running'
+      when STATE_BLOCKED: 'blocked'
+      when STATE_SHUTDOWN: 'shutdown'
+      when STATE_CRASHED: 'crashed'
+      when STATE_DYING: 'dying'
+      when STATE_PAUSED: 'paused'
+      end
+    end
+
+    def running?
+      state == STATE_RUNNING
+    end
+
+    def blocked?
+      state == STATE_BLOCKED
+    end
+
+    def shutdown?
+      state == STATE_SHUTDOWN
+    end
+
+    def crashed?
+      state == STATE_CRASHED
+    end
+
+    def dying?
+      state == STATE_DYING
+    end
+
+    def paused?
+      state == STATE_PAUSED
+    end
+
+    def update_info
+      @memory, @dom_id, @vcpus, @state, @time = self.class.find_attributes_by_name(name).values_at(:memory, :dom_id, :vcpus, :state, :time)
+    end
+  end
+end

data/lib/xen/server.rb

@@ -0,0 +1,32 @@
+require 'xen/instance'
+require 'log/logger'
+require 'system/command'
+
+module Xen
+  class Server
+    # Loglevel
+    # => 1 DEBUG
+    # => 2 Info
+    # => 3 Warning
+    # => 4 Critcal
+    LOG_LEVEL = 1
+
+    class << self
+      def logger
+        @@logger ||= Log::Logger.log(:log_level => LOG_LEVEL)
+      end
+    end
+
+    def initialize
+    end
+
+    def instances
+      Xen::Instance.all
+    end
+    
+
+    def logger
+      self.class.logger
+    end
+  end
+end

data/lib/xen/util.rb

@@ -0,0 +1,10 @@
+module Xen
+  module Util
+    class << self
+      def generate_root_password
+        pwgen = System::Command.new("pwgen 16 1", :command_level => 1)
+        return pwgen.execute
+      end
+    end
+  end
+end

data/ruby-xen.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-xen}
+  s.version = "0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Heiko Kr\303\244mer", "Clemens Kofler"]
+  s.date = %q{2011-04-12}
+  s.description = %q{simple gem to controle xen dom0}
+  s.email = %q{kraemer@avarteq.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "lib/log/logger.rb",
+    "lib/system/command.rb",
+    "lib/xen/instance.rb",
+    "lib/xen/server.rb",
+    "lib/xen/util.rb",
+    "ruby-xen.gemspec"
+  ]
+  s.homepage = %q{http://github.com/foexle/ruby-xen}
+  s.licenses = ["GPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{simple gem to controle xen dom0}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<log4r>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<log4r>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<log4r>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: xen-ruby
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: 
+  segments: 
+  - 0
+  - 7
+  version: "0.7"
+platform: ruby
+authors: 
+- "Heiko Kr\xC3\xA4mer"
+- Clemens Kofler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: log4r
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  prerelease: false
+  type: :development
+  requirement: *id005
+description: simple gem to controle xen dom0
+email: kraemer@avarteq.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/log/logger.rb
+- lib/system/command.rb
+- lib/xen/instance.rb
+- lib/xen/server.rb
+- lib/xen/util.rb
+- ruby-xen.gemspec
+homepage: http://github.com/foexle/ruby-xen
+licenses: 
+- GPL
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: simple gem to controle xen dom0
+test_files: []
+