junos-ez-stdlib 0.0.10

data/lib/junos-ez/facts/version.rb

@@ -0,0 +1,32 @@
+Junos::Ez::Facts::Keeper.define( :version ) do |ndev, facts|
+  
+  f_master, f_persona = uses :master, :personality
+      
+  case f_persona
+  when :MX
+    swver = ndev.rpc.command "show version invoke-on all-routing-engines"
+  when :SWITCH
+    swver = ndev.rpc.command "show version all-members"        
+  else
+    swver = ndev.rpc.command "show version"
+  end
+  
+  if swver.name == 'multi-routing-engine-results'
+    swver_infos = swver.xpath('//software-information')
+    swver_infos.each do |re_sw|
+      re_name = re_sw.xpath('preceding-sibling::re-name').text.upcase
+      re_sw.xpath('package-information[1]/comment').text =~ /\[(.*)\]/
+      ver_key = ('version_' + re_name).to_sym
+      facts[ver_key] = $1                  
+    end
+    master_id = f_master
+    facts[:version] = 
+      facts[("version_" + "RE" + master_id).to_sym] || 
+      facts[('version_' + "FPC" + master_id).to_sym]
+  else
+    junos = swver.xpath('//package-information[name = "junos"]/comment').text
+    junos =~ /\[(.*)\]/
+    facts[:version] = $1        
+  end    
+  
+end

data/lib/junos-ez/facts.rb

@@ -0,0 +1,85 @@
+require 'junos-ez/provider'
+
+### -----------------------------------------------------------------
+### Junos::Ez module devices the toplevel Provider and associated
+### Facts class & methods
+### -----------------------------------------------------------------
+
+module Junos::Ez
+  
+  attr_accessor :providers, :facts
+
+  def self.Provider( ndev )       
+    ndev.extend Junos::Ez
+    ndev.providers = []
+    ndev.facts = Junos::Ez::Facts::Keeper.new( ndev )     
+    ndev.facts.read!
+    true
+  end      
+  
+  def fact( name ); facts[name] end
+end; 
+
+module Junos::Ez::Facts
+  
+  class Keeper
+    attr_accessor :known
+    
+    def initialize( ndev )
+      @ndev = ndev
+      @known = Hash.new
+    end
+    
+    def clear; @known.clear end
+      
+    def list; @known.keys end   
+    def list!; read!; list; end
+      
+    def catalog; @known end          
+    def catalog!; read!; catalog end
+          
+    def uses( *facts )
+      values = facts.collect do |f|
+        self.send( "fact_read_#{f}", @ndev, @known ) unless @known[f]
+        self[f]
+      end      
+      (values.count == 1) ? values[0] : values      
+    end
+    
+    def self.define( fact, &block )
+      define_method( "fact_read_#{fact}".to_sym, block )
+    end
+  
+    def []=(key,value)
+      @known[key] = value
+    end
+    
+    def [](key)
+      @known[key]
+    end
+    
+    def read!
+      @known.clear
+      fact_readers = self.methods.grep /^fact_read_/
+      fact_readers.each do |getter| 
+        getter =~ /^fact_read_(\w+)/
+        fact = $1.to_sym
+        self.send( getter, @ndev, @known ) unless @known[fact]
+      end
+    end
+  
+  end # class
+end
+
+### -----------------------------------------------------------------
+### Load all of the fact files
+### -----------------------------------------------------------------
+
+Dir[File.dirname(__FILE__) + "/facts/*.rb"].each do |file|
+  require file
+end    
+
+
+
+
+

data/lib/junos-ez/ip_ports/classic.rb

