cisco_node_utils 1.2.0 → 1.3.0

data/bin/git/hooks/hook_lib

@@ -86,6 +86,13 @@ get_last_version() {
 }
 export -f get_last_version
 
+get_staged_ruby_files() {
+  rubocop_target=$(rubocop --list-target-files)
+  staged_files=$(git diff --name-only --staged)
+  echo $(printf "$rubocop_target $staged_files " | tr ' ' '\n' | sort | uniq -d)
+}
+export -f get_staged_ruby_files
+
 add_changelog_diff_link() {
     local OLD_VERSION=$1
     local NEW_VERSION=$2

data/bin/git/hooks/pre-commit/check_unstaged_changes

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+# Check if a staged file has unstaged changes and print a warning
+
+staged_files = `git diff --name-only --staged`.split(' ')
+unstaged_files = `git diff --name-only`.split(' ')
+files = (staged_files << unstaged_files).flatten!
+
+if files.length != files.uniq.length
+  puts 'Warning: a staged file has unstaged changes!'
+  fd = IO.sysopen('/dev/tty', 'w+')
+  a = IO.new(fd, 'w+')
+  a.print 'Continue anyway? [y/N] '
+  input = a.gets.chomp
+  exit input =~ /^y/i ? 0 : -1
+end
+
+exit 0

data/bin/git/hooks/pre-commit/rubocop

@@ -9,12 +9,17 @@
 # rubocop run of all checks as part of the pre-push hook
 
 step_name "Running RuboCop lint checks"
-rubocop --lint
+staged_ruby_files=$(get_staged_ruby_files)
+if [ -z "$staged_ruby_files" ]; then
+  # quit since there are no ruby files to check
+  exit 0
+fi
+rubocop --lint $staged_ruby_files
 check_rc "Please fix RuboCop lint failures before committing."
 
 # Do a full rubocop run to warn the user, but don't block a commit by it.
 step_name "Running all RuboCop checks"
-rubocop
+rubocop $staged_ruby_files
 check_rc_optional "Fix all RuboCop failures before pushing upstream"
 
 exit 0

data/bin/git/hooks/pre-commit/validate-diffs

@@ -17,15 +17,29 @@ else
     against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 fi
 
+step_name 'Checking for non-ASCII filenames'
 # We exploit the fact that the printable range starts at the space character
 # and ends with tilde.
 # Note that the use of brackets around a tr range is ok here, (it's
 # even required, for portability to Solaris 10's /usr/bin/tr), since
 # the square bracket bytes happen to fall in the designated range.
-git diff --cached --name-only --diff-filter=A -z $against |
-        LC_ALL=C tr -d '[ -~]\0' | wc -c
+added_files=$(git diff --cached --name-only --diff-filter=A -z $against | tr '\0' ' ')
+added_files_array=(`echo $added_files`)
+# Print the files that have non-ascii text
+for i in ${added_files_array[@]}; do
+  bad_chars=$(echo -n $i | LC_ALL=C tr -d '[ -~]\0')
+  if [ -n "$bad_chars" ]; then echo $i; fi
+done
+# Fail if any non-ASCII characters are discovered
+(echo -n $added_files | LC_ALL=C tr -d '[ -~]\0' | exit $(wc -c))
 check_rc "Rename non-ASCII file name(s) before committing"
 
+step_name 'Checking for trailing whitespace in non-Ruby files'
 # If there are whitespace errors, print the offending file names and fail.
-git diff-index --check --cached $against --
-check_rc "Fix trailing whitespace before committing"
+# Ignore .rb files, as whitespace in these files is managed by Rubocop
+# Ignore .proto files, as they are generated code
+non_ruby_files=`git diff --staged --name-only | grep -v \.rb | grep -v \.proto`
+if [ -n "$non_ruby_files" ]; then
+  ! git grep -n -I '\s$' -- $non_ruby_files
+  check_rc "Fix trailing whitespace before committing"
+fi

data/bin/git/hooks/pre-commit/validate-yaml

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+[ -n "$GIT_DIR" ] || export GIT_DIR="$(git rev-parse --show-toplevel 2>/dev/null)/.git"
+. "$GIT_DIR"/hooks/hook_lib
+
+# Run the Kwalify YAML schema validation
+
+step_name "Validating YAML files"
+rspec "$REPO_DIR"/spec/yaml_spec.rb
+check_rc "Please fix YAML schema validation failures before committing"
+
+# Ensure that command_reference can parse all the YAML as well
+
+step_name "Checking command_reference YAML parsing"
+ruby "$REPO_DIR"/tests/test_command_reference.rb
+check_rc "Please fix command_reference unit test failures before committing"
+
+exit 0

data/bin/git/update-hooks

@@ -12,6 +12,52 @@ HOOK_DIR="$(git rev-parse --show-toplevel)/.git/hooks"
 
 . "$SRC_DIR/hook_lib"
 
+usage() {
+    echo "Usage: update-hooks [OPTION]"
+    echo "Update the hooks in the local git repository to match those"
+    echo "under version control."
+    echo
+    echo "Options:"
+    echo "  --dry-run       Do not make any updates"
+    echo "  -v  --verbose   Verbose output, including diffs of updated files"
+    echo "  --[no-]pager    Explicity request or suppress pagination in git diff"
+    echo "  -h  --help      Display this help text"
+}
+
+# Flags that can be set from the command line, with default values
+make_updates=1  # the inverse of --dry-run
+verbose=0
+pager= # default to whatever defaults git has configured
+
+# parse command line options
+while [ "$#" -gt 0 ]; do
+    case "$1" in
+        (-h|--help)
+            usage
+            exit 0
+            ;;
+        (-v|--verbose)
+            verbose=1
+            ;;
+        (--pager)
+            pager=--paginate
+            ;;
+        (--no-pager)
+            pager=--no-pager
+            ;;
+        (--dry-run)
+            make_updates=0
+            ;;
+        (*)
+            echo "Unrecognized option: $1"
+            usage
+            exit 1
+            ;;
+    esac
+    shift 1
+done
+
+
 install_hook_wrapper() {
     local hook=$1
     # Does the symlink exist?
@@ -19,11 +65,15 @@ install_hook_wrapper() {
         # If a hook already exists and is a file:
         if [ -f $HOOK_DIR/$hook ]; then
             step_name "Moving existing '$hook' script to '$hook-local'"
-            mv $HOOK_DIR/$hook $HOOK_DIR/$hook-local
+            if [ $make_updates == 1 ]; then
+                mv $HOOK_DIR/$hook $HOOK_DIR/$hook-local
+            fi
         fi
         # create the symlink to our wrapper script
         step_name "Installing hook wrapper script for '$hook'"
-        ln -s -f ./hooks-wrapper $HOOK_DIR/$hook
+        if [ $make_updates == 1 ]; then
+            ln -s -f ./hooks-wrapper $HOOK_DIR/$hook
+        fi
     fi
 }
 
@@ -32,14 +82,22 @@ check_update() {
     local dest=$2
     if [ ! -e "$dest" ] ; then
         step_name "Creating new file at '$dest':"
-        git diff --color --no-index /dev/null $src
-        cp $src $dest
+        if [ $verbose == 1 ]; then
+            git ${pager} diff --color --no-index /dev/null $src
+        fi
+        if [ $make_updates == 1 ]; then
+            cp $src $dest
+        fi
     else
         diff $src $dest >> /dev/null
         if [ $? -ne 0 ] ; then
             step_name "File '$dest' will be updated: "
-            git diff --color --no-index $dest $src
-            cp -f $src $dest
+            if [ $verbose == 1 ]; then
+                git ${pager} diff --color --no-index $dest $src
+            fi
+            if [ $make_updates == 1 ]; then
+                cp -f $src $dest
+            fi
         fi
     fi
 }

data/cisco_node_utils.gemspec

@@ -6,15 +6,15 @@ require 'cisco_node_utils/version'
 Gem::Specification.new do |spec|
   spec.name          = 'cisco_node_utils'
   spec.version       = CiscoNodeUtils::VERSION
-  spec.authors       = ['Alex Hunsberger', 'Glenn Matthews',
-                        'Chris Van Heuveln', 'Mike Wiebe', 'Jie Yang',
-                        'Rob Gries']
+  spec.authors       = ['Rob Gries', 'Alex Hunsberger', 'Glenn Matthews',
+                        'Chris Van Heuveln', 'Rich Wellum', 'Mike Wiebe',
+                        'Jie Yang']
   spec.email         = 'cisco_agent_gem@cisco.com'
   spec.summary       = 'Utilities for management of Cisco network nodes'
   spec.description   = <<-EOF
 Utilities for management of Cisco network nodes.
 Designed to work with Puppet and Chef.
-Currently supports NX-OS nodes.
+Currently supports NX-OS and IOS XR nodes.
   EOF
   spec.license       = 'Apache-2.0'
   spec.homepage      = 'https://github.com/cisco/cisco-network-node-utils'
@@ -28,10 +28,13 @@ Currently supports NX-OS nodes.
   spec.required_ruby_version     = '>= 2.0.0'
   spec.required_rubygems_version = '>= 2.1.0'
 
-  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'kwalify', '~> 0.7.2'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '= 0.35.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
-  spec.add_runtime_dependency 'cisco_nxapi', '~> 1.0', '>= 1.0.1'
+
+  spec.extensions = ['ext/mkrf_conf.rb']
 end

data/docs/README-develop-best-practices.md

@@ -14,24 +14,25 @@ This document is intended to assist in developing cisco_node_utils API's that ar
 
 * [Y1](#yaml1): One feature per YAML file
 * [Y2](#yaml2): All attribute entries must be kept in alphabetical order.
-* [Y3](#yaml3): Use *regexp* anchors where needed for `config_get` and `config_get_token` entries.
+* [Y3](#yaml3): Use *regexp* anchors where needed for CLI `get_context` and `get_value` entries.
 * [Y4](#yaml4): Avoid nested optional matches.
 * [Y5](#yaml5): Use the `_template` feature when getting/setting the same property value at multiple levels.
 * [Y6](#yaml6): When possible include a `default_value` that represents the system default value.
-* [Y7](#yaml7): When possible, use the same `config_get` show command for all properties and document any anomalies.
+* [Y7](#yaml7): When possible, use the same `get_command` for all properties and document any anomalies.
 * [Y8](#yaml8): Use Key-value wildcards instead of Printf-style wildcards.
-* [Y9](#yaml9): Selection of `show` commands for `config_get`.
+* [Y9](#yaml9): Selection of `show` commands for `get_command`.
 * [Y10](#yaml10): Use `true` and `false` for boolean values.
-
-
+* [Y11](#yaml11): Use YAML anchors and aliases to avoid redundant entries.
+* [Y12](#yaml12): Use `_exclude` to return `nil` for unsupported properties.
 
 ## <a name="odbp">Common Object Development Best Practices</a>
 
 * [CO1](#co1): Features that can be configured under the global and non-global vrfs need to account for this in the object design.
 * [CO2](#co2): Make use of the equality operator allowing proper `instance1 == instance2` checks in the minitests.
 * [CO3](#co3): Use `''` rather than `nil` to represent "property is absent entirely"
-* [CO4](#co4): Make sure all new properites have a `getter`, `setter` and `default_getter` method.
+* [CO4](#co4): Make sure all new properties have a `getter`, `setter` and `default_getter` method.
 * [CO5](#co5): Use singleton-like design for resources that cannot have multiple instances.
+* [CO6](#co6): Implement a meaningful `to_s` method
 
 ## <a name="mdbp">MiniTest Development Best Practices</a>
 
@@ -40,7 +41,7 @@ This document is intended to assist in developing cisco_node_utils API's that ar
 * [MT3](#mt3): Do not hardcode interface names.
 * [MT4](#mt4): Make use of the `config` helper method for device configuration instead of `@device.cmd`.
 * [MT5](#mt5): Make use of the `assert_show_match` and `refute_show_match` helper methods to validate expected outcomes in the CLI instead of `@device.cmd("show...")`.
-
+* [MT6](#mt6): Unsupported properties must include negative test cases.
 
 
 ## YAML Best Practices:
@@ -55,16 +56,18 @@ All attribute entries in a given YAML file must be kept in alphabetical order. A
 
 This rule is enforced by the `Cisco::CommandReference` class itself - it will raise an exception if it detects any out-of-order entries.
 
-### <a name="yaml3">Y3: Use *regexp* anchors where needed for `config_get` and `config_get_token` entries.
+### <a name="yaml3">Y3: Use *regexp* anchors where needed for CLI `get_context` and `get_value` entries.
 
-Please use *regexp* anchors `^$` to ensure you match the correct feature information in the `show` output.
+By default, CLI clients assume that `get_context` and `get_value` are to be treated as Regexps, and implicitly add regexp anchors and case-insensitivity (i.e., a `get_value` of `'router bgp 100'` becomes the regexp `/^router bgp 100$/i`). If you want to explicitly specify a regexp (perhaps because the default behavior does not meet your needs for a specific property), be sure to add the `^` and `$` anchors to ensure you match the correct feature information in the `show` output and do not unexpectedly match similar but undesired CLI strings.
 
 ```yaml
 # syslog_settings.yaml
 timestamp:
-  config_get: "show running-config all | include '^logging timestamp'"
-  config_get_token: '/^logging timestamp (.*)$/'
-  config_set: '<state> logging timestamp <units>'
+  get_command: "show running-config all | include '^logging timestamp'"
+  get_value: 'logging timestamp (.*)'
+  # this is equivalent to:
+  # get_value: '/^logging timestamp (.*)$/'
+  set_value: '<state> logging timestamp <units>'
   default_value: 'seconds'
 ```
 
@@ -77,18 +80,20 @@ One case where this may crop up is in trying to match both affirmative and
 negative variants of a config command:
 
 ```yaml
-config_get_token: ['/^interface <name>$/i', '/^((no )?switchport)$/']
+get_context: ['interface <name>']
+get_value: '((no )?switchport)'
 
-config_get_token: '/^(no)? ?ip tacacs source-interface ?(\S+)?$/'
+get_value: '(no)? ?ip tacacs source-interface ?(\S+)?'
 ```
 
 Instead, match the affirmative form of a command and treat its absence as
 confirmation of the negative form:
 
 ```yaml
-config_get_token: ['/^interface <name>$/i', '/^switchport$/']
+get_context: ['interface <name>']
+get_value: 'switchport'
 
-config_get_token: '/^tacacs-server source-interface (\S+)$/'
+get_value: 'tacacs-server source-interface (\S+)'
 ```
 
 ### <a name="yaml5">Y5: Use the `_template` feature when getting/setting the same property value at multiple levels.
@@ -98,22 +103,19 @@ Using the template below, `auto_cost` and `default_metric` can be set under `rou
 ```yaml
 # ospf.yaml
 _template:
-  config_get: "show running ospf all"
-  config_get_token: '/^router ospf <name>$/'
-  config_get_token_append:
-    - '/^vrf <vrf>$/'
-  config_set: "router ospf <name>"
-  config_set_append:
-    - "vrf <vrf>"
+  get_command: "show running ospf all"
+  context:
+    - 'router ospf <name>'
+    - '(?)vrf <vrf>'
 
 auto_cost:
-  config_get_token_append: '/^auto-cost reference-bandwidth (\d+)\s*(\S+)?$/'
-  config_set_append: "auto-cost reference-bandwidth <cost> <type>"
+  get_value: 'auto-cost reference-bandwidth (\d+)\s*(\S+)?'
+  set_value: "auto-cost reference-bandwidth <cost> <type>"
   default_value: [40, "Gbps"]
 
 default_metric:
-  config_get_token_append: '/^default-metric (\d+)?$/'
-  config_set_append: "<state> default-metric <metric>"
+  get_value: 'default-metric (\d+)?'
+  set_value: "<state> default-metric <metric>"
   default_value: 0
 ```
 
@@ -126,20 +128,22 @@ Default value for `message_digest_alg_type` is `md5`
 
 ```yaml
 message_digest_alg_type:
-  config_get: 'show running interface all'
-  config_get_token: ['/^interface <name>$/i', '/^\s*ip ospf message-digest-key \d+ (\S+)/']
+  get_command: 'show running interface all'
+  get_context: 'interface <name>'
+  get_value: '/^\s*ip ospf message-digest-key \d+ (\S+)/'
   default_value: 'md5'
 ```
 
 **NOTE1: Use strings rather then symbols when applicable**.
 
-If the `default_value` differs between cisco platforms, use per-API or per-platform keys in the YAML as needed. For example, if the default value on all platforms except the N9K is `md5` then you might do something like this:
+If the `default_value` differs between cisco platforms, use per-API or per-platform keys in the YAML as needed. For example, if the default value on all platforms except the N9k is `md5` then you might do something like this:
 
 ```yaml
 message_digest_alg_type:
-  config_get: 'show running interface all'
-  config_get_token: ['/^interface <name>$/i', '/^\s*ip ospf message-digest-key \d+ (\S+)/']
-  /N9K/:
+  get_command: 'show running interface all'
+  get_context: 'interface <name>'
+  get_value: '/^\s*ip ospf message-digest-key \d+ (\S+)/'
+  N9k:
     default_value: 'sha2'
   else:
     default_value: 'md5'
@@ -147,33 +151,33 @@ message_digest_alg_type:
 
 See [README_YAML](../lib/cisco_node_utils/cmd_ref/README_YAML.md) for more details about this advanced feature.
 
-### <a name="yaml7">Y7: When possible, use the same `config_get` show command for all properties and document any anomalies.
+### <a name="yaml7">Y7: When possible, use the same `get_command` for all properties and document any anomalies.
 
 All properties below use the `show run tacacs all` command except `directed_request` which is documented.
 
 ```yaml
 # tacacs_server.yaml
+_template:
+  get_command: "show run tacacs all"
+
 deadtime:
-  config_get: "show run tacacs all"
-  config_get_token: '/^tacacs-server deadtime\s+(\d+)/'
-  config_set: "<state> tacacs-server deadtime <time>"
+  get_value: '/^tacacs-server deadtime\s+(\d+)/'
+  set_value: "<state> tacacs-server deadtime <time>"
   default_value: 0
 
 directed_request:
   # oddly, directed request must be retrieved from aaa output
-  config_get: "show running aaa all"
-  config_get_token: '/(?:no)?\s*tacacs-server directed-request/'
-  config_set: "<state> tacacs-server directed-request"
+  get_command: "show running aaa all"
+  get_value: '/(?:no)?\s*tacacs-server directed-request/'
+  set_value: "<state> tacacs-server directed-request"
   default_value: false
 
 encryption_type:
-  config_get: "show run tacacs all"
-  config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
+  get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
   default_value: 0
 
 encryption_password:
-  config_get: "show run tacacs all"
-  config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
+  get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
   default_value: ""
 ```
 
@@ -184,7 +188,7 @@ Key-value wildcards are moderately more complex to implement than Printf-style w
 **Key-value wildcards**
 
 ```yaml
-config_set_append: "<state> log-adjacency-changes <type>"
+get_value: "<state> log-adjacency-changes <type>"
 ```
 
 This following approach is quick to implement and concise, but less flexible - in particular it cannot handle a case where different platforms take parameters in a different order - and less readable in the ruby code.
@@ -192,10 +196,10 @@ This following approach is quick to implement and concise, but less flexible - i
 **Printf-style wildcards**
 
 ```yaml
-config_set_append: "%s log-adjacency-changes %s"
+get_value: "%s log-adjacency-changes %s"
 ```
 
-### <a name="yaml9">Y9: Selection of `show` commands for `config_get`.
+### <a name="yaml9">Y9: Selection of `show` commands for `get_command`.
 
 The following commands should be preferred over `show [feature]` commands since not all `show [feature]` commands behave in the same manner across cisco platforms.
 
@@ -206,6 +210,48 @@ The following commands should be preferred over `show [feature]` commands since
 
 YAML allows various synonyms for `true` and `false` such as `yes` and `no`, but for consistency and readability (especially to users more familiar with Ruby than with YAML), we recommend using `true` and `false` rather than any of their synonyms.
 
+### <a name="yaml11">Y11: Use YAML anchors and aliases to avoid redundant entries.
+
+Use the standard YAML functionality of [node anchors](http://www.yaml.org/spec/1.2/spec.html#id2785586) and [node aliases](http://www.yaml.org/spec/1.2/spec.html#id2786196) to avoid redundant entries. In other words, instead of:
+
+```yaml
+  vn_segment_vlan_based:
+   # MT-lite only
+   N3k:
+     kind: boolean
+     config_get: 'show running section feature'
+     config_get_token: '/^feature vn-segment-vlan-based$/'
+     config_set: 'feature vn-segment-vlan-based'
+     default_value: false
+   N9k:
+     # same as N3k
+     kind: boolean
+     config_get: 'show running section feature'
+     config_get_token: '/^feature vn-segment-vlan-based$/'
+     config_set: 'feature vn-segment-vlan-based'
+     default_value: false
+```
+
+instead you can do:
+
+```yaml
+  vn_segment_vlan_based:
+   # MT-lite only
+   N3k: &vn_segment_vlan_based_mt_lite
+     kind: boolean
+     config_get: 'show running section feature'
+     config_get_token: '/^feature vn-segment-vlan-based$/'
+     config_set: 'feature vn-segment-vlan-based'
+     default_value: false
+   N9k: *vn_segment_vlan_based_mt_lite
+```
+
+### <a name="yaml12">Y12: Use `_exclude` to return `nil` for unsupported properties.
+
+Some properties are only applicable to specific platforms. Rather than using `default_only` to specify an 'unconfigured' default like `''` or `false`, it is more accurate to return `nil` for a property that is not applicable at all. By returning `nil`, the property will not even appear in commands like `puppet resource`, which is the desired outcome.
+
+Rather than specifying `default_only: nil`, the most straightforward and self-evident way to mark a property as unsupported is to use the `_exclude: [my_platform]` YAML tag. See [README_YAML.md](../lib/cisco_node_utils/cmd_ref/README_YAML.md#_exclude) for more details about the `_exclude` tag.
+
 ## Common Object Best Practices:
 
 ### <a name="co1">CO1: Features that can be configured under the global and non-global vrfs need to account for this in the object design.
@@ -319,7 +365,7 @@ def access_vlan=(vlan)
   config_set('interface', 'access_vlan', @name, vlan)
 ```
 
-### <a name="co4">CO4: Make sure all new properites have a `getter`, `setter` and `default_getter` method.
+### <a name="co4">CO4: Make sure all new properties have a `getter`, `setter` and `default_getter` method.
 
 In order to have a complete set of api's for each property it is important that all properties have a `getter`, `setter` and `default_getter` method.
 
@@ -356,10 +402,49 @@ end
 
 See [TacacsServer](../lib/cisco_node_utils/tacacs_server.rb) and [SnmpServer](../lib/cisco_node_utils/snmpserver.rb) for examples.
 
+### <a name="co6">CO6: Implement a meaningful `to_s` method
+
+Request errors generated by a `NodeUtil` subclass calling `config_get` or `config_set` will automatically prepend the output of the class's `to_s` method. The default output of this method is not especially helpful as it just identifies the class name:
+
+```
+Cisco::CliError: [#<Cisco::Bgp:0x007f1b3b7af5a0>] The command 'foobar shutdown' was rejected with error:
+...
+```
+
+But by implementing the `to_s` method:
+
+```ruby
+module Cisco
+  # RouterBgp - node utility class for BGP general config management
+  class RouterBgp < NodeUtil
+    attr_reader :asnum, :vrf
+...
+    def to_s
+      "BGP #{asnum} VRF '#{vrf}'"
+    end
+```
+
+The error output can now clearly identify the instance that failed:
+
+```
+Cisco::CliError: [BGP 100 VRF 'red'] The command 'foobar shutdown' was rejected with error:
+...
+```
+
 ## MiniTest Best Practices:
 
 ### <a name="mt1">MT1: Ensure that *all new API's* have minitest coverage.
 
+Running minitest will automatically produce code coverage results using the [SimpleCov](http://www.rubydoc.info/gems/simplecov) Gem:
+
+```
+test_interface:
+39 runs, 316 assertions, 0 failures, 0 errors, 2 skips
+Coverage report generated for MiniTest to cisco-network-node-utils/coverage. 602 / 814 LOC (73.96%) covered.
+```
+
+If you are adding new APIs, after running the tests, you should inspect the coverage results (open `coverage/index.html` with a web browser) to ensure that your new APIs are being exercised appropriately by your new tests.
+
 ### <a name="mt2">MT2: Use appropriate `assert_foo` and `refute_foo` statements rather than `assert_equal`.
 
 
@@ -377,8 +462,7 @@ The more specific assertions also produce more helpful failure messages if somet
 
 ### <a name="mt3">MT3: Do not hardcode interface names.
 
-Rather then hardcode an interface name that may or may not exist, instead use 
-the `interfaces[]` array.
+Rather then hardcode an interface name that may or may not exist, instead use the `interfaces[]` array.
 
 ```ruby
 def create_interface(ifname=interfaces[0])
@@ -420,3 +504,18 @@ refute_output_match(pattern: /interface port-channel 11/)
 refute_output_match(pattern: /interface port-channel 12/)
 assert_output_match(pattern: /interface port-channel 13/)
 ```
+
+### <a name="mt6">MT6: Unsupported properties must include negative test cases.
+
+Some properties are only applicable to a particular platform and are unsupported on other platforms. To ensure that this lack of support is properly validated, at least one of the test cases for this property should include tests of the getter and default methods and a negative test for the setter method. If you followed [Y11](#yaml11), this means checking that the getter and default methods return `nil` and the setter method raises a `Cisco::UnsupportedError`:
+
+```ruby
+def test_foo_bar
+  if platform == :platform_not_supporting_bar
+    assert_nil(foo.bar)
+    assert_nil(foo.default_bar)
+    assert_raises(Cisco::UnsupportedError) { foo.bar = baz }
+  else
+    # tests for foo.bar on a platform that supports this
+    ...
+```