Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/DiagnosticsWorkflowFixture.swift
T
Qiu Yuzhou fd9be86149 refactor(ng2): add diagnostics workflow module as single UI-facing seam
诊断区收敛为 DiagnosticsWorkflow 深 module(Candidate 03,issue #43):事实
采样、轮询代际、raw 日志投影、报告准备与导出完成登记集中一个 seam,视图只
负责生命周期触发、呈现、剪贴板、保存面板与报告文件写入。侧栏与详情共享同
一份安全摘要;收集只读,不触碰目录、凭据、runtime 与系统代理设置。

目录不再把原始 ConfigurationCatalog 写入诊断快照:CatalogWorkflow 只输出
domain-neutral 聚合事实(计数 + 已知无效数),报告 builder 只接受已裁剪的
report facts。事件导出改为显式白名单派生(diagnosticReportLine):自由
detail、主机公布地址与 runtime 错误原文一律清洗,数量/端口/领域点名原因
保留;新增事件漏 case 无法编译。raw GUI 事件行与 wrapper agent.log 尾部仅
经显式查看/复制提供,永不进入报告(ADR-0006)。导出完成事件只在用户选择的
文件实际写入成功后登记。

RuntimeEventStore 事件改为携带封闭枚举原值,渲染发生在呈现边缘(白名单清
洗只可能作用于原值)。测试:新增 workflow interface 覆盖投毒导出、白名单、
raw/报告分离、缺失标注、只读、代际覆盖与取消;ADR-0006 与 CONTEXT.md 术语
同步入库。
2026-09-22 19:22:31 +08:00

169 lines
6.4 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
/// 诊断工作流测试共享夹具(issue #43):runtime 事实替身、投毒事件集、聚合
/// 目录事实与 workflow 构造(事实源全部注入,时钟固定,轮询 10ms)。
@MainActor
class DiagnosticsWorkflowTestCase: XCTestCase {
let password = "SECRET-PASSWORD"
let address = "203.0.113.7"
let remark = "香港 01"
let home = "/Users/SECRETUSER"
let lanAddress = "192.0.2.77"
/// 投毒事件 detail:白名单必须整体清洗,不得进入报告。
let poisonDetails = [
"SECRET-PERSIST-DETAIL", "SECRET-PROBE-DETAIL", "SECRET-PAC-DETAIL",
"SECRET-LISTEN-DETAIL", "SECRET-AGENT-DETAIL", "SECRET-UNREADABLE-DETAIL",
]
lazy var secrets: [String] = {
[password, address, remark, home, lanAddress] + poisonDetails
}()
var workDir: URL!
var facts: FakeRuntimeFacts!
var events: RuntimeEventStore!
override func setUp() {
super.setUp()
workDir = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-diagwf-\(UUID().uuidString)", isDirectory: true)
try? FileManager.default.createDirectory(at: workDir, withIntermediateDirectories: true)
facts = FakeRuntimeFacts()
events = RuntimeEventStore()
// 导出完成事件经 RuntimeLog 发射:测试期间把替身缓冲注册为接收缝。
RuntimeLog.setSink(events)
}
override func tearDownWithError() throws {
RuntimeLog.setSink(RuntimeEventStore.shared)
try? FileManager.default.removeItem(at: workDir)
try super.tearDownWithError()
}
/// 标准 workflow:事实源注入替身、固定时钟(报告生成时间可精确断言)。
func makeWorkflow(
catalog: @escaping @MainActor () -> DiagnosticCatalogFacts? = { nil },
agentLog: @escaping () -> String? = { nil },
fileFacts: @escaping () -> [DiagnosticFileFacts] = { [] },
managedPlugins: @escaping () -> [DiagnosticPluginFacts] = { [] },
homePath: @escaping () -> String? = { nil },
render: @escaping (DiagnosticSnapshot) -> String? = {
DiagnosticReportBuilder.markdown(from: $0)
},
capture: ((DiagnosticSnapshot) -> Void)? = nil
) -> DiagnosticsWorkflow {
DiagnosticsWorkflow(
runtimeFacts: facts,
events: events,
catalogFacts: catalog,
agentLogTail: agentLog,
fileFacts: fileFacts,
managedPlugins: managedPlugins,
homePath: homePath,
clock: { Date(timeIntervalSince1970: 1_758_000_000) },
reportRendering: { snapshot in
capture?(snapshot)
return render(snapshot)
},
pollInterval: .milliseconds(10))
}
func waitUntil(
_ condition: @autoclosure () -> Bool,
timeout: TimeInterval = 2,
file: StaticString = #filePath,
line: UInt = #line
) async {
let deadline = Date().addingTimeInterval(timeout)
while !condition() && Date() < deadline {
try? await Task.sleep(for: .milliseconds(10))
}
XCTAssertTrue(condition(), "等待条件超时", file: file, line: line)
}
func assertNoSecrets(
_ text: String, file: StaticString = #filePath, line: UInt = #line
) {
for secret in secrets {
XCTAssertFalse(
text.contains(secret),
"诊断报告不得包含敏感值「\(secret)」\n实际:\(text)",
file: file, line: line)
}
XCTAssertFalse(text.contains("{"), "诊断报告不得携带 JSON 内容", file: file, line: line)
}
/// 投毒目录:地址、备注、分组名全为敏感值(聚合后这些值在结构上进不了
/// facts)。
func poisonedCatalogFacts() throws -> DiagnosticCatalogFacts {
var catalog = ConfigurationCatalog()
let group = try catalog.addGroup("SECRET-GROUP")
_ = try catalog.addServer(
ServerFields(
address: address, port: 8388, encryptionMethod: "aes-256-gcm",
passwordRef: CredentialReference(rawValue: "pw-ref-1"),
remark: remark,
pluginProgram: "v2ray-plugin",
pluginOptionsRef: CredentialReference(rawValue: "opts-ref-1")),
to: group)
let subscriptionGroup = try catalog.addGroup("SECRET-GROUP-sub", source: .subscription)
_ = try catalog.addServer(
ServerFields(
address: address, port: 8389, encryptionMethod: "chacha20-ietf-poly1305",
passwordRef: CredentialReference(rawValue: "pw-ref-2"), remark: remark),
source: .subscription,
to: subscriptionGroup)
return DiagnosticCatalogFacts(counts: DiagnosticReportBuilder.counts(in: catalog))
}
/// 投毒事件集:白名单内类别 + 自由 detail 携带敏感值。
func appendPoisonedEvents() {
let stamp = Date(timeIntervalSince1970: 1_758_000_000)
events.append(event: .contractWritten(serverCount: 3), timestamp: stamp)
events.append(
event: .runtimePersistFailed(detail: "\(home): SECRET-PERSIST-DETAIL"), timestamp: stamp)
events.append(
event: .endpointProbeFailed(host: lanAddress, port: 11086, detail: "SECRET-PROBE-DETAIL"),
timestamp: stamp)
events.append(
event: .pacStartFailed(port: 11089, detail: "SECRET-PAC-DETAIL"), timestamp: stamp)
events.append(event: .listenNotEstablished(detail: "SECRET-LISTEN-DETAIL"), timestamp: stamp)
events.append(
event: .agentRegisterFailed(detail: "SECRET-AGENT-DETAIL"), timestamp: stamp)
events.append(
event: .listenSettingsUnreadable(detail: "SECRET-UNREADABLE-DETAIL"), timestamp: stamp)
// 激活原因是领域点名文案(显式白名单决策,story 14):可在场,但只允许
// 这类固定文本。
events.append(
event: .activationFailed(reason: "激活目标 leaf-9 的插件 simple-obfs 未随 app 提供"),
timestamp: stamp)
}
func reportText(_ outcome: DiagnosticReportOutcome) throws -> String {
guard case .ready(let draft) = outcome else {
XCTFail("应产出 ready 报告,实际 \(outcome)")
throw XCTSkip("无报告文本")
}
return try XCTUnwrap(String(data: draft.data, encoding: .utf8))
}
static func reportTimestamp(_ date: Date) -> String {
let formatter = DateFormatter()
formatter.locale = Locale(identifier: "en_US_POSIX")
formatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
return formatter.string(from: date)
}
}
/// runtime 事实替身:可编程的安全事实值。
@MainActor
final class FakeRuntimeFacts: ProxyRuntimeDiagnosticFacts {
var proxyState: DiagnosticProxyState = .off
var hasActiveTarget = false
var listen = SslocalListenSettings()
var contractSummary: String?
}