ruby-lvm 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-05-28
+
+* Initial release 
+
+  * Birthday!
+  * Test release.

data/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+Todo.txt
+examples/create_snapshot.rb
+examples/error_handling.rb
+examples/show_volumes.rb
+helpers/generate_field_data.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
+test/test_lvm.rb

data/README.txt

@@ -0,0 +1,59 @@
+= ruby-lvm
+
+* http://ruby-lvm.rubyforge.org
+* mailto:matt@bravenet.com
+
+== DESCRIPTION:
+
+This is a wrapper for the LVM2 administration utility, lvm. Its primary
+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.
+
+== FEATURES/PROBLEMS:
+
+* Not finished, is that a problem? 
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* popen4 
+
+== INSTALL:
+
+* sudo gem install ruby-lvm 
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Matthew Kent, Bravenet Web Services Inc. 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'lvm'
+
+Hoe.new('ruby-lvm', LVMWrapper::VERSION) do |p|
+  p.developer('Matthew Kent', 'matt@bravenet.com')
+  p.extra_deps << ['open4', '>= 0.9.6']
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/Todo.txt

@@ -0,0 +1,10 @@
+= 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

data/examples/create_snapshot.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+
+$: << 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)
+
+lv.remove(:vgname => "sys.vg", :name => "demo_snap")
+lv.snapshot(:origin => "sys.vg/tmp.lv", :name => "demo_snap", :size => "10k")
+
+p lv.list("sys.vg/demo_snap")

data/examples/error_handling.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'lvm'
+
+lvm = LVMWrapper::LVM.new(:command => "/usr/bin/sudo /sbin/lvm", :debug => true)
+
+lvm.raw("--blah blah")

data/examples/show_volumes.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+
+$: << 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)
+vg = LVMWrapper::VolumeGroupManager.new(lvm)
+pv = LVMWrapper::PhysicalVolumeManager.new(lvm)
+
+pv.list.each do |p|
+ puts "- pv #{p.name}"
+end
+
+puts ""
+
+vg.list.each do |v|
+  puts "- vg #{v.name}"
+  lv.list(v.name).each do |l|
+    puts "-- lv #{l.name}"
+  end
+end

