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

118 lines
5.2 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
/// 受管插件提供(issue #38,D10):受管集内且 bundle 内可执行文件在位才返回
/// 绝对路径;集外引用与文件缺失都归一为「本版本未提供」(nil → 状态机点名
/// 拒绝)。路径只从静态事实表派生,绝不拼接引用原文。
final class BundleManagedPluginProviderTests: XCTestCase {
private var bundleRoot: URL!
private var credentials: InMemoryCredentialStore!
override func setUpWithError() throws {
try super.setUpWithError()
bundleRoot = FileManager.default.temporaryDirectory
.appendingPathComponent("ssxng-plugin-tests-\(UUID().uuidString)", isDirectory: true)
try FileManager.default.createDirectory(
at: bundleRoot.appendingPathComponent("Contents/Helpers/Plugins"),
withIntermediateDirectories: true)
credentials = InMemoryCredentialStore()
}
override func tearDownWithError() throws {
try? FileManager.default.removeItem(at: bundleRoot)
try super.tearDownWithError()
}
private var pluginBinaryName: String { ManagedPluginCatalog.plugins[0].program }
private var pluginURL: URL {
bundleRoot.appendingPathComponent("Contents/Helpers/Plugins/\(pluginBinaryName)")
}
private func writePluginBinary(permissions: Int) throws {
try Data("#!/bin/sh\n".utf8).write(to: pluginURL)
try FileManager.default.setAttributes(
[.posixPermissions: permissions], ofItemAtPath: pluginURL.path)
}
private func makeProvider() -> BundleManagedPluginProvider {
BundleManagedPluginProvider(bundleURL: bundleRoot)
}
func testReturnsBundleAbsolutePathForProvidedManagedProgram() throws {
try writePluginBinary(permissions: 0o755)
let path = try XCTUnwrap(makeProvider().executablePath(forProgram: pluginBinaryName))
XCTAssertEqual(path, pluginURL.path, "配置生成的 plugin 字段是 bundle 内绝对路径")
XCTAssertTrue(path.hasPrefix(bundleRoot.path))
}
func testMissingBinaryIsNotProvided() {
XCTAssertNil(makeProvider().executablePath(forProgram: pluginBinaryName))
}
func testNonExecutableBinaryIsNotProvided() throws {
try writePluginBinary(permissions: 0o644)
XCTAssertNil(makeProvider().executablePath(forProgram: pluginBinaryName))
}
func testUnmanagedProgramIsNeverProvided() throws {
try writePluginBinary(permissions: 0o755)
let provider = makeProvider()
XCTAssertNil(provider.executablePath(forProgram: "obfs-local"), "集外程序名一律未提供")
XCTAssertNil(provider.executablePath(forProgram: "sslocal"), "非插件的 bundle 内二进制不算插件")
XCTAssertNil(provider.executablePath(forProgram: "../Helpers/sslocal"), "路径形态引用不拼接")
XCTAssertNil(provider.executablePath(forProgram: "v2ray-plugin/child"), "子路径引用不拼接")
XCTAssertNil(provider.executablePath(forProgram: ""))
}
/// 组合根事实:app bundle(生产默认 provider 的取值来源,经 AppArtifact 按
/// 构建产物定位、不依赖测试宿主)内受管插件在位——防止打包回归静默断开激
/// 活链路(编辑器显示提供而激活拒绝)。
func testHostAppBundleProvidesManagedPlugin() throws {
let path = try XCTUnwrap(
BundleManagedPluginProvider(bundleURL: AppArtifact.bundleURL)
.executablePath(forProgram: pluginBinaryName),
"app bundle 未嵌入受管插件(先跑 fetch-external-binaries.sh)")
XCTAssertTrue(path.hasSuffix("Contents/Helpers/Plugins/\(pluginBinaryName)"))
}
/// 与状态机缝的契约:文件缺失 → provider nil → 激活以 pluginNotProvided
/// 原子拒绝(app 降级丢插件时同一语义)。
func testActivationRejectsMissingPluginByNamedReason() throws {
var catalog = ConfigurationCatalog()
var fields = ActivationFixture.plainFields(remark: "带插件", passwordRef: .fresh())
fields.pluginProgram = pluginBinaryName
try credentials.save("pw", for: fields.passwordRef)
let id = try catalog.addServer(fields)
var machine = ActivationStateMachine()
ActivationFixture.assertThrows(
.invalidLeaf(node: id, reason: .pluginNotProvided(program: pluginBinaryName))
) {
try machine.activate(
id, in: catalog, credentials: credentials, plugins: makeProvider(),
options: RuntimeDocumentOptions(listen: ActivationFixture.listen))
}
}
/// 在位 → 派生文档携带 bundle 内绝对路径(与 opts 解析),激活成功。
func testActivationDerivesBundlePathWhenProvided() throws {
try writePluginBinary(permissions: 0o755)
var catalog = ConfigurationCatalog()
var fields = ActivationFixture.plainFields(remark: "带插件", passwordRef: .fresh())
fields.pluginProgram = pluginBinaryName
try credentials.save("pw", for: fields.passwordRef)
let id = try catalog.addServer(fields)
var machine = ActivationStateMachine()
let configuration = try machine.activate(
id, in: catalog, credentials: credentials, plugins: makeProvider(),
options: RuntimeDocumentOptions(listen: ActivationFixture.listen))
let server = try XCTUnwrap(configuration.document.servers.first)
XCTAssertEqual(server.plugin, pluginURL.path)
XCTAssertNil(server.pluginOpts, "无参数引用时整体省略 pluginOpts")
}
}