Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Runtime/RuntimeLogRedactionTests.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

87 lines
2.9 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import XCTest
@testable import ShadowsocksX_NG2
/// 日志脱敏基线(spec #21 D5):封闭事件枚举由构造保证不携带敏感值;脱敏
/// 工具按敏感信息定义收敛 URL 与运行时文档摘要。
final class RuntimeLogRedactionTests: XCTestCase {
/// 投毒夹具:敏感值埋进文档各字段,任何一条日志事件都不得带出。
private let poisoned = ProxyRuntimeFixture.makeDocument(
serverAddress: "203.0.113.7",
password: "SECRET-PASSWORD",
pluginOpts: "obfs=http;obfs-host=SECRET-HOST"
)
private let secrets = [
"SECRET-PASSWORD",
"SECRET-HOST",
"203.0.113.7",
"香港 01",
]
private 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)
}
func testDocumentSummaryExposesOnlyCountsProtocolsAndMode() {
let summary = Redactor.documentSummary(poisoned)
XCTAssertEqual(summary, "servers=1 protocols=socks,http mode=tcp_and_udp")
assertNoSecrets(summary)
}
func testRemoteURLKeepsOnlySchemeAndHost() {
XCTAssertEqual(
Redactor.remoteURL("https://user:SECRET@example.com/sub/CLASH-SECRET?token=abc&x=1"),
"https://example.com/…",
"完整订阅 URL 与 URL token 永不入日志(D5)")
}
func testRemoteURLRedactsUnparseableAndEmptyValues() {
for bad in ["", "not a url", "https://", "ftp://"] {
XCTAssertEqual(
Redactor.remoteURL(bad), "<redacted-url>",
"无法安全归约的 URL 一律占位:\(bad)")
}
}
func testEveryRuntimeLogEventIsFreeOfSecretsAndJSONDumps() {
let events: [RuntimeLogEvent] = [
.contractWritten(serverCount: poisoned.servers.count),
.contractUnchanged,
.runtimeFilesDeleted,
.runtimePersistFailed(detail: "errno 13"),
.agentRegistered,
.agentRegisterFailed(detail: "SMAppService error 9"),
.agentUnregistered,
.agentUnregisterFailed(detail: "SMAppService error 9"),
.sslocalSpawned(pid: 42),
.sslocalSpawnFailed,
.sslocalExitedUnexpectedly(status: 78),
.sslocalStopRequested,
.contractMissing,
.contractInvalidRemoved,
.reloadForwarded,
.reloadRestarted,
.endpointProbeFailed(host: "127.0.0.1", port: 1086, detail: "Connection refused"),
.activationFailed(
reason: AppPresentation.message(
for: ActivationFailure.invalidLeaf(
node: NodeID(rawValue: "leaf-1"),
reason: .pluginNotProvided(program: "simple-obfs")))),
.diagnosticsExported,
]
let joined = events.map(\.description).joined(separator: "\n")
assertNoSecrets(joined)
}
}