storcs 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
+tmp/*
 *.gem
 .bundle
+.rvmrc

data/README.textile

@@ -9,6 +9,8 @@ Storcs (STORage Calculation Service) is a gem designed to help you manage centra
 
 Those calulcations are performed on a state file for each device you have. The way you generate the state file depends on the type of the storage system.
 
+*Calculations are performed in bytes*.
+
 For the moment, it has only been tested on the following devices :
 * IBM DS4000 series (tested with a DS3400, a DS4100, a DS4300 and a DS4500)
 * Equalogic PS5000 and PS6000 series (tested with a PS5000XV and a PS6000)
@@ -23,11 +25,72 @@ gem install storcs-*.gem
 
 h2. Parsers
 
-A parser is an adapter specific to your device. Parser implementation depends on the way you retrieve your storage informations. Basically, it takes a name and a file, parse the file, and build a Storcs::Device object based on the parsed informations. For instance:
+A parser is an adapter specific to your device. Parser implementation depends on the way you retrieve your storage informations. Basically, it takes a name and a file, parses the file, and builds a Storcs::Device object based on the parsed informations. For instance:
 
 bc. parsed = Storcs::Parsers::DfNas.new("my-shiny-nas.example.com", "/path/to/df-k_output.txt")
 device = parsed.device
 
+h2. Sizes
+
+Now that you have a "device", you can use the common methods to retrieve informations on this device :
+
+bc. device.name
+=> "my-shiny-nas.example.com"
+device.used
+=> 612376576
+device.size
+=> 814572544
+device.free
+=> 202195968
+
+ZOMG, a sum and a percentage !!
+
+Well, ok, that's not so impressive. The interesting part comes when you have nested " " " devices" " ", like in most storage devices on the market : SAN devices have enclosures, and / or raid groups, and / or arrays of disks, etc.
+
+Let's take an example without parser (parsers do all this magic for you) :
+
+bc. dev = Storcs::Device.new("my-device")
+=> #<Storcs::Device:0x9050a9c @name="my-device", @children=[]>
+array1 = Storcs::Device.new("array1"); array1.real_size=100; array1.real_used=50; array1
+=> #<Storcs::Device:0x98ee258 @name="array1", @children=[], @real_size=100, @real_used=50>
+array2 = Storcs::Device.new("array2"); array2.real_size=100; array2.real_used=25; array2
+=> #<Storcs::Device:0x98e3c7c @name="array2", @children=[], @real_size=100, @real_used=25>
+dev.children << array1; dev.children << array2
+=> ...
+dev.size
+=> 200
+dev.used
+=> 75
+dev.percent_used
+=> 37.5
+
+Imagine you have nested storage "devices", with 3, 4 or 5 levels of recursions, you probably don't want to screw your app with all those calculations.
+
+One more thing, some parsers may parse and thus provide extra attributes which are not standard / available in others. For instance, IBM parser provides ability to know the RAID type of an array, and the size of unassigned disks:
+
+bc. ibm_device.childrens.map(&:raid)
+=> ["5", "1", "5", "5"]
+ibm_device.unassigned
+=> 3142530966
+
+h2. Helper
+
+storcs gem comes with a helper method to help you format sizes, since everything is calculated in bytes internally and you probably don't want that in your final rendering.
+
+bc. include Storcs::Formatter
+pretty_size(1)
+=> "1.0bytes"
+pretty_size(12345)
+=> "12.1Kb"
+pretty_size(825388561334)
+=> "768.7Gb"
+pretty_size(12285713148014)
+=> "11.2Tb"
+
+More options can be added on the formatter side on demand.
+
+h2. Available parsers
+
 h3. df -k
 
 This is the simplest parser. It analyzes the output of a @df -Pk@ command on a mounted filesystem, possibly a local filesystem or a NAS attached with NFS or CIFS:
@@ -45,3 +108,7 @@ bc. SMcli 192.0.0.15 -c 'show storagesubsystem profile;' > file.txt
 h3. Equalogic PS5000 and PS6000
 
 It parses the output of a 'show' command in the shell. Unfortunately, I wasn't able to run it remotely since my network administrator didn't allow me. So I have a script based on the "expect" tool with the @show@ command inside.
+
+h3. Yours!
+
+If you have a storage device you'd like to see in this list, feel free to open an issue here with at least an example 'profile' file (this can be the output of a command, a plain text or structured file) and the result I should find (used size/total size at least). Maybe somebody else (or me) will be interested in building a parser for your device.

data/lib/storcs/device.rb

@@ -1,24 +1,13 @@
 module Storcs
   class Device
-    attr_accessor :name, :children, :real_used, :real_size, :raid
+    extend SummableSizes
+
+    attr_accessor :name, :children, :raid
+    summable_sizes :size, :used, :unassigned
 
     def initialize(name)
       @name = name
       @children = []
-      @real_used = nil
-      @real_size = nil
-    end
-
-    def size
-      real_size || children.inject(0) do |memo,child|
-        memo + child.size
-      end
-    end
-
-    def used
-      real_used || children.inject(0) do |memo,child|
-        memo + child.used
-      end
     end
 
     def free
@@ -26,11 +15,13 @@ module Storcs
     end
 
     def percent_used
-      (100 * used / size).round
+      return 0 unless size.integer? && size > 0
+      (100 * used.to_f / size).round(2)
     end
 
     def percent_free
-      (100 * free / size).round
+      return 0 unless size.integer? && size > 0
+      (100 * free.to_f / size).round(2)
     end
   end
 end

data/lib/storcs/parsers/ibm.rb

@@ -12,6 +12,7 @@ module Storcs::Parsers
 
     def parse!(content)
       @device.children = arrays
+      @device.real_unassigned = unassigned
     end
 
     def sections
@@ -54,5 +55,21 @@ module Storcs::Parsers
       end.compact
       @arrays
     end
+
+    def unassigned
+      return @unassigned if @unassigned
+      @unassigned = 0
+      in_unassigned = false
+      sections[:drives].map do |line|
+        if line.match /Unassigned/
+          in_unassigned = true
+        elsif line.match /^\s*$/
+          in_unassigned = false
+        elsif in_unassigned && line.match(/Usable capacity:\s+(.+)$/)
+          @unassigned += parse_size($1)
+        end
+      end.compact
+      @unassigned
+    end
   end
 end

data/lib/storcs/summable_sizes.rb

@@ -0,0 +1,33 @@
+module Storcs
+  module SummableSizes
+    # Avoids defining recursively summable columns again
+    # and again. Usage:
+    #
+    #   class Device
+    #     summable_sizes :size, :used, :blah
+    #     ...
+    #   end
+    #
+    # For instance, here's the result for 'used' size:
+    #
+    #   def used
+    #     real_used || children.inject(0) do |memo,child|
+    #       memo + child.used
+    #     end
+    #   end
+    #
+    def summable_sizes(*columns)
+      columns.each do |column|
+        class_eval <<-EOF
+          attr_accessor :real_#{column}
+          def #{column}
+            real_#{column} || children.inject(0) do |memo,child|
+              memo + child.#{column}
+            end
+          end
+        EOF
+      end
+    end
+  end
+end
+

data/lib/storcs/version.rb

@@ -1,3 +1,3 @@
 module Storcs
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/storcs.rb

@@ -1,3 +1,4 @@
+require 'storcs/summable_sizes'
 require 'storcs/device'
 require 'storcs/parsers'
 require 'storcs/formatter'

data/spec/device_spec.rb

@@ -26,4 +26,10 @@ describe Storcs::Device do
     @bay.percent_used.should == 55
     @bay.percent_free.should == 45
   end
+
+  it "ensures a device with no size doesn't screw up on calculations" do
+    device = Storcs::Device.new("bay")
+    device.percent_used.should == 0
+    device.percent_free.should == 0
+  end
 end

data/spec/formatter_spec.rb

@@ -1,3 +1,5 @@
+require File.expand_path('../spec_helper',__FILE__)
+
 describe Storcs::Formatter do
   include Storcs::Formatter
   it "formats sizes in bytes" do

data/spec/parsers/df_nas_spec.rb

@@ -8,5 +8,8 @@ describe Storcs::Parsers::DfNas do
     parsed.device.used.should == 612376576
     parsed.device.size.should == 814572544
     parsed.device.free.should == 202195968
+    parsed.device.unassigned.should == 0
+    parsed.device.percent_free.should == 24.82
+    parsed.device.percent_used.should == 75.18
   end
 end

data/spec/parsers/equalogic_spec.rb

@@ -9,6 +9,7 @@ describe Storcs::Parsers::Equalogic do
     bay.size.should == 4020012968837
     bay.used.should == 3972897177600
     bay.free.should ==   47115791237
+    bay.unassigned.should == 0
   end
 
   it "divides the bay into a set of logical volumes" do

data/spec/parsers/ibm_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe Storcs::Parsers::Ibm do
-  models = {"DS4500" => { :num_arrays => 15, :num_sections => 11,
-                          :bay_size => 12285713148014, :bay_used => 11460324586680, :bay_free => 825388561334,
+  models = {"DS4500" => { :num_arrays => 15, :num_sections => 11, :bay_size => 12285713148014,
+                          :bay_used => 11460324586680, :bay_free => 825388561334, :bay_unassigned => 731389980835,
                           :first_array_name => "ARRAY 1", :first_array_raid => "5", :first_array_ld_num => 17,
                           :ld_name => "array1_LUN0_app01_5G", :ld_size => 5368709120,
                           :array_size => 1316496596795, :array_used => 655826473713 },
-            "DS3400" => { :num_arrays => 1, :num_sections => 9,
-                          :bay_size => 2395702692938, :bay_used => 2395702692938, :bay_free => 0,
+            "DS3400" => { :num_arrays => 1, :num_sections => 9, :bay_size => 2395702692938,
+                          :bay_used => 2395702692938, :bay_free => 0, :bay_unassigned => 0,
                           :first_array_name => "ARRAY 1", :first_array_raid => "5", :first_array_ld_num => 2,
                           :ld_name => "SAN01_LUN1", :ld_size => 1099511627776,
                           :array_size => 2395702692938, :array_used => 2395702692938 }
@@ -29,6 +29,7 @@ describe Storcs::Parsers::Ibm do
         bay.size.should == @expected[:bay_size]
         bay.used.should == @expected[:bay_used]
         bay.free.should == @expected[:bay_free]
+        bay.unassigned.should == @expected[:bay_unassigned]
       end
 
       it "divides a profile file into small sections" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jean-Baptiste Barth
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 +01:00
+date: 2011-03-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - lib/storcs/parsers/equalogic.rb
 - lib/storcs/parsers/ibm.rb
 - lib/storcs/parsers/utils.rb
+- lib/storcs/summable_sizes.rb
 - lib/storcs/version.rb
 - spec/data/df_nas.txt
 - spec/data/equalogic_PS5000XV.txt