Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Settings/SettingsWorkflowInterfaceTests.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

271 lines
11 KiB
Swift

import XCTest
@testable import ShadowsocksX_NG2
/// 设置项编辑器的 UI-facing interface 测试;写入缝与占用探测均注入替身,
/// 不触碰真实偏好文件、钥匙串与系统端口。
@MainActor
final class SettingsWorkflowInterfaceTests: XCTestCase {
var committing: FakeSettingsCommitter!
var probe: FakeOccupancyProbe!
override func setUp() async throws {
try await super.setUp()
committing = FakeSettingsCommitter()
probe = FakeOccupancyProbe()
}
func makeWorkflow() -> SettingsWorkflow {
SettingsWorkflow(committing: committing, occupancyProbe: probe)
}
func testPortEditorMapsValidationIssuesToTheAffectedFields() {
let workflow = makeWorkflow()
let invalid = SettingsPortDraft(socksPort: 0, httpPort: 11_087)
XCTAssertEqual(
workflow.portFieldState(for: .socks, editorDraft: invalid).issues,
[.port(.socks, error: .portOutOfRange(endpoint: .socks, port: 0))])
XCTAssertTrue(workflow.portFieldState(for: .http, editorDraft: invalid).issues.isEmpty)
let duplicate = SettingsPortDraft(socksPort: 11_086, httpPort: 11_086)
let duplicateIssue = SettingsFieldIssue.port(
.socks, error: .duplicatePort(endpoint: .socks, otherEndpoint: .http, port: 11_086))
XCTAssertEqual(
workflow.portFieldState(for: .socks, editorDraft: duplicate).issues,
[
duplicateIssue
])
XCTAssertEqual(
workflow.portFieldState(for: .http, editorDraft: duplicate).issues,
[.port(.http, error: .duplicatePort(endpoint: .socks, otherEndpoint: .http, port: 11_086))])
}
func testPortEditorReportsFreeOccupiedAndUnknownFacts() async {
probe = FakeOccupancyProbe(occupiedPorts: [11_087])
let workflow = makeWorkflow()
let draft = workflow.beginPortSettingsEditing()
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
XCTAssertEqual(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy, .free)
XCTAssertEqual(
workflow.portFieldState(for: .http, editorDraft: draft).occupancy,
.occupied(occupier: "other-app"))
probe = FakeOccupancyProbe(unknownPorts: [11_086])
let unknownWorkflow = makeWorkflow()
let unknownDraft = unknownWorkflow.beginPortSettingsEditing()
unknownWorkflow.refreshPortEditorOccupancy(for: unknownDraft)
await waitUntil(
unknownWorkflow.portFieldState(for: .socks, editorDraft: unknownDraft).occupancy != nil)
XCTAssertEqual(
unknownWorkflow.portFieldState(for: .socks, editorDraft: unknownDraft).occupancy,
.unknown(detail: "无法判定"))
}
func testPortEditorProbeUsesTheCompleteCommittedListenIdentity() async {
committing.committedSettings.listen.listenerMode = .allIPv4Interfaces
let workflow = makeWorkflow()
let draft = workflow.beginPortSettingsEditing()
workflow.refreshPortEditorOccupancy(for: draft)
let expected = RuntimeListenFacts(
listenerMode: .allIPv4Interfaces,
socksPort: draft.socksPort,
httpPort: draft.httpPort)
await waitUntil(probe.requests.contains { $0.listen == expected })
XCTAssertEqual(probe.requests.first(where: { $0.listen == expected })?.endpoint, .socks)
XCTAssertEqual(probe.requests.first(where: { $0.listen == expected })?.bindAddress, "0.0.0.0")
}
func testRuntimePortExceptionRequiresTheCompleteUnchangedListenIdentity() async {
probe = FakeOccupancyProbe(occupiedPorts: [11_086])
committing.isProxyRunning = true
let workflow = makeWorkflow()
let draft = workflow.beginPortSettingsEditing()
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
XCTAssertTrue(workflow.portFieldState(for: .socks, editorDraft: draft).isRuntimePortException)
XCTAssertFalse(workflow.portFieldState(for: .socks, editorDraft: draft).canSuggestFreePort)
XCTAssertTrue(workflow.canSavePortSettings(draft))
committing.runtimeListenFacts = RuntimeListenFacts(
listenerMode: .allIPv4Interfaces, socksPort: 11_086, httpPort: 11_087)
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
XCTAssertFalse(workflow.portFieldState(for: .socks, editorDraft: draft).isRuntimePortException)
XCTAssertFalse(workflow.canSavePortSettings(draft))
}
func testChangedPortWithKnownExternalOccupancyBlocksPortSave() async {
probe = FakeOccupancyProbe(occupiedPorts: [12_086])
let workflow = makeWorkflow()
let draft = SettingsPortDraft(socksPort: 12_086, httpPort: 12_087)
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
XCTAssertTrue(workflow.portFieldState(for: .socks, editorDraft: draft).canSuggestFreePort)
XCTAssertFalse(workflow.canSavePortSettings(draft))
let outcome = await workflow.savePortSettings(draft)
XCTAssertEqual(outcome, .rejected(.occupied([.socks])))
XCTAssertTrue(committing.updateCalls.isEmpty)
}
func testUnknownPortOccupancyAllowsPortSave() async {
probe = FakeOccupancyProbe(unknownPorts: [12_086])
let workflow = makeWorkflow()
let draft = SettingsPortDraft(socksPort: 12_086, httpPort: 12_087)
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
XCTAssertTrue(workflow.canSavePortSettings(draft))
let outcome = await workflow.savePortSettings(draft)
XCTAssertEqual(outcome, .persisted)
XCTAssertEqual(committing.committedSettings.listen.socksPort, 12_086)
}
func testPortSuggestionReturnsACandidateWithoutSavingIt() async {
probe = FakeOccupancyProbe(occupiedPorts: [12_086])
let workflow = makeWorkflow()
let draft = SettingsPortDraft(socksPort: 12_086, httpPort: 12_087)
workflow.refreshPortEditorOccupancy(for: draft)
await waitUntil(workflow.portFieldState(for: .socks, editorDraft: draft).occupancy != nil)
let outcome = await workflow.suggestFreePort(for: .socks, from: draft)
XCTAssertEqual(outcome, .suggestedPort(port: .socks, value: 32_768))
XCTAssertTrue(committing.updateCalls.isEmpty)
XCTAssertEqual(committing.committedSettings.listen.socksPort, 11_086)
}
func testPortSettingsSaveChangesOnlyTheCommittedPorts() async {
let original = committedSettingsForItemSaveTests()
committing.committedSettings = original
let workflow = makeWorkflow()
let edited = SettingsPortDraft(socksPort: 12_096, httpPort: 12_097)
workflow.refreshPortEditorOccupancy(for: edited)
await waitUntil(workflow.canSavePortSettings(edited))
let outcome = await workflow.savePortSettings(edited)
var expected = original
expected.listen.socksPort = edited.socksPort
expected.listen.httpPort = edited.httpPort
XCTAssertEqual(outcome, .persisted)
XCTAssertEqual(committing.updateCalls, [expected])
XCTAssertEqual(committing.committedSettings, expected)
}
func testPortSaveRejectsInvalidPortsWithoutStartingACommit() async {
let workflow = makeWorkflow()
let invalid = SettingsPortDraft(socksPort: 0, httpPort: 11_087)
let outcome = await workflow.savePortSettings(invalid)
XCTAssertEqual(
outcome,
.rejected(
.validation([
.port(.socks, error: .portOutOfRange(endpoint: .socks, port: 0))
])))
XCTAssertFalse(workflow.isCommitting)
XCTAssertTrue(committing.updateCalls.isEmpty)
}
func testProxyExceptionsSaveChangesOnlyTheCommittedExceptions() async {
let original = committedSettingsForItemSaveTests()
committing.committedSettings = original
let workflow = makeWorkflow()
let edited = "localhost\nexample.com"
let outcome = await workflow.saveProxyExceptions(edited)
var expected = original
expected.proxyExceptions = edited
XCTAssertEqual(outcome, .persisted)
XCTAssertEqual(committing.updateCalls, [expected])
XCTAssertEqual(committing.committedSettings, expected)
XCTAssertNil(workflow.lastFailure)
}
func testProxyExceptionsPersistenceFailurePreservesCommittedSnapshot() async {
let original = committedSettingsForItemSaveTests()
committing.committedSettings = original
committing.updateError = ProxySettingsStoreError.ioFailure(detail: "disk full")
let workflow = makeWorkflow()
let outcome = await workflow.saveProxyExceptions("localhost")
XCTAssertEqual(
outcome,
.persistenceFailed(.store(.ioFailure(detail: "disk full"))))
XCTAssertEqual(workflow.lastFailure, .store(.ioFailure(detail: "disk full")))
XCTAssertEqual(committing.committedSettings, original)
XCTAssertTrue(committing.updateCalls.isEmpty)
XCTAssertFalse(workflow.isCommitting)
}
func testItemSavesSerializeWhilePersistenceIsInProgress() async {
committing.updateGate = AsyncGate()
let workflow = makeWorkflow()
let first = Task { await workflow.saveProxyExceptions("localhost") }
await waitUntil(workflow.isCommitting)
let second = await workflow.savePortSettings(
SettingsPortDraft(socksPort: 11_086, httpPort: 11_087))
committing.updateGate?.release()
let firstOutcome = await first.value
XCTAssertEqual(second, .rejected(.inProgress))
XCTAssertEqual(firstOutcome, .persisted)
XCTAssertEqual(committing.updateCalls.count, 1)
}
func testEqualProxyExceptionsDoNotWrite() async {
let workflow = makeWorkflow()
committing.committedSettings.proxyExceptions = "localhost"
let outcome = await workflow.saveProxyExceptions("localhost")
XCTAssertEqual(outcome, .persisted)
XCTAssertTrue(committing.updateCalls.isEmpty)
}
func testStalePortOccupancyCannotOverrideTheNewerEditorDraft() async {
let gated = GatedOccupancyProbe(
gatedAnswer: .occupied(
PortOccupancyFacts(
occupier: "stale", occupiedFamilies: [.ipv4], verifiedFamilies: [.ipv4])),
passThroughAnswer: .free)
let workflow = SettingsWorkflow(committing: committing, occupancyProbe: gated)
let firstDraft = workflow.beginPortSettingsEditing()
workflow.refreshPortEditorOccupancy(for: firstDraft)
await waitUntil(gated.entered > 0)
let laterDraft = SettingsPortDraft(socksPort: 30_086, httpPort: 11_087)
gated.passThrough(.free)
workflow.refreshPortEditorOccupancy(for: laterDraft)
await waitUntil(
workflow.portFieldState(for: .socks, editorDraft: laterDraft).occupancy == .free)
gated.releaseGatedCalls()
try? await Task.sleep(nanoseconds: 50_000_000)
XCTAssertEqual(
workflow.portFieldState(for: .socks, editorDraft: laterDraft).occupancy, .free)
}
func committedSettingsForItemSaveTests() -> ProxySettings {
var settings = ProxySettings()
settings.listen.listenerMode = .allIPv6Interfaces
settings.listen.socksPort = 12_086
settings.listen.httpPort = 12_087
settings.proxyExceptions = "existing.example"
settings.preferredMode = .global
settings.agentEnabled = true
settings.systemProxyEnabled = true
return settings
}
}