Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Support/ProxyRuntimeFixture.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

367 lines
11 KiB
Swift

import Darwin
import XCTest
@testable import ShadowsocksX_NG2
/// 代理运行时测试共享夹具(票 #27):临时运行时目录、契约文档构造、LaunchAgent
/// 与探测替身。
/// 跨替身共享的有序事件记录:断言「先清理系统代理、再停止监听」等次序。
final class ProxyRuntimeEventLog: @unchecked Sendable {
private let lock = NSLock()
private var items: [String] = []
func record(_ item: String) {
lock.lock()
defer { lock.unlock() }
items.append(item)
}
var events: [String] {
lock.lock()
defer { lock.unlock() }
return items
}
}
enum ProxyRuntimeFixture {
/// 在临时目录中建一套隔离的运行时文件组(不触碰真实 ~/Library)。
struct TemporaryRuntime {
let directory: URL
let contract: URL
let pidFile: URL
}
static func makeTemporaryRuntime(file: StaticString = #filePath, line: UInt = #line)
-> TemporaryRuntime
{
let directory = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-tests-\(UUID().uuidString)", isDirectory: true)
try? FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)
return TemporaryRuntime(
directory: directory,
contract: directory.appendingPathComponent("sslocal-active.json"),
pidFile: directory.appendingPathComponent("agent.pid"))
}
@MainActor
static func catalogSnapshotReader(at fileURL: URL) -> RuntimeCatalogSnapshotReading {
CatalogCommitCoordinator.bootstrap(fileStore: CatalogFileStore(fileURL: fileURL))
.catalogSnapshotReader
}
static func unusedLoopbackPort() throws -> Int {
let descriptor = socket(AF_INET, SOCK_STREAM, 0)
guard descriptor >= 0 else { throw POSIXError(.ENOTSOCK) }
defer { close(descriptor) }
var address = sockaddr_in()
address.sin_len = UInt8(MemoryLayout<sockaddr_in>.size)
address.sin_family = sa_family_t(AF_INET)
address.sin_port = 0
address.sin_addr = in_addr(s_addr: inet_addr("127.0.0.1"))
let result = withUnsafePointer(to: &address) { pointer in
pointer.withMemoryRebound(to: sockaddr.self, capacity: 1) {
Darwin.bind(descriptor, $0, socklen_t(MemoryLayout<sockaddr_in>.size))
}
}
guard result == 0 else { throw POSIXError(.EADDRINUSE) }
var bound = sockaddr_in()
var length = socklen_t(MemoryLayout<sockaddr_in>.size)
let nameResult = withUnsafeMutablePointer(to: &bound) { pointer in
pointer.withMemoryRebound(to: sockaddr.self, capacity: 1) {
getsockname(descriptor, $0, &length)
}
}
guard nameResult == 0 else { throw POSIXError(.EINVAL) }
return Int(CFSwapInt16BigToHost(bound.sin_port))
}
/// 夹具默认监听端口:测试进程内一次性分配的空闲端口对。不能固定 11086/
/// 11087(与 app 默认监听相同):宿主 app 在跑时其 sslocal 占住这两个端口,
/// wrapper 健康探测会误判「监听已建立」。进程内共享同一对端口而非逐调用
/// 分配,保证两次默认构造之间除显式参数外无差异——「仅服务器变化」类
/// 变更协议语义依赖这一点。
private static let defaultListenPorts: (socks: Int, http: Int) = {
func freePort() -> Int {
guard let port = try? unusedLoopbackPort() else {
preconditionFailure("夹具端口分配失败:socket 不可用(fd 耗尽?)")
}
return port
}
let socks = freePort()
var http = freePort()
while http == socks {
http = freePort()
}
return (socks, http)
}()
static func makeDocument(
serverAddress: String = "203.0.113.7",
password: String = "resolved-password",
pluginOpts: String? = nil,
listenerMode: ListenerMode = .localhost,
localPort: Int? = nil,
inboundProtocol: String = "socks"
) -> SslocalRuntimeDocument {
precondition(inboundProtocol == "socks")
let socksPort: Int
let httpPort: Int
if let localPort {
socksPort = localPort
httpPort = SslocalListenSettings.defaultHTTPPort
} else {
socksPort = defaultListenPorts.socks
httpPort = defaultListenPorts.http
}
return SslocalRuntimeDocument(
servers: [
SslocalServerDocument(
id: "server-1",
server: serverAddress,
serverPort: 8388,
password: password,
method: "aes-256-gcm",
plugin: nil,
pluginOpts: pluginOpts
)
],
listen: SslocalListenSettings(
listenerMode: listenerMode,
socksPort: socksPort,
httpPort: httpPort))
}
/// LaunchAgent 注册态可编程替身,记录全部调用。
final class FakeLaunchAgent: LaunchAgentControlling {
private(set) var currentStatus: LaunchAgentStatus
private(set) var registerCount = 0
private(set) var unregisterCount = 0
var registerError: Error?
/// register() 成功后自动迁移到的状态(模拟 launchd 拉起)。
var statusAfterRegister: LaunchAgentStatus = .registered
/// 测试用的运行回执。生产 wrapper 对 ACL 实例需等 sslocal 绑定监听后才写。
var onRegister: (() -> Void)?
var onUnregister: (() -> Void)?
/// 可选共享事件日志(次序断言用)。
weak var eventLog: ProxyRuntimeEventLog?
init(initialStatus: LaunchAgentStatus = .notRegistered) {
currentStatus = initialStatus
}
var status: LaunchAgentStatus { currentStatus }
func setStatus(_ status: LaunchAgentStatus) {
currentStatus = status
}
func register() throws {
registerCount += 1
eventLog?.record("register")
if let registerError {
currentStatus = .registered
throw registerError
}
currentStatus = statusAfterRegister
onRegister?()
}
func unregister() throws {
unregisterCount += 1
eventLog?.record("unregister")
currentStatus = .notRegistered
onUnregister?()
}
}
/// 探测替身:按预设序列返回,序列耗尽后停留在最后一项。
final class FakeProbe: EndpointProbing, @unchecked Sendable {
private let lock = NSLock()
private var outcomes: [EndpointHealthProbe.Outcome]
private var requestedPorts: [Int] = []
private(set) var callCount = 0
init(outcomes: [EndpointHealthProbe.Outcome]) {
self.outcomes = outcomes
}
static func reachable() -> FakeProbe {
FakeProbe(outcomes: [.reachable])
}
static func refusing() -> FakeProbe {
FakeProbe(outcomes: [.refused(detail: "Connection refused")])
}
/// 运行中改写探测序列(「条件恢复后自动收敛」类测试用)。
func setOutcomes(_ newOutcomes: [EndpointHealthProbe.Outcome]) {
lock.lock()
defer { lock.unlock() }
outcomes = newOutcomes
}
var ports: [Int] {
lock.lock()
defer { lock.unlock() }
return requestedPorts
}
func probe(host: String, port: Int, timeout: TimeInterval) -> EndpointHealthProbe.Outcome {
lock.lock()
defer { lock.unlock() }
callCount += 1
requestedPorts.append(port)
guard let outcome = outcomes.first else { return .timedOut }
if outcomes.count > 1 {
outcomes.removeFirst()
}
return outcome
}
}
final class FakeFirewallChecker: FirewallStatusChecking, @unchecked Sendable {
private let lock = NSLock()
private var outcomes: [FirewallBlockStatus]
private var recordedURLs: [URL] = []
var checkedURLs: [URL] {
lock.lock()
defer { lock.unlock() }
return recordedURLs
}
init(_ result: FirewallBlockStatus = .permitted) {
outcomes = [result]
}
init(outcomes: [FirewallBlockStatus]) {
precondition(!outcomes.isEmpty)
self.outcomes = outcomes
}
func status(for executableURL: URL) -> FirewallBlockStatus {
lock.lock()
defer { lock.unlock() }
recordedURLs.append(executableURL)
let outcome = outcomes[0]
if outcomes.count > 1 { outcomes.removeFirst() }
return outcome
}
}
/// 可暂停探测替身:arm 后的下一次探测挂起在信号量上,直到测试放行——
/// 在启动健康门的 await 窗口内确定性插入交错命令(探测运行在 detached
/// 线程,不占主 actor)。放行后恢复直通。
final class BlockingProbe: EndpointProbing, @unchecked Sendable {
private let lock = NSLock()
private var gate: DispatchSemaphore?
private var started: XCTestExpectation?
func arm(started: XCTestExpectation) {
lock.lock()
defer { lock.unlock() }
precondition(gate == nil, "上一次 arm 尚未 release")
gate = DispatchSemaphore(value: 0)
self.started = started
}
func release() {
lock.lock()
let gate = self.gate
self.gate = nil
self.started = nil
lock.unlock()
gate?.signal()
}
func probe(host: String, port: Int, timeout: TimeInterval) -> EndpointHealthProbe.Outcome {
lock.lock()
let gate = self.gate
let started = self.started
lock.unlock()
if let gate {
started?.fulfill()
gate.wait()
}
return .reachable
}
}
/// 按调用序返回预设结果、并可在第 N 次调用处挂起的防火墙检查替身:
/// 钉住「轮询 await 恢复后代际已推进时不得再写状态」的回归。
final class BlockingFirewallChecker: FirewallStatusChecking, @unchecked Sendable {
private let lock = NSLock()
private var callCount = 0
private let outcomes: [FirewallBlockStatus]
private let blockOnCall: Int
private let started: XCTestExpectation
private let gate = DispatchSemaphore(value: 0)
init(outcomes: [FirewallBlockStatus], blockOnCall: Int, started: XCTestExpectation) {
precondition(!outcomes.isEmpty)
self.outcomes = outcomes
self.blockOnCall = blockOnCall
self.started = started
}
func release() { gate.signal() }
func status(for executableURL: URL) -> FirewallBlockStatus {
lock.lock()
callCount += 1
let call = callCount
lock.unlock()
if call == blockOnCall {
started.fulfill()
gate.wait()
}
return outcomes[min(call, outcomes.count) - 1]
}
}
}
final class InMemoryProxySettingsStore: ProxySettingsStoring {
var saved: ProxySettings?
var saveError: Error?
func load() throws -> ProxySettings {
saved ?? ProxySettings()
}
func save(_ settings: ProxySettings) throws {
if let saveError { throw saveError }
saved = settings
}
}
extension ProxyRuntimeFixture {
static func controlFlowRuleSnapshot(_ source: RulesSource) throws
-> RuleSnapshot
{
switch source {
case .geolocationCN:
return rulesFixture(
source,
rules: [
ProxyRule(action: .direct, match: .domainExact("direct.example")),
ProxyRule(action: .direct, match: .domainSuffix("fixture-direct.example")),
])
case .chinaIPv4:
return rulesFixture(
source,
rules: [
ProxyRule(action: .direct, match: .ipv4CIDR("1.0.0.0/24"))
])
case .gfwlist:
return rulesFixture(
source,
rules: [
ProxyRule(action: .proxy, match: .domainSuffix("proxy.example")),
ProxyRule(action: .direct, match: .domainExact("safe.proxy.example")),
])
case .custom, .fixed:
throw RuleSnapshotError.missing
}
}
}