@@ -0,0 +1,149 @@
+class Junos::Ez::IPports::Provider::CLASSIC < Junos::Ez::IPports::Provider
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top    
+    
+    # if just the IFD is given as the name, default to unit "0"
+    @ifd, @ifl = @name.split '.'
+    @ifl ||= "0"
+    
+    Nokogiri::XML::Builder.new{ |x| x.configuration{ 
+      x.interfaces { x.interface { x.name @ifd
+        x.unit {
+          x.name @ifl
+          return x
+        }
+      }}
+    }}
+  end
+  
+  def xml_element_rename( new_name )
+    
+    # if just the IFD is given as the name, default to unit "0"
+    n_ifd, n_ifl = new_name.split '.'
+    n_ifl ||= "0"
+    
+    # do not allow rename to different IFD.
+    return false unless @ifd == n_ifd
+    
+    # return the new element name
+    return n_ifl
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//unit')[0]
+  end
+    
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )    
+    
+    ifa_inet = as_xml.xpath('family/inet')
+    
+    as_hash[:tag_id] = as_xml.xpath('vlan-id').text.to_i
+    as_hash[:description] = as_xml.xpath('description').text
+    as_hash[:mtu] = ifa_inet.xpath('mtu').text.to_i || nil
+    as_hash[:address] = ifa_inet.xpath('address/name').text || nil
+    as_hash[:admin] = as_xml.xpath('disable').empty? ? :up : :down
+    
+    return true
+  end  
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_address( xml )
+    xml.family { xml.inet {
+      if @has[:address]
+        xml.address( Netconf::JunosConfig::DELETE ) {
+          xml.name @has[:address]
+        }
+      end
+      xml.address { 
+        xml.name @should[:address] 
+      }
+    }}
+  end
+  
+  def xml_change_tag_id( xml )
+    xml_set_or_delete( xml, 'vlan-id', @should[:tag_id] )
+  end
+
+  def xml_change_mtu( xml )
+    xml.family { xml.inet {
+      xml_set_or_delete( xml, 'mtu', @should[:mtu] )
+    }}
+  end   
+
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::IPports::Provider::CLASSIC
+  
+  def build_list            
+    from_junos_get_ifa_xml.collect do |ifa|
+      ifa.xpath('name').text.strip
+    end                
+  end
+  
+  def build_catalog
+    @catalog = {}
+
+    ## do the equivalent of "show interfaces ..." to retrieve the list
+    ## of known interfaces that have an IFA == 'inet'.  Note that this
+    ## list will *not* include anything that has been deactivated.
+    
+    ifa_list = from_junos_get_ifa_xml
+    
+    ## from this list of IFA, retrieve the configurations
+    
+    got_xml_cfg = @ndev.rpc.get_configuration do |cfg|
+      cfg.interfaces {
+        ifa_list.each do |ifa|
+          ifa_name = ifa.xpath('name').text.strip
+          ifa_ifd, ifa_ifl = ifa_name.split '.'
+          cfg.interface { 
+            cfg.name ifa_ifd 
+            cfg.unit { cfg.name ifa_ifl }
+          }
+        end
+      }
+    end    
+    
+    ## now create the object property hashes for each of the instances
+    
+    got_xml_cfg.xpath('interfaces/interface/unit').each do |ifl|      
+      ifd = ifl.xpath('preceding-sibling::name').text.strip
+      unit = ifl.xpath('name').text.strip
+      obj_name = ifd + '.' + unit
+      
+      @catalog[obj_name] = {}
+      xml_read_parser( ifl, @catalog[obj_name] )
+    end
+    
+    return @catalog
+  end
+  
+  private
+  
+  def from_junos_get_ifa_xml
+    
+    xml_data = @ndev.rpc.get_interface_information( 
+      :terse => true,
+      :interface_name => '[xgf]e-*/*/*.*' )
+    
+    ifa_list = xml_data.xpath('logical-interface[normalize-space(address-family/address-family-name) = "inet"]')    
+    
+  end
+  
+end

data/lib/junos-ez/ip_ports.rb

@@ -0,0 +1,28 @@
+
+require "junos-ez/provider"
+
+module Junos::Ez::IPports
+
+  PROPERTIES = [ 
+    :admin,             # [:up, :down]
+    :description,       # general description text
+    :tag_id,            # VLAN tag-id for vlan-tag enabled ports
+    :mtu,               # MTU value as number
+    :address            # ip/prefix as text, e.g. "192.168.10.22/24"
+  ]  
+
+  def self.Provider( ndev, varsym )            
+    newbie = Junos::Ez::IPports::Provider::CLASSIC.new( ndev )      
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )    
+  end
+  
+  class Provider < Junos::Ez::Provider::Parent
+    # common parenting goes here ...
+  end
+  
+end
+
+require 'junos-ez/ip_ports/classic'
+
+

data/lib/junos-ez/l1_ports/classic.rb

