Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Support/DiagnosticsWorkflowFixture.swift
T
Qiu Yuzhou 20a62117f2 refactor(tests): 按功能领域重组 Tests/ 目录
Tests/ 根层原有 138 个平铺测试文件,无法从目录读出测试覆盖的功能领域。

按功能领域重组为 17 个目录(Catalog/Workflow 与 Rules/Custom 两处嵌套,分别
对应 App/Application/CatalogWorkflow 与 Domain/Rules/Custom):Architecture /
Support / Agent / Activation / Catalog / Subscription / Rules / ProxyRuntime /
ProxyControl / Runtime / Settings / SystemProxy / Plugin / Diagnostics /
Credentials / Workspace / Servers;Smoke/ 保持独立 target 不动。138 个移动中
132 个是 100% 相似度的纯重命名,其余 6 个在重命名之上带路径反推改写(见下)。

本次不是纯搬移:测试代码比生产代码多一层位置耦合,有 7 处用固定层数的
deletingLastPathComponent() 从 #filePath 反推仓库路径(都假定文件就在 Tests/
根层)。这 7 处改走新增的 Tests/Support/TestSourceTree.swift——从调用点沿父
目录上溯找到含 project.yml 的目录,因此不再依赖父目录层数,以后移动测试文件
也不会静默指错。

配套改动:

- 新增 Tests 布局守卫 TestsLayoutTests,断言 Tests/ 根层无平铺 .swift。比
  Domain 那条弱一档——根层的 Info.plist(info.path 生成物)与
  Fixtures/RuleSnapshots 下的 JSON(folder resource)都必须保留,不能用
  「树下只有 .swift」覆盖。
- project.yml:Smoke target 按文件引用的 Tests/AppArtifact.swift 改指
  Tests/Support/;两处注释里写死的 Tests/SkeletonTests.swift 随移动更新。
  excludes 的裸名 "Smoke" / "Fixtures" 仍匹配 Tests/ 直属子目录,无需改动。
- README 的 Tests 条目展开为目录说明,并修掉 Domain 条目里写死的
  Tests/SkeletonTests.swift。
- 顺带删去 DomainLayoutTests 文档注释里「整理前 62 个文件」这类易漂移的数字。

验证:xcodegen generate 后单测 target 为 139 个源文件(全部非 Smoke 文件,0 个
Smoke 文件混入)且仍以 Fixtures/RuleSnapshots 为资源,Smoke target 为 8 个
Smoke 文件加 AppArtifact;依赖路径反推的 6 个测试类全绿(路径指错即失败);
task format 未改写任何被移动文件;task lint 与整理前同为 21 条内容型 warning;
build 0 error;task test 1025 用例全通过(整理前 1024,+1 为新守卫);
TestsLayoutTests 经变异验证(根层投放探针即失败);packaging-gate ALL CHECKS
PASSED。
2026-10-05 20:37:35 +08:00

168 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-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() async throws {
try await 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 tearDown() async throws {
RuntimeLog.setSink(RuntimeEventStore.shared)
try? FileManager.default.removeItem(at: workDir)
try await super.tearDown()
}
/// 标准 workflow:事实源注入替身、固定时钟(报告生成时间可精确断言)。
func makeWorkflow(
catalog: @escaping @MainActor () -> DiagnosticCatalogFacts? = { nil },
agentLog: @escaping () -> String? = { nil },
fileFacts: @escaping @MainActor () -> [DiagnosticFileFacts] = { [] },
managedPlugins: @escaping @MainActor () -> [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: .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?
var customRuleSummary: CustomRuleSummary?
}