oxidized 0.36.0 → 0.37.0

data/lib/oxidized/input/debugtext.rb

@@ -0,0 +1,40 @@
+module Oxidized
+  class DebugText
+    include SemanticLogger::Loggable
+
+    def initialize(config_debug, node, input_name)
+      return unless config_debug == true ||
+                    (config_debug.is_a?(String) && config_debug.downcase.include?('text'))
+
+      @log = File.open(logfile(node, input_name), 'w')
+    end
+
+    # Separate method to ease unit tests
+    def logfile(node, input_name)
+      timestamp = Time.now.strftime('%Y%m%d-%H%M%S')
+      file = Oxidized::Config::LOG + "/#{node&.ip}-#{input_name}-#{timestamp}.txt"
+      logger.debug "Writing I/O Debugging to #{file}"
+      file
+    end
+
+    def send_data(data)
+      return unless @log
+
+      @log.puts "sent cmd #{data.dump}"
+      @log.flush
+    end
+
+    def receive_data(data)
+      return unless @log
+
+      @log.puts "received #{data.dump}"
+      @log.flush
+    end
+
+    def close
+      return unless @log
+
+      @log.close
+    end
+  end
+end

data/lib/oxidized/input/debugyaml.rb

@@ -0,0 +1,82 @@
+module Oxidized
+  class DebugYAML
+    include SemanticLogger::Loggable
+
+    def initialize(config_debug, node, input_name)
+      return unless config_debug == true ||
+                    (config_debug.is_a?(String) && config_debug.downcase.include?('yaml'))
+
+      @log = File.open(logfile(node, input_name), 'w')
+
+      @partial_line = false
+      @first_line = true
+      @commands_started = false
+
+      @log.puts '---'
+      @log.puts 'init_prompt: |-'
+      @log.flush
+    end
+
+    # Separate method to ease unit tests
+    def logfile(node, input_name)
+      timestamp = Time.now.strftime('%Y%m%d-%H%M%S')
+      file = Oxidized::Config::LOG + "/#{node&.ip}-#{input_name}-#{timestamp}.yaml"
+      logger.debug "Writing YAML Simulation to #{file}"
+      file
+    end
+
+    def send_data(data)
+      return unless @log
+
+      @log.puts
+      @log.puts 'commands:' unless @commands_started
+      @log.puts "  - #{data.dump}: |-"
+      @first_line = true
+      @partial_line = false
+      @commands_started = true
+      @log.flush
+    end
+
+    def receive_data(data)
+      return unless @log
+      return if data.empty?
+
+      lines = data.split("\n", -1)
+
+      lines.each_with_index do |line, idx|
+        is_last = idx == lines.length - 1
+        full_line = is_last ? (data[-1] == "\n") : true
+        # Escape line and strip surrounding double quotes
+        line = line.dump[1..-2]
+        if @first_line
+          # Make sure the leading space of the first line (if present)
+          # is coded with \0x20 or YAML block scalars won't work
+          line.sub!(/^ /, '\x20')
+          @first_line = false
+        end
+
+        # Make sure trailing white spaces are coded with \0x20
+        line.gsub!(/ $/, '\x20')
+
+        output = @partial_line ? line : ('      ' + line)
+        @partial_line = false
+
+        if full_line
+          @log.puts output
+        else
+          @log.write output
+        end
+      end
+
+      @partial_line = data[-1] != "\n"
+
+      @log.flush
+    end
+
+    def close
+      return unless @log
+
+      @log.close
+    end
+  end
+end

data/lib/oxidized/input/exec.rb

@@ -2,7 +2,6 @@ module Oxidized
   class Exec < Input
     def connect(node)
       @node = node
-      @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-exec", "w") if Oxidized.config.input.debug?
       @node.model.cfg["exec"].each { |cb| instance_exec(&cb) }
     end
 
@@ -15,10 +14,6 @@ module Oxidized
 
     private
 
-    def disconnect
-      true
-    ensure
-      @log.close if Oxidized.config.input.debug?
-    end
+    def disconnect; end
   end
 end

data/lib/oxidized/input/ftp.rb

@@ -5,7 +5,6 @@ module Oxidized
     def connect(node) # rubocop:disable Naming/PredicateMethod
       @node = node
       @node.model.cfg['ftp'].each { |cb| instance_exec(&cb) }
-      @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-ftp", 'w') if Oxidized.config.input.debug?
       @ftp = Net::FTP.new(@node.ip)
       @ftp.passive = Oxidized.config.input.ftp.passive
       @ftp.login @node.auth[:username], @node.auth[:password]
