net-connector 0.7.3 → 0.8.0

data/lib/net/connector/engine/response_reader.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "expect/pty"
+require_relative "dialogue"
+
+module Net
+  module Connector
+    # 在传输层上执行有界对话；收到字节或分页标记不会重置截止时间。
+    class ResponseReader
+      # 保存会话引用，以便读取器使用传输、配置和脱敏上下文。
+      def initialize(session)
+        @session = session
+      end
+
+      # 读取到结束提示、失败模式或超时，并处理交互响应和输出上限。
+      def read(prompt:, interactions:, phase:, timeout: nil, deadline: nil, command: nil, failures: {})
+        deadline ||= Expect.monotonic + timeout
+        patterns = [*failures.keys, *interactions.map(&:pattern), prompt]
+        raw = []
+        output = []
+        counts = Hash.new(0)
+        bytes = 0
+        loop do
+          event = read_event(patterns, deadline)
+          raw << event.before unless event.before.empty?
+          output << event.before unless event.before.empty?
+          bytes += event.before.bytesize + event.match.bytesize
+          validate_event!(event, bytes, raw, phase, command)
+
+          if event.index == patterns.size
+            raw << event.match
+            output << event.match
+          elsif event.index == patterns.size - 1
+            return finish_response(event.match, raw, output, phase, command)
+          elsif event.index < failures.size
+            raise build_connection_error(failures.values.fetch(event.index), phase, command), cause: nil
+          else
+            reply = interactions.fetch(event.index - failures.size)
+            raw << event.match
+            output << event.match if reply.capture?
+            respond(reply, event.match, counts, deadline, phase, command)
+          end
+          next if Expect.monotonic < deadline
+
+          raise build_read_error(nil, phase, command, raw.join), cause: nil
+        end
+      end
+
+      private
+
+      # 分页和流式输出只消耗剩余时间，不为下一次读取重新计时。
+      def read_event(patterns, deadline)
+        @session.transport.read(patterns, timeout: [deadline - Expect.monotonic, 0].max)
+      end
+
+      # 连接失败模式携带稳定错误码，供连接级恢复规则选择处理方式。
+      def build_connection_error(failure, phase, command)
+        klass, code = failure
+        @session.build_error(klass, "device connection failed (#{code})", phase: phase, code: code, command: command)
+      end
+
+      # 先限制原始字节数，再处理传输失败，避免错误输出绕过总量限制。
+      def validate_event!(event, bytes, raw, phase, command)
+        if bytes > @session.configuration.max_output_bytes
+          raise @session.build_error(OutputLimitExceeded, "device output exceeded max_output_bytes",
+                                     phase: phase, command: command, output: (raw + [event.match]).join), cause: nil
+        end
+        raise build_read_error(event, phase, command, raw.join), cause: nil unless event.matched?
+      end
+
+      # 完整提示符必须消费字节；交互标记可从业务输出排除，但原始响应始终保留。
+      def finish_response(prompt, raw, output, phase, command)
+        if prompt.empty?
+          raise @session.build_error(PromptError, "prompt pattern did not consume any output",
+                                     phase: phase, command: command, output: raw.join), cause: nil
+        end
+
+        raw << prompt
+        output << prompt
+        raw_text = raw.join
+        Response.new(raw: raw_text, output: (output == raw) ? raw_text : output.join, prompt: prompt)
+      end
+
+      # 重复提示和缺失应答必须在写入前失败；所有应答共用读取操作的截止时间。
+      def respond(reply, prompt, counts, deadline, phase, command)
+        counts[reply] += 1
+        if prompt.empty? || (reply.limit && counts[reply] > reply.limit)
+          raise build_interaction_error("response rejected or repeated", phase, command), cause: nil
+        end
+
+        value = interaction_response(reply, prompt, phase, command)
+        raise build_interaction_error("response unavailable", phase, command), cause: nil unless value.is_a?(String)
+
+        @session.redactor.remember(value.chomp) if reply.sensitive?
+        @session.write(value, deadline: deadline, phase: phase, command: command)
+      end
+
+      # 动态口令尚未返回时无法加入词表，须在敏感范围内先归一化回调异常。
+      # 成功后由调用方登记响应，临时敏感标记不会影响后续普通命令的诊断。
+      def interaction_response(reply, prompt, phase, command)
+        return reply.response(prompt) unless reply.sensitive?
+
+        @session.redactor.with_scope(reuse: true) do
+          @session.redactor.sensitive!
+          reply.response(prompt)
+        rescue => error
+          raise @session.normalize_error(error, phase: phase, command: command), cause: nil
+        end
+      end
+
+      # 将交互拒绝或响应缺失转换为认证或脚本错误。
+      def build_interaction_error(message, phase, command)
+        authenticating = %i[login enable].include?(phase)
+        klass = authenticating ? AuthenticationError : ScriptError
+        label = authenticating ? "authentication" : "command interaction"
+        @session.build_error(klass, "#{label} #{message}", phase: phase, command: command)
+      end
+
+      # 根据 EOF、提示符、阶段和底层异常选择具体读取错误类型。
+      def build_read_error(event, phase, command, output)
+        if event&.error.is_a?(Exception)
+          return @session.build_error(TransportError, "transport read failed", phase: phase, command: command,
+                                      underlying: event.error, output: output)
+        end
+        klass = if event&.error == :eof
+                  ConnectionClosed
+                elsif command&.prompt
+                  PromptError
+                elsif %i[login enable].include?(phase)
+                  LoginTimeout
+                else
+                  CommandTimeout
+                end
+        @session.build_error(klass, "device response #{event&.error || :timeout}", phase: phase,
+                             command: command, output: output)
+      end
+    end
+  end
+end

