Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/ProxyRuntimePlanTests.swift
T
Qiu Yuzhou 6bfd3c0d35 feat(ng2): proxy runtime LaunchAgent, wrapper and sslocal lifecycle (#27)
GUI → LaunchAgent → wrapper → sslocal full chain (spec #21 D2/D5):

- ShadowsocksX-NG2Agent: Swift BundleProgram tool target embedded at
  Contents/MacOS, supervised by launchd via SMAppService agent plist
  (Contents/Library/LaunchAgents, bundle-relative ProgramArguments,
  KeepAlive={SuccessfulExit:false}). Wrapper reads the cross-process
  contract v2/sslocal-active.json, spawns sslocal -c <absolute path>
  and supervises it: SIGTERM chain stop, SIGUSR1 forward for
  server-only changes vs graceful restart on listen fingerprint
  changes, non-zero exit on unexpected child loss for KeepAlive
  replay, invalid/missing contract → clean exit with plain unlink.
- Runtime file protocol: RuntimeFileStore reuses AtomicFileWriter
  (0700 dir self-heal, 0600 temp at creation, atomic replace);
  explicit-stop cleanup unlinks contract, agent pid file and stale
  temporaries. Shared read-side validation via
  SslocalRuntimeDocument.decodeValidated so GUI and wrapper cannot
  drift. Wrapper pid file bridges SMAppService's missing pid.
- GUI: ProxyRuntimeController consumes ActivationStateMachine effects
  through pure ProxyRuntimePlan decision table (ordered actions,
  idempotent skip of identical contract); proxy toggle and launch
  failure presentation (naming endpoint:port) in the status menu;
  launch resync reconciles agent registration, wrapper liveness and
  on-disk contract; catalog commits re-expand immediately.
- Log sanitization baseline: closed RuntimeLogEvent enum plus Redactor,
  wrapper/sslocal output converged to a 0600 agent.log with RUST_LOG
  defaulting to warn.

Tests (126 total, all green): stub-sslocal driven wrapper lifecycle
(start/stop order, SIGTERM chain, crash replay, cleanup, reload
protocol), real sslocal smoke (SOCKS port binding + full SOCKS5
handshake), plan decision table, controller flows with fakes,
runtime file permissions/atomic replace, endpoint probe, redaction.

Manual release-gate items (real launchd/SMAppService): agent
registration approval flow, GUI-quit persistence, bootout behaviors.

Closes #27
2026-09-20 20:26:54 +08:00

120 lines
4.3 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 XCTest
@testable import ShadowsocksX_NG2
/// 纯决策层(spec #21 D2/D5,issue #27):代理开关、GUI 重同步与目录重展开
/// 共用的计划表。断言的是动作序列——执行次序即协议次序。
final class ProxyRuntimePlanTests: XCTestCase {
private let document = ProxyRuntimeFixture.makeDocument()
private func contractData() throws -> Data {
try document.jsonData()
}
private func actions(
_ intent: RuntimeIntent,
agent: LaunchAgentStatus,
wrapper: WrapperProcessState = .notRunning,
disk: Data?? = nil
) throws -> [RuntimeAction] {
let fallback = try contractData()
return ProxyRuntimePlan.actions(
intent: intent,
agentStatus: agent,
wrapper: wrapper,
contractOnDisk: disk ?? fallback)
}
// MARK: 开启代理
func testEnableWhenUnregisteredWritesContractThenRegisters() throws {
XCTAssertEqual(
try actions(.run(document), agent: .notRegistered, disk: .some(nil)),
[.writeContract, .registerAgent],
"启动服务前写入(D5),注册后 launchd 拉起的 wrapper 直接读新档")
}
func testEnableWhenNotFoundBehavesLikeUnregistered() throws {
XCTAssertEqual(
try actions(.run(document), agent: .notFound, disk: .some(nil)),
[.writeContract, .registerAgent])
}
func testEnableWhenRequiresApprovalStillWritesAndRegisters() throws {
XCTAssertEqual(
try actions(.run(document), agent: .requiresApproval, disk: .some(nil)),
[.writeContract, .registerAgent],
"注册动作把 requiresApproval 上抛给用户批准,计划不变")
}
func testRunningWithIdenticalContractSkipsWrite() throws {
XCTAssertEqual(
try actions(
.run(document), agent: .registered, wrapper: .running(pid: 42),
disk: try contractData()),
[],
"相同内容跳过写入与信号(激活状态机幂等注记)")
}
func testRunningWithStaleContractWritesThenSignalsReload() throws {
let stale = try ProxyRuntimeFixture.makeDocument(
serverAddress: "198.51.100.9", localPort: 1086
).jsonData()
XCTAssertEqual(
try actions(.run(document), agent: .registered, wrapper: .running(pid: 42), disk: stale),
[.writeContract, .signalReload(pid: 42)],
"原子替换后发 SIGUSR1 reload(D5 变更协议)")
}
func testRunningWithMissingContractWritesThenSignalsReload() throws {
XCTAssertEqual(
try actions(.run(document), agent: .registered, wrapper: .running(pid: 42), disk: .some(nil)),
[.writeContract, .signalReload(pid: 42)])
}
func testRegisteredButWrapperDeadRelaunchesAgent() throws {
XCTAssertEqual(
try actions(
.run(document), agent: .registered, wrapper: .notRunning, disk: try contractData()),
[.writeContract, .unregisterAgent, .registerAgent],
"已注册但 wrapper 已干净退出:写盘后强制重新拉起,让 wrapper 读新档")
}
// MARK: 停止代理
func testStopWhenRegisteredUnregistersThenDeletesRuntimeFiles() throws {
XCTAssertEqual(
try actions(.stop, agent: .registered, wrapper: .running(pid: 42)),
[.unregisterAgent, .deleteRuntimeFiles],
"显式停止协议次序(D2):注销(SIGTERM wrapper→停 sslocal)后才删文件")
}
func testStopWhenUnregisteredOnlyCleansResidue() throws {
XCTAssertEqual(
try actions(.stop, agent: .notRegistered),
[.deleteRuntimeFiles])
}
func testStopWhenApprovalPendingOnlyCleansResidue() throws {
XCTAssertEqual(
try actions(.stop, agent: .requiresApproval),
[.deleteRuntimeFiles])
}
// MARK: 服务器列表变化 vs 监听结构变化
func testServerOnlyChangeStillTriggersSignalReload() throws {
// 内容级差异由 plan 比对(数据不等),结构判定在 wrapper:这里只断言
// 服务器列表变化会带来重写+信号,而不是被误判为「无需动作」。
let otherServers = ProxyRuntimeFixture.makeDocument(serverAddress: "198.51.100.1")
let onDisk = try ProxyRuntimeFixture.makeDocument(serverAddress: "198.51.100.2").jsonData()
XCTAssertEqual(
ProxyRuntimePlan.actions(
intent: .run(otherServers), agentStatus: .registered,
wrapper: .running(pid: 7), contractOnDisk: onDisk),
[.writeContract, .signalReload(pid: 7)])
}
}