cisco_node_utils 1.0.1 → 1.1.0

data/docs/README-maintainers.md

@@ -30,17 +30,47 @@ Either run `git flow init` from the repository root directory, or manually edit
 
 Most of these are default for git-flow except for the `versiontag` setting.
 
+## Release Checklist
+
+When we are considering publishing a new release, all of the following steps must be carried out (using the latest code base in `develop`):
+
+1. Review cisco_node_utils.gemspec
+  * Is the data still relevant?
+  * Do the version dependencies need to be updated? (e.g. rubocop)
+
+2. Run full minitest suite with various Ruby versions and hardware platforms:
+  * Ruby versions:
+    - REQUIRED: the Ruby version(s) bundled with Chef and Puppet (currently 2.1.6)
+    - OPTIONAL: any/all other Ruby major versions currently supported by this gem (2.0, 2.2.2)
+  * Platforms (all with latest released software or release candidate)
+    - N30xx
+    - N31xx
+    - N9xxx
+
+3. Triage any minitest failures.
+
+4. Check code coverage results from minitest to see if there are any critical gaps in coverage.
+
+5. Build gem and test it in combination with the latest released Puppet module (using Beaker and demo manifests) to make sure no backward compatibility issues have been introduced.
+
+6. Make sure CHANGELOG.md accurately reflects all changes since the last release.
+  * Add any significant changes that weren't documented in the changelog
+  * Clean up any entries that are overly verbose, unclear, or otherwise could be improved.
+
 ## Release Process
 
-When we agree as a team that a new release should be published, the process is as follows:
+When the release checklist above has been fully completed, the process for publishing a new release is as follows:
 
