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

175 lines
7.9 KiB
Swift

import Combine
import XCTest
@testable import ShadowsocksX_NG2
@MainActor
final class RuleStatusWorkflowTests: XCTestCase {
func testUnavailableFinalDocumentKeepsRowsAndRequiresExplicitRetry() 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 workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
_ = saveFixture(document, to: store, outcome: .saved)
return RuleDocumentCommit(outcome: .saved, document: nil)
},
feedbackDelay: { XCTFail("An incomplete collection must not start the success timer") },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let rows = workflow.snapshot.rows
await workflow.setEnabled(false, identities: [rule.identity])
XCTAssertEqual(workflow.snapshot.operationStatus, .collectionIncomplete)
XCTAssertEqual(workflow.snapshot.rows, rows)
XCTAssertFalse(workflow.snapshot.isComplete)
await workflow.refresh()
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
}
func testSuccessCountsOnlyActualChangesAndExpiresAfterCollectionUpdate() 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 disabled = CustomRule(action: .proxy, match: .domainExact("disabled.example"))
let enabled = CustomRule(action: .proxy, match: .domainExact("enabled.example"))
try store.saveDocument(
CustomRuleDocument(rules: [disabled, enabled], disabledIdentities: [disabled.identity]))
let timerStarted = expectation(description: "success timer started")
let clock = RuleFeedbackClock(started: timerStarted)
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
saveFixture(document, to: store, outcome: .saved)
},
feedbackDelay: { await clock.wait() },
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let fixed = try XCTUnwrap(workflow.snapshot.rows.first { $0.isFixed }?.identity)
await workflow.setEnabled(true, identities: [disabled.identity, enabled.identity, fixed])
let feedback = try XCTUnwrap(workflow.snapshot.commitFeedback)
XCTAssertEqual(feedback.changedCount, 1)
XCTAssertEqual(feedback.operation, .enablement(true))
XCTAssertEqual(feedback.outcome, .saved)
XCTAssertTrue(workflow.snapshot.rows.first { $0.identity == disabled.identity }!.isEnabled)
await fulfillment(of: [timerStarted], timeout: 3)
let expired = expectation(description: "success dismissed")
let observation = workflow.$snapshot.filter { $0.commitFeedback == nil }.sink { _ in
expired.fulfill()
}
await clock.resume()
await fulfillment(of: [expired], timeout: 3)
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
withExtendedLifetime(observation) {}
}
func testCommitRemainsOneBusyOperationAndAllowsBrowsing() 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 reloadStarted = expectation(description: "collection reload paused")
let gate = RuleFeedbackClock(started: reloadStarted)
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
await gate.wait()
return saveFixture(document, to: store, outcome: .saved)
},
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
let pending = Task { await workflow.setEnabled(false, identities: [rule.identity]) }
await fulfillment(of: [reloadStarted], timeout: 3)
XCTAssertFalse(workflow.snapshot.isLoading)
XCTAssertEqual(workflow.snapshot.operationStatus, .updating)
XCTAssertNil(workflow.snapshot.commitFeedback)
XCTAssertTrue(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
let query = RulesQuery(search: "example", source: .custom)
workflow.query(query)
let row = try XCTUnwrap(workflow.snapshot.rows.first)
workflow.select([row.id])
await gate.resume()
await pending.value
XCTAssertEqual(workflow.snapshot.query, query)
XCTAssertEqual(workflow.snapshot.selection, [row.id])
XCTAssertFalse(workflow.snapshot.rows.first!.isEnabled)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
}
func testOldSuccessTimerCannotDismissNewFailureAndClosingDoesNotChangeRules() 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 timerStarted = expectation(description: "success timer started")
let timerReturned = expectation(description: "old timer returned")
let clock = RuleFeedbackClock(started: timerStarted)
let commitState = RuleCommitState()
let workflow = RulesWorkflow(
loadDocument: { try store.loadDocument() },
commitDocument: { document in
commitState.outcome.isSuccess
? saveFixture(document, to: store, outcome: commitState.outcome)
: RuleDocumentCommit(outcome: commitState.outcome, document: try? store.loadDocument())
},
feedbackDelay: {
await clock.wait()
timerReturned.fulfill()
},
builtinSnapshots: BuiltinRuleSnapshots(loader: { rulesFixture($0) }))
await workflow.refresh()
await workflow.setEnabled(false, identities: [rule.identity])
await fulfillment(of: [timerStarted], timeout: 3)
commitState.outcome = .persistenceFailed
await workflow.setEnabled(true, identities: [rule.identity])
await clock.resume()
await fulfillment(of: [timerReturned], timeout: 3)
XCTAssertEqual(workflow.snapshot.commitOutcome, .persistenceFailed)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
workflow.dismissFeedback()
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
}
}
@MainActor
private final class RuleCommitState {
var outcome: CustomRuleUpdateOutcome = .saved
}
private actor RuleFeedbackClock {
let started: XCTestExpectation
private var continuation: CheckedContinuation<Void, Never>?
init(started: XCTestExpectation) { self.started = started }
func wait() async {
await withCheckedContinuation {
continuation = $0
started.fulfill()
}
}
func resume() {
continuation?.resume()
continuation = nil
}
}
private func saveFixture(
_ document: CustomRuleDocument, to store: CustomRuleStore, outcome: CustomRuleUpdateOutcome
) -> RuleDocumentCommit {
do {
try store.saveDocument(document)
return RuleDocumentCommit(outcome: outcome, document: document)
} catch {
XCTFail("Fixture save failed: \(error)")
return RuleDocumentCommit(outcome: .persistenceFailed, document: try? store.loadDocument())
}
}