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

144 lines
5.1 KiB
Swift

import Foundation
import XCTest
@testable import ShadowsocksX_NG2
/// #33 偏好持久化缝:设置文件只保存公开偏好;重置不触碰配置目录与活动目标
/// 使用的其他文件。
final class ProxySettingsFileStoreTests: XCTestCase {
private var directory: URL!
private var store: ProxySettingsFileStore!
override func setUpWithError() throws {
try super.setUpWithError()
directory = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-settings-tests-\(UUID().uuidString)", isDirectory: true)
store = ProxySettingsFileStore(
fileURL: directory.appendingPathComponent("settings.json"),
legacyListenFileURL: directory.appendingPathComponent("listen-settings.json"))
}
override func tearDownWithError() throws {
try? FileManager.default.removeItem(at: directory)
try super.tearDownWithError()
}
private func writeRaw(_ text: String) throws {
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)
try Data(text.utf8).write(to: store.fileURL)
}
private func makeWriteFailingStore() throws -> ProxySettingsFileStore {
try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)
let blockedParent = directory.appendingPathComponent("blocked")
try Data("not a directory".utf8).write(to: blockedParent)
return ProxySettingsFileStore(
fileURL: blockedParent.appendingPathComponent("settings.json"),
legacyListenFileURL: directory.appendingPathComponent("listen-settings.json"))
}
func testRoundTripKeepsPreferences() throws {
var settings = ProxySettings()
settings.listen.listenerMode = .allIPv6Interfaces
settings.listen.socksPort = 2086
settings.listen.httpPort = 2087
settings.proxyExceptions = "localhost, 127.0.0.1"
settings.preferredMode = .direct
try store.save(settings)
XCTAssertEqual(try store.load(), settings)
let raw = try String(contentsOf: store.fileURL, encoding: .utf8)
XCTAssertFalse(raw.contains("udpRelayEnabled"))
XCTAssertFalse(raw.contains("timeoutSeconds"))
XCTAssertFalse(raw.contains("verboseLogging"))
XCTAssertFalse(raw.contains("advertisedAddress"))
XCTAssertTrue(raw.contains("all_ipv6_interfaces"))
XCTAssertEqual(try store.load().listen.mode, "tcp_and_udp")
}
func testEveryListenerModeRoundTripsWithoutAnAdvertisedAddress() throws {
for mode in ListenerMode.allCases {
try store.save(ProxySettings(listen: SslocalListenSettings(listenerMode: mode)))
XCTAssertEqual(try store.load().listen.listenerMode, mode)
let raw = try String(contentsOf: store.fileURL, encoding: .utf8)
XCTAssertFalse(raw.contains("advertisedAddress"))
}
}
func testLoadPreservesPersistedLegacyDefaultPortsWithoutImplicitMigration() throws {
var settings = ProxySettings()
settings.listen.socksPort = 1086
settings.listen.httpPort = 1087
try store.save(settings)
let loaded = try store.load()
XCTAssertEqual(loaded.listen.socksPort, 1086)
XCTAssertEqual(loaded.listen.httpPort, 1087)
}
func testMissingPortFieldsUseNewFactoryDefaults() throws {
try writeRaw("{}")
XCTAssertEqual(try store.load(), ProxySettings())
}
func testUnknownEnabledModesIsIgnoredAndNeverWrittenBack() throws {
try writeRaw("{\"enabledModes\":[\"global\"],\"preferredMode\":\"global\"}")
XCTAssertEqual(try store.load().preferredMode, .global)
try store.save(ProxySettings())
let raw = try String(contentsOf: store.fileURL, encoding: .utf8)
XCTAssertFalse(raw.contains("enabledModes"))
}
func testLegacyPACPreferredModeFallsBackToRuleWithoutLosingOtherFields() throws {
try writeRaw(
"""
{"preferredMode":"pac","socksPort":2086,"httpPort":2087,"timeoutSeconds":120,
"verboseLogging":true,
"pacUserRules":"@@example.com","gfwListURLConfigured":true,"pacPort":2089}
""")
let loaded = try store.load()
XCTAssertEqual(loaded.preferredMode, .rule)
XCTAssertEqual(loaded.listen.socksPort, 2086)
XCTAssertEqual(loaded.listen.httpPort, 2087)
}
func testInvalidSaveDoesNotTouchExistingSettings() throws {
try store.save(ProxySettings())
var invalid = ProxySettings()
invalid.listen.socksPort = 0
XCTAssertThrowsError(try store.save(invalid)) { error in
XCTAssertEqual(
error as? ProxySettingsStoreError,
.invalid([.portOutOfRange(endpoint: .socks, port: 0)]))
}
XCTAssertEqual(try store.load(), ProxySettings())
}
func testSaveFailureIsTypedIOFailure() throws {
store = try makeWriteFailingStore()
XCTAssertThrowsError(try store.save(ProxySettings())) { error in
guard case .ioFailure = error as? ProxySettingsStoreError else {
return XCTFail("文件写入失败应保留为 typed io failure,实际为 \(error)")
}
}
}
func testMissingNewFileMigratesLegacyListenSettingsAndUsesNewDefaults() throws {
var legacy = SslocalListenSettings()
legacy.socksPort = 2086
try ListenSettingsFileStore(fileURL: store.legacyListenFileURL).save(legacy)
let loaded = try store.load()
XCTAssertEqual(loaded.listen, legacy)
}
}