brocadesan 0.4.0

data/lib/brocadesan/wwn.rb

@@ -0,0 +1,63 @@
+module Brocade module SAN
+  
+# Wwn model
+class Wwn
+  # returns value of the WWN
+  attr_reader :value
+  
+  # description of WWN is provided by device itself
+  
+  attr_reader :symbol
+  
+  # device type - usualy target or initiator
+  
+  attr_reader :dev_type
+  
+  # port index where wwn is located
+  
+  attr_reader :port_index
+  
+  # domain of switch where wwn is online
+  #
+  # domain of 0 means the switch does not have any domain id
+  
+  attr_reader :domain_id
+  
+  # value naming rule
+  # value ca be only WWN
+  #
+  # 50:00:10:20:30:40:50:60
+  
+  VALUE_RULE='([\da-f]{2}:){7}[\da-f]{2}'
+  
+  # verifies if +str+ matches convetion defined in Wwn::VALUE_RULE
+  # raises Switch::Error: Incorrect value format if not
+  # this method is used internally mostly
+    
+  def self.verify_value(str)
+    raise Switch::Error.new("Incorrect value format \"#{str}\"") if !str.match(/#{VALUE_RULE}/i)
+  end
+  
+  # shadows value
+  def name
+    @value
+  end
+   
+  # init method
+  #
+  # opts => :symbol => "text" - device description
+  def initialize(value,dev_type,domain_id,port_index,opts={}) # :nodoc:
+    Wwn::verify_value(value)
+    @value=value 
+    @dev_type=dev_type
+    @domain_id=domain_id.to_i
+    @port_index=port_index.to_i
+    @symbol= !opts[:symbol].nil? ? opts[:symbol] : ""
+  end  
+  
+  def to_s
+    @value
+  end
+end
+
+end; end

data/lib/brocadesan/zone.rb

@@ -0,0 +1,60 @@
+module Brocade module SAN
+  
+# Zone model
+class Zone
+  # returns name of the zone
+  attr_reader :name
+  
+  # true if zone is active / member of effective ZoneConfiguration
+  attr_reader :active
+  
+  # member naming rule
+  # member can be anything that match Switch::NAME_RULE
+  # or WWN or Domain,Index port notation
+  # allowed examples:
+  #
+  # 50:00:10:20:30:40:50:60
+  #
+  # 2,61
+  #
+  # alias_test_3
+  
+  MEMBER_RULE='([\da-f]{2}:){7}[\da-f]{2}|\d{1,3},\d{1,3}|' << Switch::NAME_RULE
+   
+  # verifies if +str+ matches convetion defined in Zone::MEMBER_RULE
+  # raises Switch::Error: Incorrect name format if not
+  # this method is used internally mostly
+    
+  def self.verify_member_name(str)
+    raise Switch::Error.incorrect("#{str}") if !str.match(/#{MEMBER_RULE}/i)
+  end
+  
+  # init method
+  def initialize(name,opts={}) # :nodoc:
+    Switch::verify_name(name)
+    @name=name
+    @active=opts[:active].nil? ? false : opts[:active]
+    @members=[] 
+  end
+  
+  # returns array of members
+  
+  def members
+    @members
+  end
+  
+  # add member to the object
+  # members of zones are aliases, wwns or D,I notation
+  # +member+ is name of the member  
+  def add_member(member)
+    Zone::verify_member_name(member)
+    @members<<member
+  end
+  
+  def to_s
+    @name
+  end
+  
+end
+
+end; end

data/lib/brocadesan/zone_configuration.rb

@@ -0,0 +1,38 @@
+module Brocade module SAN
+  
+# Zone Configuration model
+class ZoneConfiguration
+  # returns name of the zone configuration
+  attr_reader :name
+  
+  # true if configuration is effective, false if defined
+  attr_reader :effective
+  
+  # init method
+  def initialize(name,opts={}) # :nodoc:
+    Switch::verify_name(name)
+    @name=name
+    @effective=opts[:effective].nil? ? false : true
+    @members=[] 
+  end
+  
+  # returns array of members
+  
+  def members
+    @members
+  end
+  
+  # add member to the object
+  # members of zone configurations are zones
+  # +member+ is name of the zone
+  def add_member(member)
+    Switch::verify_name(member)
+    @members<<member
+  end
+  
+  def to_s
+    @name
+  end
+end
+
+end; end

data/lib/meta_methods.rb

@@ -0,0 +1,263 @@
+class Brocade::SAN::Switch
+##
+# :method: name
+# :call-seq:
+#   name(forced=true)
+#
+# If called with +true+ argument it will get the switch_name from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: state
+# :call-seq:
+#   state(forced=true)
+#
+# If called with +true+ argument it will get the switch_state from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: mode
+# :call-seq:
+#   mode(forced=true)
+#
+# If called with +true+ argument it will get the switch_mode from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: role
+# :call-seq:
+#   role(forced=true)
+#
+# If called with +true+ argument it will get the switch_role from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: domain
+# :call-seq:
+#   domain(forced=true)
+#
+# If called with +true+ argument it will get the switch_domain from the switch instead of cache
+#
+# Returns value in (integer) format
+
+##
+# :method: id
+# :call-seq:
+#   id(forced=true)
+#
+# If called with +true+ argument it will get the switch_id from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: wwn
+# :call-seq:
+#   wwn(forced=true)
+#
+# If called with +true+ argument it will get the switch_wwn from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: zoning_enabled
+# :call-seq:
+#   zoning_enabled(forced=true)
+#
+# If called with +true+ argument it will get the zoning_enabled from the switch instead of cache
+#
+# Returns value in (boolean) format
+
+##
+# :method: active_config
+# :call-seq:
+#   active_config(forced=true)
+#
+# If called with +true+ argument it will get the active_config from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: switch_beacon
+# :call-seq:
+#   switch_beacon(forced=true)
+#
+# If called with +true+ argument it will get the switch_beacon from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: fc_router
+# :call-seq:
+#   fc_router(forced=true)
+#
+# If called with +true+ argument it will get the fc_router from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: allow_xisl_use
+# :call-seq:
+#   allow_xisl_use(forced=true)
+#
+# If called with +true+ argument it will get the allow_xisl_use from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: ls_attributes
+# :call-seq:
+#   ls_attributes(forced=true)
+#
+# If called with +true+ argument it will get the ls_attributes from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: kernel
+# :call-seq:
+#   kernel(forced=true)
+#
+# If called with +true+ argument it will get the kernel from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: firmware
+# :call-seq:
+#   firmware(forced=true)
+#
+# If called with +true+ argument it will get the fabric_os from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: logical_switches
+# :call-seq:
+#   logical_switches(forced=true)
+#
+# If called with +true+ argument it will get the created_switches from the switch instead of cache
+#
+# Returns value in (array) format
+
+##
+# :method: ports
+# :call-seq:
+#   ports(forced=true)
+#
+# If called with +true+ argument it will get the ports from the switch instead of cache
+#
+# Returns value in (array) format
+
+##
+# :method: aptpolicy
+# :call-seq:
+#   aptpolicy(forced=true)
+#
+# If called with +true+ argument it will get the current_policy from the switch instead of cache
+#
+# Returns value in (integer) format
+
+##
+# :method: chassisname
+# :call-seq:
+#   chassisname(forced=true)
+#
+# If called with +true+ argument it will get the chassisname from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: dls
+# :call-seq:
+#   dls(forced=true)
+#
+# If called with +true+ argument it will get the dlsshow from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: iod
+# :call-seq:
+#   iod(forced=true)
+#
+# If called with +true+ argument it will get the iodshow from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: status
+# :call-seq:
+#   status(forced=true)
+#
+# If called with +true+ argument it will get the switch_state from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: status_details
+# :call-seq:
+#   status_details(forced=true)
+#
+# If called with +true+ argument it will get the switchstatusshow from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: ip
+# :call-seq:
+#   ip(forced=true)
+#
+# If called with +true+ argument it will get the ip_address from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: supportshow
+# :call-seq:
+#   supportshow(forced=true)
+#
+# If called with +true+ argument it will get the supportshow from the switch instead of cache
+#
+# Returns value in (string) format
+
+##
+# :method: isls
+# :call-seq:
+#   isls(forced=true)
+#
+# If called with +true+ argument it will get the isl_links from the switch instead of cache
+#
+# Returns value in (array) format
+
+##
+# :method: trunks
+# :call-seq:
+#   trunks(forced=true)
+#
+# If called with +true+ argument it will get the trunk_links from the switch instead of cache
+#
+# Returns value in (array) format
+
+##
+# :method: access_gateways
+# :call-seq:
+#   access_gateways(forced=true)
+#
+# If called with +true+ argument it will get the ag from the switch instead of cache
+#
+# Returns value in (array) format
+
+##
+# :method: cfg_transaction
+# :call-seq:
+#   cfg_transaction(forced=true)
+#
+# If called with +true+ argument it will get the cfg_transaction from the switch instead of cache
+#
+# Returns value in (hash) format
+
+end

data/test/alias_test.rb

@@ -0,0 +1,68 @@
+require 'brocadesan'
+require 'minitest/autorun'
+require 'output_helpers'
+
+module Brocade module SAN
+  
+class AliasTest < MiniTest::Test
+  include OutputReader
+  include Mock::Net::SSH
+  patch_set
+  
+  def setup
+    init_dev
+  end
+  
+  def init_dev
+    @switch = Switch.new("test","test","test")
+  end
+  
+  def test_new_alias 
+    al=Alias.new("test")
+    assert_equal "test", al.name
+    assert_raises Switch::Error do
+      zone=Alias.new("test-d")
+    end
+  end
+  
+  def test_members
+    @output_dir=File.join(Dir.pwd,"test","outputs")
+    read_all_starting_with "cfgshow_" do |file,output|
+      response=new_mock_response
+      response.data=output
+      init_dev
+      yaml=read_yaml_for(file)
+      @switch.stub :query, response do 
+        @switch.aliases.each_with_index do |al,i|
+          assert_equal yaml[:defined_configuration][:alias].values[i], al.members
+        end
+      end
+    end
+  end
+  
+  def test_add_member
+    a=Alias.new("test")
+    a.add_member "50:00:10:20:30:40:50:60"
+    assert_equal ["50:00:10:20:30:40:50:60"], a.members
+    a.add_member "2,61"
+    assert_equal ["50:00:10:20:30:40:50:60","2,61"], a.members
+    
+    assert_raises(Switch::Error) do
+      a.add_member "invalid_name_for_alias_member"
+    end
+  end
+  
+  def test_validity_verification
+    name = "invalid_name_for_alias_member"
+    exp = assert_raises(Switch::Error) do
+      Alias::verify_member_name name
+    end
+    assert_equal Switch::Error.incorrect(name).message, exp.message
+    assert_silent do
+      Alias::verify_member_name "50:00:10:20:30:40:50:60"
+      Alias::verify_member_name "2,61"
+    end
+  end
+end
+
+end; end