@@ -34,9 +33,6 @@ module Oxidized
 
     def disconnect
       @ftp.close
-    # rescue Errno::ECONNRESET, IOError
-    ensure
-      @log.close if Oxidized.config.input.debug?
     end
   end
 end

data/lib/oxidized/input/http.rb

@@ -10,7 +10,6 @@ module Oxidized
       @username = nil
       @password = nil
       @headers = {}
-      @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-http", "w") if Oxidized.config.input.debug?
       @node.model.cfg["http"].each { |cb| instance_exec(&cb) }
 
       return true unless @main_page && defined?(login)
@@ -110,13 +109,7 @@ module Oxidized
       "Basic " + ["#{@username}:#{@password}"].pack('m').delete("\r\n")
     end
 
-    def log(str)
-      @log&.write(str)
-    end
-
-    def disconnect
-      @log.close if Oxidized.config.input.debug?
-    end
+    def disconnect; end
 
     def get_uri(path)
       path = URI.parse(path)

data/lib/oxidized/input/ssh.rb

@@ -1,7 +1,9 @@
-module Oxidized
-  require 'timeout'
-  require_relative 'sshbase'
+require 'timeout'
+require_relative 'sshbase'
+require_relative 'debugyaml'
+require_relative 'debugtext'
 
+module Oxidized
   class SSH < SSHBase
     class NoShell < OxidizedError; end
 
@@ -18,11 +20,9 @@ module Oxidized
       @output      = String.new('')
       @pty_options = { term: "vt100" }
       @node.model.cfg['ssh'].each { |cb| instance_exec(&cb) }
-      if Oxidized.config.input.debug?
-        logfile = Oxidized::Config::LOG + "/#{@node.ip}-ssh"
-        @log = File.open(logfile, 'w')
-        logger.debug "I/O Debuging to #{logfile}"
-      end
+
+      @yaml_debug = DebugYAML.new(Oxidized.config.input.debug, @node, config_name)
+      @text_debug = DebugText.new(Oxidized.config.input.debug, @node, config_name)
 
       logger.debug "Connecting to #{@node.name}"
       @ssh = Net::SSH.start(@node.ip, @node.auth[:username], make_ssh_opts)
@@ -38,25 +38,30 @@ module Oxidized
     end
 
     def cmd(cmd, expect = node.prompt)
-      logger.debug "Sending '#{cmd.dump}' @ #{node.name} with expect: #{expect.inspect}"
-      if Oxidized.config.input.debug?
-        @log.puts "sent cmd #{@exec ? cmd.dump : (cmd + newline).dump}"
-        @log.flush
+      unless cmd.is_a?(String)
+        logger.error "cmd must be a String (#{cmd.class}): #{cmd.inspect} @ #{node.name}"
+        raise ArgumentError, "cmd must be a String"
       end
+      logger.debug "Sending '#{cmd.dump}' @ #{node.name} with expect: #{expect.inspect}"
       cmd_output = if @exec
+                     @yaml_debug&.send_data(cmd)
+                     @text_debug&.send_data(cmd)
                      @ssh.exec! cmd
                    else
                      cmd_shell(cmd, expect).gsub("\r\n", "\n")
                    end
+
+      # only logging @exec as cmd_shell is handled in the ssh loop
+      @yaml_debug&.receive_data(cmd_output) if @exec
+      @text_debug&.receive_data(cmd_output) if @exec
+
       # Make sure we return a String
       cmd_output.to_s
     end
 
     def send(data)
-      if Oxidized.config.input.debug?
-        @log.puts "sent data #{data.dump}"
-        @log.flush
-      end
+      @yaml_debug&.send_data(data)
+      @text_debug&.send_data(data)
       @ses.send_data data
     end
 
@@ -79,17 +84,16 @@ module Oxidized
     rescue Timeout::Error
       logger.debug "#{@node.name} timed out while disconnecting"
     ensure
-      @log.close if Oxidized.config.input.debug?
+      @yaml_debug&.close
+      @text_debug&.close
       (@ssh.close rescue true) unless @ssh.closed? # rubocop:disable Style/RedundantParentheses
     end
 
     def shell_open(ssh)
       @ses = ssh.open_channel do |ch|
         ch.on_data do |_ch, data|
-          if Oxidized.config.input.debug?
-            @log.puts "received #{data.dump}"
-            @log.flush
-          end
+          @yaml_debug&.receive_data(data)
+          @text_debug&.receive_data(data)
           @output << data
           @output = @node.model.expects @output
         end
@@ -111,6 +115,9 @@ module Oxidized
 
     def cmd_shell(cmd, expect_re)
       @output = String.new('')
