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

332 lines
15 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
@MainActor
final class RulesWorkflowTests: XCTestCase {
func testDisableAcrossSourcesRestoresCoverageAndOrphanCanBeEnabled() async throws {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: directory) }
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
let broad = CustomRule(action: .proxy, match: .domainSuffix("example.com"))
let narrow = CustomRule(action: .direct, match: .domainExact("safe.example.com"))
let orphan = RuleIdentity(action: .proxy, match: .domainExact("gone.example"))
try store.saveDocument(
CustomRuleDocument(rules: [broad, narrow], disabledIdentities: [orphan]))
var commits = 0
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
commits += 1
do {
try store.saveDocument(document)
return RuleDocumentCommit(outcome: .saved, document: document)
} catch {
XCTFail("Fixture save failed: \(error)")
return RuleDocumentCommit(
outcome: .persistenceFailed, document: try? store.loadDocument())
}
},
builtinSnapshots: BuiltinRuleSnapshots(loader: { source in
guard source == .gfwlist else { return rulesFixture(source) }
return rulesFixture(
source,
rules: [
ProxyRule(action: .proxy, match: broad.match)
])
}))
await workflow.refresh()
let version = workflow.snapshot.version
let covered = try XCTUnwrap(workflow.snapshot.rows.first { $0.identity == narrow.identity })
XCTAssertTrue(covered.relationships.contains { $0.kind == .shadowing && $0.extent == .full })
workflow.select([.rule(broad.identity), .noDotHostname])
XCTAssertEqual(workflow.actionableSelection, [broad.identity])
await workflow.setEnabled(false, identities: workflow.actionableSelection)
XCTAssertEqual(commits, 1)
XCTAssertNotEqual(workflow.snapshot.version, version)
let disabled = try XCTUnwrap(workflow.snapshot.rows.first { $0.identity == broad.identity })
XCTAssertFalse(disabled.isEnabled)
XCTAssertEqual(disabled.sources, [.custom, .gfwlist])
await workflow.analysisTask?.value
XCTAssertTrue(
workflow.snapshot.rows.first { $0.identity == narrow.identity }!.relationships.isEmpty)
workflow.setTestTarget("safe.example.com")
await workflow.testAddress()
XCTAssertEqual(workflow.snapshot.addressTest.result?.outcome, .direct)
workflow.query(RulesQuery(enabled: false))
XCTAssertTrue(workflow.snapshot.rows.contains { $0.identity == orphan && !$0.hasCurrentSource })
await workflow.setEnabled(true, identities: [orphan])
XCTAssertFalse(workflow.snapshot.rows.contains { $0.identity == orphan })
XCTAssertNil(workflow.snapshot.addressTest.result)
XCTAssertFalse(try store.loadDocument().disabledIdentities.contains(orphan))
}
func testEquivalentSourcesMergeForShippedRules() async throws {
let match = try RuleMatch(domainExact: "Example.COM")
let custom = CustomRule(action: .direct, match: match)
let source = RuleSourceIdentity(kind: .geolocationCN, upstreamVersion: "fixture", label: "geo")
let snapshot = RuleSnapshot(
metadata: RuleSnapshotMetadata(
source: source, upstreamReference: "upstream", inputDigest: "digest",
fetchedAt: Date(timeIntervalSince1970: 0), license: "MIT", attribution: "author"),
rules: [ProxyRule(action: .direct, match: match)])
let workflow = RulesWorkflow(
loadCustom: { [custom] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { source in
source == .geolocationCN ? snapshot : rulesFixture(source)
}))
await workflow.refresh()
workflow.query(RulesQuery(search: "EXAMPLE", action: .direct, source: .geolocationCN))
let row = try XCTUnwrap(workflow.snapshot.rows.first)
XCTAssertEqual(workflow.snapshot.rows.count, 1)
XCTAssertTrue(row.sources.contains(.custom))
XCTAssertTrue(row.sources.contains(.geolocationCN))
XCTAssertEqual(row.customIDs, [custom.id])
XCTAssertEqual(row.identity, custom.identity)
}
func testWrongBuiltinSourceIsAnIncompleteCollectionRatherThanMislabeledRules() async {
let workflow = RulesWorkflow(
loadCustom: { [] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { _ in
rulesFixture(.geolocationCN)
}))
await workflow.refresh()
XCTAssertFalse(workflow.snapshot.isComplete)
XCTAssertEqual(workflow.snapshot.issues.count, 2)
}
func testSearchActionAndSourceIntersectAndHiddenSelectionIsCleared() async throws {
let direct = CustomRule(action: .direct, match: try RuleMatch(domainSuffix: "example.com"))
let proxy = CustomRule(action: .proxy, match: try RuleMatch(domainExact: "outside.net"))
let workflow = RulesWorkflow(
loadCustom: { [direct, proxy] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
workflow.select([.rule(direct.identity), .rule(proxy.identity), .noDotHostname])
workflow.query(RulesQuery(search: "EXAMPLE", action: .direct, source: .custom))
XCTAssertEqual(workflow.snapshot.rows.map(\.identity), [direct.identity])
XCTAssertEqual(workflow.snapshot.selection, [.rule(direct.identity)])
workflow.query(RulesQuery(search: "EXAMPLE", action: .proxy, source: .custom))
XCTAssertTrue(workflow.snapshot.rows.isEmpty)
XCTAssertTrue(workflow.snapshot.selection.isEmpty)
XCTAssertTrue(workflow.snapshot.isComplete)
}
func testStableInputOrderAndNavigationPreserveVersionAndSessionQuery() async throws {
let entries = [
CustomRule(action: .proxy, match: try RuleMatch(domainExact: "z.net")),
CustomRule(action: .direct, match: try RuleMatch(domainExact: "a.net")),
]
let workflow = RulesWorkflow(
loadCustom: { entries }, builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let version = workflow.snapshot.version
workflow.query(RulesQuery(source: .custom))
workflow.select([.rule(entries[0].identity)])
let route = WorkspaceRoute()
route.navigate(to: .rules)
route.navigate(to: .home)
route.navigate(to: .rules)
XCTAssertEqual(workflow.snapshot.rows.map(\.content), ["z.net", "a.net"])
XCTAssertEqual(workflow.snapshot.query.source, .custom)
XCTAssertEqual(workflow.snapshot.selection, [.rule(entries[0].identity)])
await workflow.refresh()
XCTAssertEqual(workflow.snapshot.version, version)
XCTAssertEqual(workflow.snapshot.selection, [.rule(entries[0].identity)])
}
func testCorruptUserDocumentAndMissingBuiltinStayDistinctFromEmptySearch() async {
let workflow = RulesWorkflow(
loadCustom: { throw CustomRuleStoreError.corrupt(detail: "fixture") },
builtinSnapshots: BuiltinRuleSnapshots(loader: { source in
if source == .chinaIPv4 { throw RuleSnapshotError.missing }
return rulesFixture(source)
}))
await workflow.refresh()
XCTAssertFalse(workflow.snapshot.isComplete)
XCTAssertEqual(
workflow.snapshot.issues,
[.userDocument("corrupt(detail: \"fixture\")"), .builtin(.chinaIPv4, "missing")])
XCTAssertTrue(workflow.snapshot.rows.contains { $0.isFixed })
workflow.query(RulesQuery(search: "no-result.example"))
XCTAssertTrue(workflow.snapshot.rows.isEmpty)
XCTAssertFalse(workflow.snapshot.isComplete)
XCTAssertEqual(workflow.snapshot.issues.count, 2)
}
func testPackagedCollectionLoadsMetadataShippedRulesAndFixedSemanticPolicy() async throws {
let bundle = AppArtifact.bundle
let workflow = RulesWorkflow(
loadCustom: { [] },
builtinSnapshots: BuiltinRuleSnapshots(bundle: bundle))
await workflow.refresh()
XCTAssertTrue(workflow.snapshot.isComplete, "\(workflow.snapshot.issues)")
XCTAssertEqual(workflow.snapshot.sources.count, 5)
XCTAssertTrue(workflow.snapshot.rows.contains { $0.id == .noDotHostname && $0.isFixed })
let geo = try XCTUnwrap(workflow.snapshot.sources.first { $0.id == .geolocationCN })
XCTAssertEqual(geo.count, 4241)
XCTAssertEqual(geo.metadata?.source.upstreamVersion, "20260925234224")
XCTAssertNotNil(geo.conversionReport)
let rows = workflow.snapshot.rows
XCTAssertEqual(Set(rows.map(\.id)).count, rows.count)
workflow.query(RulesQuery(source: .geolocationCN))
XCTAssertTrue(workflow.snapshot.rows.contains { $0.content == "cn" })
XCTAssertEqual(workflow.snapshot.rows.count, 4241)
}
func testRefreshPublishesVersionAndRowsTogetherAndInvalidatesRemovedSelection() async throws {
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: directory) }
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
let old = CustomRule(action: .direct, match: try RuleMatch(domainExact: "old.net"))
let new = CustomRule(action: .proxy, match: try RuleMatch(domainExact: "new.net"))
try store.save([old])
let workflow = RulesWorkflow(
loadCustom: { try store.load() },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
workflow.query(RulesQuery(source: .custom))
workflow.select([.rule(old.identity)])
let oldVersion = workflow.snapshot.version
try store.save([new])
let observation = workflow.$snapshot.sink { snapshot in
if snapshot.version != oldVersion {
XCTAssertEqual(snapshot.rows.map(\.content), ["new.net"])
XCTAssertTrue(snapshot.selection.isEmpty)
}
}
await workflow.refresh()
observation.cancel()
XCTAssertNotEqual(workflow.snapshot.version, oldVersion)
XCTAssertEqual(workflow.snapshot.rows.map(\.identity), [new.identity])
let loadedVersion = workflow.snapshot.version
try Data("broken".utf8).write(to: store.fileURL)
await workflow.refresh()
XCTAssertFalse(workflow.snapshot.isComplete)
XCTAssertEqual(workflow.snapshot.issues.count, 1)
XCTAssertEqual(workflow.snapshot.rows.map(\.identity), [new.identity])
XCTAssertEqual(workflow.snapshot.version, loadedVersion)
XCTAssertEqual(workflow.snapshot.operationStatus, .collectionIncomplete)
}
func testLateOldRefreshCannotReplaceTheNewCollection() async throws {
let firstRead = XCTestExpectation(description: "first read")
let barrier = RulesReadBarrier(firstRead: firstRead)
let workflow = RulesWorkflow(
loadCustom: { try barrier.read() },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
let older = Task { await workflow.refresh() }
await fulfillment(of: [firstRead], timeout: 3)
defer { barrier.release.signal() }
XCTAssertTrue(workflow.snapshot.isLoading)
await workflow.refresh()
workflow.query(RulesQuery(source: .custom))
XCTAssertEqual(workflow.snapshot.rows.map(\.content), ["new.net"])
let version = workflow.snapshot.version
barrier.release.signal()
await older.value
XCTAssertEqual(workflow.snapshot.rows.map(\.content), ["new.net"])
XCTAssertEqual(workflow.snapshot.version, version)
XCTAssertFalse(workflow.snapshot.isLoading)
}
}
extension RulesWorkflowTests {
func testCandidatePermutationKeepsVersionAndCoverageWhilePreservingInputOrder() async throws {
let broad = CustomRule(action: .direct, match: try RuleMatch(domainSuffix: "example.com"))
let narrow = CustomRule(action: .proxy, match: try RuleMatch(domainExact: "www.example.com"))
let forward = RulesWorkflow(
loadCustom: { [broad, narrow] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
let reverse = RulesWorkflow(
loadCustom: { [narrow, broad] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await forward.refresh()
await reverse.refresh()
XCTAssertEqual(forward.snapshot.version, reverse.snapshot.version)
XCTAssertEqual(
Dictionary(uniqueKeysWithValues: forward.snapshot.rows.map { ($0.id, $0) }),
Dictionary(uniqueKeysWithValues: reverse.snapshot.rows.map { ($0.id, $0) }))
XCTAssertEqual(
forward.snapshot.rows.prefix(2).compactMap(\.identity), [broad.identity, narrow.identity])
XCTAssertEqual(
reverse.snapshot.rows.prefix(2).compactMap(\.identity), [narrow.identity, broad.identity])
}
func testSameNamedExactAndSuffixHaveStableVersionsAcrossRefreshes() async throws {
let exact = CustomRule(action: .direct, match: try RuleMatch(domainExact: "example.com"))
let suffix = CustomRule(action: .direct, match: try RuleMatch(domainSuffix: "example.com"))
let workflow = RulesWorkflow(
loadCustom: { [suffix, exact] },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let version = workflow.snapshot.version
let identities = workflow.snapshot.rows.map(\.identity)
for _ in 0..<12 {
await workflow.refresh()
XCTAssertEqual(workflow.snapshot.version, version)
XCTAssertEqual(workflow.snapshot.rows.map(\.identity), identities)
}
}
}
extension RulesWorkflowTests {
func testCollectionPreservesInputOrderForEqualContentWithDistinctActionsAndMatches() throws {
let exact = try RuleMatch(domainExact: "same.example")
let suffix = try RuleMatch(domainSuffix: "same.example")
let rules = [
CustomRule(action: .proxy, match: suffix),
CustomRule(action: .direct, match: suffix),
CustomRule(action: .proxy, match: exact),
CustomRule(action: .direct, match: exact),
]
for input in [rules, Array(rules.reversed())] {
let collection = RulesCollection.load(custom: { input }, builtin: { rulesFixture($0) })
XCTAssertTrue(collection.issues.isEmpty)
XCTAssertEqual(
collection.rows.filter { $0.content == "same.example" }.compactMap(\.identity),
input.map(\.identity))
XCTAssertTrue(collection.rows.contains { $0.id == .noDotHostname && $0.isFixed })
}
}
}
func rulesFixture(
_ source: RulesSource, rules: [ProxyRule] = []
) -> RuleSnapshot {
guard let kind = source.sourceKind else {
preconditionFailure("Fixed policy has no rule snapshot")
}
return RuleSnapshot(
metadata: RuleSnapshotMetadata(
source: RuleSourceIdentity(kind: kind, upstreamVersion: "v1", label: source.rawValue),
upstreamReference: "https://example.com/source", inputDigest: "fixture",
fetchedAt: Date(timeIntervalSince1970: 0),
license: "MIT", attribution: "fixture author"), rules: rules)
}
private final class RulesReadBarrier: @unchecked Sendable {
let release = DispatchSemaphore(value: 0)
private let lock = NSLock()
private var reads = 0
private let firstRead: XCTestExpectation
init(firstRead: XCTestExpectation) { self.firstRead = firstRead }
func read() throws -> [CustomRule] {
lock.lock()
reads += 1
let first = reads == 1
lock.unlock()
if first {
firstRead.fulfill()
guard release.wait(timeout: .now() + 5) == .success else { throw RuleSnapshotError.missing }
}
return [
CustomRule(action: .direct, match: try RuleMatch(domainExact: first ? "old.net" : "new.net"))
]
}
}