mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-16 04:54:42 +00:00
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。
388 lines
17 KiB
Swift
388 lines
17 KiB
Swift
import XCTest
|
|
|
|
@testable import ShadowsocksX_NG2
|
|
|
|
final class RuleEnablementControllerTests: ProxyRuntimeControllerTests {
|
|
override func makeDefaultRuleSnapshots() -> BuiltinRuleSnapshots {
|
|
BuiltinRuleSnapshots(loader: ProxyRuntimeFixture.controlFlowRuleSnapshot)
|
|
}
|
|
|
|
private func makeRuleEnablementController(
|
|
store: CustomRuleStore,
|
|
settings: ProxySettings,
|
|
proxyMode: ProxyMode? = nil,
|
|
launchHealthTimeoutSeconds: TimeInterval = 0.05,
|
|
ruleSnapshots: BuiltinRuleSnapshots? = nil,
|
|
launchHealthRetryDelay: @escaping () async throws -> Void = {
|
|
try await Task.sleep(for: .milliseconds(1))
|
|
},
|
|
ruleApplicationDelay: @escaping () async throws -> Void = { await Task.yield() }
|
|
) -> ProxyRuntimeController {
|
|
makeControllerWithCustomRules(
|
|
store: store, settings: settings, proxyMode: proxyMode,
|
|
launchHealthTimeoutSeconds: launchHealthTimeoutSeconds,
|
|
launchHealthRetryDelay: launchHealthRetryDelay,
|
|
ruleApplicationDelay: ruleApplicationDelay,
|
|
ruleSnapshots: ruleSnapshots)
|
|
}
|
|
|
|
func testRapidRuleSavesCoalesceIntoOneLatestACLDeployment() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let first = CustomRule(action: .direct, match: .domainExact("first-save.example"))
|
|
let latest = CustomRule(action: .direct, match: .domainExact("latest-save.example"))
|
|
let applicationStarted = expectation(description: "rule application paused")
|
|
let applicationGate = RuleRuntimeDelayGate(started: applicationStarted)
|
|
defer { applicationGate.resume() }
|
|
let controller = makeRuleEnablementController(
|
|
store: store,
|
|
settings: ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .rule, agentEnabled: true),
|
|
proxyMode: .rule, ruleApplicationDelay: { await applicationGate.wait() })
|
|
try await controller.activate(seeded.server)
|
|
let before = agent.registerCount
|
|
let one = await controller.commitRuleDocument(CustomRuleDocument(rules: [first]))
|
|
await fulfillment(of: [applicationStarted], timeout: 3)
|
|
let two = await controller.commitRuleDocument(CustomRuleDocument(rules: [latest]))
|
|
XCTAssertEqual(one.outcome, .saved)
|
|
XCTAssertEqual(two.outcome, .saved)
|
|
XCTAssertEqual(try store.load(), [latest])
|
|
XCTAssertEqual(
|
|
agent.registerCount, before, "Saving does not wait for or start deployment inline")
|
|
applicationGate.resume()
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(agent.registerCount, before + 1)
|
|
let content = try activeACLContent(RuntimeFileStore(fileURL: runtime.contract))
|
|
XCTAssertTrue(content.contains("latest-save.example"))
|
|
XCTAssertFalse(content.contains("first-save.example"))
|
|
}
|
|
|
|
func testSaveDuringDeploymentIsAcceptedAndLatestDocumentConvergesAfterIt() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let first = CustomRule(action: .direct, match: .domainExact("in-flight.example"))
|
|
let latest = CustomRule(action: .direct, match: .domainExact("after-flight.example"))
|
|
let healthWaiting = expectation(description: "health retry paused")
|
|
let healthGate = RuleRuntimeDelayGate(started: healthWaiting)
|
|
defer { healthGate.resume() }
|
|
let controller = makeRuleEnablementController(
|
|
store: store,
|
|
settings: ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .rule, agentEnabled: true),
|
|
proxyMode: .rule, launchHealthTimeoutSeconds: 0.3,
|
|
launchHealthRetryDelay: { await healthGate.wait() })
|
|
try await controller.activate(seeded.server)
|
|
let runtimeStore = RuntimeFileStore(fileURL: runtime.contract)
|
|
let started = expectation(description: "first deployment awaiting receipt")
|
|
let before = agent.registerCount
|
|
var firstDocument: SslocalRuntimeDocument?
|
|
agent.onRegister = { [agent] in
|
|
guard let document = runtimeStore.loadDocument() else { return }
|
|
if agent?.registerCount == before + 1 {
|
|
firstDocument = document
|
|
try? FileManager.default.removeItem(at: runtimeStore.runtimeStatusFileURL)
|
|
started.fulfill()
|
|
} else {
|
|
try? runtimeStore.writeRuntimeReceipt(for: document, processID: 42)
|
|
}
|
|
}
|
|
let one = await controller.commitRuleDocument(CustomRuleDocument(rules: [first]))
|
|
XCTAssertEqual(one.outcome, .saved)
|
|
await fulfillment(of: [started, healthWaiting], timeout: 3)
|
|
let two = await controller.commitRuleDocument(CustomRuleDocument(rules: [latest]))
|
|
XCTAssertEqual(two.outcome, .saved)
|
|
XCTAssertEqual(try store.load(), [latest])
|
|
XCTAssertEqual(agent.registerCount, before + 1, "A new save cannot overlap rule deployments")
|
|
try runtimeStore.writeRuntimeReceipt(for: XCTUnwrap(firstDocument), processID: 42)
|
|
healthGate.resume()
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(try store.load(), [latest])
|
|
XCTAssertEqual(agent.registerCount, before + 2)
|
|
let content = try activeACLContent(runtimeStore)
|
|
XCTAssertTrue(content.contains("after-flight.example"))
|
|
XCTAssertFalse(content.contains("in-flight.example"))
|
|
XCTAssertEqual(controller.state, .running)
|
|
}
|
|
|
|
func testNewPreparationStopsRemainingActionsOfAnAwaitingRuntimeOperation() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let started = expectation(description: "new source preparation")
|
|
let loader = PausedRuntimeRuleSource(started: started)
|
|
defer { loader.release.signal() }
|
|
let controller = makeRuleEnablementController(
|
|
store: store,
|
|
settings: ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true),
|
|
proxyMode: .global, ruleSnapshots: BuiltinRuleSnapshots(loader: { loader.load($0) }))
|
|
try await controller.activate(seeded.server)
|
|
let runtimeStore = RuntimeFileStore(fileURL: runtime.contract)
|
|
let previous = try XCTUnwrap(runtimeStore.loadDocument())
|
|
try Data("42".utf8).write(to: runtimeStore.pidFileURL)
|
|
let unregistered = expectation(description: "old operation waiting for wrapper exit")
|
|
agent.onUnregister = { unregistered.fulfill() }
|
|
let oldOperation = Task { await controller.execute(.stop, document: nil) }
|
|
await fulfillment(of: [unregistered], timeout: 3)
|
|
let newMode = Task { await controller.setProxyMode(.rule) }
|
|
await fulfillment(of: [started], timeout: 3)
|
|
try FileManager.default.removeItem(at: runtimeStore.pidFileURL)
|
|
let completed = await oldOperation.value
|
|
XCTAssertFalse(completed.succeeded)
|
|
XCTAssertEqual(runtimeStore.loadDocument(), previous, "Stale stop must not delete the contract")
|
|
loader.release.signal()
|
|
await newMode.value
|
|
XCTAssertEqual(controller.lastDocument?.aclRuntime?.summary, "rule-proxy-default")
|
|
XCTAssertEqual(controller.state, .running)
|
|
}
|
|
|
|
func testSystemProxyToggleDoesNotDiscardPendingRuleModePreparation() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let started = expectation(description: "background source preparation")
|
|
let loader = PausedRuntimeRuleSource(started: started)
|
|
defer { loader.release.signal() }
|
|
let controller = makeRuleEnablementController(
|
|
store: store,
|
|
settings: ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true),
|
|
proxyMode: .global, ruleSnapshots: BuiltinRuleSnapshots(loader: { loader.load($0) }))
|
|
try await controller.activate(seeded.server)
|
|
let modeSwitch = Task { await controller.setProxyMode(.rule) }
|
|
await fulfillment(of: [started], timeout: 3)
|
|
await controller.setSystemProxyEnabled(true)
|
|
loader.release.signal()
|
|
await modeSwitch.value
|
|
XCTAssertEqual(controller.proxyMode, .rule)
|
|
XCTAssertTrue(controller.settings.systemProxyEnabled)
|
|
XCTAssertEqual(controller.lastDocument?.aclRuntime?.summary, "rule-proxy-default")
|
|
XCTAssertEqual(controller.state, .running)
|
|
}
|
|
|
|
func testOffIntentDuringSharedSourcePreparationCannotBeOverwritten() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let started = expectation(description: "background source preparation")
|
|
let loader = PausedRuntimeRuleSource(started: started)
|
|
defer { loader.release.signal() }
|
|
let snapshots = BuiltinRuleSnapshots(loader: { loader.load($0) })
|
|
let settings = ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true)
|
|
let controller = makeRuleEnablementController(
|
|
store: store, settings: settings, proxyMode: .global, ruleSnapshots: snapshots)
|
|
try await controller.activate(seeded.server)
|
|
let modeSwitch = Task { await controller.setProxyMode(.rule) }
|
|
await fulfillment(of: [started], timeout: 3)
|
|
let identity = RuleIdentity(action: .proxy, match: .domainExact("kept.example"))
|
|
let ruleCommit = Task {
|
|
await controller.commitRuleDocument(
|
|
CustomRuleDocument(rules: [], disabledIdentities: [identity]))
|
|
}
|
|
// Persistence happens before the awaited source. Observe the owner, not timing.
|
|
while controller.ruleDocuments.current?.disabledIdentities.contains(identity) != true {
|
|
await Task.yield()
|
|
}
|
|
await controller.setAgentEnabled(false)
|
|
let registrationsAfterStop = agent.registerCount
|
|
loader.release.signal()
|
|
await modeSwitch.value
|
|
let result = await ruleCommit.value
|
|
XCTAssertEqual(result.outcome, .saved)
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(result.document?.disabledIdentities, [identity])
|
|
XCTAssertEqual(try store.loadDocument().disabledIdentities, [identity])
|
|
XCTAssertEqual(controller.state, .off)
|
|
XCTAssertFalse(controller.settings.agentEnabled)
|
|
XCTAssertEqual(agent.registerCount, registrationsAfterStop)
|
|
XCTAssertNil(RuntimeFileStore(fileURL: runtime.contract).loadDocument())
|
|
}
|
|
|
|
func testNewModeSupersedesRulePreparationWithoutRestoringOldMode() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let started = expectation(description: "background source preparation")
|
|
let loader = PausedRuntimeRuleSource(started: started)
|
|
defer { loader.release.signal() }
|
|
let controller = makeRuleEnablementController(
|
|
store: store,
|
|
settings: ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true),
|
|
proxyMode: .global, ruleSnapshots: BuiltinRuleSnapshots(loader: { loader.load($0) }))
|
|
try await controller.activate(seeded.server)
|
|
let old = Task { await controller.setProxyMode(.rule) }
|
|
await fulfillment(of: [started], timeout: 3)
|
|
await controller.setProxyMode(.direct)
|
|
loader.release.signal()
|
|
await old.value
|
|
XCTAssertEqual(controller.proxyMode, .direct)
|
|
XCTAssertEqual(controller.state, .running)
|
|
XCTAssertEqual(
|
|
RuntimeFileStore(fileURL: runtime.contract).loadDocument()?.aclRuntime?.summary, "direct")
|
|
}
|
|
|
|
func testOffSaveUsesOwnedDocumentAndNewSessionRejectsCorruption() async throws {
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let controller = makeRuleEnablementController(
|
|
store: store, settings: ProxySettings(listen: ActivationFixture.listen, agentEnabled: false))
|
|
let identity = RuleIdentity(action: .proxy, match: .domainExact("saved.example"))
|
|
let outcome = await controller.updateRuleDocument(
|
|
CustomRuleDocument(rules: [], disabledIdentities: [identity]))
|
|
XCTAssertEqual(outcome, .saved)
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(agent.registerCount, 0)
|
|
XCTAssertEqual(try store.loadDocument().disabledIdentities, [identity])
|
|
let broken = Data("broken".utf8)
|
|
try broken.write(to: store.fileURL)
|
|
let newSession = makeRuleEnablementController(
|
|
store: store, settings: ProxySettings(listen: ActivationFixture.listen, agentEnabled: false))
|
|
let rejected = await newSession.updateRuleDocument(CustomRuleDocument(rules: []))
|
|
XCTAssertEqual(rejected, .persistenceFailed)
|
|
XCTAssertEqual(try Data(contentsOf: store.fileURL), broken)
|
|
XCTAssertEqual(agent.registerCount, 0)
|
|
}
|
|
|
|
}
|
|
|
|
extension RuleEnablementControllerTests {
|
|
func testAgentOffDuringRecoveryCannotBeOverwrittenByOldRuleTransaction() async throws {
|
|
try await interruptRuleRecovery(switchMode: false)
|
|
}
|
|
|
|
func testModeSwitchDuringRecoveryCannotBeOverwrittenByOldRuleTransaction() async throws {
|
|
try await interruptRuleRecovery(switchMode: true)
|
|
}
|
|
|
|
private func interruptRuleRecovery(switchMode: Bool) async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let rule = CustomRule(action: .direct, match: .domainExact("kept.example"))
|
|
try store.save([rule])
|
|
let settings = ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .rule,
|
|
ruleDefaultAction: .proxyWhenUnmatched, agentEnabled: true)
|
|
let recoveryWaiting = expectation(description: "recovery health retry paused")
|
|
let recoveryGate = RuleRuntimeDelayGate(started: recoveryWaiting)
|
|
defer { recoveryGate.resume() }
|
|
var recoveryIsRunning = false
|
|
let controller = makeRuleEnablementController(
|
|
store: store, settings: settings, proxyMode: .rule,
|
|
launchHealthTimeoutSeconds: 0.05,
|
|
launchHealthRetryDelay: {
|
|
if recoveryIsRunning {
|
|
await recoveryGate.wait()
|
|
} else {
|
|
try await Task.sleep(for: .milliseconds(1))
|
|
}
|
|
})
|
|
try await controller.activate(seeded.server)
|
|
let runtimeStore = RuntimeFileStore(fileURL: runtime.contract)
|
|
let initialRegistrations = agent.registerCount
|
|
configureRecoveryReceipts(runtimeStore, initialRegistrations: initialRegistrations) {
|
|
recoveryIsRunning = true
|
|
}
|
|
let disabledDocument = CustomRuleDocument(rules: [rule], disabledIdentities: [rule.identity])
|
|
let pending = Task { await controller.updateRuleDocument(disabledDocument) }
|
|
await fulfillment(of: [recoveryWaiting], timeout: 5)
|
|
if switchMode {
|
|
await controller.setProxyMode(.global)
|
|
} else {
|
|
await controller.setAgentEnabled(false)
|
|
}
|
|
let registrations = agent.registerCount
|
|
recoveryGate.resume()
|
|
let outcome = await pending.value
|
|
XCTAssertEqual(outcome, .saved)
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(try store.loadDocument().disabledIdentities, [rule.identity])
|
|
XCTAssertEqual(agent.registerCount, registrations)
|
|
if switchMode {
|
|
XCTAssertEqual(controller.proxyMode, .global)
|
|
XCTAssertEqual(runtimeStore.loadDocument()?.aclRuntime?.summary, "global")
|
|
} else {
|
|
XCTAssertFalse(controller.settings.agentEnabled)
|
|
XCTAssertEqual(controller.state, .off)
|
|
XCTAssertNil(runtimeStore.loadDocument())
|
|
}
|
|
}
|
|
|
|
private func configureRecoveryReceipts(
|
|
_ runtimeStore: RuntimeFileStore,
|
|
initialRegistrations: Int,
|
|
onRecovery: @escaping () -> Void
|
|
) {
|
|
agent.onRegister = { [agent] in
|
|
if agent?.registerCount == initialRegistrations + 2 { onRecovery() }
|
|
if (agent?.registerCount ?? 0) <= initialRegistrations + 2 {
|
|
try? FileManager.default.removeItem(at: runtimeStore.runtimeStatusFileURL)
|
|
} else if let document = runtimeStore.loadDocument() {
|
|
try? runtimeStore.writeRuntimeReceipt(for: document, processID: 42)
|
|
}
|
|
}
|
|
}
|
|
|
|
func testFailedDisableAndFailedRuntimeRecoveryReportsFailure() async throws {
|
|
let seeded = try makeSeededCatalog()
|
|
let (store, _) = try makeCustomRuleStore()
|
|
let rule = CustomRule(action: .direct, match: .domainExact("kept.example"))
|
|
try store.save([rule])
|
|
let settings = ProxySettings(
|
|
listen: ActivationFixture.listen, preferredMode: .rule,
|
|
ruleDefaultAction: .proxyWhenUnmatched, agentEnabled: true)
|
|
let controller = makeRuleEnablementController(
|
|
store: store, settings: settings, proxyMode: .rule)
|
|
try await controller.activate(seeded.server)
|
|
let runtimeStore = RuntimeFileStore(fileURL: runtime.contract)
|
|
agent.onRegister = {
|
|
try? FileManager.default.removeItem(at: runtimeStore.runtimeStatusFileURL)
|
|
}
|
|
let result = await controller.commitRuleDocument(
|
|
CustomRuleDocument(rules: [rule], disabledIdentities: [rule.identity]))
|
|
XCTAssertEqual(result.outcome, .saved)
|
|
await controller.ruleApplicationTask?.value
|
|
XCTAssertEqual(
|
|
result.document, CustomRuleDocument(rules: [rule], disabledIdentities: [rule.identity]))
|
|
XCTAssertEqual(try store.loadDocument().disabledIdentities, [rule.identity])
|
|
XCTAssertNotNil(controller.runtimeFacts.failure)
|
|
XCTAssertNotEqual(controller.state, .running)
|
|
}
|
|
}
|
|
|
|
private final class PausedRuntimeRuleSource: @unchecked Sendable {
|
|
let started: XCTestExpectation
|
|
let release = DispatchSemaphore(value: 0)
|
|
init(started: XCTestExpectation) { self.started = started }
|
|
func load(_ source: RulesSource) -> RuleSnapshot {
|
|
if source == .geolocationCN {
|
|
started.fulfill()
|
|
release.wait()
|
|
}
|
|
return rulesFixture(source)
|
|
}
|
|
}
|
|
|
|
/// Pause one retry/debounce phase; subsequent passes remain asynchronous without wall-clock delay.
|
|
@MainActor
|
|
private final class RuleRuntimeDelayGate {
|
|
private let started: XCTestExpectation
|
|
private var didPause = false
|
|
private var continuation: CheckedContinuation<Void, Never>?
|
|
|
|
init(started: XCTestExpectation) { self.started = started }
|
|
|
|
func wait() async {
|
|
guard !didPause else {
|
|
await Task.yield()
|
|
return
|
|
}
|
|
didPause = true
|
|
await withCheckedContinuation {
|
|
continuation = $0
|
|
started.fulfill()
|
|
}
|
|
}
|
|
|
|
func resume() {
|
|
continuation?.resume()
|
|
continuation = nil
|
|
}
|
|
}
|