data/helpers/generate_field_data.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby
+
+# collect all lvm reporting columns and format to our liking for inclusion in
+# the library
+#
+# ruby generate_field_data.rb ~/iscsi_work/LVM2.2.02.36
+
+require 'yaml'
+
+LVM_COLUMNS = "/lib/report/columns.h"
+
+CONVERSION_MAP = {
+ # Only types we can really trust
+ "uint32" => "Integer",
+ "int32" => "Integer",
+ # These were determined by reading the code, they invoke _(u)int32_disp right away
+ "pvmdas" => "Integer",
+ "vgmdas" => "Integer",
+ "lvcount" => "Integer",
+ "lvsegcount" => "Integer",
+ "segstartpe" => "Integer",
+ # listed to return STR?
+ "lvkmaj" => "Integer",
+ "lvkmin" => "Integer",
+ "snpercent" => "Float",
+ "copypercent" => "Float",
+ # size32/64, these do unit formatting unless overridden on command line. We
+ # typically want them in bytes so we can convert them to Integers safely
+ "size32" => "Integer",
+ "size64" => "Integer",
+ # These types return size32/size64 as well
+ "lvkreadahead" => "Integer",
+ "pvsize" => "Integer",
+ "devsize" => "Integer",
+ "pvfree" => "Integer",
+ "pvused" => "Integer",
+ "pvmdafree" => "Integer",
+ "vgsize" => "Integer",
+ "vgfree" => "Integer",
+ "vgmda_free" => "Integer",
+ "chunksize" => "Integer",
+ "segstart" => "Integer",
+ "segsize" => "Integer",
+ "vgmdafree" => "Integer",
+ # Weird one, can be "auto" or size32
+ "lvreadahead" => "String"
+}
+
+lvm_source = ARGV[0]
+
+lvs = [] 
+vgs = []
+pvs = []
+File.readlines(lvm_source + LVM_COLUMNS).each do |line|
+  chunked = line.split(", ")
+
+  app = chunked[0]
+  general_type = chunked[2]
+  specific_type = chunked[6] 
+  field = chunked[7]
+#  description = chunked[8]
+
+  attribute = field
+  attribute_type = nil
+
+  if app.nil? || general_type.nil? || specific_type.nil? || field.nil?
+    next
+  end
+
+  attribute.gsub!('"', '')
+
+  if general_type == "NUM"
+    attribute_type = CONVERSION_MAP[specific_type]
+    if attribute_type.nil?
+      puts "oops, missing hanlding of attribute '#{attribute}' which says its going to return a '#{specific_type}'"
+      exit 1
+    end
+  else
+    attribute_type = "String"
+  end
+ #XXX man page says we can skip the lv_ prefixes! and seg_!
+  if app == "FIELD(LVS" || app == "FIELD(SEGS"
+    lvs << { :option => attribute, :type_hint => attribute_type, :method => attribute.sub(%r{^lv_}, '') }
+  elsif app == "FIELD(PVS" || app == "FIELD(PVSEGS"
+    pvs << { :option => attribute, :type_hint => attribute_type, :method => attribute.sub(%r{^pv_}, '') }
+  elsif app == "FIELD(VGS"
+    vgs << { :option => attribute, :type_hint => attribute_type, :method => attribute.sub(%r{^vg_}, '') }
+  end
+end
+
+lvs.sort! {|x,y| x[:option] <=> y[:option]}
+pvs.sort! {|x,y| x[:option] <=> y[:option]} 
+vgs.sort! {|x,y| x[:option] <=> y[:option]}
+
+File.open("lvs.yaml", "w") do |f|
+  f.write "# these are column to object attribute mappings \n"
+  f.write "# generated by #{$0} based on \n"
+  f.write "# #{lvm_source}/lib/report/columns.h\n"
+  f.write(lvs.to_yaml)
+end
+puts "Wrote data to lvs.yaml"
+
+File.open("pvs.yaml", "w") do |f|
+  f.write "# these are column to object attribute mappings \n"
+  f.write "# generated by #{$0} based on \n"
+  f.write "# #{lvm_source}/lib/report/columns.h\n"
+  f.write(pvs.to_yaml)
+end
+puts "Wrote data to pvs.yaml"
+
+File.open("vgs.yaml", "w") do |f|
+  f.write "# these are column to object attribute mappings \n"
+  f.write "# generated by #{$0} based on \n"
+  f.write "# #{lvm_source}/lib/report/columns.h\n"
+  f.write(vgs.to_yaml)
+end
+puts "Wrote data to vgs.yaml"

data/lib/lvm/attrib/lvs.yaml

