ruby-lvm 0.0.1 → 0.1.1

data/History.txt

@@ -1,6 +1,14 @@
-=== 0.0.1 / 2008-05-28
+=== 0.1.1 / 2008-07-21
+
+* 1 major enhancement
+  * A complete rewrite! We won't bother attempting to wrap complex lvm
+    operations, but instead provide LVM.raw() command. The wrapper now focuses
+    purely on translating lvm lv/vg/pv data into the most useful ruby objects
+    possible. The arguments passed to the underlying binaries have been broken
+    out into a ruby-lvm-attributes package.
 
-* Initial release 
+=== 0.0.1 / 2008-05-28
 
+* 1 major enhancement
   * Birthday!
   * Test release.

data/Manifest.txt

@@ -5,23 +5,24 @@ Rakefile
 Todo.txt
 examples/create_snapshot.rb
 examples/error_handling.rb
-examples/show_volumes.rb
-helpers/generate_field_data.rb
+examples/show_lvm_config.rb
 lib/lvm.rb
-lib/lvm/attrib/lvs.yaml
-lib/lvm/attrib/pvs.yaml
-lib/lvm/attrib/vgs.yaml
 lib/lvm/external.rb
-lib/lvm/lv.rb
-lib/lvm/lvmanager.rb
-lib/lvm/lvs.rb
-lib/lvm/lvseg.rb
-lib/lvm/proc.rb
-lib/lvm/pv.rb
-lib/lvm/pvmanager.rb
-lib/lvm/pvs.rb
-lib/lvm/pvseg.rb
-lib/lvm/vg.rb
-lib/lvm/vgmanager.rb
-lib/lvm/vgs.rb
+lib/lvm/logical_volume.rb
+lib/lvm/logical_volume_segment.rb
+lib/lvm/logical_volumes.rb
+lib/lvm/physical_volume.rb
+lib/lvm/physical_volume_segment.rb
+lib/lvm/physical_volumes.rb
+lib/lvm/userland.rb
+lib/lvm/volume_group.rb
+lib/lvm/volume_groups.rb
+lib/lvm/volumes.rb
+lib/lvm/wrapper.rb
+lib/lvm/wrapper/constants.rb
+lib/lvm/wrapper/lvs.rb
+lib/lvm/wrapper/lvsseg.rb
+lib/lvm/wrapper/pvs.rb
+lib/lvm/wrapper/pvsseg.rb
+lib/lvm/wrapper/vgs.rb
 test/test_lvm.rb

data/README.txt

@@ -1,7 +1,7 @@
 = ruby-lvm
 
 * http://ruby-lvm.rubyforge.org
-* mailto:matt@bravenet.com
+* mailto:mkent@magoazul.com
 
 == DESCRIPTION:
 
@@ -10,29 +10,42 @@ function it to convert physical volumes, logical volumes and volume groups
 into easy to use ruby objects. It also provides a simple wrapper for typical
 create/delete/etc operations.
 
-Unfortunately due to it's lack of a proper api this is as good as it gets for
-ruby integration for the forseeable future.
-
-See this thread
-http://www.redhat.com/archives/libvir-list/2007-March/msg00192.html for a
-similar discussion.
+Due to a lack of LVM2 api this is a best effort attempt at ruby integration but
+subject to complete replacement in the future.
 
 == FEATURES/PROBLEMS:
 
-* Not finished, is that a problem? 
+* Exposes all possible data from the lvs/vgs/pvs commands. Data is grouped
+  sensibly (I hope).
+* Doesn't nicely wrap creation/deletion/etc operations, they must be created
+  by hand and passed as raw commands.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+  require 'lvm'
+
+  LVM::LVM.new({:command => "/usr/bin/sudo /sbin/lvm"}) do |lvm|
+    puts "lvm version: #{lvm.version}\n"
+
+    lvm.volume_groups.each do |vg|
+      puts "vg: #{vg.name}"
+    end
+  end
 
 == REQUIREMENTS:
 
+* ruby-lvm-attributes
 * popen4 
 
 == INSTALL:
 
 * sudo gem install ruby-lvm 
 
+== FEEDBACK:
+
+Please feel free to submit patches or constructive criticism, I'm still pretty
+new to ruby and object oriented programming in general.
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -5,9 +5,10 @@ require 'hoe'
 $:.unshift(File.dirname(__FILE__) + "/lib")
 require 'lvm'
 
-Hoe.new('ruby-lvm', LVMWrapper::VERSION) do |p|
-  p.developer('Matthew Kent', 'matt@bravenet.com')
+Hoe.new('ruby-lvm', LVM::VERSION) do |p|
+  p.developer('Matthew Kent', 'mkent@magoazul.com')
   p.extra_deps << ['open4', '>= 0.9.6']
+  p.extra_deps << ['ruby-lvm-attrib', '>= 0.0.1']
   p.remote_rdoc_dir = ''
 end
 

data/Todo.txt

@@ -1,10 +1,9 @@
 = to do
 
