net-connector 0.4.0

data/lib/net/connector/vendor/cisco_ios/running_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../../device/running_config/strategy"
+
+module Net
+  module Connector
+    module CiscoIos
+      class RunningConfig < Net::Connector::RunningConfig::Rendered
+        def clean(text)
+          config = super
+          config.gsub!(/^[^\n]*#\s*terminal\s+length\s+0\s*\n/i, "")
+          config.sub!(/^[^\n]*#\s*copy\s+run(?:ning-config)?\s+(?:start|startup-config)\s*\n.*\z/im, "")
+          config.gsub!(/^!.*(?:Last\s+configuration\s+change|NVRAM\s+config).*\n/i, "")
+          config
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_ios/tftp_backup.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/tftp/strategy"
+
+module Net
+  module Connector
+    module CiscoIos
+      class TftpBackup < Operations::Tftp::Strategy
+        # 构造当前厂商的 TFTP 导出交互脚本。
+        def script(target, source_file:, vrf: nil)
+          raise ArgumentError, "Cisco IOS does not use source_file" if source_file
+          raise ArgumentError, "Cisco IOS TFTP backup does not use vrf" if vrf
+
+          Script.new([Command.new("copy running-config tftp:", timeout: 180,
+                                  interactions: [
+                                    interaction(/Address\s+or\s+name\s+of\s+remote\s+host\s*\[[^\]]*\]\?\s*\z/i,
+                                                "#{target.host}\n"),
+                                    interaction(/Destination\s+filename\s*\[[^\]]*\]\?\s*\z/i,
+                                                "#{target.path}\n")
+                                  ])])
+        end
+
+        # 检查设备回显是否确认 TFTP 传输完成。
+        def complete?(result)
+          completion_lines(result).any? do |line|
+            copied_bytes?(line) || line.match?(/\A\[OK(?:\s*-\s*[1-9]\d*\s+bytes)?\]\z/i)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_ios/topology.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/topology/strategy"
+
+module Net
+  module Connector
+    module CiscoIos
+      class Topology < Operations::Topology::Strategy
+        def self.supports?(capability)
+          %i[neighbors interface_descriptions interface_description_changes].include?(capability)
+        end
+
+        def neighbor_command = "show cdp neighbors detail"
+        def description_template = "cisco_ios_running_config_interfaces.textfsm"
+        def protocol = :cdp
+        def enter_configuration = "configure terminal"
+        def finish_commands = ["end"] + @device.profile.save_commands
+
+        def expected_neighbor_count(output, _template)
+          output.scan(/^\s*Device ID:\s*\S+/i).size
+        end
+
+        def empty_neighbor_output?(output)
+          output.match?(/Total cdp entries displayed\s*:\s*0|no cdp neighbors/i)
+        end
+
+        def change_commands(change)
+          InterfaceDescription.commands(interface: change.interface, description: change.new_description)
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_ios.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../device/base"
+require_relative "cisco_ios/running_config"
+require_relative "cisco_ios/tftp_backup"
+require_relative "cisco_ios/topology"
+
+module Net
+  module Connector
+    module CiscoIos
+      # Cisco IOS 和 IOS-XE 配置采集连接器。
+      class Connector < Net::Connector::Base
+        vendor :cisco_ios
+        # 声明 IOS 的命令、提示、分页、诊断和保存确认规则。
+        profile do
+          running_config_strategy Net::Connector::CiscoIos::RunningConfig
+          tftp_strategy Net::Connector::CiscoIos::TftpBackup
+          topology_strategy Net::Connector::CiscoIos::Topology
+          commands do
+            running_config "terminal length 0", "show running-config"
+            save_config "copy running-config startup-config"
+          end
+
+          prompts do
+            login(/(?:\A|(?<=[\r\n]))\S+[>#]\s*\z/)
+            command(/(?:\A|(?<=[\r\n]))\S+#\s*\z/)
+          end
+
+          pager do
+            pattern(/(?:\A|(?<=[\r\n]))[^\S\r\n]*--More--[^\r\n]*(?=\r|\n|\z)/i)
+          end
+
+          errors do
+            command(/^[ \t]*%[ \t]+(?:Invalid|Incomplete|Ambiguous)\s+(?:input|command)\b/i, /^[ \t]*\^/)
+          end
+
+          command_timeout 60
+
+          interactions do
+            confirm(/Destination\s+filename\s+\[[^\]]+\]\?\s*\z/i, response: "\n")
+            confirm(%r{Do\s+you\s+want\s+to\s+overwrite\?\s*\[yes/no\]\s*\z}i, response: "yes\n")
+            confirm(/Proceed\s+with\s+copy\?\s*\[confirm\]\s*\z/i, response: "\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_nxos/running_config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../cisco_ios/running_config"
+
+module Net
+  module Connector
+    module CiscoNxos
+      class RunningConfig < CiscoIos::RunningConfig
+        def clean(text)
+          without_pager = text.to_s.gsub(
+            /[ \t]*(?:\x1b\[[0-9;]*[A-Za-z])*--More--
+              (?:\x1b\[[0-9;]*[A-Za-z])*(?:[\r\x00\x08 ]|\x1b\[[0-9;]*[A-Za-z])*/ix, ""
+          )
+          config = super(without_pager)
+          config.sub!(/\A.*?^(?=[^\n]*#\s*show\s+running-config\s*$)/im, "")
+          config.gsub(/^[ \t]*(?:\[[# ]*\]|\])[ \t]*\d+%[ \t]*\n?/i, "")
+                .gsub(/^[ \t]*Copy\s+complete\b[^\n]*\n?/i, "")
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_nxos/tftp_backup.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/tftp/strategy"
+
+module Net
+  module Connector
+    module CiscoNxos
+      class TftpBackup < Operations::Tftp::Strategy
+        # 构造当前厂商的 TFTP 导出交互脚本。
+        def script(target, source_file:, vrf: nil)
+          raise ArgumentError, "Cisco NX-OS does not use source_file" if source_file
+
+          vrf ||= "management"
+          command = "copy running-config tftp://#{target.host}/#{target.path} vrf #{vrf}"
+          Script.new([Command.new(command, timeout: 180,
+                                  interactions: [
+                                    interaction(/Enter\s+vrf\s*\([^\r\n]*\):\s*\z/i,
+                                                "#{vrf}\n")
+                                  ])])
+        end
+
+        # 检查设备回显是否确认 TFTP 传输完成。
+        def complete?(result)
+          completion_lines(result).any? do |line|
+            line.match?(/\A
+              (?:transfer|copy)(?:\s+operation)?\s+
+              (?:success(?:ful(?:ly)?)?|succeeded|complete(?:d)?(?:\s+successfully)?)[.!]?
+              \z/ix) || copied_bytes?(line)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/cisco_nxos.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "../device/base"
+require_relative "cisco_nxos/running_config"
+require_relative "cisco_nxos/tftp_backup"
+require_relative "cisco_ios/topology"
+
+module Net
+  module Connector
+    module CiscoNxos
+      # Cisco Nexus 9000 和 NX-OS 配置采集连接器。
+      class Connector < Net::Connector::Base
+        vendor :cisco_nxos
+        # 声明 NX-OS 的命令、提示、分页、诊断和保存确认规则。
+        profile do
+          running_config_strategy Net::Connector::CiscoNxos::RunningConfig
+          tftp_strategy Net::Connector::CiscoNxos::TftpBackup
+          topology_strategy Net::Connector::CiscoIos::Topology
+          commands do
+            running_config "terminal length 0", "show running-config"
+            save_config "copy run start"
+          end
+
+          prompts do
+            login(/\S+[>#]\s*\z/)
+            command(/\S+#\s*\z/)
+          end
+
+          pager do
+            pattern(/(?:\A|(?<=[\r\n]))[ \t]*(?:\x1b\[[0-9;]*[A-Za-z])*--More--
+              (?:[ \t\x00\x08]|\x1b\[[0-9;]*[A-Za-z])*(?=\r|\n|\z)/ix)
+          end
+
+          errors do
+            command(
+              /^[ \t]*%?[ \t]*(?:(?:Invalid|Ambiguous|Incomplete)\s+command(?:\s+\([^)]+\))?|
+                Invalid\s+parameter\s+detected)\s+at\s+'\^'\s+marker\./ix,
+              /^[ \t]*\^/,
+              /^[ \t]*%[ \t]+(?:Invalid|Ambiguous|Incomplete)\s+command\b/i,
+              /^[ \t]*%?[ \t]*Invalid\s+parameter\s+detected\b/i,
+              /^[ \t]*syntax\s+error\b/i
+            )
+          end
+
+          command_timeout 60
+
+          interactions do
+            confirm(/Destination\s+filename\s+\[[^\]]+\]\?\s*\z/i, response: "\n")
+            confirm(%r{Do\s+you\s+want\s+to\s+overwrite\?\s*\[yes/no\]\s*\z}i, response: "yes\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/h3c/tftp_backup.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/tftp/strategy"
+
+module Net
+  module Connector
+    module H3c
+      class TftpBackup < Operations::Tftp::Strategy
+        # 选取并校验 H3C 启动配置文件路径。
+        def source_file(value)
+          return TftpTarget.validate_source_file!(value) if value
+
+          output = @device.execute("display startup").value!
+          rendered = TerminalRenderer.render(output)
+          path = rendered[/^\s*Next main startup saved-configuration file:\s*(\S+)/i, 1]
+          path ||= rendered[/^\s*Current startup saved-configuration file:\s*(\S+)/i, 1]
+          if path.nil? || path.casecmp?("NULL")
+            raise DeviceError.new("device has no saved startup configuration",
+                                  code: :startup_config_missing, host: @device.host, phase: :tftp_backup)
+          end
+
+          TftpTarget.validate_source_file!(path.sub(/\(\*\)\z/, ""))
+        end
+
+        # 根据 H3C 源文件确定默认导出名称。
+        def default_path(source_file) = File.basename(source_file)
+
+        # 构造当前厂商的 TFTP 导出交互脚本。
+        def script(target, source_file:, vrf: nil)
+          raise ArgumentError, "H3C TFTP backup does not use vrf" if vrf
+
+          destination = target.explicit_path? ? " #{target.path}" : ""
+          Script.new([Command.new("tftp #{target.host} put #{source_file}#{destination}", timeout: 180)])
+        end
+
+        # 检查设备回显是否确认 TFTP 传输完成。
+        def complete?(result)
+          completion_lines(result).any? { |line| completed_upload?(line) }
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/h3c/topology.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/topology/strategy"
+
+module Net
+  module Connector
+    module H3c
+      class Topology < Operations::Topology::Strategy
+        TABLE_HEADER = /^\s*(?:System Name\s+Local Interface\b|(?:Local Interface|LocalIf)\s+)/i
+        def self.supports?(capability)
+          %i[neighbors interface_descriptions interface_description_changes].include?(capability)
+        end
+
+        def neighbor_command = "display lldp neighbor-information list"
+        def description_template = "h3c_interface_descriptions.textfsm"
+        def enter_configuration = "system-view"
+        def finish_commands = ["return"] + @device.profile.save_commands
+
+        def neighbor_template(output)
+          return "h3c_lldp_name_first.textfsm" if output.match?(/^\s*System Name\s+Local Interface\b/im)
+          return "h3c_lldp_local_first.textfsm" if output.match?(/^\s*(?:Local Interface|LocalIf)\s+/im)
+
+          raise ParsingError.new("H3C LLDP table header was not recognized", code: :unrecognized_output,
+                                 host: @device.host, phase: :discover)
+        end
+
+        def expected_neighbor_count(output, template)
+          local_column = template == "h3c_lldp_name_first.textfsm" ? 1 : 0
+          lines = neighbor_lines(output)
+          return unless lines.all? do |line|
+            interface = line.split.fetch(local_column, nil)
+            interface&.match?(/\A[A-Za-z][A-Za-z-]*\d+(?:\/\d+)+\z/)
+          end
+
+          lines.size
+        end
+
+        # 表头之后的未知行不能作为零邻居证据。
+        def empty_neighbor_output?(output) = neighbor_lines(output).empty?
+
+        def change_commands(change)
+          InterfaceDescription.commands(interface: change.interface, description: change.new_description, leave: "quit")
+        end
+
+        private
+
+        def neighbor_lines(output)
+          output.lines.drop_while { |line| !line.match?(TABLE_HEADER) }.map(&:strip).reject do |line|
+            line.empty? || line.match?(TABLE_HEADER) || line.match?(/\A[-=+ ]+\z/) ||
+              line.match?(/\A(?:<[^>]+>|\[[^\]]+\])\z/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/h3c.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "../device/base"
+require_relative "h3c/tftp_backup"
+require_relative "h3c/topology"
+
+module Net
+  module Connector
+    module H3c
+      # H3C 直接使用登录后的命令视图，并在单个批次内解析设备分配的规则编号。
+      class Connector < Net::Connector::Base
+        vendor :h3c
+        # 声明 H3C 的命令、提示、诊断和保存确认规则。
+        profile do
+          running_config_strategy Net::Connector::RunningConfig::Rendered
+          tftp_strategy Net::Connector::H3c::TftpBackup
+          topology_strategy Net::Connector::H3c::Topology
+          commands do
+            running_config "dis cur"
+            save_config "save force"
+          end
+
+          prompts do
+            login(/(?:\A|(?<=[\r\n]))(?:[^\S\n]|\x00)*\S+[>\]](?:[^\S\n]|\x00)*\z/)
+            command(/(?:\A|(?<=[\r\n]))(?:[^\S\n]|\x00)*[^\r\n]+[>\]](?:[^\S\n]|\x00)*\z/)
+            username(/(?:login|Username):\s*\z/i)
+          end
+
+          errors do
+            command(
+              /
+                ^[ \t]*%[ \t]+(?:(?:Unrecognized|Ambiguous|Incomplete)\s+command|Too\s+many\s+parameters)
+                \s+found\s+at\s+'\^'\s+position\.
+              /ix,
+              /^[ \t]*error:/i,
+              /^[ \t]*Permission\s+denied\./i,
+              /^\s*\^/
+            )
+          end
+
+          command_timeout 10
+
+          interactions do
+            confirm %r{Are\s+you\s+sure\?\s*\[Y/N\]}i, response: "y\n"
+            confirm(/press\s+the\s+enter\s+key\)/i, response: "\n")
+            confirm %r{Continue\?\s*\[Y/N\]}i, response: "y\n"
+            confirm(/Please\s+input\s+the\s+file\s+name\(\*\.cfg\)\[[^\]]+\]\s*\z/i, response: "\n")
+            confirm %r{overwrite\?\s*\[Y/N\]}i, response: "y\n"
+          end
+        end
+
+        protected
+
+        # 发送规则追加命令前，用本批次已获取的真实规则编号替换 XXX 占位符。
+        def prepare_command(command, execution)
+          return command unless /\A[ \t]*rule[ \t]+XXX[ \t]+append\b/i.match?(command.text)
+
+          rule_id = execution.context[:rule_id]
+          raise execution.failure("new rule ID has not been acquired") unless rule_id
+
+          command.with_text(command.text.sub(/XXX/i, rule_id))
+        end
+
+        # 规则创建成功后查询当前配置，提取设备分配的编号并保存到本批次变量。
+        def after_command(command, _response, execution)
+          return unless /\A[ \t]*rule[ \t]+pass\b/i.match?(command.text)
+
+          response = execution.query("dis this")
+          rule_id = response.raw[/rule\s+(\d+)\s+pass[^\n]+\n\s*#/i, 1]
+          raise execution.failure("device did not return the new rule ID") unless rule_id
+
+          execution.context[:rule_id] = rule_id
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/h3c_wireless.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "h3c"
+
+module Net
+  module Connector
+    module H3cWireless
+      # H3C 无线控制器沿用 Comware CLI，对无线设备单独暴露厂商入口。
+      class Connector < H3c::Connector
+        vendor :h3c_wireless
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/hillstone/running_config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "../../device/running_config/strategy"
+
+module Net
+  module Connector
+    module Hillstone
+      class RunningConfig < Net::Connector::RunningConfig::Strategy
+        def clean(text) = text.gsub(/\x00?\x08+[ \t]+\x08+/, "")
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/hillstone/tftp_backup.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/tftp/strategy"
+
+module Net
+  module Connector
+    module Hillstone
+      class TftpBackup < Operations::Tftp::Strategy
+        # 构造当前厂商的 TFTP 导出交互脚本。
+        def script(target, source_file:, vrf: nil)
+          raise ArgumentError, "Hillstone TFTP export does not use source_file" if source_file
+          if target.explicit_path? && target.path.include?("/")
+            raise ArgumentError, "Hillstone TFTP filename cannot contain a directory"
+          end
+
+          command = "export configuration startup to tftp server #{target.host} vrouter #{vrf || "mgt-vr"}"
+          command += " #{target.path}" if target.explicit_path?
+          Script.new([Command.new(command, timeout: 180)])
+        end
+
+        # 检查设备回显是否确认 TFTP 传输完成。
+        def complete?(result)
+          !completion_line(result).nil?
+        end
+
+        # 从山石成功回显提取实际目标文件名。
+        def remote_path(_target, result)
+          filename = completion_line(result)&.split&.last
+          TftpTarget.validate_path!(filename)
+        end
+
+        private
+
+        def completion_line(result)
+          completion_lines(result).find { |line| line.match?(/\AExport\s+ok\s*,\s*target\s+file\s+name\s+\S+\z/i) }
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/hillstone/topology.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/topology/strategy"
+
+module Net
+  module Connector
+    module Hillstone
+      class Topology < Operations::Topology::Strategy
+        def self.supports?(capability)
+          %i[neighbors interface_descriptions interface_description_changes].include?(capability)
+        end
+
+        def neighbor_command = "show lldp neighbor-information"
+        def description_template = "hillstone_interface_descriptions.textfsm"
+        def enter_configuration = "configure"
+        def finish_commands = ["exit"] + @device.profile.save_commands
+
+        def expected_neighbor_count(output, _template)
+          reported = output[/Total lldp neighbor number:\s*(\d+)/i, 1]
+          lines = neighbor_lines(output)
+          return unless lines.all? { |line| line.match?(/\A\S+\s+ethernet\d+\/\d+\s/i) }
+          return if reported && reported.to_i != lines.size
+
+          lines.size
+        end
+
+        def empty_neighbor_output?(output)
+          neighbor_lines(output).empty? && (output.match?(/Total lldp neighbor number:\s*0\b/i) ||
+            output.match?(/System Name\s+Local Interface/i))
+        end
+
+        def change_commands(change)
+          InterfaceDescription.commands(interface: change.interface, description: change.new_description)
+        end
+
+        private
+
+        def neighbor_lines(output)
+          output.lines.map(&:strip).reject do |line|
+            line.empty? || line == neighbor_command || line.match?(/\ASystem Name\s+Local Interface\b/i) ||
+              line.match?(/\ATotal lldp neighbor number:\s*\d+\.?\z/i) ||
+              line.match?(/\A[-=+ ]+\z/) || line.match?(/\A\S+(?:#|\([MBF]\))\z/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/hillstone.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../device/base"
+require_relative "hillstone/running_config"
+require_relative "hillstone/tftp_backup"
+require_relative "hillstone/topology"
+
+module Net
+  module Connector
+    module Hillstone
+      # 山石 StoneOS 命令行和原生启动配置导出连接器。
+      class Connector < Net::Connector::Base
+        vendor :hillstone
+        profile do
+          running_config_strategy Net::Connector::Hillstone::RunningConfig
+          tftp_strategy Net::Connector::Hillstone::TftpBackup
+          topology_strategy Net::Connector::Hillstone::Topology
+          commands do
+            running_config "terminal length 0", "show configuration running"
+            save_config "save all"
+          end
+
+          prompts do
+            login(/(?:\A|(?<=[\r\n]))\S+(?:[#>$]|\([MBF]\))\s*\z/)
+            command(/(?:\A|(?<=[\r\n]))\S+(?:#|\([MBF]\))\s*\z/)
+          end
+
+          pager do
+            pattern(/(?:\A|(?<=[\r\n]))[ \t]*--More--[ \t\x00\x08]*(?=\r|\n|\z)/i)
+          end
+
+          errors do
+            command(/^[ \t]*\^-+/i, /^\s*\^/,
+                    /^[ \t]*(?:Unknown|Invalid|Error)\s+command/i,
+                    /^[ \t]*Error:\s*[^\r\n]+/i)
+          end
+
+          command_timeout 60
+        end
+      end
+    end
+  end
+end

data/lib/net/connector/vendor/huawei/tftp_backup.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../operations/tftp/strategy"
+
+module Net
+  module Connector
+    module Huawei
+      class TftpBackup < Operations::Tftp::Strategy
+        # 要求调用方提供合法的华为启动配置文件路径。
+        def source_file(value)
+          raise ArgumentError, "Huawei TFTP backup requires source_file" unless value
+
+          TftpTarget.validate_source_file!(value)
+        end
+
+        # 根据华为配置源文件确定默认导出名称。
+        def default_path(source_file) = File.basename(source_file)
+
+        # 构造当前厂商的 TFTP 导出交互脚本。
+        def script(target, source_file:, vrf: nil)
+          raise ArgumentError, "Huawei TFTP backup does not use vrf" if vrf
+
+          destination = target.explicit_path? ? " #{target.path}" : ""
+          Script.new([Command.new("tftp #{target.host} put #{source_file}#{destination}", timeout: 180)])
+        end
+
+        # 检查设备回显是否确认 TFTP 传输完成。
+        def complete?(result)
+          completion_lines(result).any? { |line| completed_upload?(line) }
+        end
+      end
+    end
+  end
+end