cisco_node_utils_mgx 2.1.0.1

data/bin/git/update-hooks

@@ -0,0 +1,123 @@
+#!/bin/bash
+#
+# Based on:
+# http://stackoverflow.com/questions/3462955/putting-git-hooks-into-repository
+# https://github.com/sjungwirth/githooks
+
+# Where hooks are stored in the repo
+SRC_DIR="$(git rev-parse --show-toplevel)/bin/git/hooks"
+
+# Where hooks need to be installed
+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?
+    if [ ! -h $HOOK_DIR/$hook ]; then
+        # If a hook already exists and is a file:
+        if [ -f $HOOK_DIR/$hook ]; then
+            step_name "Moving existing '$hook' script to '$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'"
+        if [ $make_updates == 1 ]; then
+            ln -s -f ./hooks-wrapper $HOOK_DIR/$hook
+        fi
+    fi
+}
+
+check_update() {
+    local src=$1
+    local dest=$2
+    if [ ! -e "$dest" ] ; then
+        step_name "Creating new file at '$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: "
+            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
+}
+
+for item in "$SRC_DIR"/*; do
+    if [ ! -d "$item" ]; then
+        # Not a hook subdirectory, just a library file - update it as needed
+        file="${item##*/}"
+        check_update "$SRC_DIR/$file" "$HOOK_DIR/$file"
+        continue
+    fi
+    # Else it's a hook subdirectory.
+    hook="${item##*/}"
+    # First, make sure we have our hook-wrapper script installed for this hook:
+    install_hook_wrapper "$hook"
+    # Now descend into the subdirectory and update the individual scripts:
+    for file in "$item"/*; do
+        # bin/git/hooks/pre-commit/rubocop --> "pre-commit-rubocop"
+        hook_script="${hook}-${file##*/}"
+        check_update "$file" "$HOOK_DIR/$hook_script"
+    done
+done
+

data/bin/show_running_yang.rb

