shopify-junos-ez-stdlib 1.0.0

data/examples/re_utils.rb

@@ -0,0 +1,33 @@
+require 'pry'
+require 'pp'
+require 'net/scp'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+print "Connecting to device #{login[:target]} ... "
+ndev.open
+puts "OK!"
+
+binding.pry
+
+## attach our private & utils that we need ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::RE::Utils( ndev, :re )
+Junos::Ez::FS::Utils( ndev, :fs )
+Junos::Ez::Config::Utils( ndev, :cu )
+
+binding.pry
+
+ndev.close

data/examples/simple.rb

@@ -0,0 +1,46 @@
+require 'pry'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+# login information for NETCONF session 
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+## Now bind providers to the device object.
+## the 'Junos::Ez::Provider' must be first before all others
+## this provider will setup the device 'facts'.  The other providers
+## allow you to define the instance variables; so this example
+## is using 'l1_ports' and 'ip_ports', but you could name them
+## what you like, yo!
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::L1ports::Provider( ndev, :l1_ports )
+Junos::Ez::IPports::Provider( ndev, :ip_ports )
+
+## drop into interactive mode to play around ... let's look
+## at what the device has for facts ...
+
+#->  ndev.facts.list
+#->  ndev.facts.catalog
+#->  ndev.fact :version
+
+## now look at specific providers like the physical (l1) ports ...
+
+#-> ndev.l1_ports.list
+#-> ndev.l1_ports.catalog
+
+binding.pry
+
+ndev.close

data/examples/st_hosts.rb

@@ -0,0 +1,33 @@
+require 'pry'
+require 'pp'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+# login information for NETCONF session 
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+## Now bind providers to the device object.
+## the 'Junos::Ez::Provider' must be first before all others
+## this provider will setup the device 'facts'.  The other providers
+## allow you to define the instance variables; so this example
+## is using 'l1_ports' and 'ip_ports', but you could name them
+## what you like, yo!
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::StaticHosts::Provider( ndev, :hosts )
+
+pp ndev.hosts.list
+pp ndev.hosts.catalog
+
+binding.pry
+
+ndev.close

data/examples/user.rb

@@ -0,0 +1,32 @@
+require 'pry'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+require 'junos-ez/srx'
+
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+# login information for NETCONF session 
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Users::Provider( ndev, :users )
+Junos::Ez::UserAuths::Provider( ndev, :sshkeys )
+Junos::Ez::Config::Utils( ndev, :cu )
+
+user = ndev.users["jeremy"]
+user.load_ssh_key! :filename=>'/home/jschulman/.ssh/keys/key1.pub'
+
+binding.pry
+
+ndev.close

data/examples/vlans.rb

@@ -0,0 +1,31 @@
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+# login information for NETCONF session 
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cu )
+Junos::Ez::Vlans::Provider( ndev, :vlans )
+#Junos::Ez::L1ports::Provider( ndev, :l1_ports )
+Junos::Ez::L2ports::Provider( ndev, :l2_ports )
+#Junos::Ez::IPports::Provider( ndev, :ip_ports )
+
+#pp ndev.vlans.list
+#pp ndev.vlans.catalog
+
+binding.pry
+
+ndev.close

data/junos-ez-stdlib.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift 'lib'
+require 'rake'
+require 'junos-ez/version'
+
+Gem::Specification.new do |s|
+  s.name = 'shopify-junos-ez-stdlib'
+  s.version = Junos::Ez::VERSION
+  s.summary = "Junos EZ Framework - Standard Libraries"
+  s.description = "Automation Framework for Junos/NETCONF:  Facts, Providers, and Utils"
+  s.homepage = 'https://github.com/Juniper/ruby-junos-ez-stdlib'
+  s.authors = ["Jeremy Schulman", "John Deatherage", "Nitin Kumar", "Priyal Jain", "Ganesh Nalawade"]
+  s.email = 'jnpr-community-netdev@juniper.net'
+  s.files = FileList[ '*', 'lib/**/*.rb', 'examples/**/*.rb', 'docs/**/*.md' ]
+  s.add_dependency('netconf', ">= 0.2.5")
+end

data/lib/junos-ez/exceptions.rb

@@ -0,0 +1,3 @@
+module Junos::Ez
+  class NoProviderError < StandardError; end
+end

data/lib/junos-ez/facts.rb

@@ -0,0 +1,83 @@
+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
+### -----------------------------------------------------------------
+
+require 'junos-ez/facts/chassis'
+require 'junos-ez/facts/personality'
+require 'junos-ez/facts/version'
+require 'junos-ez/facts/switch_style'
+require 'junos-ez/facts/ifd_style'
+

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

