shopify-junos-ez-stdlib 1.0.0

data/lib/junos-ez/version.rb

@@ -0,0 +1,6 @@
+module Junos; end
+module Junos::Ez; end
+  
+module Junos::Ez
+  VERSION = "1.0.0"
+end

data/lib/junos-ez/vlans.rb

@@ -0,0 +1,38 @@
+require "junos-ez/provider"
+
+module Junos::Ez::Vlans
+
+  PROPERTIES = [
+     :vlan_id,                  # Fixnum, [ 1 .. 4094 ]
+     :description,              # String, description
+     :no_mac_learning,          # [ true | nil ] - used to disable MAC-address learning
+     :interfaces,               # READ-ONLY, array of bound interface names
+  ]  
+
+  def self.Provider( ndev, varsym )        
+    newbie = case ndev.fact :switch_style
+    when :VLAN
+      Junos::Ez::Vlans::Provider::VLAN.new( ndev )
+    when :VLAN_L2NG
+      Junos::Ez::Vlans::Provider::VLAN_L2NG.new( ndev )      
+    when :BRIDGE_DOMAIN
+      Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN.new( ndev )     
+    else
+      raise Junos::Ez::NoProviderError, "target does not support vlan bridges"
+    end      
+    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/vlans/vlan'
+require 'junos-ez/vlans/vlan_l2ng'
+require 'junos-ez/vlans/bridge_domain'
+
+

data/lib/junos-ez/vlans/bridge_domain.rb

@@ -0,0 +1,89 @@
+class Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN < Junos::Ez::Vlans::Provider
+
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    Nokogiri::XML::Builder.new{|x| x.configuration{ 
+      x.send( :'bridge-domains' ) { x.domain { x.name @name
+        return x
+      }}
+    }}
+  end
+
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_read!    
+    cfg_xml = @ndev.rpc.get_configuration( xml_at_top )    
+    return nil unless (@has_xml = cfg_xml.xpath('//domain')[0])      
+    xml_read_parser( @has_xml, @has )    
+  end
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//domain')[0]    
+  end
+  
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )        
+    as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
+    as_hash[:description] = as_xml.xpath('description').text
+    as_hash[:no_mac_learning] = as_xml.xpath('bridge-options/no-mac-learning').empty? ? :disable : :enable    
+    return true    
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+
+  def xml_on_create( xml )
+    xml.send( :'domain-type', 'bridge' )
+  end
+    
+  def xml_change_no_mac_learning( xml )
+    no_ml = @should[:no_mac_learning]     
+    return unless ( exists? and no_ml )    
+    xml.send(:'bridge-options') {
+      xml.send(:'no-mac-learning', (no_ml == :enable) ? nil : Netconf::JunosConfig::DELETE )
+    }    
+  end
+  
+  def xml_change_vlan_id( xml )
+    xml.send( :'vlan-id', @should[:vlan_id] )
+  end
+  
+  def xml_change_description( xml )
+    xml.description @should[:description]
+  end
+
+end
+
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN
+  
+  def build_list    
+    bd_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'bridge-domains' }
+    bd_cfgs.xpath('bridge-domains/domain').collect do |domain|
+      domain.xpath('name').text
+    end    
+  end
+  
+  def build_catalog
+    @catalog = {}    
+    bd_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'bridge-domains' }    
+    bd_cfgs.xpath('bridge-domains/domain').collect do |domain|
+      name = domain.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( domain, @catalog[name] )
+    end          
+    return @catalog
+  end
+  
+end
+

data/lib/junos-ez/vlans/vlan.rb