@@ -0,0 +1,87 @@
+class Junos::Ez::L1ports::Provider::CLASSIC < Junos::Ez::L1ports::Provider
+
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top    
+    xml = Nokogiri::XML::Builder.new {|xml| xml.configuration {
+      xml.interfaces {
+        xml.interface { 
+          xml.name @name
+          return xml
+        }
+      }
+    }}
+  end
+      
+  ### ---------------------------------------------------------------
+  ### XML property readers
+  ### ---------------------------------------------------------------
+  
+  def xml_read_filter( xml )
+    xml.description
+    xml.disable
+    xml.mtu
+    xml.speed
+    xml.send(:'link-mode') 
+    xml.unit({:recurse => 'false'})    
+  end
+  
+  def xml_config_read!
+    xml = xml_at_top
+    xml_read_filter( xml )
+    @ndev.rpc.get_configuration( xml )      
+  end    
+
+  def xml_read_parser( as_xml, as_hash )    
+    set_has_status( as_xml, as_hash )
+
+    as_hash[:admin] = as_xml.xpath('disable').empty? ? :up : :down
+    
+    unless (desc = as_xml.xpath('description').text.chomp).empty?
+      as_hash[:description] = desc
+    end
+        
+    if mtu = as_xml.xpath('mtu')[0]; as_hash[:mtu] = mtu.text.to_i end
+            
+    as_hash[:duplex] = case as_xml.xpath('link-mode').text.chomp
+      when 'full-duplex' then :full
+      when 'half-duplex' then :half
+      else :auto
+    end
+      
+    as_hash[:speed] = ( speed = as_xml.xpath('speed')[0] ) ? speed.text : :auto         
+    as_hash[:unit_count] = as_xml.xpath('unit').count
+    
+    return true
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML property writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_speed( xml )
+    if @should[:speed] == :auto
+      if is_new?
+        xml.speed Netconf::JunosConfig::DELETE
+      end
+    else
+      xml.speed @should[:speed]
+    end
+  end  
+
+  def xml_change_duplex( xml )
+    if @should[:duplex] == :auto
+      unless is_new?
+        xml.send( :'link-mode', Netconf::JunosConfig::DELETE )
+      end
+    else
+      xml.send( :'link-mode', case @should[:duplex]
+        when :full then 'full-duplex'
+        when :half then 'half-duplex'
+        end )
+    end
+  end  
+    
+end

data/lib/junos-ez/l1_ports/switch.rb