@@ -0,0 +1,51 @@
+Junos::Ez::Facts::Keeper.define( :chassis ) do |ndev, facts|
+  
+  inv_info = ndev.rpc.get_chassis_inventory
+  errs = inv_info.xpath('//output')[0]
+
+  if errs and errs.text.include? "This command can only be used on the master routing engine"
+     raise Junos::Ez::NoProviderError, "Chef can only be used on master routing engine !!"
+  end
+
+  chassis = inv_info.xpath('chassis')
+  
+  facts[:hardwaremodel] = chassis.xpath('description').text
+  facts[:serialnumber] = chassis.xpath('serial-number').text           
+  
+  cfg = ndev.rpc.get_configuration{|xml|
+    xml.system {
+      xml.send(:'host-name')
+      xml.send(:'domain-name')
+    }
+  }
+  
+  facts[:hostname] = cfg.xpath('//host-name').text
+  facts[:domain] = cfg.xpath('//domain-name').text
+  facts[:fqdn] = facts[:hostname]
+  facts[:fqdn] += ".#{facts[:domain]}" unless facts[:domain].empty?
+  
+end
+
+Junos::Ez::Facts::Keeper.define( :master ) do |ndev, facts|
+  uses :routingengines
+end
+
+Junos::Ez::Facts::Keeper.define( :routingengines ) do |ndev, facts|
+
+  re_facts = ['mastership-state','status','model','up-time','last-reboot-reason']
+  re_info = ndev.rpc.get_route_engine_information
+  re_info.xpath('//route-engine').each do |re|
+    slot_id = re.xpath('slot').text || "0"
+    slot = ("RE" + slot_id).to_sym
+    facts[slot] = Hash[ re_facts.collect{ |ele| [ ele.tr('-','_').to_sym, re.xpath(ele).text ] } ]
+    if facts[slot][:mastership_state].empty?
+      facts[slot].delete :mastership_state
+    else 
+      facts[:master] = slot_id if facts[slot][:mastership_state] == 'master'
+    end
+  end
+  
+end
+
+        
+

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

@@ -0,0 +1,17 @@
+Junos::Ez::Facts::Keeper.define( :ifd_style ) do  |ndev, facts|
+  persona,sw_style = uses :personality,:switch_style
+  
+  facts[:ifd_style] = case persona
+  when :SWITCH
+    if sw_style == :VLAN_L2NG
+      :CLASSIC
+    else
+      :SWITCH
+    end
+  else
+    :CLASSIC
+  end      
+  
+end
+
+

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

@@ -0,0 +1,25 @@
+Junos::Ez::Facts::Keeper.define( :personality ) do |ndev, facts|
+  
+  uses :chassis, :routingengines  
+  model = facts[:hardwaremodel]
+
+  examine = ( model != "Virtual Chassis" ) ? model : facts.select {|k,v| k.match(/^RE[0..9]+/) }.values[0][:model]
+      
+  facts[:personality] = case examine   
+  when /^(EX)|(QFX)|(OCX)/i
+    :SWITCH
+  when /^MX/i
+    :MX
+  when /^vMX/i
+    facts[:virtual] = true
+    :MX
+  when /SRX(\d){3}/i
+    :SRX_BRANCH
+  when /junosv-firefly/i
+    facts[:virtual] = true
+    :SRX_BRANCH
+  when /SRX(\d){4}/i
+    :SRX_HIGHEND
+  end
+  
+end

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

@@ -0,0 +1,31 @@
+Junos::Ez::Facts::Keeper.define( :switch_style ) do |ndev, facts|
+  f_persona = uses :personality
+  
+  model = facts[:hardwaremodel]
+  examine = ( model != "Virtual Chassis" ) ? model : facts.select {|k,v| k.match(/^RE[0-9]+/) }.values[0][:model]   
+    
+  facts[:switch_style] = case f_persona
+  when :SWITCH, :SRX_BRANCH
+    case examine
+    when /junosv-firefly/i
+      :NONE
+    when /^(ex9)|(ex43)|(ocx)/i
+      :VLAN_L2NG
+    when /^(qfx)/i
+      if facts[:version][0..3].to_f >= 13.2
+        :VLAN_L2NG
+      else
+        :VLAN
+      end
+    else
+      :VLAN
+    end        
+  when :MX, :SRX_HIGHEND
+    :BRIDGE_DOMAIN
+  else
+    :NONE
+  end
+
+end
+    
+

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

@@ -0,0 +1,58 @@
+Junos::Ez::Facts::Keeper.define( :version ) do |ndev, facts|
+  
+  f_master, f_persona = uses :master, :personality
+      
+  case f_persona
+  when :MX
+    begin
+      swver = ndev.rpc.command "show version invoke-on all-routing-engines"
+    rescue Netconf::RpcError
+      swver = ndev.rpc.command "show version"
+    end
+  when :SWITCH
+    ## most EX switches support the virtual-chassis feature, so the 'all-members' option would be valid
+    ## in some products, this options is not valid (i.e. not vc-capable.  so we're going to try for vc, and if that
+    ## throws an exception we'll rever to non-VC
+    
+    begin
+      swver = ndev.rpc.command "show version all-members"
+    rescue Netconf::RpcError
+      facts[:vc_capable] = false
+      swver = ndev.rpc.command "show version"
+    else
+      facts[:vc_capable] = true
+    end
+  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
+      ver_key = ('version_' + re_name).to_sym
+      
+      if re_sw.at_xpath('//junos-version')
+        facts[ver_key] = re_sw.xpath('//junos-version').text
+      else
+        re_sw.xpath('package-information[1]/comment').text =~ /\[(.*)\]/
+        facts[ver_key] = $1
+      end	
+    end
+    master_id = f_master
+    unless master_id.nil?
+      facts[:version] = 
+        facts[("version_" + "RE" + master_id).to_sym] || 
+        facts[('version_' + "FPC" + master_id).to_sym]
+    end
+  else
+    if swver.at_xpath('//junos-version')
+      facts[:version] = swver.xpath('//junos-version').text
+    else
+      junos = swver.xpath('//package-information[name = "junos"]/comment').text
+      junos =~ /\[(.*)\]/
+      facts[:version] = $1
+    end  
+  end    
+  
+end