data/lib/net/connector/engine/session.rb

@@ -3,6 +3,8 @@
 require "English"
 require_relative "authentication"
 require_relative "log"
+require_relative "redactor"
+require_relative "response_reader"
 require_relative "recovery"
 require_relative "transport"
 
@@ -45,12 +47,14 @@ module Net
           started = Expect.monotonic
           @log.log_event("operation_start", level: :debug, phase: :script)
           result = yield
-          log_operation_completion(started, result.is_a?(Result) ? result.error : nil, steps: steps.size)
-          result
         rescue => error
           failure = normalize_error(error, phase: :script)
           log_operation_completion(started, failure, steps: steps.size)
           raise failure, cause: nil
+        else
+          # 完成事件只发送一次；观察者失败由外层保留业务结果，不再次调用同一观察者。
+          log_operation_completion(started, result.is_a?(Result) ? result.error : nil, steps: steps.size)
+          result
         end
       end
 

data/lib/net/connector/netdisco/backup_run.rb

@@ -2,6 +2,12 @@
 
 require "json"
 require "socket"
+require_relative "cli/options"
+require_relative "connection"
+require_relative "fleet"
+require_relative "progress"
+require_relative "report/files"
+require_relative "../storage/batch_directory"
 
 module Net
   module Connector
@@ -38,8 +44,9 @@ module Net
 
           Storage::PrivateFile.write(File.join(batch_directory, "plan.json"), JSON.pretty_generate(preview))
           report = execute(fleet, settings, plan, batch_directory, progress, success_policy, server_root)
+          report = record_progress_error(report, progress)
           report = Report::Files.write(report, directory: batch_directory, plan: plan, concurrency: settings.concurrency)
-          finish(report, progress, options, batch_directory)
+          finish(report, progress, options, batch_directory, plan, settings.concurrency)
         rescue ArgumentError, Client::Error => exception
           @error.puts "备份参数或清单错误：#{exception.message}"
           2
@@ -95,10 +102,16 @@ module Net
           end
         end
 
-        def finish(report, progress, options, batch_directory)
+        def finish(report, progress, options, batch_directory, plan, concurrency)
           progress.finish(report)
           progress.location(report.report_location) if report.report_location