-== 0.1.0
-* improve auto generation of attributes, clean it up
-* don't bother wrapping lvm create/delete etc commands, too complex, just 
-  provide a standard lvm.raw('lvcreate foo'), that traps errors to do work at 
-  this level for now
-* proper documentation
-* basic test suite
-* compatibility check and warning, pass flag to shutup
+== 0.2.1
+* basic test suite, how?
+
+== 0.1.2
+* test on more distributions!
+* more documentation.
+* debug mode, logger?

data/examples/create_snapshot.rb

@@ -1,16 +1,28 @@
 #!/usr/bin/ruby
 
+# Demonstration of the creation of an lvm snapshot, using sudo, and reading its
+# attributes.
+
 $: << File.dirname(__FILE__) + "/../lib"
 
 require 'lvm'
-require 'lvm/lvmanager'
-require 'lvm/pvmanager'
-require 'lvm/vgmanager'
 
-lvm = LVMWrapper::LVM.new(:command => "/usr/bin/sudo /sbin/lvm")
-lv = LVMWrapper::LogicalVolumeManager.new(lvm)
+vol = "sys.vg/tmp.lv"
+snap = "demo_snap"
+
+lvm = LVM::LVM.new(:command => "/usr/bin/sudo /sbin/lvm")
+
+if lvm.logical_volumes[snap]
+  puts "#{snap} exists! Remove it"
+  exit(1)
+end
 
-lv.remove(:vgname => "sys.vg", :name => "demo_snap")
-lv.snapshot(:origin => "sys.vg/tmp.lv", :name => "demo_snap", :size => "10k")
+lvm.raw("lvcreate --snapshot --size 10M --name #{snap} #{vol}")
+lv = lvm.logical_volumes[snap]
 
-p lv.list("sys.vg/demo_snap")
+out=<<msg
+snapshot of #{vol}, #{snap}, created
+- uuid: #{lv.uuid}
+- major,minor: #{lv.kernel_major},#{lv.kernel_minor}
+msg
+puts out

data/examples/error_handling.rb

@@ -1,9 +1,15 @@
 #!/usr/bin/ruby
 
+# Demonstration of the exception handling with raw commands. 
+
 $: << File.dirname(__FILE__) + "/../lib"
 
 require 'lvm'
 
-lvm = LVMWrapper::LVM.new(:command => "/usr/bin/sudo /sbin/lvm", :debug => true)
+lvm = LVM::LVM.new(:command => "/usr/bin/sudo /sbin/lvm")
 
-lvm.raw("--blah blah")
+begin 
+  lvm.raw("--blah blah")
+rescue LVM::External::ExternalFailure => error 
+  puts "Raw operation failed with [#{error}]"
+end

data/examples/show_lvm_config.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+
+# A more advanced demonstration displaying a complete overview of the current
+# lvm configuration.
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'lvm'
+
+LVM::LVM.new({:command => "/usr/bin/sudo /sbin/lvm"}) do |lvm|
+  puts "lvm version: #{lvm.version}\n"
+  
+  puts "\nlogical view"
+  puts "------------"
+  lvm.volume_groups.each do |vg|
+    puts "vg: #{vg.name}"
+    vg.logical_volumes.each do |lv|
+      puts "  lv: #{lv.name} #{lv.size}"
+      lv.segments.each do |lvseg|
+        puts "    lvseg: #{lvseg.devices} ##{lv.segments.index(lvseg)} #{lvseg.start} - #{lvseg.finish} = #{lvseg.size}"
+      end
+      if lv.snapshot?
+        puts "    snapshot origin: #{lv.origin}"
+      end
+    end
+  end
+  
+  puts "\nphysical view"
+  puts   "-------------"
+  lvm.volume_groups.each do |vg|
+    puts "vg: #{vg.name}"
+    vg.physical_volumes.each do |pv|
+      puts "  pv: #{pv.name}"
+      pv.segments.each do |pvseg|
+        puts "    pvseg: ##{pv.segments.index(pvseg)} #{pvseg.start} - #{pvseg.finish}"
+      end
+    end
+  end
+
+end

data/lib/lvm.rb

@@ -1,39 +1,82 @@
 require 'lvm/external'
+require 'lvm/userland'
+require 'lvm/logical_volumes'
+require 'lvm/volume_groups'
+require 'lvm/physical_volumes'
 
-module LVMWrapper
-  VERSION = '0.0.1'
-  COMPAT_VERSION = '2.02.26-RHEL5'
+module LVM
+  VERSION = '0.1.1'
 
   class LVM
-    class LVM < Exception; end
-    
-    attr_accessor :command
+    attr_reader :command
+    attr_reader :logical_volumes
+    attr_reader :volume_groups
+    attr_reader :physical_volumes
+
+    VALID_OPTIONS = [
+      :command,
+      :version,
+      :debug
+    ]
 
     DEFAULT_COMMAND = '/sbin/lvm'
 
