net-connector 0.4.0 → 0.4.1

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

@@ -6,6 +6,9 @@ module Net
   module Connector
     module Hillstone
       class TftpBackup < Operations::Tftp::Strategy
+        # 山石原生导出的配置文件使用 dat 扩展名。
+        def self.file_extension = "dat"
+
         # 构造当前厂商的 TFTP 导出交互脚本。
         def script(target, source_file:, vrf: nil)
           raise ArgumentError, "Hillstone TFTP export does not use source_file" if source_file
@@ -31,6 +34,7 @@ module Net
 
         private
 
+        # 仅认可设备明确给出目标文件名的 Export ok 回显。
         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

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

@@ -6,15 +6,21 @@ module Net
   module Connector
     module Hillstone
       class Topology < Operations::Topology::Strategy
+        # 山石提供 LLDP 邻居、配置描述读取和描述变更。
         def self.supports?(capability)
           %i[neighbors interface_descriptions interface_description_changes].include?(capability)
         end
 
+        # 读取 LLDP 邻居信息。
         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)
@@ -24,17 +30,20 @@ module Net
           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) ||

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

@@ -1,33 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "../../operations/tftp/strategy"
+require_relative "../../operations/tftp/file_upload"
 
 module Net
   module Connector
     module Huawei
-      class TftpBackup < Operations::Tftp::Strategy
+      class TftpBackup < Operations::Tftp::FileUpload
         # 要求调用方提供合法的华为启动配置文件路径。
         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

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

@@ -7,6 +7,7 @@ module Net
   module Connector
     module PaloAlto
       class RunningConfig < Net::Connector::RunningConfig::Strategy
+        # 配置位于 show 步骤，最后的 exit 只负责离开候选视图。
         def result_step(result)
           result.steps.find { |step| step.command.text == "show" }
         end
@@ -21,6 +22,7 @@ module Net
           end
         end
 
+        # 采集前后都检查候选差异，拒绝把未提交配置误作运行配置。
         def check_response(command, response, _execution)
           return unless command.text == "show config diff"
           return if body(response.output, command.text).empty?
@@ -29,6 +31,7 @@ module Net
                                 code: :uncommitted_configuration, host: @device.host, phase: :collect)
         end
 
+        # 只接受完整的 set 命令文本，排除 XML 或截断的引号配置。
         def clean(text)
           normalized = body(text, "show").sub(/(?:\A|\n)[ \t]*\[edit\][ \t]*\z/, "").strip
           unless set_commands?(normalized)
@@ -60,6 +63,7 @@ module Net
           pending.empty?
         end
 
