Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/ProxyRuntime/ProxyRuntimeControllerModeTests.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

285 lines
12 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
/// Mode restoration and commands share the Domain availability policy without
/// starting a real runtime or touching host proxy settings.
@MainActor
final class ProxyRuntimeControllerModeTests: ProxyRuntimeControllerTests {
override func makeDefaultRuleSnapshots() -> BuiltinRuleSnapshots {
BuiltinRuleSnapshots(loader: ProxyRuntimeFixture.controlFlowRuleSnapshot)
}
func testRuntimeFactsProjectControllerStateAtStableSeam() async {
let controller = makeController(probe: ProxyRuntimeFixture.FakeProbe.reachable())
XCTAssertEqual(
controller.runtimeFacts,
ProxyRuntimeFacts(status: .off, isOn: false))
await controller.resyncOnLaunch()
XCTAssertEqual(
controller.runtimeFacts,
ProxyRuntimeFacts(status: .running, isOn: true),
"默认 agent 意图开启:重同步后无目标也进入空列表监听")
}
}
// MARK: - 收敛票据全事实检查(候选①:agent 关闭不得被任何 await 窗口内的
// 旧收敛复活;restore 先查时效再动持久层)
@MainActor
extension ProxyRuntimeControllerModeTests {
/// agent-off 落在 mode 切换的健康门 await 窗口内:票据查全四事实 →
/// superseded,不触发 restore 重注册,用户的 mode 意图保留在持久层与内存。
func testAgentOffDuringModeTransitionHealthGateSupersedesWithoutRestore() async throws {
let seeded = try makeSeededCatalog()
let probe = ProxyRuntimeFixture.BlockingProbe()
let started = expectation(description: "mode transition health probe paused")
let settingsStore = InMemoryProxySettingsStore()
let controller = makeController(
probe: probe,
settingsStore: settingsStore,
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: .global,
agentEnabled: true, systemProxyEnabled: true),
proxyMode: .global)
try await controller.activate(seeded.server)
XCTAssertEqual(controller.state, .running)
probe.arm(started: started)
let modeSwitch = Task { await controller.setProxyMode(.direct) }
await fulfillment(of: [started], timeout: 3)
await controller.setAgentEnabled(false)
XCTAssertEqual(controller.state, .off)
let registrationsAfterStop = agent.registerCount
probe.release()
await modeSwitch.value
XCTAssertEqual(
agent.registerCount, registrationsAfterStop, "被取代的切换不得经 restore 重注册 agent")
XCTAssertEqual(controller.state, .off)
XCTAssertFalse(controller.settings.agentEnabled)
XCTAssertEqual(controller.settings.preferredMode, ProxyModeKind.direct, "切换意图保留在内存")
XCTAssertEqual(settingsStore.saved?.preferredMode, ProxyModeKind.direct, "切换意图保留在持久层")
XCTAssertEqual(settingsStore.saved?.agentEnabled, false)
XCTAssertNil(controller.lastDocument)
}
/// agent-off 落在 mode→rule 的派生窗口内:派生缝 preparationIsCurrent
/// 恒查 agent 意图与并发流,派生即弃权,apply 根本不会启动。
func testAgentOffDuringModeRuleDerivationSupersedesDeployment() async throws {
let seeded = try makeSeededCatalog()
let started = expectation(description: "rule snapshot load paused")
let release = DispatchSemaphore(value: 0)
defer { release.signal() }
let loader = BuiltinRuleSnapshots(loader: { source -> RuleSnapshot in
if source == .geolocationCN {
started.fulfill()
release.wait()
}
return rulesFixture(source)
})
let controller = makeController(
probe: ProxyRuntimeFixture.FakeProbe.reachable(),
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true),
proxyMode: .global,
ruleSnapshots: loader)
try await controller.activate(seeded.server)
let modeSwitch = Task { await controller.setProxyMode(.rule) }
await fulfillment(of: [started], timeout: 3)
await controller.setAgentEnabled(false)
XCTAssertEqual(controller.state, .off)
let registrationsAfterStop = agent.registerCount
release.signal()
await modeSwitch.value
XCTAssertEqual(agent.registerCount, registrationsAfterStop, "派生被取代后不得部署")
XCTAssertEqual(controller.state, .off)
XCTAssertNil(controller.lastDocument)
XCTAssertFalse(controller.settings.agentEnabled)
XCTAssertEqual(controller.settings.preferredMode, ProxyModeKind.rule, "切换意图保留")
}
/// agent-off 落在目录部署的健康门窗口内:结果必须是
/// superseded(而非误分类的 failed),运行时保持 off、lastDocument 不复活。
func testAgentOffDuringDeploymentHealthGateSupersedesDeployment() async throws {
let seeded = try makeSeededCatalog()
let probe = ProxyRuntimeFixture.BlockingProbe()
let started = expectation(description: "deployment health probe paused")
let controller = makeController(
probe: probe,
settings: ProxySettings(
listen: ActivationFixture.listen, preferredMode: .global, agentEnabled: true),
proxyMode: .global)
try await controller.activate(seeded.server)
XCTAssertEqual(controller.state, .running)
probe.arm(started: started)
let deployment = Task {
await controller.deploy(SslocalRuntimeDocument(servers: [], listen: ActivationFixture.listen))
}
await fulfillment(of: [started], timeout: 3)
await controller.setAgentEnabled(false)
XCTAssertEqual(controller.state, .off)
let registrationsAfterStop = agent.registerCount
probe.release()
let result = await deployment.value
XCTAssertEqual(result, .superseded)
XCTAssertEqual(controller.state, .off)
XCTAssertEqual(agent.registerCount, registrationsAfterStop)
XCTAssertNil(controller.lastDocument)
}
/// 防火墙轮询在 await 恢复后代际已推进(含取消本任务的 stop 路径)时,
/// 不得把过期的 .firewallBlocked 盖到最新状态呈现上。
func testFirewallPollDoesNotWriteAfterExecutionSupersedesIt() async throws {
let seeded = try makeSeededCatalog()
let started = expectation(description: "firewall poll awaiting checker")
let checker = ProxyRuntimeFixture.BlockingFirewallChecker(
outcomes: [.permitted, .blocked], blockOnCall: 2, started: started)
let controller = makeController(
probe: ProxyRuntimeFixture.FakeProbe.reachable(),
listen: SslocalListenSettings(listenerMode: .allIPv4Interfaces),
firewallChecker: checker)
try await controller.activate(seeded.server)
XCTAssertEqual(controller.state, .running, "首次防火墙检查通过后进入运行态并武装轮询")
await fulfillment(of: [started], timeout: 3)
await controller.setAgentEnabled(false)
XCTAssertEqual(controller.state, .off)
checker.release()
try await Task.sleep(nanoseconds: 50_000_000)
XCTAssertEqual(controller.state, .off, "被取代的轮询不得改写状态")
}
}
/// Coordinator/controller integration for the shared committed catalog source.
@MainActor
final class CatalogRuntimeSnapshotIntegrationTests: XCTestCase {
private var runtime: ProxyRuntimeFixture.TemporaryRuntime!
private var catalogFileURL: URL!
private var activationFileURL: URL!
private var credentials: InMemoryCredentialStore!
private var agent: ProxyRuntimeFixture.FakeLaunchAgent!
private var systemProxy: ProxyRuntimeFixture.FakeSystemProxy!
override func setUp() async throws {
try await super.setUp()
runtime = ProxyRuntimeFixture.makeTemporaryRuntime()
catalogFileURL = runtime.directory.appendingPathComponent("catalog.json")
activationFileURL = runtime.directory.appendingPathComponent("activation.json")
credentials = InMemoryCredentialStore()
agent = ProxyRuntimeFixture.FakeLaunchAgent()
systemProxy = ProxyRuntimeFixture.FakeSystemProxy()
}
override func tearDown() async throws {
try? FileManager.default.removeItem(at: runtime.directory)
try await super.tearDown()
}
func testCommitWithoutActiveTargetFeedsLaterActivationThroughSharedSnapshot() async throws {
let fileStore = CatalogFileStore(fileURL: catalogFileURL)
let bootstrap = CatalogCommitCoordinator.bootstrap(fileStore: fileStore)
let controller = makeController(
catalogSnapshotReader: bootstrap.catalogSnapshotReader,
settings: ProxySettings(listen: ActivationFixture.listen, agentEnabled: false))
let coordinator = CatalogCommitCoordinator(
fileStore: fileStore,
runtime: ProxyRuntimeSyncAdapter(controller: controller),
bootstrap: bootstrap)
let server = try coordinator.commit { catalog, _ in
try ActivationFixture.addPlainServer(
"提交后激活", in: &catalog, credentials: credentials)
}
XCTAssertEqual(coordinator.syncStatus, .idle, "无目标时目录只发布,不触发运行时")
XCTAssertNil(controller.activeTargetID)
try await controller.activate(server)
XCTAssertEqual(controller.activeTargetID, server, "激活读取协调器刚发布的唯一快照")
XCTAssertEqual(controller.state, .off, "agent 意图关闭时该命令仅选择目标,不部署")
}
func testCoordinatorUsesProductionAdapterToClearRemovedActiveTarget() async throws {
let server = try makeSeededCatalog()
try ActivationStateFileStore(fileURL: activationFileURL).save(activeTargetID: server)
let fileStore = CatalogFileStore(fileURL: catalogFileURL)
let bootstrap = CatalogCommitCoordinator.bootstrap(fileStore: fileStore)
let controller = makeController(
catalogSnapshotReader: bootstrap.catalogSnapshotReader,
probe: ProxyRuntimeFixture.FakeProbe.reachable())
let coordinator = CatalogCommitCoordinator(
fileStore: fileStore,
runtime: ProxyRuntimeSyncAdapter(controller: controller),
bootstrap: bootstrap)
_ = try coordinator.commit { catalog, _ in try catalog.remove(server) }
await waitUntilRuntimeSettles(
{
if case .finished = coordinator.syncStatus { return true }
return false
}())
guard case .finished(_, .clearedAndStopped) = coordinator.syncStatus else {
return XCTFail("生产 adapter 应以刚提交快照清理无效目标")
}
XCTAssertNil(controller.activeTargetID)
XCTAssertNil(
try ActivationStateFileStore(fileURL: activationFileURL).loadActiveTargetID(),
"adapter 收敛后持久化清除失效目标")
}
private func makeController(
catalogSnapshotReader: RuntimeCatalogSnapshotReading,
settings: ProxySettings? = nil,
probe: EndpointProbing = SystemEndpointProbe()
) -> ProxyRuntimeController {
let runtimeFileStore = RuntimeFileStore(fileURL: runtime.contract)
agent.onRegister = { [runtimeFileStore] in
guard let document = runtimeFileStore.loadDocument() else { return }
try? runtimeFileStore.writeRuntimeReceipt(for: document, processID: 42)
}
return ProxyRuntimeController(
catalogSnapshotReader: catalogSnapshotReader,
activationFileStore: ActivationStateFileStore(fileURL: activationFileURL),
runtimeFileStore: runtimeFileStore,
credentials: credentials,
plugins: ActivationFixture.plugins,
listenRestore: RestoredListenSettings(
settings: ActivationFixture.listen, unreadableError: nil),
settingsStore: InMemoryProxySettingsStore(),
appBundle: AppArtifact.bundle,
ruleSnapshots: BuiltinRuleSnapshots(loader: ProxyRuntimeFixture.controlFlowRuleSnapshot),
settingsRestore: RestoredProxySettings(
settings: settings ?? ProxySettings(listen: ActivationFixture.listen),
unreadableError: nil),
agent: agent,
probe: probe,
systemProxy: systemProxy,
systemProxyHelper: ProxyRuntimeFixture.FakeSystemProxyHelperService(),
firewallExecutableURLs: [URL(fileURLWithPath: "/bundle/Helpers/sslocal")],
firewallPollIntervalNanoseconds: 1_000_000,
launchHealthTimeoutSeconds: 0.05,
sendSignal: { _, _ in 0 },
processIsAlive: { $0 == 42 })
}
private func makeSeededCatalog() throws -> NodeID {
var catalog = ConfigurationCatalog()
let server = try ActivationFixture.addPlainServer(
"待删除", in: &catalog, credentials: credentials)
try CatalogFileStore(fileURL: catalogFileURL).save(CatalogDocument(catalog: catalog))
return server
}
}