cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/yang.rb

@@ -0,0 +1,160 @@
+# June 2016, Charles Burkett
+#
+# Copyright (c) 2015-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.
+
+require 'json'
+
+module Cisco
+  # class Cisco::Yang
+  # Utility class mainly containing methods to compare YANG configurations
+  # in order to determine if the running config is in-sync with the
+  # desired config.
+  class Yang
+    # Is the specified yang string empty?
+    def self.empty?(yang)
+      !yang || yang.empty?
+    end
+
+    # Given target and current YANG configurations, returns true if
+    # the configurations are in-sync, relative to a "merge_config" action
+    # @param should [String] the should configuration in YANG JASON format
+    # @param is [String] the is configuration in YANG JASON format
+    def self.insync_for_merge?(should, is)
+      should_hash = self.empty?(should) ? {} : JSON.parse(should)
+      is_hash = self.empty?(is) ? {} : JSON.parse(is)
+
+      !needs_something?(:merge, should_hash, is_hash)
+    end
+
+    # Given a is and should YANG configuration, returns true if
+    # the configuration are in-sync, relative to a "replace_config" action
+    # @param should [String] the should configuration in YANG JASON format
+    # @param is [String] the is configuration in YANG JASON format
+    def self.insync_for_replace?(should, is)
+      should_hash = self.empty?(should) ? {} : JSON.parse(should)
+      is_hash = self.empty?(is) ? {} : JSON.parse(is)
+
+      !needs_something?(:replace, should_hash, is_hash)
+    end
+
+    # usage:
+    #   needs_something?(op, should, run)
+    #
+    #   op     - symbol - If value is not :replace, it's assumed to be :merge.
+    #                     Indicates to the function whether to check for a
+    #                     possible merge vs. replace
+    #
+    #   should - JSON   - JSON tree representing target configuration
+    #
+    #   is     - JSON   - JSON tree representing current configuration
+    #
+    #
+    # Needs merge will determine if should and is differ
+    # sufficiently to necessitate running the merge command.
+    #
+    # The logic here amounts to determining if should is a subtree
+    # of is, with a tiny bit of domain trickiness surrounding
+    # elements that are arrays that contain a single nil element
+    # that is required for "creating" certain configuration elements.
+    #
+    # There are ultimately 3 different types of elements in a json
+    # tree.  Hashes, Arrays, and leaves.  While hashes and array values
+    # are organized with an order, the logic here ignores the order.
+    # In fact, it specifically attempts to match assuming order
+    # doesn't matter.  This is largely to allow users some freedom
+    # in specifying the target configuration.  The gRPC interface
+    # doesn't seem to care about order.  If that changes, then so
+    # should this code.
+    #
+    # Arrays and Hashes are compared by iterating over every element
+    # in should, and ensuring it is within is.
+    #
+    # Leaves are directly compared for equality, excepting the
+    # condition that the should leaf is in fact an array with one
+    # element that is nil.
+    #
+    # Needs replace will determine if should and is differ
+    # sufficiently to necessitate running the replace command.
+    #
+    # The logic is the same as merge, except when comparing
+    # hashes, if the is hash table has elements that are not
+    # in should, we ultimately indicate that replace is needed
+    def self.needs_something?(op, should, is)
+      !hash_equiv?(op, should, is)
+    end
+
+    def self.nil_array(elt)
+      elt.nil? || (elt.is_a?(Array) && elt.length == 1 && elt[0].nil?)
+    end
+
+    def self.sub_elt(op, should, is)
+      if should.is_a?(Hash) && is.is_a?(Hash)
+        return self.hash_equiv?(op, should, is)
+      elsif should.is_a?(Array) && is.is_a?(Array)
+        return self.array_equiv?(op, should, is)
+      else
+        return !(should != is && !nil_array(should))
+      end
+    end
+
+    def self.array_equiv?(op, should, is)
+      n = should.length
+      loop = lambda do|i|
+        if i == n
+          if op == :replace
+            is.length == should.length
+          else
+            true
+          end
+        else
+          should_elt = should[i]
+          is_elt = is.find do |elt|
+            sub_elt(op, should_elt, elt)
+          end
+          if is_elt.nil? && !nil_array(should_elt)
+            should_elt.nil?
+          else
+            loop.call(i + 1)
+          end
+        end
+      end
+      loop.call(0)
+    end
+
+    def self.hash_equiv?(op, should, is)
+      keys = should.keys
+      n = keys.length
+      loop = lambda do|i|
+        if i == n
+          if op == :replace
+            is.keys.length == should.keys.length
+          else
+            true
+          end
+        else
+          k = keys[i]
+          is_v = is[k]
+          should_v = should[k]
+          if is_v.nil? && !nil_array(should_v)
+            false
+          else
+            sub_elt(op, should_v, is_v) && loop.call(i + 1)
+          end
+        end
+      end
+      loop.call(0)
+    end
+  end # Yang
+end # Cisco

