cisco_node_utils 0.9.0

data/lib/cisco_node_utils/platform.rb

@@ -0,0 +1,184 @@
+# Platform provider class
+#
+# Alex Hunsberger, Mar 2015
+#
+# Copyright (c) 2015 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(File.dirname(__FILE__), 'node')
+
+class Platform
+  @@node = Cisco::Node.instance
+
+  # ex: 'n3500-uk9.6.0.2.A3.0.40.bin'
+  def Platform.system_image
+    @@node.config_get("show_version", "boot_image")
+  end
+
+  # returns package hash with state values
+  # ex: { 'n3000-uk9.6.0.2.U1.1.CSCaa12345.bin' => 'inactive committed',
+  #       'n3000-uk9.6.0.2.U1.1.CSCaa12346.bin' => 'active', }
+  def Platform.packages
+    pkgs = @@node.config_get("images", "packages")
+    return {} if pkgs.nil?
+    pkg_hsh = {}
+    pkgs.each { |p|
+      pkg_hsh[p[0]] = p[1].downcase
+    }
+    pkg_hsh
+  end
+
+  # ex: 'Cisco Nexus3064 Chassis ("48x10GE + 16x10G/4x40G Supervisor")'
+  def Platform.hardware_type
+    @@node.config_get("show_version", "description")
+  end
+
+  # ex: 'Intel(R) Celeron(R) CPU P450'
+  def Platform.cpu
+    @@node.config_get("show_version", "cpu")
+  end
+
+  # return hash with keys "total", "used", "free"
+  # ex: { 'total' => '16402252K',
+  #       'used'  => '5909004K',
+  #       'free'  => '10493248K' }
+  def Platform.memory
+    total = @@node.config_get("memory", "total")
+    used = @@node.config_get("memory", "used")
+    free = @@node.config_get("memory", "free")
+
+    raise "failed to retrieve platform memory information" if
+      total.nil? or used.nil? or free.nil?
+
+    { 'total' => total.first,
+      'used'  => used.first,
+      'free'  => free.first, }
+  end
+
+  # ex: 'Processor Board ID FOC15430TEY'
+  def Platform.board
+    @@node.config_get("show_version", "board")
+  end
+
+  # ex: '1 day(s), 21 hour(s), 46 minute(s), 54 second(s)'
+  def Platform.uptime
+    u = @@node.config_get("show_version", "uptime")
+    raise "failed to retrieve platform uptime" if u.nil?
+    u.first
+  end
+
+  # ex: '23113 usecs after  Mon Jul  1 15:24:29 2013'
+  def Platform.last_reset
+    r = @@node.config_get("show_version", "last_reset_time")
+    r.nil? ? nil : r.strip
+  end
+
+  # ex: 'Reset Requested by CLI command reload'
+  def Platform.reset_reason
+    @@node.config_get("show_version", "last_reset_reason")
+  end
+
+  # returns chassis hash with keys "descr", "pid", "vid", "sn"
+  # ex: { 'descr' => 'Nexus9000 C9396PX Chassis',
+  #       'pid'   => 'N9K-C9396PX',
+  #       'vid'   => 'V02',
+  #       'sn'    => 'SAL1812NTBP' }
+  def Platform.chassis
+    chas = @@node.config_get("inventory", "chassis")
+    return nil if chas.nil?
+    { 'descr' => chas['desc'].tr('"', ''),
+      'pid'   => chas['productid'],
+      'vid'   => chas['vendorid'],
+      'sn'    => chas['serialnum'], }
+  end
+
+  # returns hash of hashes with inner keys "name", "descr", "pid", "vid", "sn"
+  # ex: { 'Slot 1' => { 'descr' => '1/10G SFP+ Ethernet Module',
+  #                     'pid'   => 'N9K-C9396PX',
+  #                     'vid'   => 'V02',
+  #                     'sn'    => 'SAL1812NTBP' },
+  #       'Slot 2' => { ... }}
+  def Platform.inventory_of(type)
+    @@node.cache_flush # TODO: investigate why this is needed
+    inv = @@node.config_get("inventory", "all")
+    return {} if inv.nil?
+    inv.select! { |x| x['name'].include? type }
+    return {} if inv.empty?
+    # match desired output format
+    inv_hsh = {}
+    inv.each { |s|
+      inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
+                                         'pid'   => s['productid'],
+                                         'vid'   => s['vendorid'],
+                                         'sn'    => s['serialnum'] }
+    }
+    inv_hsh
+  end
+
+  # returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+  def Platform.slots
+    Platform.inventory_of('Slot')
+  end
+
+  # returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+  def Platform.power_supplies
+    Platform.inventory_of('Power Supply')
+  end
+
+  # returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+  def Platform.fans
+    Platform.inventory_of('Fan')
+  end
+
+  # returns hash of hashes with inner keys "state", "application", ...
+  # ex: { 'chef' => {
+  #        'package_info' => { 'name'     => 'n3k_chanm_chef.ova',
+  #                            'path'     => 'bootflash:/n3k_chanm_chef.ova' },
+  #        'application'  => { 'name'     => 'ChefAgent',
+  #                            'version'  => '0.1',
+  #                            'descr'    => 'Cisco Chef Agent' },
+  #        'signing'      => { 'key_type' => 'Cisco development key',
+  #                            'method'   => 'SHA-1' }
+  #        'licensing'    => { 'name'     => 'none',
+  #                            'version'  => 'none' }
+  #        'reservation'  => { 'disk'     => '111 MB',
+  #                            'memory'   => '0 MB',
+  #                            'cpu'      => '0% system CPU' }},
+  #      { ... }}
+  def Platform.virtual_services
+    virts = @@node.config_get("virtual_service", "services")
+    return [] if virts.nil?
+    # NXAPI returns hash instead of array if there's only 1
+    virts = [virts] if virts.is_a? Hash
+    # convert to expected format
+    virts_hsh = {}
+    virts.each { |serv|
+      virts_hsh[serv['name']] = {
+        'package_info' => { 'name'     => serv['package_name'],
+                            'path'     => serv['ova_path'], },
+        'application'  => { 'name'     => serv['application_name'],
+                            'version'  => serv['application_version'],
+                            'descr'    => serv['application_description'], },
+        'signing'      => { 'key_type' => serv['key_type'],
+                            'method'   => serv['signing_method'], },
+        'licensing'    => { 'name'     => serv['licensing_name'],
+                            'version'  => serv['licensing_version'], },
+        'reservation'  => { 'disk'     => serv['disk_reservation'],
+                            'memory'   => serv['memory_reservation'],
+                            'cpu'      => serv['cpu_reservation'], },
+      }
+    }
+    virts_hsh
+  end
+end