-1. Create a release branch. Follow [semantic versioning](http://semver.org) - a bugfix release is a 0.0.x version bump, a new feature is a 0.x.0 bump, and a backward-incompatible change is a new x.0.0 version. 
+1. Create a release branch. Follow [semantic versioning](http://semver.org):
+    * 0.0.x - a bugfix release
+    * 0.x.0 - new feature(s)
+    * x.0.0 - backward-incompatible change (if unvoidable!)
 
     ```
     git flow release start 1.0.1
     ```
 
-2. In the newly created release branch, update `CHANGELOG.md`:
+2. In the newly created release branch, update `CHANGELOG.md` (this *should* be automatic if you have installed the Git hooks for this repository):
 
     ```diff
      Changelog

data/docs/template-router.rb

@@ -1,6 +1,3 @@
-#
-# NXAPI implementation of X__CLASS_NAME__X class
-#
 # Copyright (c) 2014-2015 Cisco and/or its affiliates.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,111 +12,112 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.join(File.dirname(__FILE__), 'node')
+require_relative 'node_util'
 
 module Cisco
-class X__CLASS_NAME__X
-  attr_reader :name
-
-  # Establish connection to node
-  @@node = Cisco::Node.instance
-
-  # name: name of the router instance
-  # instantiate: true = create router instance
-  def initialize(name, instantiate=true)
-    raise ArgumentError unless name.length > 0
-    @name = name
-    create if instantiate
-  end
+  # X__CLASS_NAME__X - node utility class for X__CLASS_NAME__X config mgmt.
+  class X__CLASS_NAME__X < NodeUtil
+    attr_reader :name
+
+    # name: name of the router instance
+    # instantiate: true = create router instance
+    def initialize(name, instantiate=true)
+      fail ArgumentError unless name.length > 0
+      @name = name
+      create if instantiate
+    end
 
-  # Create a hash of all current router instances.
-  def X__CLASS_NAME__X.routers
-    instances = @@node.config_get('X__RESOURCE_NAME__X', 'router')
-    return {} if instances.nil?
-    hash = {}
-    instances.each do |name|
-      hash[name] = X__CLASS_NAME__X.new(name, false)
+    # Create a hash of all current router instances.
+    def self.routers
+      instances = config_get('X__RESOURCE_NAME__X', 'router')
+      return {} if instances.nil?
+      hash = {}
+      instances.each do |name|
+        hash[name] = X__CLASS_NAME__X.new(name, false)
+      end
+      return hash
+    rescue Cisco::CliError => e
+      # CLI will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
     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 feature_enabled
-    feat =  @@node.config_get('X__RESOURCE_NAME__X', 'feature')
-    return (!feat.nil? and !feat.empty?)
-  rescue Cisco::CliError => e
-    # This cmd will syntax reject if feature is not
-    # enabled. Just catch the reject and return false.
-    return false if e.clierror =~ /Syntax error/
-    raise
-  end
+    def feature_enabled
+      feat = config_get('X__RESOURCE_NAME__X', 'feature')
+      return !(feat.nil? || feat.empty?)
+    rescue Cisco::CliError => e
+      # This cmd will syntax reject if feature is not
+      # enabled. Just catch the reject and return false.
+      return false if e.clierror =~ /Syntax error/
+      raise
+    end
 
-  def feature_enable
-    @@node.config_set('X__RESOURCE_NAME__X', 'feature', { :state => '' })
-  end
+    def feature_enable
+      config_set('X__RESOURCE_NAME__X', 'feature', state: '')
+    end
 
-  def feature_disable
-    @@node.config_set('X__RESOURCE_NAME__X', 'feature', { :state => 'no' })
-  end
+    def feature_disable
+      config_set('X__RESOURCE_NAME__X', 'feature', state: 'no')
+    end
 
-  # Enable feature and create router instance
-  def create
-    feature_enable unless feature_enabled
-    X__RESOURCE_NAME__X_router
-  end
+    # Enable feature and create router instance
+    def create
+      feature_enable unless feature_enabled
+      X__RESOURCE_NAME__X_router
+    end
 
-  # Destroy a router instance; disable feature on last instance
-  def destroy
-    ids = @@node.config_get('X__RESOURCE_NAME__X', 'router')
-    return if ids.nil?
-    if ids.size == 1
-      feature_disable
-    else
-      X__RESOURCE_NAME__X_router('no')
+    # Destroy a router instance; disable feature on last instance
+    def destroy
+      ids = config_get('X__RESOURCE_NAME__X', 'router')
+      return if ids.nil?
+      if ids.size == 1
+        feature_disable
+      else
+        X__RESOURCE_NAME__X_router('no')
+      end
+    rescue Cisco::CliError => e
+      # CLI will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
     end
-  rescue Cisco::CliError => e
-    # cmd will syntax reject when feature is not enabled
-    raise unless e.clierror =~ /Syntax error/
-  end
 
-  def X__RESOURCE_NAME__X_router(state='')
-    @@node.config_set('X__RESOURCE_NAME__X', 'router', { :name => @name, :state => state })
-  end
+    def X__RESOURCE_NAME__X_router(state='')
+      config_set('X__RESOURCE_NAME__X', 'router', name: @name, state: state)
+    end
 
-  # ----------
-  # PROPERTIES
-  # ----------
+    # ----------
+    # PROPERTIES
+    # ----------
 
-  # Property methods for boolean property
-  def default_X__PROPERTY_BOOL__X
-    @@node.config_get_default('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X')
-  end
+    # Property methods for boolean property
+    def default_X__PROPERTY_BOOL__X
+      config_get_default('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X')
+    end
 
-  def X__PROPERTY_BOOL__X
-    state = @@node.config_get('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X', { :name => @name })
-    state ? true : false
-  end
+    def X__PROPERTY_BOOL__X
+      state = config_get('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X',
+                         name: @name)
+      state ? true : false
+    end
 
-  def X__PROPERTY_BOOL__X=(state)
-    state = (state ? '' : 'no')
-    @@node.config_set('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X', { :name => @name, :state => state })
-  end
+    def X__PROPERTY_BOOL__X=(state)
+      state = (state ? '' : 'no')
+      config_set('X__RESOURCE_NAME__X', 'X__PROPERTY_BOOL__X',
+                 name: @name, state: state)
+    end
 
-  # Property methods for integer property
-  def default_X__PROPERTY_INT__X
-    @@node.config_get_default('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X')
-  end
+    # Property methods for integer property
+    def default_X__PROPERTY_INT__X
+      config_get_default('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X')
+    end
 
-  def X__PROPERTY_INT__X
-    val = @@node.config_get('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X', { :name => @name })
-    val.nil? ? default_X__PROPERTY_INT__X : val.first.to_i
-  end
+    def X__PROPERTY_INT__X
+      val = config_get('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X', name: @name)
+      val.nil? ? default_X__PROPERTY_INT__X : val.first.to_i
+    end
 
-  def X__PROPERTY_INT__X=(val)
-    @@node.config_set('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X', { :name => @name, :val => val })
+    def X__PROPERTY_INT__X=(val)
+      config_set('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X',
+                 name: @name, val: val)
+    end
   end
 end
-end

data/docs/template-test_router.rb

@@ -1,6 +1,3 @@
-#
-# Minitest for __CLASS_NAME__ class
-#
 # Copyright (c) 2014-2015 Cisco and/or its affiliates.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,93 +12,93 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.expand_path("../ciscotest", __FILE__)
-require File.expand_path("../../lib/cisco_node_utils/router___RESOURCE_NAME__", __FILE__)
+require_relative 'ciscotest'
+require_relative '../lib/cisco_node_utils/router_X__RESOURCE_NAME__X'
 
-class Test__CLASS_NAME__ < CiscoTestCase
+# TestX__CLASS_NAME__X - Minitest for X__CLASS_NAME__X node utility class
+class TestX__CLASS_NAME__X < CiscoTestCase
   def setup
     # setup runs at the beginning of each test
     super
-    no_feature___RESOURCE_NAME__
+    no_feature_X__RESOURCE_NAME__X
   end
 
   def teardown
     # teardown runs at the end of each test
-    no_feature___RESOURCE_NAME__
+    no_feature_X__RESOURCE_NAME__X
     super
   end
 
-  def no_feature___RESOURCE_NAME__
+  def no_feature_X__RESOURCE_NAME__X
     # Turn the feature off for a clean test.
-    @device.cmd("conf t ; no feature __RESOURCE_NAME__ ; end")
-    # Flush the cache since we've modified the device outside of the node_utils APIs
-    node.cache_flush()
+    config('no feature X__RESOURCE_NAME__X')
   end
 
   # TESTS
 
   def test_router_create_destroy_one
-    id = "blue"
-    rtr = __CLASS_NAME__.new(id)
-    s = @device.cmd("show runn | i 'router __RESOURCE_NAME__ #{id}'")
-    assert_match(s, /^router __RESOURCE_NAME__ #{id}$/,
-                 "Error: failed to create router __RESOURCE_NAME__ #{id}")
+    id = 'blue'
+    rtr = X__CLASS_NAME__X.new(id)
+    @default_show_command = "show runn | i 'router X__RESOURCE_NAME__X #{id}'"
+    assert_show_match(pattern: /^router X__RESOURCE_NAME__X #{id}$/,
+                      msg:     "failed to create router X__RESOURCE_NAME__X #{id}")
 
     rtr.destroy
-    s = @device.cmd("show runn | i 'router __RESOURCE_NAME__ #{id}'")
-    refute_match(s, /^router __RESOURCE_NAME__ #{id}$/,
-                 "Error: failed to destroy router __RESOURCE_NAME__ #{id}")
+    refute_show_match(pattern: /^router X__RESOURCE_NAME__X #{id}$/,
+                      msg:     "failed to destroy router X__RESOURCE_NAME__X #{id}")
 
-    s = @device.cmd("show runn | i 'feature __RESOURCE_NAME__'")
-    refute_match(s, /^feature __RESOURCE_NAME__$/,
-                 "Error: failed to disable feature __RESOURCE_NAME__")
+    refute_show_match(command: "show runn | i 'feature X__RESOURCE_NAME__X'",
+                      pattern: /^feature X__RESOURCE_NAME__X$/,
+                      msg:     'failed to disable feature X__RESOURCE_NAME__X')
   end
 
   def test_router_create_destroy_multiple
-    id1 = "blue"
-    rtr1 = __CLASS_NAME__.new(id1)
-    id2 = "red"
-    rtr2 = __CLASS_NAME__.new(id2)
+    id1 = 'blue'
+    rtr1 = X__CLASS_NAME__X.new(id1)
+    id2 = 'red'
+    rtr2 = X__CLASS_NAME__X.new(id2)
+
+    @default_show_command = "show runn | i 'router X__RESOURCE_NAME__X'"
+
+    assert_show_match(pattern: /^router X__RESOURCE_NAME__X #{id1}$/,
+                      msg:     "failed to create router X__RESOURCE_NAME__X #{id1}")
 
-    s = @device.cmd("show runn | i 'router __RESOURCE_NAME__'")
-    assert_match(s, /^router __RESOURCE_NAME__ #{id1}$/)
-    assert_match(s, /^router __RESOURCE_NAME__ #{id2}$/)
+    assert_show_match(pattern: /^router X__RESOURCE_NAME__X #{id2}$/,
+                      msg:     "failed to create router X__RESOURCE_NAME__X #{id2}")
 
     rtr1.destroy
-    s = @device.cmd("show runn | i 'router __RESOURCE_NAME__ #{id1}'")
-    refute_match(s, /^router __RESOURCE_NAME__ #{id1}$/,
-                 "Error: failed to destroy router __RESOURCE_NAME__ #{id1}")
+    refute_show_match(pattern: /^router X__RESOURCE_NAME__X #{id1}$/,
+                      msg:     "failed to destroy router X__RESOURCE_NAME__X #{id1}")
 
     rtr2.destroy
-    s = @device.cmd("show runn | i 'router __RESOURCE_NAME__ #{id2}'")
-    refute_match(s, /^router __RESOURCE_NAME__ #{id2}$/,
-                 "Error: failed to destroy router __RESOURCE_NAME__ #{id2}")
+    refute_show_match(pattern: /^router X__RESOURCE_NAME__X #{id2}$/,
+                      msg:     "failed to destroy router X__RESOURCE_NAME__X #{id2}")
 
-    s = @device.cmd("show runn | i 'feature __RESOURCE_NAME__'")
-    refute_match(s, /^feature __RESOURCE_NAME__$/,
-                 "Error: failed to disable feature __RESOURCE_NAME__")
+    refute_show_match(command: "show runn | i 'feature X__RESOURCE_NAME__X'",
+                      pattern: /^feature X__RESOURCE_NAME__X$/,
+                      msg:     'failed to disable feature X__RESOURCE_NAME__X')
   end
 
-  def test_router___PROPERTY_INT__
-    id = "blue"
-    rtr = __CLASS_NAME__.new(id)
-    val = 5   # This value depends on property bounds
-    rtr.__PROPERTY_INT__ = val
-    assert_equal(rtr.__PROPERTY_INT__, val, "__PROPERTY_INT__ is not #{val}")
+  def test_router_X__PROPERTY_INT__X
+    id = 'blue'
+    rtr = X__CLASS_NAME__X.new(id)
+    val = 5 # This value depends on property bounds
+    rtr.X__PROPERTY_INT__X = val
+    assert_equal(rtr.X__PROPERTY_INT__X, val, "X__PROPERTY_INT__X is not #{val}")
 
     # Get default value from yaml
-    val = node.config_get_default("__RESOURCE_NAME__", "__PROPERTY_INT__")
-    rtr.__PROPERTY_INT__ = val
-    assert_equal(rtr.__PROPERTY_INT__, val, "__PROPERTY_INT__ is not #{val}")
+    val = node.config_get_default('X__RESOURCE_NAME__X', 'X__PROPERTY_INT__X')
+    rtr.X__PROPERTY_INT__X = val
+    assert_equal(rtr.X__PROPERTY_INT__X, val, "X__PROPERTY_INT__X is not #{val}")
   end
 
-  def test_router___PROPERTY_BOOL__
-    id = "blue"
-    rtr = __CLASS_NAME__.new(id)
-    rtr.__PROPERTY_BOOL__ = true
-    assert(rtr.__PROPERTY_BOOL__, "__PROPERTY_BOOL__ state is not true")
+  def test_router_X__PROPERTY_BOOL__X
+    id = 'blue'
+    rtr = X__CLASS_NAME__X.new(id)
+    rtr.X__PROPERTY_BOOL__X = true
+    assert(rtr.X__PROPERTY_BOOL__X, 'X__PROPERTY_BOOL__X state is not true')
 
-    rtr.__PROPERTY_BOOL__ = false
-    refute(rtr.__PROPERTY_BOOL__, "__PROPERTY_BOOL__ state is not false")
+    rtr.X__PROPERTY_BOOL__X = false
+    refute(rtr.X__PROPERTY_BOOL__X, 'X__PROPERTY_BOOL__X state is not false')
   end
 end

data/lib/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: ../.rubocop.yml
+
+# Baseline code complexity metrics for the lib/ subdirectory:
+
+Metrics/AbcSize:
+  Max: 47
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+Metrics/MethodLength:
+  Max: 39
+
+Metrics/ParameterLists:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 19

data/lib/cisco_node_utils.rb

@@ -12,22 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "cisco_node_utils/cisco_cmn_utils"
-require "cisco_node_utils/command_reference"
-require "cisco_node_utils/configparser_lib"
-require "cisco_node_utils/interface"
-require "cisco_node_utils/interface_ospf"
-require "cisco_node_utils/node"
-require "cisco_node_utils/platform"
-require "cisco_node_utils/router_ospf"
-require "cisco_node_utils/router_ospf_vrf"
-require "cisco_node_utils/snmpcommunity"
-require "cisco_node_utils/snmpgroup"
-require "cisco_node_utils/snmpserver"
-require "cisco_node_utils/snmpuser"
-require "cisco_node_utils/tacacs_server"
-require "cisco_node_utils/tacacs_server_host"
-require "cisco_node_utils/version"
-require "cisco_node_utils/vlan"
-require "cisco_node_utils/vtp"
-require "cisco_node_utils/yum"
+# Automatically load all Ruby files in the cisco_node_utils subdirectory
+Dir.glob(__dir__ + '/cisco_node_utils/*.rb') { |file| require file }