+        # 去掉命令回显和提示符，保留真正需要校验的设备响应。
         def body(text, command)
           text.gsub("\r\n", "\n").sub(/\A[ \t]*#{Regexp.escape(command)}[ \t]*\n/, "")
               .sub(@device.profile.command_prompt, "").strip

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

@@ -6,18 +6,20 @@ module Net
   module Connector
     module PaloAlto
       class TftpBackup < Operations::Tftp::Strategy
+        FILENAME = "running-config.xml"
+
         # 返回 PAN-OS 固定使用的运行配置文件名。
-        def default_path(_source_file) = "running-config.xml"
+        def self.filename(_host, **) = FILENAME
 
         # 构造当前厂商的 TFTP 导出交互脚本。
         def script(target, source_file:, vrf: nil)
           raise ArgumentError, "PAN-OS does not use source_file" if source_file
           raise ArgumentError, "PAN-OS TFTP backup does not use vrf" if vrf
-          unless target.path == "running-config.xml"
-            raise ArgumentError, "PAN-OS TFTP export uses the fixed filename running-config.xml"
+          unless target.path == FILENAME
+            raise ArgumentError, "PAN-OS TFTP export uses the fixed filename #{FILENAME}"
           end
 
-          Script.new([Command.new("tftp export configuration to #{target.host} from running-config.xml",
+          Script.new([Command.new("tftp export configuration to #{target.host} from #{FILENAME}",
                                   timeout: 180)])
         end
 
@@ -29,7 +31,7 @@ module Net
         end
 
         # 返回 PAN-OS 实际上传的固定文件名。
-        def remote_path(_target, _result) = "running-config.xml"
+        def remote_path(_target, _result) = FILENAME
       end
     end
   end

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

@@ -6,19 +6,26 @@ module Net
   module Connector
     module PaloAlto
       class Topology < Operations::Topology::Strategy
+        # PAN-OS 提供 LLDP 邻居、接口备注读取和备注变更。
         def self.supports?(capability)
           %i[neighbors interface_descriptions interface_description_changes].include?(capability)
         end
 
+        # 读取各本机接口的 LLDP 邻居详情。
         def neighbor_command = "show lldp neighbors all"
+        # 从 set 格式配置解析接口备注。
         def description_template = "palo_alto_interface_descriptions.textfsm"
+        # 进入候选配置视图。
         def enter_configuration = "configure"
+        # 提交候选配置后退出配置视图。
         def finish_commands = ["commit", "exit"]
 
+        # 只计入非空邻居块，跳过没有对端的本机接口。
         def expected_neighbor_count(output, _template)
           neighbor_blocks(output).count { |block| !empty_neighbor_block?(block) }
         end
 
+        # 输出必须明确说明无邻居，或每个本机接口块都明确为空。
         def empty_neighbor_output?(output)
           return true if output.match?(/No LLDP neighbors/i)
 
@@ -34,6 +41,7 @@ module Net
           output.split(/^\s*Local information:\s*$/i).select { |block| block.match?(/^\s*Local interface:\s*\S+/i) }
         end
 
+        # 邻居字段区只有空行和提示符时，才视为明确的空块。
         def empty_neighbor_block?(block)
           tail = block.split(/^\s*Neighbor information:\s*$/i, 2)
           tail.size == 2 && tail.last.lines.all? { |line| line.strip.empty? || line.match?(/^\S+[>#]\s*$/) }
@@ -50,10 +58,12 @@ module Net
                                  code: :unrecognized_output, host: @device.host, phase: :parse)
         end
 
+        # 用 PAN-OS set 语法生成接口备注变更。
         def change_commands(change)
           [%Q(set network interface ethernet #{change.interface} comment "#{change.new_description}")]
         end
 
+        # commit 可能耗时较长，单独放宽该命令的超时。
         def script_command(command)
           command == "commit" ? Command.new(command, timeout: 300) : command
         end

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

@@ -6,8 +6,8 @@ module Net
   module Connector
     module Radware
       class TftpBackup < Operations::Tftp::Strategy
-        # 生成 Radware 压缩配置的远端文件名。
-        def default_path(_source_file) = TftpTarget.filename(@device.host, extension: "tgz")
+        # Radware 原生导出生成压缩配置归档。
+        def self.file_extension = "tgz"
 
         # 构造当前厂商的 TFTP 导出交互脚本。
         def script(target, source_file:, vrf: nil)

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

@@ -6,7 +6,9 @@ module Net
   module Connector
     module Radware
       class Topology < Operations::Topology::Strategy
+        # Alteon 只支持读取端口描述，不提供邻居发现或自动改写。
         def self.supports?(capability) = capability == :interface_descriptions
+        # 从设备配置转储解析端口名称。
         def description_template = "radware_port_names.textfsm"
       end
     end

data/lib/net/connector/version.rb

@@ -2,6 +2,6 @@
 
 module Net
   module Connector
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-connector
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - net-connector contributors
@@ -23,26 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.1
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
 - !ruby/object:Gem::Dependency
   name: textfsm
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +139,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: net-http
   requirement: !ruby/object:Gem::Requirement
@@ -373,8 +373,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Automate network device login, configuration collection, command scripts,
-  interactive prompts, redacted logging, and Netdisco inventory backups.
+description: 通过 SSH 或 Telnet 登录网络设备，采集配置、执行命令脚本、处理交互提示，并提供脱敏日志与基于 Netdisco 清单的批量备份。
 executables:
 - net-connector-backup
 extensions: []
@@ -393,6 +392,7 @@ files:
 - lib/net/connector/device/interface_description.rb
 - lib/net/connector/device/interface_name.rb
 - lib/net/connector/device/profile.rb
+- lib/net/connector/device/profile/builder.rb
 - lib/net/connector/device/running_config.rb
 - lib/net/connector/device/running_config/strategy.rb
 - lib/net/connector/engine.rb
@@ -419,6 +419,7 @@ files:
 - lib/net/connector/netdisco/config_file.rb
 - lib/net/connector/netdisco/device.rb
 - lib/net/connector/netdisco/fleet.rb
+- lib/net/connector/netdisco/plan.rb
 - lib/net/connector/netdisco/planner.rb
 - lib/net/connector/netdisco/result_store.rb
 - lib/net/connector/netdisco/rules.rb
@@ -436,6 +437,7 @@ files:
 - lib/net/connector/operations/saved_config.rb
 - lib/net/connector/operations/tftp/cisco_ios.rb
 - lib/net/connector/operations/tftp/cisco_nxos.rb
+- lib/net/connector/operations/tftp/file_upload.rb
 - lib/net/connector/operations/tftp/h3c.rb
 - lib/net/connector/operations/tftp/hillstone.rb
 - lib/net/connector/operations/tftp/huawei.rb
@@ -513,5 +515,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.12
 specification_version: 4
-summary: Network device CLI sessions and Netdisco-driven concurrent backups
+summary: 网络设备命令行会话与 Netdisco 清单批量备份
 test_files: []