Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Rules/Custom/CustomRuleStoreTests.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

146 lines
5.4 KiB
Swift

import Foundation
import XCTest
@testable import ShadowsocksX_NG2
/// 自定义规则持久化(issue #66 AC1/AC5):往返、缺失文件、损坏与诊断摘要。
final class CustomRuleStoreTests: XCTestCase {
private var directory: URL!
private var store: CustomRuleStore!
override func setUpWithError() throws {
try super.setUpWithError()
directory = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-custom-rules-\(UUID().uuidString)", isDirectory: true)
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)
store = CustomRuleStore(fileURL: directory.appendingPathComponent("custom-rules.json"))
}
override func tearDownWithError() throws {
try? FileManager.default.removeItem(at: directory)
try super.tearDownWithError()
}
func testSchemaOneMigratesAndDisablementRoundTripsInSameDocument() throws {
let rule = CustomRule(action: .direct, match: .domainExact("private.example"))
let legacy = try JSONSerialization.data(withJSONObject: [
"schemaVersion": 1,
"rules": JSONSerialization.jsonObject(with: JSONEncoder().encode([rule])),
])
try legacy.write(to: store.fileURL)
let migrated = try store.loadDocument()
XCTAssertEqual(migrated.rules, [rule])
XCTAssertTrue(migrated.disabledIdentities.isEmpty)
try store.saveDocument(
CustomRuleDocument(rules: migrated.rules, disabledIdentities: [rule.identity]))
let saved = try store.loadDocument()
XCTAssertEqual(saved.schemaVersion, 2)
XCTAssertEqual(saved.disabledIdentities, [rule.identity])
XCTAssertNotEqual(
try store.summary().contentVersion, CustomRuleSummary.summarizing([rule]).contentVersion)
}
func testMissingFileLoadsAsEmpty() throws {
XCTAssertEqual(try store.load(), [])
}
func testRoundTripPersistsActionMatchAndSourceMetadata() throws {
let match = try RuleMatch(domainSuffix: "example.com")
let rule = CustomRule(action: .direct, match: match)
try store.save([rule])
let loaded = try store.load()
XCTAssertEqual(loaded.count, 1)
XCTAssertEqual(loaded[0].id, rule.id)
XCTAssertEqual(loaded[0].action, .direct)
XCTAssertEqual(loaded[0].match, match)
XCTAssertEqual(loaded[0].source.kind, .custom)
XCTAssertFalse(loaded[0].source.label.isEmpty)
}
func testRoundTripKeepsMultipleRuleKinds() throws {
let rules = [
CustomRule(action: .proxy, match: try RuleMatch(domainExact: "a.example.com")),
CustomRule(action: .direct, match: try RuleMatch(ipv4CIDR: "203.0.113.0/24")),
CustomRule(action: .proxy, match: try RuleMatch(ipv6CIDR: "2001:db8::/32")),
]
try store.save(rules)
XCTAssertEqual(try store.load(), rules)
}
func testStoredMatchIsNormalizedWithoutChangingCustomIdentity() throws {
let rule = CustomRule(action: .direct, match: .ipv4CIDR("203.0.113.15/24"))
try store.save([rule])
let loaded = try XCTUnwrap(store.load().first)
XCTAssertEqual(loaded.id, rule.id)
XCTAssertEqual(loaded.match, .ipv4CIDR("203.0.113.0/24"))
XCTAssertEqual(loaded.identity, rule.identity)
}
func testMalformedStoredCIDRReportsCorruptionWithoutRewritingDocument() throws {
for match in [RuleMatch.ipv4CIDR("/"), .ipv6CIDR("/")] {
try CustomRuleStore.encode(
CustomRuleDocument(rules: [CustomRule(action: .direct, match: match)])
).write(to: store.fileURL)
let before = try Data(contentsOf: store.fileURL)
XCTAssertThrowsError(try store.load()) { error in
guard case .corrupt = error as? CustomRuleStoreError else {
return XCTFail("Expected corrupt document, got \(error)")
}
}
XCTAssertEqual(try Data(contentsOf: store.fileURL), before)
}
}
func testCorruptFileThrowsCorrupt() throws {
try Data("not-json".utf8).write(to: store.fileURL)
XCTAssertThrowsError(try store.load()) { error in
guard case .corrupt = error as? CustomRuleStoreError else {
return XCTFail("应点名 corrupt,实际 \(error)")
}
}
}
func testSchemaVersionMismatchIsRejected() throws {
let payload = """
{"schemaVersion": 99, "rules": []}
"""
try Data(payload.utf8).write(to: store.fileURL)
XCTAssertThrowsError(try store.load()) { error in
guard case .schemaVersionMismatch(let found, let expected)? = error as? CustomRuleStoreError
else {
return XCTFail("应点名 schema 版本不匹配,实际 \(error)")
}
XCTAssertEqual(found, 99)
XCTAssertEqual(expected, CustomRuleDocument.currentSchemaVersion)
}
}
func testSummaryExposesCountAndStableContentVersionWithoutRawDomains() throws {
let rules = [
CustomRule(action: .proxy, match: try RuleMatch(domainSuffix: "secret-internal.example")),
CustomRule(action: .direct, match: try RuleMatch(ipv4CIDR: "203.0.113.0/24")),
]
try store.save(rules)
let summary = try store.summary()
XCTAssertEqual(summary.count, 2)
XCTAssertEqual(summary.contentVersion.count, 12)
XCTAssertFalse(summary.contentVersion.contains("secret"))
// 重排不改内容版本。
let reordered = CustomRuleSummary.summarizing(Array(rules.reversed()))
XCTAssertEqual(reordered.contentVersion, summary.contentVersion)
// 内容变化改版本。
let changed = CustomRuleSummary.summarizing([
CustomRule(action: .proxy, match: try RuleMatch(domainSuffix: "other.example"))
])
XCTAssertNotEqual(changed.contentVersion, summary.contentVersion)
}
}