data/lib/cisco_node_utils/platform_info.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2013-2015 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'yaml'
+
+# Class: PlatformInfo
+# This class reads device specific details from the yaml file - platform_info.yaml
+# These details can be used to customize unit tests for a device
+class PlatformInfo
+  # Default constructor for the PlatformInfo class. This class
+  # requires the hostname of the device on which UTs are to run
+  # to be passed in. The constructor reads platform_info.yaml
+  # and stores info for this device in the instance variable
+  # @platform_info_hash
+  #
+  # @param[in] device_name      hostname of device on which
+  #                             UTs are to be run
+  #
+  def initialize(device_name)
+    raise "device name must be specified in PlatformInfo constructor." if device_name.nil? or device_name.empty?
+    @platform_info_hash = {}
+
+    begin
+      project_info_hash = YAML.load_file(File.join(File.dirname(__FILE__), "platform_info.yaml"))
+    rescue Exception => e
+      raise "Error - could not open platform file - platform_info.yaml"
+    end
+
+    @platform_info_hash = project_info_hash[device_name]
+    raise "Error - could not find #{device_name} device specific information in platform_info.yaml" if @platform_info_hash.nil?
+  end
+
+  # The following instance method will return the value associated with
+  # the specified key from the instance variable @platform_info_hash.
+  #
+  # @param[in] key  String value indicating the key to be searched for
+  #                 in @platform_info_hash
+  #
+  def get_value_from_key(key)
+    raise "key must be specified in the method get_value_from_key" if key.nil?
+
+    value = @platform_info_hash[key]
+    raise "no value exists for the key #{key}" if value.nil?
+
+    value
+  end
+end

