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

223 lines
9.7 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
@MainActor
final class RuleEnablementWorkflowTests: XCTestCase {
func testSavedTogglesStayInteractiveAndOfflineMatchingUsesLatestFactsDuringAnalysis() async throws
{
let broad = CustomRule(action: .direct, match: .domainSuffix("pending.example"))
let narrow = CustomRule(action: .direct, match: .domainExact("x.pending.example"))
let started = expectation(description: "analysis debounce paused")
let gate = RulesAnalysisGate(started: started)
var documents: [CustomRuleDocument] = []
let workflow = RulesWorkflow(
loadDocument: { CustomRuleDocument(rules: [broad, narrow]) },
commitDocument: {
documents.append($0)
return RuleDocumentCommit(outcome: .saved, document: $0)
},
analysisDelay: { await gate.wait() },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
workflow.query(RulesQuery(source: .custom))
let originalOrder = workflow.snapshot.rows.map(\.id)
let oldRelationships = try XCTUnwrap(
workflow.snapshot.rows.first { $0.identity == narrow.identity }
).relationships
XCTAssertFalse(oldRelationships.isEmpty)
await workflow.setEnabled(false, identities: [broad.identity])
await fulfillment(of: [started], timeout: 3)
XCTAssertTrue(workflow.snapshot.isComplete)
XCTAssertFalse(workflow.snapshot.isCommitting)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == broad.identity }!.isEnabled)
XCTAssertEqual(
workflow.snapshot.rows.first { $0.identity == narrow.identity }!.relationships,
oldRelationships)
workflow.setTestTarget("other.pending.example")
await workflow.testAddress()
XCTAssertEqual(workflow.snapshot.addressTest.result?.outcome, .unmatched)
await workflow.setEnabled(true, identities: [broad.identity])
await workflow.setEnabled(false, identities: [broad.identity])
XCTAssertEqual(documents.count, 3)
let version = workflow.snapshot.version
await gate.resume()
await workflow.analysisTask?.value
XCTAssertEqual(workflow.snapshot.version, version)
XCTAssertEqual(workflow.snapshot.rows.map(\.id), originalOrder)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == broad.identity }!.isEnabled)
XCTAssertTrue(
workflow.snapshot.rows.first { $0.identity == narrow.identity }!.relationships.isEmpty)
}
func testCollectionSaveKeepsRowOrderAndFixedFactsWithoutWaitingForAnalysis() 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 session = RuleDocumentSession(store: store)
let started = expectation(description: "analysis paused")
let gate = RulesAnalysisGate(started: started)
let workflow = RulesWorkflow(
loadDocument: { try session.load() },
commitDocument: { document in
do {
try session.save(document)
return RuleDocumentCommit(outcome: .saved, document: session.current)
} catch {
XCTFail("Fixture save failed: \(error)")
return RuleDocumentCommit(outcome: .persistenceFailed, document: session.current)
}
},
analysisDelay: { await gate.wait() },
builtinSnapshots: BuiltinRuleSnapshots(loader: { source in
if source == .geolocationCN {
return rulesFixture(
source,
rules: [
ProxyRule(action: .direct, match: .domainSuffix("cn")),
ProxyRule(action: .direct, match: .domainExact("fixture.example")),
])
}
return rulesFixture(source)
}))
await workflow.refresh()
XCTAssertTrue(workflow.snapshot.isComplete)
XCTAssertTrue(workflow.snapshot.sources.contains { $0.id == .geolocationCN })
let rowIDs = workflow.snapshot.rows.map(\.id)
let fixed = workflow.snapshot.rows.filter(\.isFixed)
XCTAssertFalse(fixed.isEmpty)
let nationalSuffix = RuleIdentity(action: .direct, match: .domainSuffix("cn"))
await workflow.setEnabled(false, identities: [nationalSuffix])
XCTAssertTrue(try store.loadDocument().disabledIdentities.contains(nationalSuffix))
XCTAssertEqual(workflow.snapshot.rows.map(\.id), rowIDs)
XCTAssertEqual(workflow.snapshot.rows.filter(\.isFixed), fixed)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == nationalSuffix }!.isEnabled)
XCTAssertTrue(workflow.snapshot.isComplete)
await fulfillment(of: [started], timeout: 3)
await gate.resume()
await workflow.analysisTask?.value
XCTAssertEqual(workflow.snapshot.rows.map(\.id), rowIDs)
XCTAssertEqual(workflow.snapshot.rows.filter(\.isFixed), fixed)
}
func testSuccessfulCommitDoesNotReadSourcesOrUserDocumentAgain() async throws {
let reads = RulesReadCounts()
let rule = CustomRule(action: .proxy, match: .domainExact("saved.example"))
let workflow = RulesWorkflow(
loadDocument: {
reads.recordDocument()
return CustomRuleDocument(rules: [rule])
},
commitDocument: { RuleDocumentCommit(outcome: .saved, document: $0) },
builtinSnapshots: BuiltinRuleSnapshots(loader: { source in
reads.recordSource()
return rulesFixture(source)
}))
await workflow.refresh()
await workflow.setEnabled(false, identities: [rule.identity])
XCTAssertEqual(reads.documentCount, 1)
XCTAssertEqual(reads.sourceCount, 3)
XCTAssertFalse(
try XCTUnwrap(workflow.snapshot.rows.first { $0.identity == rule.identity }).isEnabled)
}
func testInFlightBatchRejectsRepeatedCommandAndPublishesProgress() 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 rule = CustomRule(action: .proxy, match: .domainExact("example.net"))
try store.save([rule])
let started = expectation(description: "commit started")
var continuation: CheckedContinuation<Void, Never>?
var commits = 0
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
commits += 1
await withCheckedContinuation {
continuation = $0
started.fulfill()
}
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: { rulesFixture($0) }))
await workflow.refresh()
let pending = Task { await workflow.setEnabled(false, identities: [rule.identity]) }
await fulfillment(of: [started], timeout: 3)
XCTAssertTrue(workflow.snapshot.isCommitting)
XCTAssertEqual(workflow.snapshot.operationStatus, .updating)
XCTAssertNil(workflow.snapshot.commitFeedback)
await workflow.setEnabled(false, identities: [rule.identity])
await workflow.refresh()
XCTAssertEqual(commits, 1)
continuation?.resume()
await pending.value
XCTAssertFalse(workflow.snapshot.isCommitting)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
let feedback = try XCTUnwrap(workflow.snapshot.commitFeedback)
XCTAssertEqual(feedback.changedCount, 1)
XCTAssertEqual(feedback.operation, .enablement(false))
XCTAssertEqual(workflow.snapshot.operationStatus, .feedback(feedback))
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
}
func testFailedSaveKeepsSnapshotWithoutReload() 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 rule = CustomRule(action: .direct, match: .domainExact("kept.example"))
try store.save([rule])
var commits = 0
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { _ in
commits += 1
return RuleDocumentCommit(outcome: .persistenceFailed, document: try? store.loadDocument())
},
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let version = workflow.snapshot.version
await workflow.setEnabled(false, identities: [rule.identity])
XCTAssertEqual(workflow.snapshot.commitOutcome, .persistenceFailed)
XCTAssertEqual(workflow.snapshot.version, version)
XCTAssertTrue(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
XCTAssertEqual(commits, 1)
}
}
private final class RulesReadCounts: @unchecked Sendable {
private let lock = NSLock()
private var documents = 0
private var sources = 0
func recordDocument() { lock.withLock { documents += 1 } }
func recordSource() { lock.withLock { sources += 1 } }
var documentCount: Int { lock.withLock { documents } }
var sourceCount: Int { lock.withLock { sources } }
}
private actor RulesAnalysisGate {
let started: XCTestExpectation
private var continuation: CheckedContinuation<Void, Never>?
private var first = true
init(started: XCTestExpectation) { self.started = started }
func wait() async {
guard first else { return }
first = false
await withCheckedContinuation {
continuation = $0
started.fulfill()
}
}
func resume() {
continuation?.resume()
continuation = nil
}
}