@@ -0,0 +1,119 @@
+class Junos::Ez::Vlans::Provider::VLAN < Junos::Ez::Vlans::Provider
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    Nokogiri::XML::Builder.new{|x| x.configuration{ 
+      x.vlans { x.vlan { x.name @name
+        return x
+      }}
+    }}
+  end
+
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//vlan')[0]    
+  end
+        
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )    
+    
+    as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
+    xml_when_item(as_xml.xpath('description')){ |i| as_hash[:description] = i.text }    
+    xml_when_item(as_xml.xpath('no-mac-learning')){ as_hash[:no_mac_learning] = :enable }
+    
+    # get a brief list of the interfaces on this vlan
+    got = @ndev.rpc.get_vlan_information( :vlan_name => @name || as_xml.xpath('name').text )
+    as_hash[:interfaces] = got.xpath('//vlan-member-interface').collect{|ifs| ifs.text.strip }
+    as_hash[:interfaces] = nil if as_hash[:interfaces][0] == "None"
+    
+    return true
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_no_mac_learning( xml )
+    no_ml = @should[:no_mac_learning]     
+    return unless exists? and no_ml
+    xml.send(:'no-mac-learning', no_ml ? nil : Netconf::JunosConfig::DELETE )
+  end
+  
+  def xml_change_vlan_id( xml )
+    xml.send(:'vlan-id', @should[:vlan_id] )
+  end
+  
+  def xml_change_description( xml )
+    value = @should[:description]
+    xml.description value ? value : Netconf::JunosConfig::DELETE
+  end
+
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN
+  
+  def build_list    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      vlan.xpath('name').text
+    end    
+  end
+  
+  def build_catalog
+    @catalog = {}    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }    
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      name = vlan.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( vlan, @catalog[name] )
+    end          
+    return @catalog
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider operational methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN
+
+  ### ---------------------------------------------------------------
+  ### interfaces - returns a Hash of each interface in the VLAN
+  ###    each interface (key) will identify:
+  ###    :mode = [ :access | :trunk ]
+  ###    :native = true if (:mode == :trunk) and this VLAN is the 
+  ###       native vlan-id (untagged packets)
+  ### ---------------------------------------------------------------
+  
+  def interfaces( opts = {} )
+    raise ArgumentError, "not a resource" if is_provider?
+    
+    args = {}
+    args[:vlan_name] = @name 
+    args[:extensive] = true    
+    got = @ndev.rpc.get_vlan_information( args )
+    
+    members = got.xpath('vlan/vlan-detail/vlan-member-list/vlan-member')
+    ifs_h = {}
+    members.each do |port|
+      port_name = port.xpath('vlan-member-interface').text.split('.')[0]
+      port_h = {}
+      port_h[:mode] = port.xpath('vlan-member-port-mode').text.to_sym
+      native = (port.xpath('vlan-member-tagness').text == 'untagged')
+      port_h[:native] = true if( native and port_h[:mode] == :trunk)
+      ifs_h[port_name] = port_h
+    end
+    ifs_h    
+  end
+end

data/lib/junos-ez/vlans/vlan_l2ng.rb

@@ -0,0 +1,126 @@
+class Junos::Ez::Vlans::Provider::VLAN_L2NG < Junos::Ez::Vlans::Provider
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    Nokogiri::XML::Builder.new{|x| x.configuration{ 
+      x.vlans { x.vlan { x.name @name
+        return x
+      }}
+    }}
+  end
+
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//vlan')[0]    
+  end
+        
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )    
+    
+    as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
+    xml_when_item(as_xml.xpath('description')){ |i| as_hash[:description] = i.text }
+        
+    xml_when_item(as_xml.xpath('switch-options/no-mac-learning')) {
+      as_hash[:no_mac_learning] = :enable
+    }
+    
+    # get a brief list of the interfaces on this vlan
+    got = @ndev.rpc.get_vlan_information( :vlan_name => @name || as_xml.xpath('name').text )
+    as_hash[:interfaces] = got.xpath('//l2ng-l2rtb-vlan-member-interface').collect{|ifs| ifs.text.strip }
+    as_hash[:interfaces] = nil if as_hash[:interfaces][0] == "None"
+    
+    return true
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_no_mac_learning( xml )
+    no_ml = @should[:no_mac_learning]     
+    return unless exists? and no_ml    
+    xml.send(:'switch-options') {
+      xml.send(:'no-mac-learning', no_ml == :enable ? nil : Netconf::JunosConfig::DELETE )
+    }
+  end
+  
+  def xml_change_vlan_id( xml )
+    xml.send(:'vlan-id', @should[:vlan_id] )
+  end
+  
+  def xml_change_description( xml )
+    value = @should[:description]
+    xml.description value ? value : Netconf::JunosConfig::DELETE
+  end
+
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN_L2NG
+  
+  def build_list    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      vlan.xpath('name').text
+    end    
+  end
+  
+  def build_catalog
+    @catalog = {}    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }    
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      name = vlan.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( vlan, @catalog[name] )
+    end          
+    return @catalog
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider operational methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN_L2NG
+
+  ### ---------------------------------------------------------------
+  ### interfaces - returns a Hash of each interface in the VLAN
+  ###    each interface (key) will identify:
+  ###    :mode = [ :access | :trunk ]
+  ###    :native = true if (:mode == :trunk) and this VLAN is the 
+  ###       native vlan-id (untagged packets)
+  ### ---------------------------------------------------------------
+  
+  def interfaces( opts = {} )
+    raise ArgumentError, "not a resource" if is_provider?
+    
+    args = {}
+    args[:vlan_name] = @name 
+    args[:extensive] = true    
+    got = @ndev.rpc.get_vlan_information( args )
+    
+    member_pfx = 'l2ng-l2rtb-vlan-member'
+    members = got.xpath("//#{member_pfx}-interface")
+    ifs_h = {}
+    members.each do |port|
+      port_name = port.text.split('.')[0]
+      port_h = {}
+      port_h[:mode] = port.xpath("following-sibling::#{member_pfx}-interface-mode[1]").text.to_sym
+      tgd = port.xpath("following-sibling::#{member_pfx}-tagness[1]").text
+      native = (tgd == 'untagged')
+      port_h[:native] = true if( native and port_h[:mode] == :trunk)
+      ifs_h[port_name] = port_h
+    end
+    ifs_h    
+  end
+end