@@ -0,0 +1,88 @@
+# these are column to object attribute mappings 
+# generated by generate_field_data.rb based on 
+# /home/iscsidev/LVM2.2.02.26/lib/report/columns.h
+--- 
+- :method: chunk_size
+  :option: chunk_size
+  :type_hint: Integer
+- :method: chunksize
+  :option: chunksize
+  :type_hint: Integer
+- :method: copy_percent
+  :option: copy_percent
+  :type_hint: Float
+- :method: devices
+  :option: devices
+  :type_hint: String
+- :method: attr
+  :option: lv_attr
+  :type_hint: String
+- :method: kernel_major
+  :option: lv_kernel_major
+  :type_hint: String
+- :method: kernel_minor
+  :option: lv_kernel_minor
+  :type_hint: String
+- :method: major
+  :option: lv_major
+  :type_hint: Integer
+- :method: minor
+  :option: lv_minor
+  :type_hint: Integer
+- :method: name
+  :option: lv_name
+  :type_hint: String
+- :method: size
+  :option: lv_size
+  :type_hint: Integer
+- :method: tags
+  :option: lv_tags
+  :type_hint: String
+- :method: uuid
+  :option: lv_uuid
+  :type_hint: String
+- :method: mirror_log
+  :option: mirror_log
+  :type_hint: String
+- :method: modules
+  :option: modules
+  :type_hint: String
+- :method: move_pv
+  :option: move_pv
+  :type_hint: String
+- :method: origin
+  :option: origin
+  :type_hint: String
+- :method: region_size
+  :option: region_size
+  :type_hint: Integer
+- :method: regionsize
+  :option: regionsize
+  :type_hint: Integer
+- :method: seg_count
+  :option: seg_count
+  :type_hint: Integer
+- :method: seg_size
+  :option: seg_size
+  :type_hint: Integer
+- :method: seg_start
+  :option: seg_start
+  :type_hint: Integer
+- :method: seg_tags
+  :option: seg_tags
+  :type_hint: String
+- :method: segtype
+  :option: segtype
+  :type_hint: String
+- :method: snap_percent
+  :option: snap_percent
+  :type_hint: Float
+- :method: stripe_size
+  :option: stripe_size
+  :type_hint: Integer
+- :method: stripes
+  :option: stripes
+  :type_hint: Integer
+- :method: stripesize
+  :option: stripesize
+  :type_hint: Integer

data/lib/lvm/attrib/pvs.yaml

@@ -0,0 +1,46 @@
+# these are column to object attribute mappings 
+# generated by generate_field_data.rb based on 
+# /home/iscsidev/LVM2.2.02.26/lib/report/columns.h
+--- 
+- :method: dev_size
+  :option: dev_size
+  :type_hint: Integer
+- :method: pe_start
+  :option: pe_start
+  :type_hint: Integer
+- :method: attr
+  :option: pv_attr
+  :type_hint: String
+- :method: fmt
+  :option: pv_fmt
+  :type_hint: String
+- :method: free
+  :option: pv_free
+  :type_hint: Integer
+- :method: name
+  :option: pv_name
+  :type_hint: String
+- :method: pe_alloc_count
+  :option: pv_pe_alloc_count
+  :type_hint: Integer
+- :method: pe_count
+  :option: pv_pe_count
+  :type_hint: Integer
+- :method: size
+  :option: pv_size
+  :type_hint: Integer
+- :method: tags
+  :option: pv_tags
+  :type_hint: String
+- :method: used
+  :option: pv_used
+  :type_hint: Integer
+- :method: uuid
+  :option: pv_uuid
+  :type_hint: String
+- :method: pvseg_size
+  :option: pvseg_size
+  :type_hint: Integer
+- :method: pvseg_start
+  :option: pvseg_start
+  :type_hint: Integer

data/lib/lvm/attrib/vgs.yaml

@@ -0,0 +1,55 @@
+# these are column to object attribute mappings 
+# generated by generate_field_data.rb based on 
+# /home/iscsidev/LVM2.2.02.26/lib/report/columns.h
+--- 
+- :method: lv_count
+  :option: lv_count
+  :type_hint: Integer
+- :method: max_lv
+  :option: max_lv
+  :type_hint: Integer
+- :method: max_pv
+  :option: max_pv
+  :type_hint: Integer
+- :method: pv_count
+  :option: pv_count
+  :type_hint: Integer
+- :method: snap_count
+  :option: snap_count
+  :type_hint: Integer
+- :method: attr
+  :option: vg_attr
+  :type_hint: String
+- :method: extent_count
+  :option: vg_extent_count
+  :type_hint: Integer
+- :method: extent_size
+  :option: vg_extent_size
+  :type_hint: Integer
+- :method: fmt
+  :option: vg_fmt
+  :type_hint: String
+- :method: free
+  :option: vg_free
+  :type_hint: Integer
+- :method: free_count
+  :option: vg_free_count
+  :type_hint: Integer
+- :method: name
+  :option: vg_name
+  :type_hint: String
+- :method: seqno
+  :option: vg_seqno
+  :type_hint: Integer
+- :method: size
+  :option: vg_size
+  :type_hint: Integer
+- :method: sysid
+  :option: vg_sysid
+  :type_hint: String
+- :method: tags
+  :option: vg_tags
+  :type_hint: String
+- :method: uuid
+  :option: vg_uuid
+  :type_hint: String