-          @error.puts "文本报告：#{File.join(batch_directory, "summary.txt")}" if @env.fetch("NC_PROGRESS", "1") != "0" && File.file?(File.join(batch_directory, "summary.txt"))
+          summary_path = File.join(batch_directory, "summary.txt")
+          progress.location(summary_path, label: "文本报告") if File.file?(summary_path)
+          updated = record_progress_error(report, progress)
+          unless updated.equal?(report)
+            # 末尾显示也可能首次失败，只补写诊断，不重复设备任务或事件。
+            report = Report::Files.write(updated, directory: batch_directory, plan: plan, concurrency: concurrency)
+          end
           if options[:json]
             @output.puts JSON.generate(directory: batch_directory, counts: report.counts,
                                        tasks_succeeded: report.policy_success?, success: report.policy_success?,
@@ -108,6 +121,12 @@ module Net
           report.policy_success? ? 0 : 1
         end
 
+        def record_progress_error(report, progress)
+          return report unless progress.output_error && !report.callback_errors.include?(progress.output_error)
+
+          report.with(callback_errors: [*report.callback_errors, progress.output_error].freeze)
+        end
+
         def tftp_root(settings, options)
           server = settings.tftp_server || (raise ArgumentError, "TFTP_HOST or YAML tftp.server is required")
           return options[:tftp_root] || @env["TFTP_ROOT"] if options[:tftp_root] || @env["TFTP_ROOT"]

data/lib/net/connector/netdisco/cli/options.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "optparse"
+require_relative "../settings"
+require_relative "../planner"
+require_relative "../config_file"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/cli.rb

@@ -3,6 +3,9 @@
 require "json"
 require "ipaddr"
 require "optparse"
+require_relative "../version"
+require_relative "fleet"
+require_relative "cli/options"
 
 module Net
   module Connector
@@ -46,23 +49,23 @@ module Net
             return 0
           end
 
-          batch = backup(fleet, plan, settings, options)
-          summary = batch.summary
+          report = backup(fleet, plan, settings, options)
+          summary = report.summary
           @output.puts JSON.pretty_generate(summary)
-          batch.policy_success? ? 0 : 1
+          report.policy_success? ? 0 : 1
         rescue Storage::PrivateFile::WriteError => exception
           message = Storage::PrivateFile.receipt_error?(exception) ? exception.message : exception.class.name
-          @error.puts "net-connector-backup: #{message}"
+          @error.puts "net-backup: #{message}"
           2
         rescue OptionParser::ParseError
-          @error.puts "net-connector-backup: 参数无效；使用 --help 查看参数"
+          @error.puts "net-backup: 参数无效；使用 --help 查看参数"
           2
         rescue ArgumentError, KeyError, Errno::ENOENT,
           Psych::Exception, JSON::ParserError, Client::Error => exception
-          @error.puts "net-connector-backup: #{exception.message}"
+          @error.puts "net-backup: #{exception.message}"
           2
         rescue StandardError => exception
-          @error.puts "net-connector-backup 失败（#{exception.class}）"
+          @error.puts "net-backup 失败（#{exception.class}）"
           2
         end
 
@@ -113,7 +116,7 @@ module Net
         def parse_options
           options = { environment: {} }
           parser = OptionParser.new do |args|
-            args.banner = "用法：net-connector-backup [--config FILE] [--plan | --show-config | --export IP] [--tftp]"
+            args.banner = "用法：net-backup [--config FILE] [--plan | --show-config | --export IP] [--tftp]"
             Options.add_settings(args, options)
             Options.add_execution(args, options)
             args.on("--source SOURCE", %w[http postgres], "清单来源：http（默认）或 postgres") { |value| options[:source] = value }

data/lib/net/connector/netdisco/connection.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "client"
 
 # 清单连接与设备凭据来源；业务入口负责规划和执行备份。
 module Net

data/lib/net/connector/netdisco/database_client.rb

@@ -48,8 +48,10 @@ module Net
           connected = false
           begin
             Timeout.timeout(budget.remaining, Client::InventoryTimeout) do
-              # 从握手开始持有连接；PG.connect 尚未返回时被超时中断，调用方无法负责关闭它。
-              connection = PG::Connection.connect_start(@connection_options)
+              # 先取得连接句柄再交付超时，确保异常到达时 ensure 能显式关闭连接。
+              Thread.handle_interrupt(Client::InventoryTimeout => :never) do
+                connection = PG::Connection.connect_start(@connection_options)
+              end
               # PostgreSQL NOTICE 可能包含 SQL 或数据，不交给 libpq 默认的 stderr 输出器。
               connection.set_notice_processor { |_notice| nil }
               wait_for_connection(connection, budget)

data/lib/net/connector/netdisco/device.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "ipaddr"
+require_relative "../../connector"
 require_relative "../storage/saved_config"
+require_relative "client"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/diagnostic.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../engine/error_metadata"
+require_relative "../engine/errors"
+require_relative "../device/local_backup"
+require_relative "../device/tftp/receipt"
+require_relative "../storage/private_file"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/fleet.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
 require "fileutils"
-require "digest"
+require_relative "../storage"
+require_relative "client"
+require_relative "settings"
+require_relative "device"
+require_relative "worker"
+require_relative "result_store"
+require_relative "planner"
+require_relative "report"
+require_relative "tftp_verification"
+require_relative "tftp_archive"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/plan.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "ipaddr"
+require_relative "device"
+require_relative "batch"
+
 module Net
   module Connector
     module Netdisco

data/lib/net/connector/netdisco/planner.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "plan"
+require_relative "batch"
 
 module Net
   module Connector
@@ -20,7 +21,7 @@ module Net
           end
           selected_tasks = if limit_per_vendor
                              ready_tasks.group_by { |_index, device| device.vendor }.values.flat_map do |tasks|
-                               tasks.sort_by { |_index, device| device.host }.first(limit_per_vendor)
+                               tasks.min_by(limit_per_vendor) { |_index, device| device.host }
                              end
                            else
                              ready_tasks

data/lib/net/connector/netdisco/progress.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require "io/console"
+require_relative "../engine/error_metadata"
+require_relative "../engine/log/event"
 
 module Net
   module Connector
     module Netdisco
       # 共享一个实例接收并发会话事件和任务回调；人类进度不混入 JSON 输出。
       class Progress
+        attr_reader :output_error
+
         def initialize(io: $stderr, enabled: true, verbose: false)
           @io, @enabled, @verbose = io, enabled, verbose
           @tty = io.respond_to?(:tty?) && io.tty?
@@ -148,8 +152,8 @@ module Net
           @mutex.synchronize { refresh(force: true) }
         end
 
-        def location(path)
-          write(nil, "报告：#{path}")
+        def location(path, label: "报告")
+          write(nil, "#{label}：#{path}")
         end
 
         private
@@ -209,9 +213,7 @@ module Net
 
           clear_refresh
           @last_status = lines
-          @io.write(lines.join("\n"))
-          @io.flush
-          @refreshing = true
+          @refreshing = write_output(lines.join("\n"))
         end
 
         # 留一列避免终端自动换行，窄窗口也不会留下旧进度行。
@@ -231,7 +233,7 @@ module Net
         def clear_refresh
           return unless @refreshing
 
-          @io.write("\r\e[2K" + ("\e[1A\r\e[2K" * (@last_status.length - 1)))
+          write_output("\r\e[2K" + ("\e[1A\r\e[2K" * (@last_status.length - 1)))
           @refreshing = false
         end
 
@@ -246,8 +248,21 @@ module Net
           clear_refresh
           line = "[#{Time.now.strftime("%H:%M:%S")}] [#{@completed}/#{@total}#{percent} 执行中 #{@active}] [#{host || "批次"}] #{message}"
           line = "[#{Time.now.strftime("%H:%M:%S")}] #{host ? "#{host}  " : ""}#{message}" unless @verbose
-          @io.write(line.gsub(/[[:cntrl:]]/, " ") + "\n")
+          write_output(line.gsub(/[[:cntrl:]]/, " ") + "\n")
+        end
+
+        # 显示失败只停用进度输出；批次仍保存回执和事件，并记录一次受控回调诊断。
+        # 所有调用均持有 @mutex，心跳与设备线程不会重复访问已失败的输出。
+        def write_output(text)
+          return false unless @enabled
+
+          @io.write(text)
           @io.flush
+          true
+        rescue IOError, SystemCallError => error
+          @output_error = { host: nil, error_type: ErrorMetadata.type(error.class.name) }.freeze
+          @enabled = false
+          false
         end
       end
     end

data/lib/net/connector/netdisco/report/files.rb

@@ -16,8 +16,9 @@ module Net
             Storage::PrivateFile.write(destination, JSON.pretty_generate(finalized.summary))
             finalized
           rescue StandardError => error
-            location = committed_location(error, destination)
-            failed = report.with_report_error(error, location: location)
+            location = committed_location(error, destination) || report.report_location
+            # 更新已有诊断时仍保留首次报告故障，以及之前已提交的报告位置。
+            failed = report.report_error ? report.with(report_location: location) : report.with_report_error(error, location: location)
             begin
               saved = failed.with(report_location: destination)
               Storage::PrivateFile.write(destination, JSON.pretty_generate(saved.summary))

data/lib/net/connector/netdisco/result_store.rb

@@ -12,17 +12,15 @@ module Net
         # 每批保存一份私有 JSON 报告，通过重命名防止半写文件。
         class Json
           # 以临时文件和重命名原子写入私有 JSON 报告。
-          def write(batch, directory:)
+          def write(report, directory:)
             destination = File.expand_path(directory)
             FileUtils.mkdir_p(destination, mode: 0o700)
-            filename = "netdisco-#{batch.mode}-#{batch.started_at.strftime("%Y%m%dT%H%M%SZ")}-#{SecureRandom.hex(4)}.json"
+            filename = "netdisco-#{report.mode}-#{report.started_at.strftime("%Y%m%dT%H%M%SZ")}-#{SecureRandom.hex(4)}.json"
             path = File.join(destination, filename)
-            Storage::PrivateFile.write(path, JSON.pretty_generate(batch.summary)).path
+            Storage::PrivateFile.write(path, JSON.pretty_generate(report.summary)).path
           end
         end
 
-        Text = Json # Compatibility with the former name of the JSON writer.
-
         # 数据库仓储由调用方提供，可使用 Active Record 或其他对象。
         # 仓储须实现 create!，本项目不负责数据库表结构。
         class Database
@@ -34,8 +32,8 @@ module Net
           end
 
           # 把批量摘要写入调用方仓储并返回记录位置。
-          def write(batch, **_options)
-            record = @repository.create!(batch.summary)
+          def write(report, **_options)
+            record = @repository.create!(report.summary)
             record.respond_to?(:id) ? "database:#{record.id}" : "database"
           end
         end

data/lib/net/connector/netdisco/rules.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "ipaddr"
+require_relative "../../connector"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/settings.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "../../connector"
+require_relative "client"
+require_relative "database_client"
+require_relative "config_file"
+require_relative "rules"
+require_relative "planner"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/tftp_archive.rb

@@ -2,10 +2,12 @@
 
 require "fileutils"
 require "tempfile"
+require "digest"
 require_relative "../storage/backup_lock"
 require_relative "../storage/private_file"
 require_relative "../storage/safe_file"
 require_relative "tftp_verification"
+require_relative "diagnostic"
 
 module Net
   module Connector
@@ -69,9 +71,6 @@ module Net
           end
         end
 
-        alias path_for upload_filename
-        alias capture upload_and_archive
-
         private
 
         # 文件系统的 mtime 可能落后于 Time.now；用同一服务器目录的时间建立上传边界。

data/lib/net/connector/netdisco/tftp_verification.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../storage/safe_file"
+require_relative "../device/tftp/receipt"
 
 module Net
   module Connector

data/lib/net/connector/netdisco/worker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "settings"
+
 module Net
   module Connector
     module Netdisco

data/lib/net/connector/netdisco.rb

@@ -1,25 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../connector"
-require_relative "netdisco/client"
-require_relative "netdisco/database_client"
-require_relative "netdisco/rules"
-require_relative "netdisco/device"
-require_relative "netdisco/config_file"
-require_relative "netdisco/settings"
-require_relative "netdisco/worker"
-require_relative "netdisco/result_store"
-require_relative "netdisco/batch"
-require_relative "netdisco/planner"
-require_relative "netdisco/fleet"
-require_relative "netdisco/progress"
+# 公共入口只组合应用流程；每个模块自行声明依赖，不要求调用方维护加载顺序。
 require_relative "netdisco/cli"
-require_relative "storage/batch_directory"
-require_relative "netdisco/report/text"
-require_relative "netdisco/connection"
-require_relative "netdisco/cli/options"
-require_relative "netdisco/report/files"
-require_relative "netdisco/tftp_verification"
-require_relative "netdisco/tftp_archive"
-require_relative "netdisco/tftp_history"
 require_relative "netdisco/backup_run"

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

@@ -48,19 +48,39 @@ module Net
           return false if text.empty?
 
           pending = +""
+          quote = nil
           text.each_line do |line|
             next if pending.empty? && line.strip.empty?
             return false if pending.empty? && !line.start_with?("set ")
 
             pending << line
-            begin
-              Shellwords.split(pending)
-              pending.clear
-            rescue ArgumentError
-              # 未闭合引号继续读取；末尾仍未闭合则拒绝整个采集结果。
-            end
+            quote = quote_after(line, quote)
+            next if quote
+
+            Shellwords.split(pending)
+            pending.clear
           end
           pending.empty?
+        rescue ArgumentError
+          false
+        end
+
+        # 每行只扫描新增字节，整条逻辑命令闭合后才交给 Shellwords 校验。
+        # 单引号中的反斜杠是普通字符；其他位置的转义只影响紧随的一个字节。
+        def quote_after(line, quote)
+          escaped = false
+          line.each_byte do |byte|
+            if escaped
+              escaped = false
+            elsif byte == 92 && quote != 39
+              escaped = true
+            elsif byte == quote
+              quote = nil
+            elsif quote.nil? && (byte == 34 || byte == 39)
+              quote = byte
+            end
+          end
+          quote
         end
 
         # 去掉命令回显和提示符，保留真正需要校验的设备响应。

data/lib/net/connector/version.rb

@@ -2,6 +2,6 @@
 
 module Net
   module Connector
-    VERSION = "0.7.3"
+    VERSION = "0.8.0"
   end
 end