-    def initialize(args = {})
-      @command = args[:command] || DEFAULT_COMMAND
-      @debug = args[:debug] || false
+    def initialize(options={})
+      # handy, thanks net-ssh!
+      invalid_options = options.keys - VALID_OPTIONS
+      if invalid_options.any?
+        raise ArgumentError, "invalid option(s): #{invalid_options.join(', ')}"
+      end
+
+      @command = options[:command] || DEFAULT_COMMAND
+
+      # default to loading attributes for the current version
+      options[:version] ||= version 
+      options[:debug] ||= false
+
+      @logical_volumes = LogicalVolumes.new(options)
+      @volume_groups = VolumeGroups.new(options)
+      @physical_volumes = PhysicalVolumes.new(options)
+
+      if block_given?
+        yield self
+      else
+        return self
+      end
     end
 
-    def raw(args) #:nodoc:
-      External.cmd(args)
+    def raw(args)
+      output = []
+      External.cmd("#{@command} #{args}") do |line|
+        output << line
+      end
+      if block_given?
+        return output.each { |l| yield l }
+      else
+        return output.join
+      end
     end
 
-    def cmd(args)
-      to_exec = "#{@command} #{args}"
-      puts "Going to execute `#{to_exec}`" if @debug
-      raw(to_exec)
+    def version
+      %r{^(.*?)(-| )}.match(userland.lvm_version)[1]
     end
 
-    class<<self
-      def raw(args)
-        new(args).raw(args)
+    # helper methods
+    def userland
+      userland = UserLand.new
+      raw('version') do |line|
+        case line
+        when  %r{^\s+LVM version:\s+([0-9].*)$}
+          userland.lvm_version = $1
+        when %r{^\s+Library version:\s+([0-9].*)$}
+          userland.library_version = $1
+        when  %r{^\s+Driver version:\s+([0-9].*)$}
+          userland.driver_version = $1
+        end
       end
-      def cmd(args)
-        new(args).raw(args)
-      end
-    end # self
 
-  end # class
-end # module
+      return userland
+    end
+
+  end
+end

data/lib/lvm/external.rb

@@ -1,41 +1,36 @@
 require 'rubygems'
 require 'open4'
 
-module LVMWrapper 
-  class External
+module LVM
+  module External
     class ExternalFailure < RuntimeError; end 
 
-     class<<self
-      # Execute a command, returning the resulting String of standard output.
-      #
-      # The block is optional. If given, it will be invoked for each line of
-      # output.
-      def cmd(cmd)
-        output = []
-        error = nil
-        stat = Open4::popen4(cmd) do |pid, stdin, stdout, stderr|
-          while line = stdout.gets
-            output << line 
-          end
-          error = stderr.read.strip
+    def cmd(cmd)
+      output = []
+      error = nil
+      stat = Open4.popen4(cmd) do |pid, stdin, stdout, stderr|
+        while line = stdout.gets
+          output << line 
         end
-        if stat.exited?
-          if stat.exitstatus > 0
-            raise ExternalFailure, "Fatal error, `#{cmd}` returned #{stat.exitstatus} with '#{error}'"
-          end
-        elsif stat.signaled?
-          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.termsig} and terminated"
-        elsif stat.stopped?
-          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.stopsig} and is stopped"
+        error = stderr.read.strip
+      end
+      if stat.exited?
+        if stat.exitstatus > 0
+          raise ExternalFailure, "Fatal error, `#{cmd}` returned #{stat.exitstatus} with '#{error}'"
         end
+      elsif stat.signaled?
+        raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.termsig} and terminated"
+      elsif stat.stopped?
+        raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.stopsig} and is stopped"
+      end
 
-        if block_given?
-          return output.each { |l| yield l }
-        else 
-          return output.join
-        end
+      if block_given?
+        return output.each { |l| yield l }
+      else 
+        return output.join
       end
     end
+    module_function :cmd
 
-  end # class
-end # module
+  end # module External 
+end # module LVM 

data/lib/lvm/logical_volume.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+
+module LVM
+  class LogicalVolume < OpenStruct
+    # Helpers
+    def open?; device_open; end
+    def snapshot?; volume_type == :snapshot ? true : false; end
+  end
+end

data/lib/lvm/logical_volume_segment.rb

@@ -0,0 +1,5 @@
+require 'ostruct'
+
+module LVM
+  class LogicalVolumeSegment < OpenStruct; end
+end

data/lib/lvm/logical_volumes.rb

@@ -0,0 +1,37 @@
+require 'lvm/volumes'
+require 'lvm/wrapper/lvs'
+require 'lvm/wrapper/lvsseg'
+
+module LVM
+  class LogicalVolumes
+    include Enumerable
+
+    include Volumes
+    include Wrapper
+
+    def initialize(options)
+      @lvs = LVS.new(options)
+      @lvsseg = LVSSEG.new(options)
+    end
+
+    # Gather all information about logical volumes.
+    #
+    # See VolumeGroups.each for a better representation of LVM data.
+    def each 
+      lvs = @lvs.list
+      lvsseg = @lvsseg.list 
+
+      lvs.each do |lv|
+        lv.segments ||= []
+        lvsseg.each do |lvseg|
+          if lvseg.lv_uuid == lv.uuid 
+            lv.segments << lvseg
+          end
+        end
+      end          
+
+      return lvs.each {|l| yield l}
+    end
+  end
+
+end