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

200 lines
9.6 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
final class CustomRuleDeletionControllerTests: ProxyRuntimeControllerTests {
override func makeDefaultRuleSnapshots() -> BuiltinRuleSnapshots {
BuiltinRuleSnapshots(loader: { source in
// Keep the covering rule used by the unchanged-ACL deletion scenario.
if source == .geolocationCN {
return rulesFixture(
source,
rules: [
ProxyRule(action: .direct, match: .domainSuffix("cn"))
])
}
return try ProxyRuntimeFixture.controlFlowRuleSnapshot(source)
})
}
func testDeletionWhileOffPersistsBatchAndDisabledOrphansWithoutStarting() async throws {
let (store, _) = try makeCustomRuleStore()
let rules = [
CustomRule(action: .direct, match: .domainExact("one.example")),
CustomRule(action: .direct, match: .domainExact("two.example")),
]
let original = CustomRuleDocument(rules: rules, disabledIdentities: [rules[0].identity])
try store.saveDocument(original)
let controller = makeDeletionController(
store: store, settings: ProxySettings(listen: ActivationFixture.listen, agentEnabled: false))
let workflow = deletionWorkflow(controller)
await workflow.refresh()
workflow.select(Set(workflow.snapshot.rows.map(\.id)))
let confirmation = try XCTUnwrap(workflow.prepareCustomRuleDeletion())
await workflow.deleteCustomRules(confirmation)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
await controller.ruleApplicationTask?.value
XCTAssertEqual(
try store.loadDocument(),
CustomRuleDocument(rules: [], disabledIdentities: original.disabledIdentities))
XCTAssertEqual(controller.state, .off)
XCTAssertEqual(agent.registerCount, 0)
var query = workflow.snapshot.query
query.enabled = false
workflow.query(query)
let orphan = try XCTUnwrap(workflow.snapshot.rows.first { $0.identity == rules[0].identity })
XCTAssertFalse(orphan.hasCurrentSource)
await workflow.setEnabled(true, identities: [rules[0].identity])
XCTAssertFalse(workflow.snapshot.rows.contains { $0.identity == rules[0].identity })
XCTAssertTrue(try store.loadDocument().disabledIdentities.isEmpty)
}
func testBatchDeletionDeploysOnceAndInvalidatesAddressTest() async throws {
let seeded = try makeSeededCatalog()
let (store, _) = try makeCustomRuleStore()
let rules = [
CustomRule(action: .direct, match: .domainExact("one-delete.example")),
CustomRule(action: .direct, match: .domainExact("two-delete.example")),
]
try store.save(rules)
let controller = makeDeletionController(
store: store,
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: .rule,
ruleDefaultAction: .proxyWhenUnmatched, agentEnabled: true), proxyMode: .rule)
try await controller.activate(seeded.server)
let workflow = deletionWorkflow(controller)
await workflow.refresh()
workflow.setTestTarget("one-delete.example")
await workflow.testAddress()
XCTAssertNotNil(workflow.snapshot.addressTest.result)
workflow.select(Set(workflow.snapshot.rows.filter { !$0.customIDs.isEmpty }.map(\.id)))
let confirmation = try XCTUnwrap(workflow.prepareCustomRuleDeletion())
let registrations = agent.registerCount
await workflow.deleteCustomRules(confirmation)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
await controller.ruleApplicationTask?.value
XCTAssertEqual(agent.registerCount, registrations + 1)
XCTAssertTrue(try store.load().isEmpty)
let content = try activeACLContent(RuntimeFileStore(fileURL: runtime.contract))
XCTAssertFalse(content.contains("one-delete.example"))
XCTAssertFalse(content.contains("two-delete.example"))
XCTAssertNil(workflow.snapshot.addressTest.result)
XCTAssertTrue(workflow.snapshot.selection.isEmpty)
XCTAssertEqual(workflow.snapshot.commitFeedback?.operation, .delete)
}
func testDeletionInNonRuleModesOnlySavesAndCoveredRuleDoesNotRestart() async throws {
let seeded = try makeSeededCatalog()
let (store, _) = try makeCustomRuleStore()
let rule = CustomRule(action: .direct, match: .domainExact("covered.cn"))
for mode in [ProxyMode.global, .direct, .rule] {
try store.save([rule])
let controller = makeDeletionController(
store: store,
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: mode.kind,
ruleDefaultAction: .proxyWhenUnmatched, agentEnabled: true), proxyMode: mode)
try await controller.activate(seeded.server)
let workflow = deletionWorkflow(controller)
await workflow.refresh()
workflow.select(Set(workflow.snapshot.rows.filter { !$0.customIDs.isEmpty }.map(\.id)))
let confirmation = try XCTUnwrap(workflow.prepareCustomRuleDeletion())
let registrations = agent.registerCount
await workflow.deleteCustomRules(confirmation)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
await controller.ruleApplicationTask?.value
XCTAssertEqual(agent.registerCount, registrations)
XCTAssertTrue(try store.load().isEmpty)
await controller.setAgentEnabled(false)
}
}
func testDeletionDeploymentFailurePreservesDeletedDocumentAndOldRuntime() async throws {
let seeded = try makeSeededCatalog()
let (store, _) = try makeCustomRuleStore()
let rule = CustomRule(action: .direct, match: .domainExact("keep-one.example"))
let orphan = RuleIdentity(action: .proxy, match: .domainExact("orphan.example"))
try store.saveDocument(CustomRuleDocument(rules: [rule], disabledIdentities: [orphan]))
let controller = makeDeletionController(
store: store,
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: .rule,
ruleDefaultAction: .proxyWhenUnmatched, agentEnabled: true), proxyMode: .rule)
try await controller.activate(seeded.server)
let workflow = deletionWorkflow(controller)
await workflow.refresh()
workflow.select([.rule(rule.identity)])
let confirmation = try XCTUnwrap(workflow.prepareCustomRuleDeletion())
let runtimeStore = RuntimeFileStore(fileURL: runtime.contract)
let previousRuntime = try XCTUnwrap(runtimeStore.loadDocument())
let previousACL = try activeACLContent(runtimeStore)
agent.onRegister = {
guard let requested = runtimeStore.loadDocument() else { return }
let isRecovery = (try? self.activeACLContent(runtimeStore)) == previousACL
try? runtimeStore.writeRuntimeReceipt(
for: isRecovery ? requested : previousRuntime, processID: 42)
}
await workflow.deleteCustomRules(confirmation)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
let saved = CustomRuleDocument(rules: [], disabledIdentities: [orphan])
XCTAssertEqual(try store.loadDocument(), saved)
await controller.ruleApplicationTask?.value
XCTAssertEqual(try store.loadDocument(), saved)
XCTAssertEqual(runtimeStore.loadDocument(), previousRuntime)
XCTAssertEqual(try activeACLContent(runtimeStore), previousACL)
XCTAssertEqual(controller.state, .running)
XCTAssertNotNil(controller.runtimeFacts.failure)
XCTAssertEqual(workflow.snapshot.commitOutcome, .saved)
XCTAssertTrue(workflow.snapshot.rows.allSatisfy { $0.customIDs.isEmpty })
agent.onRegister = {
try? FileManager.default.removeItem(at: runtimeStore.runtimeStatusFileURL)
}
await controller.setAgentEnabled(true)
await controller.ruleApplicationTask?.value
XCTAssertEqual(try store.loadDocument(), saved)
XCTAssertNotEqual(controller.state, .running)
}
func testDeletionPersistenceFailureRetainsOwnedDocumentAndDoesNotStartRuntime() async throws {
let (store, directory) = try makeCustomRuleStore()
let rule = CustomRule(action: .direct, match: .domainExact("kept.example"))
let original = CustomRuleDocument(rules: [rule], disabledIdentities: [rule.identity])
try store.saveDocument(original)
let controller = makeDeletionController(
store: store, settings: ProxySettings(listen: ActivationFixture.listen, agentEnabled: false))
let workflow = deletionWorkflow(controller)
await workflow.refresh()
workflow.select(Set(workflow.snapshot.rows.map(\.id)))
let confirmation = try XCTUnwrap(workflow.prepareCustomRuleDeletion())
let originalData = try Data(contentsOf: store.fileURL)
let backupDirectory = directory.appendingPathExtension("backup")
try FileManager.default.moveItem(at: directory, to: backupDirectory)
try Data("blocks parent directory".utf8).write(to: directory)
let backup = backupDirectory.appendingPathComponent(store.fileURL.lastPathComponent)
await workflow.deleteCustomRules(confirmation)
XCTAssertEqual(workflow.snapshot.commitOutcome, .persistenceFailed)
XCTAssertEqual(controller.ruleDocuments.current, original)
XCTAssertEqual(try Data(contentsOf: backup), originalData)
XCTAssertEqual(workflow.snapshot.version, confirmation.version)
XCTAssertEqual(workflow.deletableSelection, [rule.id])
XCTAssertEqual(agent.registerCount, 0)
}
private func makeDeletionController(
store: CustomRuleStore, settings: ProxySettings, proxyMode: ProxyMode? = nil
) -> ProxyRuntimeController {
makeControllerWithCustomRules(
store: store, settings: settings, proxyMode: proxyMode,
launchHealthRetryDelay: { try await Task.sleep(for: .milliseconds(1)) },
ruleApplicationDelay: { await Task.yield() })
}
private func deletionWorkflow(_ controller: ProxyRuntimeController) -> RulesWorkflow {
RulesWorkflow(
loadDocument: { try controller.ruleDocuments.load() },
commitDocument: { await controller.commitRuleDocument($0) },
builtinSnapshots: controller.ruleSnapshots)
}
}