+
+      @yaml_debug&.send_data(cmd + newline)
+      @text_debug&.send_data(cmd + newline)
       @ses.send_data cmd + newline
       @ses.process
       expect expect_re if expect_re

data/lib/oxidized/input/sshbase.rb

@@ -18,7 +18,6 @@ module Oxidized
     def connect(node) # rubocop:disable Naming/PredicateMethod
       @node = node
       @node.model.cfg[config_name].each { |cb| instance_exec(&cb) }
-      setup_debug_logging
       logger.debug "Connecting to #{@node.name}"
       @ssh = Net::SSH.start(@node.ip, @node.auth[:username], make_ssh_opts)
       connected?
@@ -28,14 +27,6 @@ module Oxidized
       @ssh && (not @ssh.closed?)
     end
 
-    def setup_debug_logging
-      return unless Oxidized.config.input.debug?
-
-      logfile = Oxidized::Config::LOG + "/#{@node.ip}-#{config_name}"
-      @log = File.open(logfile, 'w')
-      logger.debug "I/O Debugging to #{logfile}"
-    end
-
     def make_ssh_opts
       ssh_opts = {
         number_of_password_prompts:      0,
@@ -65,7 +56,13 @@ module Oxidized
 
       # Use our logger for Net::SSH
       ssh_logger = SemanticLogger[Net::SSH]
-      ssh_logger.level = Oxidized.config.input.debug? ? :debug : :fatal
+      config_debug = Oxidized.config.input.debug
+      if config_debug == true ||
+         (config_debug.is_a?(String) && config_debug.downcase.include?('library'))
+        ssh_logger.level = :debug
+      else
+        ssh_logger.level = :fatal
+      end
       ssh_opts[:logger] = ssh_logger
 
       ssh_opts
@@ -95,8 +92,6 @@ module Oxidized
                    "disconnecting, raising #{e.class} with #{e.message}"
     rescue Timeout::Error
       logger.debug "#{@node.name} timed out while disconnecting"
-    ensure
-      @log.close if Oxidized.config.input.debug?
     end
 
     # Methods to implement in subclasses

data/lib/oxidized/input/telnet.rb

@@ -1,3 +1,5 @@
+require_relative 'debugtext'
+
 module Oxidized
   require 'net/telnet'
   class Telnet < Input
@@ -7,7 +9,9 @@ module Oxidized
       @node    = node
       @timeout = @node.timeout
       @node.model.cfg['telnet'].each { |cb| instance_exec(&cb) }
-      @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-telnet", 'w') if Oxidized.config.input.debug?
+
+      @text_debug = DebugText.new(Oxidized.config.input.debug, @node, config_name)
+
       port = vars(:telnet_port) || 23
 
       telnet_opts = {
@@ -15,7 +19,7 @@ module Oxidized
         'Port'    => port.to_i,
         'Timeout' => @timeout,
         'Model'   => @node.model,
-        'Log'     => @log
+        'Log'     => @text_debug
       }
 
       @telnet = Net::Telnet.new telnet_opts
@@ -38,12 +42,14 @@ module Oxidized
       # create a string to be passed to oxidized_expect and modified _there_
       # default to a single space so it shouldn't be coerced to nil by any models.
       out = String(' ')
+      @text_debug&.send_data(cmd_str)
       @telnet.puts(cmd_str)
       @telnet.oxidized_expect(timeout: @timeout, expect: expect, out: out)
       out
     end
 
     def send(data)
+      @text_debug&.send_data(data)
       @telnet.write data
     end
 
@@ -63,7 +69,7 @@ module Oxidized
     rescue Errno::ECONNRESET, IOError
       # This exception is intented and therefore not handled here
     ensure
-      @log.close if Oxidized.config.input.debug?
+      @text_debug&.close
       (@telnet.close rescue true) unless @telnet.sock.closed? # rubocop:disable Style/RedundantParentheses
     end
   end
@@ -76,8 +82,8 @@ module Net
     attr_reader :output
 
     def oxidized_expect(options)
-      model    = @options["Model"]
-      @log     = @options["Log"]
+      model      = @options["Model"]
+      text_debug = @options["Log"]
 
       expects  = [options[:expect]].flatten
       time_out = options[:timeout] || @options["Timeout"]
@@ -103,10 +109,7 @@ module Net
             buf = preprocess(c)
             rest = ''
           end
-          if Oxidized.config.input.debug?
-            @log.print buf
-            @log.flush
-          end
+          text_debug&.receive_data buf
           line += buf
           line = model.expects line
           # match is a regexp object. we need to return that for logins to work.

data/lib/oxidized/input/tftp.rb

@@ -20,7 +20,6 @@ module Oxidized
       @node = node
 
       @node.model.cfg['tftp'].each { |cb| instance_exec(&cb) }
-      @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-tftp", 'w') if Oxidized.config.input.debug?
       @tftp = Net::TFTP.new @node.ip
     end
 
@@ -36,9 +35,6 @@ module Oxidized
 
     def disconnect
       # TFTP uses UDP, there is no connection to close
-      true
-    ensure
-      @log.close if Oxidized.config.input.debug?
     end
   end
 end

data/lib/oxidized/model/aoscx.rb

@@ -37,22 +37,23 @@ class Aoscx < Oxidized::Model
     comment cfg
   end
 
-  cmd 'show environment' do |cfg|
-    def with_section(cfg, section, &block)
-      cfg.sub!(/(show environment #{section}.*?-{10,}\n)(.*?)(?=\nshow environment|\z)/m) do
-        header = ::Regexp.last_match(1)
-        content = ::Regexp.last_match(2)
-        block.call(content) if block_given?
-        header + content
-      end
+  def with_section(cfg, section, &block)
+    cfg.sub!(/(show environment #{section}.*?-{10,}\n)(.*?)(?=\nshow environment|\z)/m) do
+      header = ::Regexp.last_match(1)
+      content = ::Regexp.last_match(2)
+      block.call(content) if block_given?
+      header + content
     end
+  end
 
+  cmd 'show environment' do |cfg|
     with_section(cfg, 'fan') do |content|
       content.gsub!(/^((?:\S+ +){3})(slow  |normal|medium|fast  |max   |N\/A   ) (.*?)\d+ +$/, '\\1<speed> \\3<rpm>')
     end
 
     with_section(cfg, 'power-consumption') do |content|
       content.gsub!(/^(.*?) (?:\d+\.\d+ +)+\d+\.\d+$/, '\\1 <power hidden>')
+      content.gsub!(/^(Total Power Consumption +)\d+\.\d+$/, '\\1<power hidden>')
     end
 
     with_section(cfg, 'power-allocation') do |content|
@@ -73,7 +74,10 @@ class Aoscx < Oxidized::Model
     comment cfg
   end
 
-  cmd 'show system | exclude "Up Time" | exclude "CPU" | exclude "Memory" | exclude "Pkts .x" | exclude "Lowest" | exclude "Missed"' do |cfg|
+  cmd 'show system' do |cfg|
+    cfg = cfg.reject_lines [
+      "Up Time", "CPU", "Memory", /Pkts .x/, "Lowest", "Missed"
+    ]
     comment cfg
   end
 

data/lib/oxidized/model/cumulus.rb

@@ -5,9 +5,9 @@ class Cumulus < Oxidized::Model
   # ^                 : match begin of line, to have the most specific prompt
   # [\w.-]+@[\w.-]+   : user@hostname
   # (:mgmt)?          : optional when logged in out of band
-  # :~[#$] $          : end of prompt, containing the linux path,
-  #                     which is always "~" in our context
-  prompt /^[\w.-]+@[\w.-]+(:mgmt)?:~[#$] $/
+  # :?~[#$] ?$        : end of prompt, containing the linux path,
+  #                     which is always "~" in our context.
+  prompt /^[\w.-]+@[\w.-]+(:mgmt)?:?~[#$] ?$/
   clean :escape_codes
   comment '# '
 

data/lib/oxidized/model/dlinknextgen.rb

@@ -8,6 +8,7 @@ class DlinkNextGen < Oxidized::Model
   comment '# '
 
   cmd :all do |cfg|
+    cfg.gsub!("\0", "") # Remove NULL bytes that cause Git to detect the file as binary
     cfg.each_line.to_a[2..-2].map { |line| line.delete("\r").rstrip }.join("\n") + "\n"
   end
 

data/lib/oxidized/model/fortigate.rb

@@ -103,7 +103,7 @@ class FortiGate < Oxidized::Model
     cfg = cfg.keep_lines [
       /^Interface \w/,
       "Vendor Name",
-      "Part No./",
+      "Part No.",
       "Serial No."
     ]
     cfg = cfg.reject_lines ["Transceiver is not detected"]

data/lib/oxidized/model/grandstreamht8xx.rb

@@ -0,0 +1,19 @@
+class GrandstreamHT8xx < Oxidized::Model
+  using Refinements
+
+  # Anchored prompt to avoid matching XML content
+  prompt /^(GS|CONFIG)>\s?$/
+  comment '# '
+
+  cfg :ssh do
+    # After login go to configuration submenu (looks like enabled in other devices)
+    post_login 'config'
+    # When logout use double exit - first from configuration submenu, and second to disconnect from device
+    pre_logout 'exit'
+    pre_logout 'exit'
+  end
+
+  cmd 'export' do |cfg|
+    cfg.cut_both
+  end
+end

data/lib/oxidized/model/ios.rb

@@ -112,6 +112,8 @@ class IOS < Oxidized::Model
         comments << "CPU:#{slave} #{cpu}#{cpuxtra}#{slaveslot}"
       end
 
+      comments << line.chomp if line.start_with?('Motherboard')
+
       comments << "Image: #{Regexp.last_match(1)}" if line =~ /^System image file is "([^"]*)"$/
     end
     comments << "\n"

data/lib/oxidized/model/junos.rb

@@ -44,8 +44,8 @@ class JunOS < Oxidized::Model
 
   cmd('show chassis hardware') { |cfg| comment cfg }
   cmd('show system license') do |cfg|
-    cfg.gsub!(/  fib-scale\s+(\d+)/, '  fib-scale                       <count>')
-    cfg.gsub!(/  rib-scale\s+(\d+)/, '  rib-scale                       <count>')
+    cfg.gsub!(/  fib[-\s]scale\s+(\d+)/i, '  fib-scale                       <count>')
+    cfg.gsub!(/  rib[-\s]scale\s+(\d+)/i, '  rib-scale                       <count>')
     comment cfg
   end
   cmd('show system license keys') { |cfg| comment cfg }

data/lib/oxidized/model/linuxgeneric.rb

@@ -1,8 +1,9 @@
 class LinuxGeneric < Oxidized::Model
   using Refinements
 
-  prompt /^(\w.*|\W.*)[:#$] /
+  prompt /^\S.*[#$] $/
   comment '# '
+  clean :escape_codes
 
   # add a comment in the final conf
   def add_comment(comment)
@@ -53,7 +54,7 @@ class LinuxGeneric < Oxidized::Model
   end
 
   cfg :telnet do
-    username /^Username:/
+    username /(Username|[Ll]ogin):/
     password /^Password:/
   end
 
@@ -63,6 +64,7 @@ class LinuxGeneric < Oxidized::Model
         cmd "sudo su -", /^\[sudo\] password/
         cmd @node.auth[:password]
       elsif vars(:enable)
+        # This will only work without localisation (de: "Passwort:", fr: "Mot de passe :"...)
         cmd "su -", /^Password:/
         cmd vars(:enable)
       end

data/lib/oxidized/model/nxos.rb

@@ -10,7 +10,10 @@ class NXOS < Oxidized::Model
 
   cmd :secret do |cfg|
     cfg.gsub! /^(snmp-server community).*/, '\\1 <secret hidden>'
-    cfg.gsub! /^(snmp-server user (\S+) (\S+) auth (\S+)) (\S+) (priv) (\S+)/, '\\1 <secret hidden> '
+    cfg.gsub!(
+      /^(snmp-server user \S+ \S+ auth \S+) \S+ (priv \S+) \S+ /,
+      '\\1 <secret hidden> \\2 <secret hidden> '
+    )
     cfg.gsub! /^(snmp-server host.*? )\S+( udp-port \d+)?$/, '\\1<secret hidden>\\2'
     cfg.gsub! /^(snmp-server mib community-map) \S+ ?(.*)/, '\\1 <secret hidden> \\2'
     cfg.gsub! /(password \d+) (\S+)/, '\\1 <secret hidden>'

data/lib/oxidized/model/routeros.rb

@@ -29,6 +29,10 @@ class RouterOS < Oxidized::Model
     comment cfg
   end
 
+  cmd :significant_changes do |cfg|
+    cfg.gsub(/^(#\s+installed-version: [^\n]+\n).*?^(?=# software id)/m, '\1')
+  end
+
   post do
     logger.debug "Running /export for routeros version #{@ros_version}"
     run_cmd = if vars(:remove_secret)

data/lib/oxidized/model/tplink.rb

@@ -48,19 +48,17 @@ class TPLink < Oxidized::Model
     lines[0..lines.index("end\n")].join
   end
 
+  macro :enable, regex: /^[pP]assword:/
+
   cfg :telnet, :ssh do
     username /^User ?[nN]ame:/
     password /^\r?Password:/
+    newline "\r\n"
   end
 
   cfg :telnet, :ssh do
     post_login do
-      if vars(:enable) == true
-        cmd "enable"
-      elsif vars(:enable)
-        cmd "enable", /^[pP]assword:/
-        cmd vars(:enable)
-      end
+      cmd 'terminal length 0'
     end
 
     pre_logout do