cisco_nxapi 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02b798d719eedf373814ac7666a93169f6d3bade
+  data.tar.gz: 8796e7a3e3a94e8e6ea421f3c037091469f0d574
+SHA512:
+  metadata.gz: 81cda2b93af091507ae8a528e62ef20319b49d1e255e762079164fa2a303f916266ce4f043bf40529a7556ba1ba491e1e794e57e27a268228eef70b42496cce7
+  data.tar.gz: 05c7cc8332991d7bcdbfc634349d8b15b23d9bd0ff21014b24cb5af98c69b1299780bd4337965c3b092b406e909324e598643d23aed63abf4390039070108245

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+*.gem

data/.rubocop.yml

@@ -0,0 +1,3 @@
+# Rubocop configuration file
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-22 10:12:11 -0400 using RuboCop version 0.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 48
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 164
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 86
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 55
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 15
+
+# Offense count: 12
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 8
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 1
+Style/ModuleFunction:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/RaiseArgs:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+0.9.0
+-----
+
+* First public release, corresponding to Early Field Trial (EFT) of
+  Cisco NX-OS 7.0(3)I2(1).

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+## Submitting an Issue
+
+Issues are tracked on GitHub (TODO).
+
+## Submitting a Pull Request
+
+1. Fork the code (https://github.com/cisco/cisco_nxapi/fork) (TODO)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your code
+4. Write minitest cases to cover your new code
+5. Verify that minitest passes in full (`ruby tests/test_all_cisco.rb --
+   n3k_test.mycompany.com username password`)
+6. Run rubocop (`rake rubocop`) and fix any failures.
+7. Commit your changes (`git commit -am 'Add some feature'`)
+8. Push to the branch (`git push origin my-new-feature`)
+9. Create a new Pull Request
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cisco_node_nxapi.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.

data/README.md

@@ -0,0 +1,77 @@
+# CiscoNxapi - Cisco NX-API Utilities
+
+The CiscoNxapi gem provides utilities for communicating with Cisco network
+nodes running NX-OS 7.0(3)I2(1) and later via the NX-API management API.
+
+This is a low-level library for direct communication with NX-API.
+For a greater level of abstraction, use the [CiscoNodeUtils gem](https://rubygems.org/gems/cisco_node_utils).
+
+## Installation
+
+To install the CiscoNxapi gem, use the following command:
+
+    $ gem install cisco_nxapi
+
+(Add `sudo` if you're installing under a POSIX system as root)
+
+Alternatively, if you've checked the source out directly, you can call
+`rake install` from the root project directory.
+
+## Examples
+
+This gem can be used directly on a Cisco device (as used by Puppet and Chef)
+or can run on a workstation and point to a Cisco device (as used by the
+included minitest suite).
+
+### Usage on a Cisco device
+
+```ruby
+require 'cisco_nxapi'
+
+client = CiscoNxapi::NxapiClient.new()
+
+client.show("show version")
+
+client.config(["interface ethernet1/1",
+               "description Managed by NX-API",
+               "no shutdown"])
+```
+
+### Remote usage
+
+```ruby
+require 'cisco_nxapi'
+
+client = CiscoNxapi::NxapiClient.new("n3k.mycompany.com",
+                                     "username", "password")
+
+client.show("show version")
+
+client.config(["interface ethernet1/1",
+               "description Managed by NX-API",
+               "no shutdown"])
+```
+
+## Changelog
+
+See [CHANGELOG](CHANGELOG.md) for a list of changes.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new

data/cisco_nxapi.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cisco_nxapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cisco_nxapi'
+  spec.version       = CiscoNxapi::VERSION
+  spec.authors       = ['Alex Hunsberger', 'Glenn Matthews',
+                        'Chris Van Heuveln', 'Mike Wiebe', 'Jie Yang']
+  spec.email         = 'cisco_agent_gem@cisco.com'
+  spec.summary       = 'Utilities for working with Cisco NX-OS NX-API'
+  spec.description   = <<-EOF
+Utilities for working with the Cisco NX-OS NX-API.
+Designed to be used with Puppet and Chef and the cisco_node_utils gem.
+  EOF
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'minitest', '>= 2.5.1', '< 5.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '>= 0.32'
+  spec.add_runtime_dependency 'net_http_unix', '~> 0.2', '>= 0.2.1'
+end

data/lib/cisco_nxapi.rb

@@ -0,0 +1,17 @@
+# 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 'cisco_nxapi/version'
+require 'cisco_nxapi/cisco_nxapi'
+require 'cisco_nxapi/cisco_logger'

data/lib/cisco_nxapi/cisco_logger.rb

@@ -0,0 +1,69 @@
+#
+# Cisco Logger Library.
+#
+# January 2015, Jie Yang
+#
+# 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 'logger'
+
+module CiscoLogger
+  extend self
+
+  # Figure out what provider logging utility we
+  # should use: Puppet or Chef.
+  # If not found use the Ruby Logger/STDOUT/INFO.
+  if defined? (Puppet)
+    @@logger = Puppet
+    def error(string)
+      @@logger.err(string)
+    end
+
+    def warn(string)
+      @@logger.warning(string)
+    end
+  else
+    if defined? (Chef::Log)
+      @@logger = Chef::Log
+    else
+      @@logger = Logger.new(STDOUT)
+      @@logger.level = Logger::INFO
+
+      def debug_enable
+        @@logger.level = Logger::DEBUG
+      end
+
+      def debug_disable
+        @@logger.level = Logger::INFO
+      end
+    end
+
+    def error(string)
+      @@logger.error(string)
+    end
+
+    def warn(string)
+      @@logger.warn(string)
+    end
+  end
+
+  def debug(string)
+    @@logger.debug(string)
+  end
+
+  def info(string)
+    @@logger.info(string)
+  end
+end # module

data/lib/cisco_nxapi/cisco_nxapi.rb

@@ -0,0 +1,317 @@
+# NXAPI client library.
+#
+# November 2014, Glenn F. Matthews
+#
+# 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 'json'
+require File.join(File.dirname(__FILE__), 'cisco_logger')
+
+include CiscoLogger
+require 'net/http'
+
+module CiscoNxapi
+  class NxapiError < RuntimeError
+  end
+
+  class CliError < NxapiError
+    attr_reader :input, :msg, :code, :clierror, :previous
+    def initialize(input, msg, code, clierror, previous)
+      @input = input
+      @msg = msg
+      @code = code
+      @clierror = clierror
+      @previous = previous
+    end
+
+    def to_s
+      "CliError: '#{@input}' rejected with message: '#{clierror}'"
+    end
+
+    def message
+      to_s
+    end
+  end
+
+  class RequestNotSupported < NxapiError
+  end
+
+  class ConnectionRefused < NxapiError
+  end
+
+  class HTTPBadRequest < NxapiError
+  end
+
+  class HTTPUnauthorized < NxapiError
+  end
+
+  # Location of unix domain socket for NXAPI localhost
+  NXAPI_UDS = '/tmp/nginx_local/nginx_1_be_nxapi.sock'
+  # NXAPI listens for remote connections to "http://<switch IP>/ins"
+  # NXAPI listens for local connections to "http://<UDS>/ins_local"
+  NXAPI_REMOTE_URI_PATH = '/ins'
+  NXAPI_UDS_URI_PATH = '/ins_local'
+  # Latest supported version is 1.0
+  NXAPI_VERSION = '1.0'
+
+  class NxapiClient
+    # Constructor for NxapiClient. By default this connects to the local
+    # unix domain socket. If you need to connect to a remote device,
+    # you must provide the address/username/password parameters.
+    def initialize(address = nil, username = nil, password = nil)
+      # Default: connect to unix domain socket on localhost, if available
+      if address.nil?
+        if File.socket?(NXAPI_UDS)
+          # net_http_unix provides NetX::HTTPUnix, a small subclass of Net::HTTP
+          # which supports connection to local unix domain sockets. We need this
+          # in order to run natively under NX-OS but it's not needed for off-box
+          # unit testing where the base Net::HTTP will meet our needs.
+          require 'net_http_unix'
+          @http = NetX::HTTPUnix.new('unix://' + NXAPI_UDS)
+        else
+          fail "No address specified but no UDS found at #{NXAPI_UDS} either"
+        end
+      else
+        fail TypeError, 'invalid address' unless address.is_a?(String)
+        fail ArgumentError, 'empty address' if address.empty?
+        # Remote connection. This is primarily expected
+        # when running e.g. from a Unix server as part of Minitest.
+        @http = Net::HTTP.new(address)
+        # In this case, a username and password are mandatory
+        fail TypeError if username.nil? || password.nil?
+      end
+      unless username.nil?
+        fail TypeError, 'invalid username' unless username.is_a?(String)
+        fail ArgumentError, 'empty username' unless username.length > 0
+      end
+      unless password.nil?
+        fail TypeError, 'invalid password' unless password.is_a?(String)
+        fail ArgumentError, 'empty password' unless password.length > 0
+      end
+      @username = username
+      @password = password
+      @cache_enable = true
+      @cache_auto = true
+      cache_flush
+    end
+
+    def to_s
+      @http.address
+    end
+
+    def inspect
+      "<NxapiClient of #{@http.address}>"
+    end
+
+    def reload
+      # no-op for now
+    end
+
+    def cache_enable?
+      @cache_enable
+    end
+
+    def cache_enable=(enable)
+      @cache_enable = enable
+      cache_flush unless enable
+    end
+
+    def cache_auto?
+      @cache_auto
+    end
+
+    attr_writer :cache_auto
+
+    # Clear the cache of CLI output results.
+    #
+    # If cache_auto is true (default) then this will be performed automatically
+    # whenever a config() or exec() is called, but providers may also call this
+    # to explicitly force the cache to be cleared.
+    def cache_flush
+      @cache_hash = {
+        'cli_conf' => {},
+        'cli_show' => {},
+        'cli_show_ascii' => {}
+      }
+    end
+
+    # Configure the given command(s) on the device.
+    #
+    # @raise [CiscoNxapi::CliError] if any command is rejected by the device
+    #
+    # @param commands [String, Array<String>] either of:
+    #   1) The configuration sequence, as a newline-separated string
+    #   2) An array of command strings (one command per string, no newlines)
+    def config(commands)
+      cache_flush if cache_auto?
+
+      if commands.is_a?(String)
+        commands = commands.split(/\n/)
+      elsif !commands.is_a?(Array)
+        fail TypeError
+      end
+      req('cli_conf', commands)
+    end
+
+    # Executes a command in exec mode on the device.
+    #
+    # If cache_auto? (on by default) is set then the CLI cache will be flushed.
+    #
+    # For "show" commands please use show() instead of exec().
+    #
+    # @param command [String] the exec command to execute
+    # @return [String, nil] the body of the output of the exec command
+    #   (if any)
+    def exec(command)
+      cache_flush if cache_auto?
+      req('cli_show_ascii', command)
+    end
+
+    # Executes a "show" command on the device, returning either ASCII or
+    # structured output.
+    #
+    # Unlike config() and exec() this will not clear the CLI cache;
+    # multiple calls to the same "show" command may return cached data
+    # rather than querying the device repeatedly.
+    #
+    # @raise [CiscoNxapi::RequestNotSupported] if
+    #   structured output is requested but the given command can't provide it.
+    # @raise [CiscoNxapi::CliError] if the command is rejected by the device
+    #
+    # @param command [String] the show command to execute
+    # @param type [:ascii, :structured] ASCII or structured output.
+    #             Default is :ascii
+    # @return [String] the output of the show command, if type == :ascii
+    # @return [Hash{String=>String}] key-value pairs, if type == :structured
+    def show(command, type = :ascii)
+      if type == :ascii
+        return req('cli_show_ascii', command)
+      elsif type == :structured
+        return req('cli_show', command)
+      else
+        fail TypeError
+      end
+    end
+
+    # @raise CiscoNxapi::ConnectionRefused if NXAPI is disabled
+    # @raise CiscoNxapi::HTTPUnauthorized if username/password are invalid
+    # @raise CiscoNxapi::HTTPBadRequest (should never occur)
+    # @raise CiscoNxapi::RequestNotSupported
+    # @raise CiscoNxapi::CliError if any command is rejected as invalid
+    def req(type, command_or_list)
+      if command_or_list.is_a?(Array)
+        # NXAPI wants config lines to be separated by ' ; '
+        command = command_or_list.join(' ; ')
+      else
+        command = command_or_list
+        command_or_list = [command]
+      end
+
+      debug("Input (#{type}): \'#{command}\'")
+      if cache_enable? && @cache_hash[type] && @cache_hash[type][command]
+        return @cache_hash[type][command]
+      end
+
+      # form the request
+      if !(@username.nil? || @password.nil?)
+        request = Net::HTTP::Post.new(NXAPI_REMOTE_URI_PATH)
+        request.basic_auth("#{@username}", "#{@password}")
+      else
+        request = Net::HTTP::Post.new(NXAPI_UDS_URI_PATH)
+        request['Cookie'] = 'nxapi_auth=admin:local'
+      end
+      request.content_type = 'application/json'
+      request.body = {
+        'ins_api' => {
+          'version' => NXAPI_VERSION,
+          'type' => "#{type}",
+          'chunk' => '0',
+          'sid' => '1',
+          'input' => "#{command}",
+          'output_format' => 'json'
+        }
+      }.to_json
+
+      # send the request and get the response
+      debug("Sending HTTP request to NX-API at #{@http.address}:\n" +
+            "#{request.to_hash}\n#{request.body}")
+      begin
+        response = @http.request(request)
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+        emsg = 'Connection refused or reset. Is the NX-API feature enabled?'
+        raise ConnectionRefused, emsg
+      end
+      handle_http_response(response)
+      body = JSON.parse(response.body)
+      # In case of an error the JSON may not be complete, so we need to
+      # proceed carefully, as blindly doing body["ins_api"]["outputs"]["output"]
+      # could throw an error otherwise.
+      output = body['ins_api']
+      fail NxapiError, "unexpected JSON output:\n#{body}" unless output
+      output = output['outputs'] if output['outputs']
+      output = output['output'] if output['output']
+
+      prev_cmds = []
+      if output.is_a?(Array)
+        output.zip(command_or_list) do |o, cmd|
+          handle_output(prev_cmds, cmd, o)
+          prev_cmds << cmd
+        end
+        output = output.each { |o| o['body'] }
+      else
+        handle_output(prev_cmds, command, output)
+        output = output['body']
+      end
+
+      @cache_hash[type][command] = output if cache_enable?
+      output
+    end
+    private :req
+
+    def handle_http_response(response)
+      debug("HTTP Response: #{response.message}\n#{response.body}")
+      case response
+      when Net::HTTPUnauthorized
+        emsg = 'HTTP 401 Unauthorized. Are your NX-API credentials correct?'
+        fail CiscoNxapi::HTTPUnauthorized, emsg
+      when Net::HTTPBadRequest
+        emsg = "HTTP 400 Bad Request\n#{response.body}"
+        fail CiscoNxapi::HTTPBadRequest, emsg
+      end
+    end
+    private :handle_http_response
+
+    def handle_output(prev_cmds, command, output)
+      if output['code'] == '400'
+        # CLI error.
+        # Examples: "Invalid input", "Incomplete command", etc.
+        fail CliError.new(command, output['msg'], output['code'],
+                          output['clierror'], prev_cmds)
+      elsif output['code'] == '501'
+        # if structured output is not supported for this command,
+        # raise an exception so that the calling function can
+        # handle accordingly
+        fail RequestNotSupported.new(
+          "Structured output not supported for #{command}")
+      else
+        debug("Result for '#{command}': #{output['msg']}")
+        if output['body'] && !output['body'].empty?
+          debug("Output: #{output['body']}")
+        end
+      end
+    end
+    private :handle_output
+  end
+end

data/lib/cisco_nxapi/version.rb

@@ -0,0 +1,17 @@
+# 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.
+
+module CiscoNxapi
+  VERSION = '0.9.0'
+end

data/tests/basetest.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+#
+# Basic unit test case class.
+# December 2014, Glenn F. Matthews
+#
+# 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 'rubygems'
+gem 'minitest', '>= 2.5.1', '< 5.0.0'
+require 'minitest/autorun'
+require 'net/telnet'
+require 'test/unit'
+require File.expand_path('../../lib/cisco_nxapi/cisco_logger', __FILE__)
+
+class TestCase < Test::Unit::TestCase
+  @@address = nil
+  @@username = nil
+  @@password = nil
+
+  def process_arguments
+    if ARGV.length != 3 && ARGV.length != 4
+      puts 'Usage:'
+      puts '  ruby test_nxapi.rb [options] -- <address> <username> <password> [debug]'
+      exit
+    end
+
+    # Record the version of Ruby we got invoked with.
+    puts "\nRuby Version - #{RUBY_VERSION}"
+
+    @@address = ARGV[0]
+    @@username = ARGV[1]
+    @@password = ARGV[2]
+    if ARGV.length == 4
+      if ARGV[3] == 'debug'
+        CiscoLogger.debug_enable
+      else
+        puts "Only 'debug' is allowed"
+        exit
+      end
+    end
+  end
+
+  # setup-once params
+  def address
+    process_arguments unless @@address
+    @@address
+  end
+
+  def username
+    process_arguments unless @@username
+    @@username
+  end
+
+  def password
+    process_arguments unless @@password
+    @@password
+  end
+
+  def setup
+    @device = Net::Telnet.new('Host' => address, 'Timeout' => 240)
+    @device.login(username, password)
+  rescue Errno::ECONNREFUSED
+    puts 'Connection refused - please check that the IP address is correct'
+    puts "  and that you have enabled 'feature telnet' on the UUT"
+    exit
+  end
+
+  def teardown
+    @device.close unless @device.nil?
+    GC.start
+  end
+
+  def test_placeholder
+    # needed so that we don't get a "no tests were specified" error
+  end
+end

data/tests/test_all_cisco.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#
+# One-stop shop for running all of our current test cases.
+# January 2015, Jie Yang
+#
+# 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 'rubygems'
+gem 'minitest', '>= 2.5.1', '< 5.0.0'
+require 'minitest/autorun'
+
+require File.expand_path('../test_nxapi', __FILE__)
+require File.expand_path('../test_logger', __FILE__)

data/tests/test_logger.rb

@@ -0,0 +1,41 @@
+# Cisco Logger Unit Tests
+#
+# January 2015, Jie Yang
+#
+# 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.expand_path('../basetest', __FILE__)
+require File.expand_path('../../lib/cisco_nxapi/cisco_logger', __FILE__)
+
+class TestLogger < TestCase
+  def test_logger_methods
+    assert(defined?(CiscoLogger.debug), 'debug method not defined')
+    assert(defined?(CiscoLogger.info), 'info method not defined')
+    assert(defined?(CiscoLogger.warn), 'warning method not defined')
+    assert(defined?(CiscoLogger.error), 'error method not defined')
+  end
+
+  # Due to current limitation of minitest, the following test case actually
+  # will never fail. But it will print out all the messages that the tested
+  # functions are supposed to print. So I still keep this test here
+  def test_default_logger_output
+    CiscoLogger.debug_enable
+    assert_output { CiscoLogger.debug('Test default debug output') }
+    assert_output { CiscoLogger.info('Test default info output') }
+    assert_output { CiscoLogger.warn('Test default warn output') }
+    assert_output { CiscoLogger.error('Test default error output') }
+    CiscoLogger.debug_disable
+  end
+end

data/tests/test_nxapi.rb

@@ -0,0 +1,188 @@
+# NXAPI Client Unit Tests
+#
+# November 2014, Glenn F. Matthews
+#
+# 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.expand_path('../basetest', __FILE__)
+require File.expand_path('../../lib/cisco_nxapi/cisco_nxapi', __FILE__)
+
+class TestNxapi < TestCase
+  @@client = nil
+
+  def client
+    unless @@client
+      client = CiscoNxapi::NxapiClient.new(address, username, password)
+      client.cache_enable = true
+      client.cache_auto = true
+      @@client = client
+    end
+    @@client
+  end
+
+  # Test cases for new NXAPI client APIs
+
+  def test_config_string
+    client.config("int et1/1\ndescr panda\n")
+    run = client.show('show run int et1/1')
+    desc = run.match(/description (.*)/)[1]
+    assert_equal(desc, 'panda')
+  end
+
+  def test_config_array
+    client.config(['int et1/1', 'descr elephant'])
+    run = client.show('show run int et1/1')
+    desc = run.match(/description (.*)/)[1]
+    assert_equal(desc, 'elephant')
+  end
+
+  def test_config_invalid
+    e = assert_raises CiscoNxapi::CliError do
+      client.config(['int et1/1', 'exit', 'int et1/2', 'plover'])
+    end
+    assert_equal('plover', e.input)
+    assert_equal('CLI execution error', e.msg)
+    assert_equal('400', e.code)
+    assert_equal("% Invalid command\n", e.clierror)
+    assert_equal(['int et1/1', 'exit', 'int et1/2'], e.previous)
+  end
+
+  def test_exec
+    result = client.exec('echo hello')
+    assert_equal(result.strip, 'hello')
+  end
+
+  def test_exec_invalid
+    e = assert_raises CiscoNxapi::CliError do
+      client.exec('xyzzy')
+    end
+    assert_equal('xyzzy', e.input)
+    assert_equal('Input CLI command error', e.msg)
+    assert_equal('400', e.code)
+    assert_match(/Syntax error/, e.clierror)
+    assert_equal([], e.previous)
+  end
+
+  def test_exec_too_long
+    assert_raises CiscoNxapi::NxapiError do
+      client.exec('0' * 500_000)
+    end
+  end
+
+  def test_show_ascii_default
+    result = client.show('show hostname')
+    s = @device.cmd('show hostname')
+    assert_equal(result.strip, s.split("\n")[1].strip)
+  end
+
+  def test_show_ascii_invalid
+    assert_raises CiscoNxapi::CliError do
+      client.show('show plugh')
+    end
+  end
+
+  def test_element_show_ascii_incomplete
+    assert_raises CiscoNxapi::CliError do
+      client.show('show ')
+    end
+  end
+
+  def test_show_ascii_explicit
+    result = client.show('show hostname', :ascii)
+    s = @device.cmd('show hostname')
+    assert_equal(result.strip, s.split("\n")[1].strip)
+  end
+
+  def test_show_structured
+    result = client.show('show hostname', :structured)
+    s = @device.cmd('show hostname')
+    assert_equal(result['hostname'], s.split("\n")[1].strip)
+  end
+
+  def test_show_structured_invalid
+    assert_raises CiscoNxapi::CliError do
+      client.show('show frobozz', :structured)
+    end
+  end
+
+  def test_show_structured_unsupported
+    # TBD: n3k DOES support structured for this command,
+    #  n9k DOES NOT support structured for this command
+    assert_raises CiscoNxapi::RequestNotSupported do
+      client.show('show snmp internal globals', :structured)
+    end
+  end
+
+  def test_connection_refused
+    @device.cmd('configure terminal')
+    @device.cmd('no feature nxapi')
+    @device.cmd('end')
+    client.cache_flush
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.show('show version')
+    end
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.exec('show version')
+    end
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.config('interface Et1/1')
+    end
+    # On the off chance that things behave differently when NXAPI is
+    # disabled while we're connected, versus trying to connect afresh...
+    @@client = nil
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.show('show version')
+    end
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.exec('show version')
+    end
+    assert_raises CiscoNxapi::ConnectionRefused do
+      client.config('interface Et1/1')
+    end
+
+    @device.cmd('configure terminal')
+    @device.cmd('feature nxapi')
+    @device.cmd('end')
+  end
+
+  def test_unauthorized
+    def client.password=(new) # rubocop:disable Style/TrivialAccessors
+      @password = new
+    end
+    client.password = 'wrong_password'
+    client.cache_flush
+    assert_raises CiscoNxapi::HTTPUnauthorized do
+      client.show('show version')
+    end
+    assert_raises CiscoNxapi::HTTPUnauthorized do
+      client.exec('show version')
+    end
+    assert_raises CiscoNxapi::HTTPUnauthorized do
+      client.config('interface Et1/1')
+    end
+    client.password = password
+  end
+
+  def test_unsupported
+    # Add a method to the NXAPI that sends a request of invalid type
+    def client.hello
+      req('hello', 'world')
+    end
+
+    assert_raises CiscoNxapi::RequestNotSupported do
+      client.hello
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: cisco_nxapi
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Alex Hunsberger
+- Glenn Matthews
+- Chris Van Heuveln
+- Mike Wiebe
+- Jie Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: net_http_unix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: |
+  Utilities for working with the Cisco NX-OS NX-API.
+  Designed to be used with Puppet and Chef and the cisco_node_utils gem.
+email: cisco_agent_gem@cisco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cisco_nxapi.gemspec
+- lib/cisco_nxapi.rb
+- lib/cisco_nxapi/cisco_logger.rb
+- lib/cisco_nxapi/cisco_nxapi.rb
+- lib/cisco_nxapi/version.rb
+- tests/basetest.rb
+- tests/test_all_cisco.rb
+- tests/test_logger.rb
+- tests/test_nxapi.rb
+homepage: 
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Utilities for working with Cisco NX-OS NX-API
+test_files: []