@@ -0,0 +1,233 @@
+#!/usr/bin/env ruby
+#
+# June 2016, Charles Burkett
+#
+# Copyright (c) 2016 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.
+#
+# This is a utility to output the current state of an XR configuration.
+# In order to run, this utility needs access to one or more *.yang files
+# (found in the /pkg/yang directory on the XR box, as well as from other
+# sources).
+
+require 'cisco_node_utils'
+require 'optparse'
+
+module Cisco
+  # Utility class to output the current state of an XR configuration.
+  class YangViewer
+    def process(options)
+      @options = options
+
+      client # initialize the client
+
+      dir_or_file = options[:path]
+
+      file = nil
+      dir = nil
+
+      if File.exist?(dir_or_file)
+        if File.directory?(dir_or_file)
+          dir = dir_or_file
+        else
+          file = dir_or_file
+        end
+      else
+        puts "Directory or file not found: #{dir_or_file}"
+        exit(-1)
+      end
+
+      puts "File found: #{file}" if file
+      puts "Directory found: #{dir}" if dir
+      puts 'Searching for configuration data...' unless @options[:oper]
+      puts 'Searching for operational data...' if @options[:oper]
+
+      t1 = Time.now
+
+      @files = 0
+      @cnrs = 0
+      @errors = 0
+      if file
+        process_file(file)
+        @files += 1
+      else
+        Dir.glob(dir + '/*.yang').sort.each do |item|
+          process_file(item)
+          @files += 1
+        end
+      end
+
+      delta = Time.now - t1
+      puts '---------------------------------------------'
+      puts "Files Processed: #{@files}"
+      puts "Containers Processed: #{@cnrs}"
+      puts "Errors: #{@errors}"
+      puts "Time: #{delta.round(2)} seconds"
+      puts # spacer
+    end
+
+    def process_file(file)
+      @module = nil
+      @containers = {}
+      puts "[ Processing file #{file} ]" if @options[:verbose]
+
+      File.open(file) do |f|
+        loop do
+          break if (line = f.gets).nil?
+          process_line(line, f)
+        end
+      end
+    end
+
+    def process_line(line, file)
+      if @module.nil?
+        @module = Regexp.last_match(1) if line =~ /^module (.+) {/
+      elsif line =~ /^  container (.+) {/
+        process_root_container(@module, Regexp.last_match(1), file)
+      end
+    end
+
+    def process_root_container(module_name, container, file)
+      operation = :get_config
+      loop do
+        line = file.gets
+        break if !line || line.strip == ''
+        if line =~ /^    config false;/ # abort cnr if not config
+          operation = :get_oper
+          break
+        end
+      end
+
+      # only output config or operational data, depending on options
+      if @options[:oper]
+        return if operation == :get_config
+      else
+        return if operation != :get_config
+      end
+
+      # guard against duplicate containers
+      if @containers.key?(container)
+        puts "[   Duplicate container #{container} ]" if @options[:verbose]
+        return
+      end
+
+      yang_path = "{\"#{module_name}:#{container}\": [null]}"
+
+      @containers[container] = true
+      @cnrs += 1
+
+      begin
+        data = client.get(data_format: :yang_json,
+                          command:     yang_path,
+                          mode:        operation)
+        if data && data.strip.length > 0
+          puts "[   Processing container #{container} ]"\
+              if @options[:verbose]
+          output_data(yang_path, data)
+        else
+          puts "[   Processing container #{container}: no data returned ]"\
+              if @options[:verbose]
+        end
+      rescue Cisco::ClientError, Cisco::YangError => e
+        puts "[   Processing container #{container} ]" if @options[:verbose]
+        @errors += 1
+        puts "!!Error on '#{yang_path}': #{e}"
+        debug e.backtrace
+        puts # spacer
+      end
+    end
+
+    def output_data(yang_path, data)
+      if @options[:manifest]
+        puts "  cisco_yang { '#{yang_path}':\n"\
+            "    ensure => present,\n"\
+            "    source => '#{data.chomp.gsub(/\n/, "\n    ")}'\n"\
+            '  }'
+      else
+        puts data
+      end
+      puts # spacer
+    end
+
+    def client
+      unless @client
+        puts "[ Connecting to client environment: #{@options[:environment]} ]"\
+            if @options[:verbose]
+
+        @client = Cisco::Client.create(@options[:environment])
+
+        puts "[ Connected to client: #{@client} ]"\
+            if @options[:verbose]
+      end
+      @client
+    rescue Cisco::AuthenticationFailed
+      abort 'Unauthorized to connect'
+    rescue Cisco::ClientError, TypeError, ArgumentError => e
+      abort "Error in establishing connection: #{e}"
+    end
+  end # YangViewer
+end # Cisco
+
+options = { path: '/pkg/yang', environment: 'default' }
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: ruby show_running_yang.rb '\
+      '[options] [file_or_directory_path]'
+
+  opts.on('-m', '--manifest', 'Output config in a form suitable '\
+          'for inclusion in a Puppet manifest') do |_arg|
+    options[:manifest] = true
+  end
+
+  opts.on('-o', '--oper',
+          'Retrieve operational data instead of configuration '\
+          '(warning: possibly returns a lot of data; use at own risk)') do
+    options[:oper] = true
+  end
+
+  opts.on('-e', '--environment node', 'The node in cisco_node_utils.yaml '\
+          'from which to retrieve data') do |env|
+    options[:environment] = env
+  end
+
+  opts.on('-d', '--debug', 'Enable debug-level logging') do
+    Cisco::Logger.level = Logger::DEBUG
+  end
+
+  opts.on('-v', '--verbose', 'Enable verbose messages') do
+    options[:verbose] = true
+  end
+
+  opts.on('-h', '--help', 'Print this help') do
+    puts optparse
+    exit(0)
+  end
+end
+optparse.parse!
+
+if options[:oper] && options[:manifest]
+  STDERR.puts '!! Operational data cannot be set in a manifest, '\
+      'so option -m does not make sense in conjunction with -o.'
+  exit(-1)
+end
+
+# If there is a single ARGV left, use is as the file/dir path
+if ARGV.length == 1
+  options[:path] = ARGV[0]
+elsif ARGV.length > 1
+  puts optparse
+  exit(-1)
+end
+
+ycv = Cisco::YangViewer.new
+ycv.process(options)

data/cisco_node_utils.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cisco_node_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cisco_node_utils_mgx'
+  spec.version       = CiscoNodeUtils::VERSION
+  spec.authors       = ['Rob Gries', 'Alex Hunsberger', 'Glenn Matthews',
+                        'Chris Van Heuveln', 'Rich Wellum', 'Mike Wiebe',
+                        'Jie Yang', 'Sai Chintalapudi']
+  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.
+  EOF
+  spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://github.com/cisco/cisco-network-node-utils'
+
+  spec.files         = `svn list -R`.split($/)
+  # Files in bin/git are not executables as far as the Gem is concerned
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version     = '>= 2.0.0'
+  spec.required_rubygems_version = '>= 2.1.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 'net-telnet', '~> 0.1.1'
+  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.extensions = ['ext/mkrf_conf.rb']
+end