Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/AgentLifecycleTests.swift
T
Qiu Yuzhou ac60d14099 refactor(tests): locate app product via bundle ancestor walk, not Bundle.main
测试需要 app 产物(嵌入二进制、打包面断言)时改经 AppArtifact 沿测试包
落盘位置向上查找 ShadowsocksX-NG2.app,覆盖两种布局:TEST_HOST 过渡期
.xctest 嵌于 Contents/PlugIns/,去宿主化后与 .app 平级。接触点:
AgentLifecycleTests wrapper、BundleManagedPluginProviderTests 组合根事实
断言、smoke 三处 sslocal/wrapper/plugin 定位、SkeletonTests 改读产物
Info.plist。行为等价(665 单测 + 11 冒烟全绿),为去 TEST_HOST 铺路。
2026-09-30 20:05:37 +08:00

222 lines
8.5 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import Darwin
import XCTest
@testable import ShadowsocksX_NG2
/// 薄 I/O 缝 ②(spec #21 Testing Decisions):以 stub sslocal 二进制驱动真实
/// wrapper 可执行文件,验证启停协议次序、SIGTERM 链、崩溃恢复、文件清理与
/// SIGUSR1 变更协议(D2/D5)。stub 经环境变量编排行为,全部等待有界。
final class AgentLifecycleTests: XCTestCase {
var workDir: URL!
var contractURL: URL!
private var stubStateURL: URL!
private var stubURL: URL!
override func setUpWithError() throws {
try super.setUpWithError()
workDir = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-agent-tests-\(UUID().uuidString)", isDirectory: true)
try FileManager.default.createDirectory(at: workDir, withIntermediateDirectories: true)
contractURL = workDir.appendingPathComponent("sslocal-active.json")
stubStateURL = workDir.appendingPathComponent("stub-state.log")
stubURL = workDir.appendingPathComponent("stub-sslocal.sh")
try writeStubScript()
}
override func tearDownWithError() throws {
try? FileManager.default.removeItem(at: workDir)
try super.tearDownWithError()
}
// MARK: 夹具
private var wrapperURL: URL {
get throws {
let url = AppArtifact.bundleURL.appendingPathComponent("Contents/MacOS/ShadowsocksX-NG2Agent")
return try XCTUnwrap(
FileManager.default.fileExists(atPath: url.path) ? url : nil,
"wrapper 未嵌入 app bundle(Contents/MacOS/ShadowsocksX-NG2Agent)")
}
}
private func writeStubScript() throws {
// stub 记录调用参数与收到的信号;行为由 SSLOCAL_STUB_BEHAVIOR 编排。
let script = """
#!/bin/sh
echo "invoked: $*" >> "$SSLOCAL_STUB_STATE"
echo "dns-force-builtin: ${SS_SYSTEM_DNS_RESOLVER_FORCE_BUILTIN:-unset}" >> "$SSLOCAL_STUB_STATE"
trap 'echo "SIGTERM" >> "$SSLOCAL_STUB_STATE"; exit 0' TERM
trap 'echo "SIGUSR1" >> "$SSLOCAL_STUB_STATE"' USR1
case "$SSLOCAL_STUB_BEHAVIOR" in
crash) exit 7 ;;
exit0) exit 0 ;;
*) while :; do sleep 0.05; done ;;
esac
"""
try script.write(to: stubURL, atomically: true, encoding: .utf8)
try FileManager.default.setAttributes(
[.posixPermissions: 0o755], ofItemAtPath: stubURL.path)
}
func launchWrapper(behavior: String) throws -> Process {
let wrapper = try wrapperURL
let process = Process()
process.executableURL = wrapper
var environment = ProcessInfo.processInfo.environment
environment["SSXNG_CONTRACT_PATH"] = contractURL.path
environment["SSXNG_SSLOCAL_PATH"] = stubURL.path
environment["SSXNG_RUNTIME_DIR"] = workDir.path
environment["SSLOCAL_STUB_STATE"] = stubStateURL.path
environment["SSLOCAL_STUB_BEHAVIOR"] = behavior
process.environment = environment
try process.run()
return process
}
func writeContract(_ document: SslocalRuntimeDocument) throws {
try RuntimeFileStore(fileURL: contractURL).write(document)
}
func stateLog() -> String {
(try? String(contentsOf: stubStateURL, encoding: .utf8)) ?? ""
}
func pidAlive(_ pid: Int32) -> Bool {
kill(pid, 0) == 0
}
@discardableResult
func waitUntil(
timeout: TimeInterval = 10, _ condition: () throws -> Bool
) throws -> Bool {
let deadline = Date().addingTimeInterval(timeout)
while Date() < deadline {
if try condition() { return true }
Thread.sleep(forTimeInterval: 0.05)
}
return try condition()
}
/// 断言 wrapper 在超时内退出并返回退出码。
func waitForExit(_ process: Process, timeout: TimeInterval = 10) throws -> Int32 {
try waitUntil(timeout: timeout) { !process.isRunning }
process.waitUntilExit()
return process.terminationStatus
}
// MARK: 启动协议与 SIGTERM 链(D2)
func testStartProtocolSpawnsSslocalWithAbsoluteConfigPathThenStopsOnSIGTERM() throws {
try writeContract(ProxyRuntimeFixture.makeDocument())
let wrapper = try launchWrapper(behavior: "run")
XCTAssertTrue(
try waitUntil { self.stateLog().contains("invoked: -c \(self.contractURL.path)") },
"wrapper 应以契约绝对路径调用 sslocal,实际:\(stateLog())")
XCTAssertTrue(pidAlive(wrapper.processIdentifier), "sslocal 运行期间 wrapper 应保持常驻")
kill(wrapper.processIdentifier, SIGTERM)
let exitStatus = try waitForExit(wrapper)
XCTAssertEqual(exitStatus, 0, "显式停止后 wrapper 干净退出(不触发 KeepAlive 重启)")
XCTAssertTrue(stateLog().contains("SIGTERM"), "SIGTERM 链:wrapper 转发给 sslocal")
XCTAssertTrue(
FileManager.default.fileExists(atPath: contractURL.path),
"停止路径不动契约文件(删除由 GUI 的停止协议末端负责)")
}
/// macOS resolv.conf 可能含带 zone id 的链路本地 nameserver,hickory 解析
/// 失败只会刷 ERROR 后回退:wrapper 应直接注入强制 builtin 的环境变量。
func testSpawnForcesBuiltinDnsResolverEnvironment() throws {
try writeContract(ProxyRuntimeFixture.makeDocument())
let wrapper = try launchWrapper(behavior: "run")
XCTAssertTrue(
try waitUntil { self.stateLog().contains("invoked:") },
"wrapper 应拉起 sslocal,实际:\(stateLog())")
XCTAssertTrue(
stateLog().contains("dns-force-builtin: 1"),
"sslocal 子进程应收到 SS_SYSTEM_DNS_RESOLVER_FORCE_BUILTIN=1,实际:\(stateLog())")
kill(wrapper.processIdentifier, SIGTERM)
XCTAssertEqual(try waitForExit(wrapper), 0)
}
// MARK: 契约缺失 / 无效 → 停止并清理(D5)
func testMissingContractExitsCleanlyWithoutSpawning() throws {
let wrapper = try launchWrapper(behavior: "run")
let exitStatus = try waitForExit(wrapper)
XCTAssertEqual(exitStatus, 0, "无契约干净退出,KeepAlive(SuccessfulExit:false)不重启")
XCTAssertFalse(stateLog().contains("invoked"), "不应拉起 sslocal")
}
func testInvalidContractIsUnlinkedThenCleanExit() throws {
try Data("not valid json {".utf8).write(to: contractURL)
let wrapper = try launchWrapper(behavior: "run")
let exitStatus = try waitForExit(wrapper)
XCTAssertEqual(exitStatus, 0)
XCTAssertFalse(
FileManager.default.fileExists(atPath: contractURL.path),
"无效契约按「停止并清理」普通 unlink(D5)")
XCTAssertFalse(stateLog().contains("invoked"))
}
func testStructurallyInvalidContractIsAlsoCleaned() throws {
// 可解码但本地端口无效:wrapper 校验拒绝,不给 sslocal 反复失败的机会。
// (issue #60 起空 `servers` 是合法契约——无活动目标的监听部署。)
try SslocalRuntimeDocument(
servers: [], listen: SslocalListenSettings(socksPort: 0)
).jsonData().write(to: contractURL)
let wrapper = try launchWrapper(behavior: "run")
let exitStatus = try waitForExit(wrapper)
XCTAssertEqual(exitStatus, 0)
XCTAssertFalse(FileManager.default.fileExists(atPath: contractURL.path))
}
/// 空服务器契约是合法部署(issue #60):wrapper 接受并照常拉起 sslocal,
/// 由本地入站提供无目标的本地监听。
func testEmptyServerContractIsValidAndRunsSslocal() throws {
try SslocalRuntimeDocument(
servers: [], listen: SslocalListenSettings()
).jsonData().write(to: contractURL)
let wrapper = try launchWrapper(behavior: "run")
XCTAssertTrue(
try waitUntil { self.stateLog().contains("invoked:") },
"空服务器契约应照常拉起 sslocal")
XCTAssertTrue(pidAlive(wrapper.processIdentifier), "空监听会话 wrapper 应保持常驻")
kill(wrapper.processIdentifier, SIGTERM)
XCTAssertEqual(try waitForExit(wrapper), 0, "显式停止干净退出")
}
// MARK: pid 文件契约
func testWrapperWritesAndRemovesPIDFile() throws {
let pidURL = workDir.appendingPathComponent("agent.pid")
try writeContract(ProxyRuntimeFixture.makeDocument())
let wrapper = try launchWrapper(behavior: "run")
XCTAssertTrue(
try waitUntil { FileManager.default.fileExists(atPath: pidURL.path) },
"wrapper 启动即写 pid 文件(GUI 判活与 SIGUSR1 投递依据)")
let recordedPID = Int32(
String(data: try Data(contentsOf: pidURL), encoding: .utf8)?.trimmingCharacters(
in: .whitespacesAndNewlines
) ?? "")
XCTAssertEqual(recordedPID, wrapper.processIdentifier, "pid 文件记录 wrapper 自身 pid")
kill(wrapper.processIdentifier, SIGTERM)
_ = try waitForExit(wrapper)
XCTAssertFalse(
FileManager.default.fileExists(atPath: pidURL.path), "退出路径清理 pid 文件")
}
}