Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/Plugin/PluginManagementTests.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

150 lines
6.8 KiB
Swift

import Foundation
import Testing
@testable import ShadowsocksX_NG2
@MainActor
struct PluginManagementTests {
@Test func editingKeepsNameAndUpdatesExecutable() throws {
let fixture = try ManagementFixture()
defer { fixture.cleanUp() }
let model = PluginManagementModel(catalog: fixture.catalog)
let add = model.beginAdding()
try model.save(add, name: "custom", path: fixture.first.path)
let edit = try #require(model.beginEditing("custom"))
#expect(edit.program == "custom")
#expect(edit.initialPath == fixture.first.path)
#expect(throws: PluginMappingError.invalidName) {
try model.save(edit, name: "renamed", path: fixture.second.path)
}
#expect(fixture.catalog.userMappings["custom"] == fixture.first.path)
try model.save(edit, name: "custom", path: fixture.second.path)
#expect(model.snapshot.entry(for: "custom")?.path == fixture.second.path)
#expect(model.snapshot.entry(for: "renamed") == nil)
}
@Test func overrideCanBeEditedAndRestoredWithoutDeletingManagedEntry() throws {
let fixture = try ManagementFixture()
defer { fixture.cleanUp() }
let model = PluginManagementModel(catalog: fixture.catalog)
let override = try #require(model.beginOverriding("v2ray-plugin"))
#expect(override.program == "v2ray-plugin")
#expect(override.initialPath.isEmpty)
#expect(!override.isEditing)
try model.save(override, name: "v2ray-plugin", path: fixture.first.path)
#expect(model.snapshot.entry(for: "v2ray-plugin")?.source == .user)
#expect(model.beginOverriding("v2ray-plugin") == nil)
let edit = try #require(model.beginEditing("v2ray-plugin"))
try model.save(edit, name: "v2ray-plugin", path: fixture.second.path)
#expect(model.snapshot.entry(for: "v2ray-plugin")?.path == fixture.second.path)
try model.remove("v2ray-plugin")
#expect(model.snapshot.entry(for: "v2ray-plugin")?.source == .managed)
#expect(model.beginEditing("v2ray-plugin") == nil)
#expect(model.beginOverriding("v2ray-plugin") != nil)
}
@Test func unreadableMappingsBlockChangesUntilSuccessfulReadRetry() throws {
let fixture = try ManagementFixture(corrupt: true)
defer { fixture.cleanUp() }
let model = PluginManagementModel(catalog: fixture.catalog)
#expect(model.snapshot.mappingsUnreadable)
#expect(model.beginOverriding("v2ray-plugin") == nil)
#expect(throws: PluginMappingError.unreadable) {
try model.save(model.beginAdding(), name: "custom", path: fixture.first.path)
}
#expect(throws: PluginMappingError.unreadable) { try model.retryReading() }
#expect(model.snapshot.mappingsUnreadable)
try fixture.store.save(["custom": fixture.first.path])
let repairedBytes = try Data(contentsOf: fixture.store.fileURL)
try model.retryReading()
#expect(!model.snapshot.mappingsUnreadable)
#expect(model.snapshot.entry(for: "custom")?.path == fixture.first.path)
#expect(try Data(contentsOf: fixture.store.fileURL) == repairedBytes)
#expect(model.beginEditing("custom") != nil)
}
@Test func failedSavePreservesMappingAndAllowsSameEditorToRetry() throws {
let fixture = try ManagementFixture()
defer { fixture.cleanUp() }
let model = PluginManagementModel(catalog: fixture.catalog)
try model.save(model.beginAdding(), name: "custom", path: fixture.first.path)
let edit = try #require(model.beginEditing("custom"))
let config = fixture.store.fileURL.deletingLastPathComponent()
let backup = fixture.root.appendingPathComponent("backup")
try FileManager.default.moveItem(at: config, to: backup)
try Data("blocking file".utf8).write(to: config)
#expect(throws: (any Error).self) {
try model.save(edit, name: "custom", path: fixture.second.path)
}
#expect(model.snapshot.entry(for: "custom")?.path == fixture.first.path)
#expect(model.beginEditing("custom")?.initialPath == fixture.first.path)
try FileManager.default.removeItem(at: config)
try FileManager.default.moveItem(at: backup, to: config)
try model.save(edit, name: "custom", path: fixture.second.path)
#expect(model.snapshot.entry(for: "custom")?.path == fixture.second.path)
}
@Test func unavailableFilesAndDuplicateNamesAreRejectedAndRemovalKeepsOtherMappings() throws {
let fixture = try ManagementFixture()
defer { fixture.cleanUp() }
let model = PluginManagementModel(catalog: fixture.catalog)
let add = model.beginAdding()
#expect(add.program == nil)
#expect(add.initialPath.isEmpty)
#expect(model.nameIssue("", session: add) == .invalidName)
#expect(model.pathIssue("relative") == .invalidPath)
try model.save(add, name: "custom", path: fixture.first.path)
#expect(model.nameIssue("custom", session: model.beginAdding()) == .nameExists)
#expect(throws: PluginMappingError.nameExists) {
try model.save(model.beginAdding(), name: "custom", path: fixture.second.path)
}
#expect(throws: PluginMappingError.unavailableFile) {
try model.save(
model.beginAdding(), name: "missing",
path: fixture.root.appendingPathComponent("missing").path)
}
try model.save(model.beginAdding(), name: "other", path: fixture.second.path)
try model.remove("custom")
#expect(model.snapshot.entry(for: "custom") == nil)
#expect(model.snapshot.entry(for: "other")?.path == fixture.second.path)
try FileManager.default.removeItem(at: fixture.second)
model.refresh()
#expect(model.snapshot.entry(for: "other")?.availability == .missing)
#expect(model.beginEditing("other")?.initialPath == fixture.second.path)
}
}
private struct ManagementInspector: PluginInspecting {
func inspect(_ executable: URL) async -> PluginSecurityFacts {
PluginSecurityFacts(quarantine: .absent, signature: .notApplicable, policy: .notApplicable)
}
}
@MainActor
private struct ManagementFixture {
let root: URL
let first: URL
let second: URL
let store: PluginMappingFileStore
let catalog: PluginCatalog
init(corrupt: Bool = false) throws {
root = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
first = root.appendingPathComponent("first")
second = root.appendingPathComponent("second")
store = PluginMappingFileStore(fileURL: root.appendingPathComponent("config/plugins.json"))
try FileManager.default.createDirectory(at: root, withIntermediateDirectories: true)
try FileManager.default.createDirectory(
at: store.fileURL.deletingLastPathComponent(), withIntermediateDirectories: true)
for binary in [first, second] {
try Data("#!/bin/sh\n".utf8).write(to: binary)
try FileManager.default.setAttributes([.posixPermissions: 0o755], ofItemAtPath: binary.path)
}
if corrupt { try Data("broken".utf8).write(to: store.fileURL) }
catalog = PluginCatalog(store: store, inspector: ManagementInspector())
}
func cleanUp() { try? FileManager.default.removeItem(at: root) }
}