data/lib/cisco_node_utils/platform_info.yaml

@@ -0,0 +1,10 @@
+---
+# This yaml file is read by ciscotest.rb to read
+# device specific information before running unit tests
+
+# Currently the only device specific info we support is
+# an array of ethernet interfaces. More device specific
+# attributes can be added in future.
+
+example_node:
+  interfaces: [Ethernet1/1, Ethernet1/10, Ethernet1/20]

data/lib/cisco_node_utils/router_ospf.rb

@@ -0,0 +1,96 @@
+#
+# NXAPI implementation of RouterOspf class
+#
+# November 2014, Chris Van Heuveln
+#
+# Copyright (c) 2014-2015 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(File.dirname(__FILE__), 'node')
+
+module Cisco
+class RouterOspf
+  attr_reader :name
+
+  @@node = Cisco::Node.instance
+
+  def initialize(name, instantiate=true)
+    raise ArgumentError unless name.length > 0
+    @name = name
+
+    create if instantiate
+  end
+
+  # Create a hash of all router ospf instances
+  def RouterOspf.routers
+    ospf_ids = @@node.config_get("ospf", "router")
+    return {} if ospf_ids.nil?
+
+    hash = {}
+    ospf_ids.each do |name|
+      hash[name] = RouterOspf.new(name, false)
+    end
+    return hash
+  rescue Cisco::CliError => e
+    # cmd will syntax reject when feature is not enabled
+    raise unless e.clierror =~ /Syntax error/
+    return {}
+  end
+
+  def RouterOspf.enabled
+    feat =  @@node.config_get("ospf", "feature")
+    return (!feat.nil? and !feat.empty?)
+  rescue Cisco::CliError => e
+    # cmd will syntax reject when feature is not enabled
+    raise unless e.clierror =~ /Syntax error/
+    return false
+  end
+
+  def RouterOspf.enable(state="")
+    @@node.config_set("ospf", "feature", state)
+  end
+
+  def ospf_router(name, state="")
+    @@node.config_set("ospf", "router", state, name)
+  end
+
+  def enable_create_router_ospf(name)
+    RouterOspf.enable
+    ospf_router(name)
+  end
+
+  # Create one router ospf instance
+  def create
+    if RouterOspf.enabled
+      ospf_router(name)
+    else
+      enable_create_router_ospf(name)
+    end
+  end
+
+  # Destroy one router ospf instance
+  def destroy
+    ospf_ids = @@node.config_get("ospf", "router")
+    return if ospf_ids.nil?
+    if ospf_ids.size == 1
+      RouterOspf.enable("no")
+    else
+      ospf_router(name, "no")
+    end
+  rescue Cisco::CliError => e
+    # cmd will syntax reject when feature is not enabled
+    raise unless e.clierror =~ /Syntax error/
+  end
+end
+end

data/lib/cisco_node_utils/router_ospf_vrf.rb