data/lib/lvm/external.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'open4'
+
+module LVMWrapper 
+  class 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
+        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
+      end
+    end
+
+  end # class
+end # module

data/lib/lvm/lv.rb

@@ -0,0 +1,19 @@
+module LVMWrapper
+  class LogicalVolume
+    def initialize(args)
+        @attributes = args
+        
+        # so many attributes.. we let the caller define them :)
+        meta = class << self; self; end
+        args.each_key do |name|
+          meta.send(:define_method, name) { @attributes[name] }
+        end
+    end
+
+    # helper methods
+    def open?
+      @attributes[:device_open]
+    end
+
+  end # class
+end # module

data/lib/lvm/lvmanager.rb

@@ -0,0 +1,95 @@
+require 'lvm/lv'
+require 'lvm/lvs'
+
+module LVMWrapper
+  class LogicalVolumeManager
+      
+    def initialize(lvm)
+      @lvm = lvm
+    end
+
+    # lvchange        Change the attributes of logical volume(s)
+    # lvconvert       Change logical volume layout
+    # lvdisplay       Display information about a logical volume
+    # lvextend        Add space to a logical volume
+    #*lvmchange       With the device mapper, this is obsolete and
+    #                 does nothing.
+    #*lvmdiskscan     List devices that may be used as physical
+    #                 volumes
+    #*lvmsadc         Collect activity data
+    #*lvmsar          Create activity report
+    # lvreduce        Reduce the size of a logical volume
+    # lvrename        Rename a logical volume
+    # lvresize        Resize a logical volume
+    # lvscan          List all logical volumes in
+    #                 all volume groups
+
+    # We take the options listed by 'lvm <cmd>' as symbols and pass them as is
+    # to lvm. We let LVM opt parsing handle any issues.
+    def create(args)
+      vgname = args[:vgname] || nil
+      pvpath = args[:pvpath]
+
+      raise ArgumentError if vgname.nil?
+
+      args.delete(:vgname)
+      args.delete(:pvpath)
+
+      @lvm.cmd("lvcreate #{args_to_long_opts(args)} #{vgname} #{pvpath}")
+    end
+
+    def remove(args)
+      lvname = args[:name] || nil
+      vgname = args[:vgname] || nil
+
+      raise ArgumentError if (lvname.nil? or vgname.nil?)
+
+      args.delete(:name)
+      args.delete(:vgname)
+
+      @lvm.cmd("lvremove --force #{args_to_long_opts(args)} #{vgname}/#{lvname}")
+    end
+
+    def snapshot(args)
+      origin = args[:origin] || nil
+
+      raise ArgumentError if origin.nil?
+
+      args.delete(:origin)
+
+      @lvm.cmd("lvcreate --snapshot #{args_to_long_opts(args)} #{origin}")
+    end
+ 
+    # ruby hash of key values to long options
+    def args_to_long_opts(args)
+      opts = [] 
+      args.each do |key,value|
+        opts << "--#{key.to_s} #{value}"
+      end
+      opts.join(" ")
+    end
+
+    def lookup(lvname,vgname)
+      raw_data = @lvm.cmd("#{LVS.command} #{vgname}/#{lvname}")
+      LVS.parse(raw_data)[0]
+    end
+
+    def [](lvname,vgname)
+      lookup(lvname,vgname)
+    end
+
+    def list(vgname)
+      raw_data = @lvm.cmd("#{LVS.command} #{vgname}")
+      lvs = LVS.parse(raw_data)
+      if block_given?
+        lvs.each do |lv|
+          yield lv
+        end
+      else
+        lvs 
+      end
+    end
+    alias lvs list
+
+  end # class
+end # module