data/lib/cisco_node_utils/yum.rb

@@ -0,0 +1,213 @@
+#
+# NXAPI implementation of Yum class
+#
+# April 2015, Alex Hunsberger
+#
+# March 2017, Re-written by Mike Wiebe
+#
+# Copyright (c) 2015-2017 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_relative 'node_util'
+require_relative 'logger'
+
+module Cisco
+  # This Yum class provides cisco package management functions through nxapi.
+  class Yum < NodeUtil
+    def self.validate_installed(pkg)
+      # Sample data returned from config_get('yum', 'query_all')
+      # ["nxos.sample-n8k_EOR.lib32_nxos", "1.0.0-7.0.3.F1.1", "@patching"],
+      patch_data = config_get('yum', 'query_all')
+      patch_data.each do |name_arch, version, _state|
+        # Separate name and architecture
+        next if name_arch.rindex('.').nil?
+        arch = name_arch.slice!(name_arch.rindex('.')..-1).delete('.')
+        # Version/Architecture info not available when only pkg name specified.
+        version = arch = '' if name_arch == pkg
+        # Check for match
+        if pkg.match(name_arch) && pkg.match(version) && pkg.match(arch)
+          return true
+        end
+      end
+      fail 'Failed to install the requested rpm'
+    end
+
+    def self.detect_vrf
+      # Detect current namespace from agent environment
+      inode = File::Stat.new('/proc/self/ns/net').ino
+      # -L reqd for guestshell's find command
+      vrfname = File.basename(`find -L /var/run/netns/ -inum #{inode}`.chop)
+
+      vrf = 'vrf ' + vrfname unless vrfname.empty?
+      vrf
+    end
+
+    def self.install(pkg, vrf=nil)
+      vrf = vrf.nil? ? detect_vrf : "vrf #{vrf}"
+      begin
+        # get package name first
+        name = pkg_name(pkg)
+        # call remove if pkg exists
+        remove(name) unless name.empty?
+        add(pkg, vrf)
+        activate(pkg)
+        commit(pkg_name(pkg))
+        validate_installed(pkg)
+      rescue Cisco::CliError, RuntimeError => e
+        raise Cisco::CliError, "#{e.class}, #{e.message}"
+      end
+    end
+
+    # returns version of package, or false if package doesn't exist
+    def self.query(pkg)
+      fail TypeError unless pkg.is_a? String
+      fail ArgumentError if pkg.empty?
+      b = config_get('yum', 'query', pkg)
+      fail "Multiple matching packages found for #{pkg}" if b && b.size > 1
+      b.nil? ? nil : b.first
+    end
+
+    def self.remove(pkg)
+      # get committed state
+      cstate = query_committed(pkg)
+      # get activated state
+      astate = query_activated(pkg)
+
+      if astate && cstate
+        # pkg is active and committed
+        # so deactivate, commit and remove
+        deactivate(pkg)
+        commit_deactivate(pkg)
+        delete(pkg)
+      elsif cstate
+        # pkg is inactive and committed
+        # so commit and remove
+        commit_deactivate(pkg)
+        delete(pkg)
+      elsif astate
+        # pkg is active and not committed
+        # so deactivate and remove
+        deactivate(pkg)
+        delete(pkg)
+      else
+        # pkg is inactive and not committed
+        # so just remove
+        delete(pkg)
+      end
+    rescue Cisco::CliError, RuntimeError => e
+      raise Cisco::CliError, "#{e.class}, #{e.message}"
+    end
+
+    def self.add(pkg, vrf=nil)
+      try_operation('add', pkg, vrf)
+      while (try ||= 1) < 20
+        return if query_added(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to add pkg: #{pkg}, using vrf #{vrf}"
+    end
+
+    def self.activate(pkg)
+      try_operation('activate', pkg)
+      while (try ||= 1) < 20
+        return if query_activated(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to activate pkg: #{pkg}"
+    end
+
+    def self.commit(pkg)
+      try_operation('commit', pkg)
+      while (try ||= 1) < 20
+        return if query_committed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to commit pkg: #{pkg}"
+    end
+
+    def self.commit_deactivate(pkg)
+      try_operation('commit', pkg)
+      while (try ||= 1) < 20
+        return unless query_committed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to commit after deactivate pkg: #{pkg}"
+    end
+
+    def self.deactivate(pkg)
+      try_operation('deactivate', pkg)
+      while (try ||= 1) < 20
+        return if query_inactive(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to deactivate pkg: #{pkg}"
+    end
+
+    def self.delete(pkg)
+      try_operation('remove', pkg)
+      while (try ||= 1) < 20
+        return if query_removed(pkg)
+        sleep 1
+        try += 1
+      end
+      fail "Failed to delete pkg: #{pkg}"
+    end
+
+    def self.try_operation(operation, pkg, vrf=nil)
+      args = vrf.nil? ? { pkg: pkg } : { pkg: pkg, vrf: vrf }
+      while (try ||= 1) < 20
+        o = config_set('yum', operation, args)
+        break unless o[/Another install operation is in progress/]
+        sleep 1
+        try += 1
+      end
+    end
+
+    def self.pkg_name(pkg)
+      config_get('yum', 'pkg_name', pkg: pkg)
+    end
+
+    def self.query_activated(pkg)
+      config_get('yum', 'query_activated', pkg: pkg)
+    end
+
+    def self.query_added(pkg)
+      config_get('yum', 'query_added', pkg: pkg)
+    end
+
+    def self.query_committed(pkg)
+      o = config_get('yum', 'query_committed', pkg: pkg)
+      return false if o.nil?
+      o.include? pkg
+    end
+
+    def self.query_inactive(pkg)
+      config_get('yum', 'query_inactive', pkg: pkg)
+    end
+
+    def self.query_removed(pkg)
+      val = config_get('yum', 'query_removed', pkg: pkg)
+      val ? false : true
+    end
+
+    def self.query_state(pkg)
+      config_get('yum', 'query_state', pkg: pkg).downcase
+    end
+  end
+end

data/lib/cisco_node_utils.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2014-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.
+
+# Declare module here as files referenced in glob-order below may assume
+# module already exists.
+module Cisco
+end
+
+# Automatically load all Ruby files in the cisco_node_utils subdirectory
+Dir.glob(__dir__ + '/cisco_node_utils/*.rb') { |file| require file }

data/lib/minitest/environment_plugin.rb

@@ -0,0 +1,31 @@
+# March 2016, Glenn F. Matthews
+#
+# 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.
+
+require_relative '../cisco_node_utils/environment'
+
+# Add environment option to minitest
+module Minitest
+  def self.plugin_environment_options(opts, options)
+    opts.on('-e', '--environment NAME', 'Select environment by name') do |name|
+      options[:environment] = name
+    end
+  end
+
+  def self.plugin_environment_init(options)
+    name = options[:environment]
+    Cisco::Environment.default_environment_name = name unless name.nil?
+  end
+end

data/lib/minitest/log_level_plugin.rb

@@ -0,0 +1,41 @@
+# March 2016, Glenn F. Matthews
+#
+# 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.
+
+require 'logger'
+require_relative '../cisco_node_utils/logger'
+
+# Add logging level option to minitest
+module Minitest
+  LEVEL_ALIASES = {
+    'debug'   => Logger::DEBUG,
+    'info'    => Logger::INFO,
+    'warning' => Logger::WARN,
+    'error'   => Logger::ERROR,
+  }
+  def self.plugin_log_level_options(opts, options)
+    opts.on(
+      '-l', '--log-level LEVEL', LEVEL_ALIASES,
+      'Configure logging level for tests',
+      "(#{LEVEL_ALIASES.keys.join(', ')})"
+    ) do |level|
+      options[:log_level] = level
+    end
+  end
+
+  def self.plugin_log_level_init(options)
+    Cisco::Logger.level = options[:log_level] if options[:log_level]
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper.rb'
+require 'shared_examples_for_clients'
+require 'cisco_node_utils/client'
+
+describe Cisco::Client do
+  it_behaves_like 'all clients'
+end