@@ -0,0 +1,258 @@
+#
+# NXAPI implementation of RouterOspfVrf class
+#
+# Mike Wiebe, March 2015
+#
+# Copyright (c) 2015 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(File.dirname(__FILE__), 'node')
+require File.join(File.dirname(__FILE__), 'router_ospf')
+
+module Cisco
+class RouterOspfVrf
+  attr_reader :name, :parent
+
+  OSPF_AUTO_COST = {
+    :mbps => "Mbps",
+    :gbps => "Gbps",
+  }
+
+  OSPF_LOG_ADJACENCY = {
+    :none   => "none",
+    :log    => "",
+    :detail => "detail",
+  }
+
+  @@node = Cisco::Node.instance
+
+  def initialize(router, name, instantiate=true)
+    raise TypeError if router.nil?
+    raise TypeError if name.nil?
+    raise ArgumentError unless router.length > 0
+    raise ArgumentError unless name.length > 0
+    @router = router
+    @name = name
+    @parent = {}
+    @get_args = @set_args = (@name == "default") ?
+      { :name => @router } : { :name => @router, :vrf => @name }
+
+    create if instantiate
+  end
+
+  # Create a hash of all router ospf vrf instances
+  def RouterOspfVrf.vrfs
+    hash_final = {}
+    RouterOspf.routers.each do |instance|
+      name = instance[0]
+      vrf_ids = @@node.config_get("ospf", "vrf", { :name => name })
+      hash_tmp = { name =>
+        { 'default' => RouterOspfVrf.new(name, 'default', false) } }
+      unless vrf_ids.nil?
+        vrf_ids.each do |vrf|
+          hash_tmp[name][vrf] = RouterOspfVrf.new(name, vrf, false)
+        end
+      end
+      hash_final.merge!(hash_tmp)
+    end
+    hash_final
+  end
+
+  # Create one router ospf vrf instance
+  def create
+    @parent = RouterOspf.new(@router)
+    @@node.config_set("ospf", "vrf", { :name  => @router,
+                                       :state => "",
+                                       :vrf   => @name }) if
+                                      @name != "default"
+  end
+
+  # Destroy one router ospf vrf instance
+  def destroy
+    raise RuntimeError if @name == "default"
+    @@node.config_set("ospf", "vrf", { :name  => @router,
+                                       :state => "no",
+                                       :vrf   => @name })
+  end
+
+  # Helper method to delete @set_args hash keys
+  def set_args_keys_delete(list)
+    list.each { |key| @set_args.delete(key) }
+  end
+
+  def auto_cost
+    match = @@node.config_get("ospf", "auto_cost", @get_args)
+    return default_auto_cost if match.nil?
+    # Multiple matches are possible but the first match is used.
+    # This can be removed when rally defect DE3614 is resolved.
+    match[0].last.nil? ?
+      [match[0].first.to_i, OSPF_AUTO_COST[:mbps]] :
+      [match[0].first.to_i, match[0].last]
+  end
+
+  def auto_cost_set(cost, type)
+    @set_args[:cost], @set_args[:type] = cost, OSPF_AUTO_COST[type]
+    @@node.config_set("ospf", "auto_cost", @set_args)
+    set_args_keys_delete([:cost, :type])
+  end
+
+  def default_auto_cost
+    @@node.config_get_default("ospf", "auto_cost")
+  end
+
+  def default_metric
+    match = @@node.config_get("ospf", "default_metric", @get_args)
+    match.nil? ? default_default_metric : match.first.to_i
+  end
+
+  def default_metric=(metric)
+    if metric == default_default_metric
+      @set_args[:state], @set_args[:metric] = "no", ""
+    else
+      @set_args[:state], @set_args[:metric] = "", metric
+    end
+    @@node.config_set("ospf", "default_metric", @set_args)
+    set_args_keys_delete([:state, :metric])
+  end
+
+  def default_default_metric
+    @@node.config_get_default("ospf", "default_metric")
+  end
+
+  def log_adjacency
+    match = @@node.config_get("ospf", "log_adjacency", @get_args)
+    return default_log_adjacency if match.nil?
+    # Multiple matches are possible but the first match is used.
+    # This can be removed when rally defect DE3614 is resolved.
+    match[0].flatten.last.nil? ? :log : :detail
+  end
+
+  def log_adjacency=(type)
+    case type
+    when :none
+        @set_args[:state], @set_args[:type] = "no", ""
+    when :log, :detail
+        @set_args[:state], @set_args[:type] = "", OSPF_LOG_ADJACENCY[type]
+    end
+    @@node.config_set("ospf", "log_adjacency", @set_args)
+    set_args_keys_delete([:state, :type])
+  end
+
+  def default_log_adjacency
+    @@node.config_get_default("ospf", "log_adjacency")
+  end
+
+  def router_id
+    match = @@node.config_get("ospf", "router_id", @get_args)
+    match.nil? ? default_router_id : match.first
+  end
+
+  def router_id=(router_id)
+    router_id == default_router_id ?
+      (@set_args[:state], @set_args[:router_id] = "no", "") :
+      (@set_args[:state], @set_args[:router_id] = "", router_id)
+
+    @@node.config_set("ospf", "router_id", @set_args)
+    set_args_keys_delete([:state, :router_id])
+  end
+
+  def default_router_id
+    @@node.config_get_default("ospf", "router_id")
+  end
+
+  def timer_throttle_lsa
+    match = @@node.config_get("ospf", "timer_throttle_lsa", @get_args)
+    (match.nil? or match.first.nil?) ? default_timer_throttle_lsa :
+      match.first.collect(&:to_i)
+  end
+
+  def timer_throttle_lsa_start
+    start, hold, max = timer_throttle_lsa
+    return default_timer_throttle_lsa_start if start.nil?
+    start
+  end
+
+  def timer_throttle_lsa_hold
+    start, hold, max = timer_throttle_lsa
+    return default_timer_throttle_lsa_hold if hold.nil?
+    hold
+  end
+
+  def timer_throttle_lsa_max
+    start, hold, max = timer_throttle_lsa
+    return default_timer_throttle_lsa_max if max.nil?
+    max
+  end
+
+  def timer_throttle_lsa_set(start, hold, max)
+    @set_args[:start], @set_args[:hold], @set_args[:max] = start, hold, max
+    @@node.config_set("ospf", "timer_throttle_lsa", @set_args)
+    set_args_keys_delete([:start, :hold, :max])
+  end
+
+  def default_timer_throttle_lsa_start
+    @@node.config_get_default("ospf", "timer_throttle_lsa_start")
+  end
+
+  def default_timer_throttle_lsa_hold
+    @@node.config_get_default("ospf", "timer_throttle_lsa_hold")
+  end
+
+  def default_timer_throttle_lsa_max
+    @@node.config_get_default("ospf", "timer_throttle_lsa_max")
+  end
+
+  def timer_throttle_spf
+    match = @@node.config_get("ospf", "timer_throttle_spf", @get_args)
+    (match.nil? or match.first.nil?) ? default_timer_throttle_spf :
+      match.first.collect(&:to_i)
+  end
+
+  def timer_throttle_spf_start
+    start, hold, max = timer_throttle_spf
+    return default_timer_throttle_spf_start if start.nil?
+    start
+  end
+
+  def timer_throttle_spf_hold
+    start, hold, max = timer_throttle_spf
+    return default_timer_throttle_spf_hold if hold.nil?
+    hold
+  end
+
+  def timer_throttle_spf_max
+    start, hold, max = timer_throttle_spf
+    return default_timer_throttle_spf_max if max.nil?
+    max
+  end
+
+  def timer_throttle_spf_set(start, hold, max)
+    @set_args[:start], @set_args[:hold], @set_args[:max] = start, hold, max
+    @@node.config_set("ospf", "timer_throttle_spf", @set_args)
+    set_args_keys_delete([:start, :hold, :max])
+  end
+
+  def default_timer_throttle_spf_start
+    @@node.config_get_default("ospf", "timer_throttle_spf_start")
+  end
+
+  def default_timer_throttle_spf_hold
+    @@node.config_get_default("ospf", "timer_throttle_spf_hold")
+  end
+
+  def default_timer_throttle_spf_max
+    @@node.config_get_default("ospf", "timer_throttle_spf_max")
+  end
+end
+end