@@ -0,0 +1,134 @@
+class Junos::Ez::L1ports::Provider::SWITCH < Junos::Ez::L1ports::Provider
+
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    xml = Nokogiri::XML::Builder.new {|xml| xml.configuration {
+      xml.interfaces {
+        xml.interface { 
+          xml.name @name
+          return xml
+        }
+      }
+    }}
+  end
+      
+  ### ---------------------------------------------------------------
+  ### XML property readers
+  ### ---------------------------------------------------------------
+  
+  def xml_read_filter( xml )
+    xml.description
+    xml.disable
+    xml.mtu
+    xml.send(:'ether-options') 
+    xml.unit({:recurse => 'false'})    
+  end
+  
+  def xml_config_read!
+    xml = xml_at_top
+    xml_read_filter( xml )
+    @ndev.rpc.get_configuration( xml )      
+  end    
+
+  def xml_read_parser( as_xml, as_hash )    
+    set_has_status( as_xml, as_hash )
+
+    xml_when_item(as_xml.xpath('description')){|i| as_hash[:description] = i.text}        
+    as_hash[:admin] = as_xml.xpath('disable').empty? ? :up : :down
+    xml_when_item(as_xml.xpath('mtu')){|i| as_hash[:mtu] = i.text.to_i }
+        
+    phy_options = as_xml.xpath('ether-options')    
+    if phy_options.empty?
+      as_hash[:speed] = :auto
+      as_hash[:duplex] = :auto
+    else      
+      ## :duplex
+      as_hash[:duplex] = case phy_options.xpath('link-mode').text.chomp
+        when 'full-duplex' then :full
+        when 'half-duplex' then :half
+        else :auto
+      end
+      ## :speed
+      if speed = phy_options.xpath('speed')[0]
+        as_hash[:speed] = _speed_from_junos_( speed.first_element_child.name )
+      else
+        as_hash[:speed] = :auto
+      end
+    end                      
+    
+    as_hash[:unit_count] = as_xml.xpath('unit').count    
+    return true
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML property writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_speed( xml )
+    xml.send(:'ether-options') {
+      xml.speed {
+        if @should[:speed] == :auto
+          unless @has[:speed] == :auto
+            xml.send( _speed_to_junos_( @has[:speed] ), Netconf::JunosConfig::DELETE )
+          end
+        else
+          xml.send( _speed_to_junos_( @should[:speed] ))
+        end
+      }
+    }
+  end
+  
+  def xml_change_duplex( xml )
+    xml.send(:'ether-options') {
+      if @should[:duplex] == :auto
+        unless @has[:duplex] == :auto
+          xml.send( :'link-mode', Netconf::JunosConfig::DELETE )
+        end
+      else
+        xml.send( :'link-mode', case @should[:duplex]
+           when :full then 'full-duplex'
+           when :half then 'half-duplex'
+        end )
+      end
+    }
+  end  
+  
+    
+end
+
+### -----------------------------------------------------------------
+### PRIVATE METHODS
+### -----------------------------------------------------------------
+
+class Junos::Ez::L1ports::Provider::SWITCH
+  private
+  
+  def _speed_to_junos_( pval )
+    # @@@ TODO: could remove case-statement and to
+    # @@@ string processing ...    
+    case pval
+       when '10g' then :'ethernet-10g'
+       when '1g' then :'ethernet-1g'
+       when '100m' then :'ethernet-100m'
+       when '10m' then :'ethernet-10m'
+       else :auto
+    end
+  end
+  
+  def _speed_from_junos_( jval )
+    # @@@ TODO: could remove case-statement and to
+    # @@@ string processing ...
+    case jval
+      when 'ethernet-100m' then '100m'
+      when 'ethernet-10m' then '10m'
+      when 'ethernet-1g' then '1g'
+      when 'ethernet-10g' then '10g'
+      else :auto
+    end
+  end
+  
+end
+

data/lib/junos-ez/l1_ports.rb

@@ -0,0 +1,81 @@
+require "junos-ez/provider"
+
+module Junos::Ez::L1ports
+
+  PROPERTIES = [ 
+    :admin,               # [ :up, :down ]
+    :description,         # string
+    :mtu,                 # number
+    :speed,               # [ :auto, '10m', '100m', '1g', '10g' ]
+    :duplex,              # [ :auto, :half, :full ]
+    :unit_count,          # number of configured units
+  ]  
+
+  def self.Provider( ndev, varsym )            
+    newbie = case ndev.fact( :ifd_style )
+    when :SWITCH
+      Junos::Ez::L1ports::Provider::SWITCH.new( ndev )            
+    when :CLASSIC
+      Junos::Ez::L1ports::Provider::CLASSIC.new( ndev )      
+    end      
+    
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )
+  end
+  
+end
+
+class Junos::Ez::L1ports::Provider < Junos::Ez::Provider::Parent
+  
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//interface')[0]
+  end
+    
+  def xml_change_mtu( xml )
+    xml_set_or_delete( xml, 'mtu', @should[:mtu] )
+  end
+  
+  ### ---------------------------------------------------------------
+  ###  Collection methods
+  ### ---------------------------------------------------------------  
+  
+  def build_list
+    @ndev.rpc.get_interface_information({
+        :media => true,
+        :terse => true,
+        :interface_name => '[fgx]e-*'
+    }).xpath('physical-interface/name').collect do |ifs|
+      ifs.text.strip
+    end
+  end
+  
+  def build_catalog
+    @catalog = {}
+    
+    @ndev.rpc.get_configuration{|xml|
+      xml.interfaces {
+        list!.each do |ifs|
+          xml.interface {
+            xml.name ifs
+            xml_read_filter( xml )
+          }
+        end
+      }
+    }.xpath('interfaces/interface').each do |ifs_xml|
+      ifs_name = ifs_xml.xpath('name').text
+      @catalog[ifs_name] = {}
+      xml_read_parser( ifs_xml, @catalog[ifs_name] )
+    end
+    
+    return @catalog
+  end
+  
+end  
+
+require 'junos-ez/l1_ports/switch'
+require 'junos-ez/l1_ports/classic'
+