data/shipit.yml

@@ -0,0 +1,4 @@
+deploy:
+  override:
+    - rake build
+    - package_cloud push shopify/prodeng-gems pkg/ruby-junos-ez-stdlib-*.gem

data/tmp

@@ -0,0 +1,7 @@
+
+
+[1,2,3,4,5].each do |num|
+  list << num
+end
+
+puts list

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: shopify-junos-ez-stdlib
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Schulman
+- John Deatherage
+- Nitin Kumar
+- Priyal Jain
+- Ganesh Nalawade
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netconf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: 'Automation Framework for Junos/NETCONF:  Facts, Providers, and Utils'
+email: jnpr-community-netdev@juniper.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- docs/Facts.md
+- docs/Providers/Group.md
+- docs/Providers/IPports.md
+- docs/Providers/L1ports.md
+- docs/Providers/L2ports.md
+- docs/Providers/LAGports.md
+- docs/Providers/StaticHosts.md
+- docs/Providers/StaticRoutes.md
+- docs/Providers/UserAuths.md
+- docs/Providers/Users.md
+- docs/Providers/Vlans.md
+- docs/Providers_Resources.md
+- docs/README_FIRST.md
+- docs/Utils/Config.md
+- docs/Utils/Filesystem.md
+- docs/Utils/Routing-Engine.md
+- docs/Utils/SCP.md
+- examples/config/config_file.rb
+- examples/config/config_template_object.rb
+- examples/config/config_template_simple.rb
+- examples/config/multi_config.rb
+- examples/fs_utils.rb
+- examples/lag_port.rb
+- examples/re_upgrade.rb
+- examples/re_utils.rb
+- examples/simple.rb
+- examples/st_hosts.rb
+- examples/user.rb
+- examples/vlans.rb
+- junos-ez-stdlib.gemspec
+- lib/junos-ez/exceptions.rb
+- lib/junos-ez/facts.rb
+- lib/junos-ez/facts/chassis.rb
+- lib/junos-ez/facts/ifd_style.rb
+- lib/junos-ez/facts/personality.rb
+- lib/junos-ez/facts/switch_style.rb
+- lib/junos-ez/facts/version.rb
+- lib/junos-ez/group.rb
+- lib/junos-ez/ip_ports.rb
+- lib/junos-ez/ip_ports/classic.rb
+- lib/junos-ez/l1_ports.rb
+- lib/junos-ez/l1_ports/classic.rb
+- lib/junos-ez/l1_ports/switch.rb
+- lib/junos-ez/l2_ports.rb
+- lib/junos-ez/l2_ports/bridge_domain.rb
+- lib/junos-ez/l2_ports/vlan.rb
+- lib/junos-ez/l2_ports/vlan_l2ng.rb
+- lib/junos-ez/lag_ports.rb
+- lib/junos-ez/provider.rb
+- lib/junos-ez/stdlib.rb
+- lib/junos-ez/system.rb
+- lib/junos-ez/system/st_hosts.rb
+- lib/junos-ez/system/st_routes.rb
+- lib/junos-ez/system/syscfg.rb
+- lib/junos-ez/system/userauths.rb
+- lib/junos-ez/system/users.rb
+- lib/junos-ez/utils/config.rb
+- lib/junos-ez/utils/fs.rb
+- lib/junos-ez/utils/re.rb
+- lib/junos-ez/version.rb
+- lib/junos-ez/vlans.rb
+- lib/junos-ez/vlans/bridge_domain.rb
+- lib/junos-ez/vlans/vlan.rb
+- lib/junos-ez/vlans/vlan_l2ng.rb
+- shipit.yml
+- tmp
+homepage: https://github.com/Juniper/ruby-junos-ez-stdlib
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Junos EZ Framework - Standard Libraries
+test_files: []