mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-16 04:54:42 +00:00
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。
274 lines
11 KiB
Swift
274 lines
11 KiB
Swift
import Foundation
|
|
import Security
|
|
import Testing
|
|
|
|
@testable import ShadowsocksX_NG2
|
|
|
|
@MainActor
|
|
struct SubscriptionInformationWorkflowTests {
|
|
@Test func successfulInformationSurvivesFailureAndReload() async throws {
|
|
try await withWorkflow { workflow, store, credentials, fetcher in
|
|
let summary = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
#expect(summary.information?.bytesUsed == 25)
|
|
#expect(summary.information?.bytesRemaining == 75)
|
|
let succeededAt = try #require(summary.lastSucceededAt)
|
|
if case .succeeded(let attemptAt) = summary.status {
|
|
#expect(succeededAt == attemptAt)
|
|
} else {
|
|
Issue.record("应成功提交")
|
|
}
|
|
fetcher.setBehavior(.failure(.httpStatus(code: 503)))
|
|
await workflow.refreshSubscription(summary.id)
|
|
let failed = try #require(workflow.subscriptions.first)
|
|
#expect(failed.information == summary.information)
|
|
#expect(failed.lastSucceededAt == succeededAt)
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: credentials)
|
|
#expect(reloaded.subscriptions.first?.information == summary.information)
|
|
#expect(reloaded.subscriptions.first?.lastSucceededAt == succeededAt)
|
|
}
|
|
}
|
|
|
|
@Test func successfulRefreshReplacesMissingAndInvalidFields() async throws {
|
|
try await withWorkflow { workflow, _, _, fetcher in
|
|
let first = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
fetcher.setBehavior(
|
|
.success(
|
|
Data(
|
|
#"{"version":1,"servers":[],"bytes_used":50,"bytes_remaining":-1,"expires_at":123}"#
|
|
.utf8)))
|
|
await workflow.refreshSubscription(first.id)
|
|
let replaced = try #require(workflow.subscriptions.first)
|
|
#expect(replaced.information?.bytesUsed == 50)
|
|
#expect(replaced.information?.bytesRemaining == nil)
|
|
#expect(replaced.information?.expiresAt == nil)
|
|
|
|
fetcher.setBehavior(.success(Data(#"{"version":1,"servers":[]}"#.utf8)))
|
|
await workflow.refreshSubscription(first.id)
|
|
let empty = try #require(workflow.subscriptions.first)
|
|
#expect(empty.information == nil)
|
|
if case .succeeded(let date) = empty.status {
|
|
#expect(empty.lastSucceededAt == date)
|
|
#expect(date >= first.lastSucceededAt!)
|
|
} else {
|
|
Issue.record("无资料响应仍应成功")
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test func cancelledRefreshCannotCommitEvenIfFetcherReturnsData() async throws {
|
|
try await withWorkflow { workflow, store, credentials, _ in
|
|
let first = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
let bytes = try Data(contentsOf: store.fileURL)
|
|
let fetcher = InformationGateFetcher()
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: credentials, subscriptionFetcher: fetcher)
|
|
let refresh = Task { await reloaded.refreshSubscription(first.id) }
|
|
await fetcher.entered.wait()
|
|
refresh.cancel()
|
|
fetcher.release.release()
|
|
await refresh.value
|
|
#expect(reloaded.subscriptions.first == first)
|
|
#expect(try Data(contentsOf: store.fileURL) == bytes)
|
|
}
|
|
}
|
|
|
|
@Test func persistenceFailureDoesNotPublishNewInformation() async throws {
|
|
try await withWorkflow { workflow, store, _, fetcher in
|
|
let first = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
let tree = workflow.tree
|
|
// 只破坏本夹具的文件路径,让原子替换失败,不影响其他 runner。
|
|
let directory = URL(fileURLWithPath: store.fileURL.deletingLastPathComponent().path)
|
|
try FileManager.default.removeItem(at: directory)
|
|
try Data().write(to: directory)
|
|
fetcher.setBehavior(.success(Data(#"{"version":1,"servers":[],"bytes_used":100}"#.utf8)))
|
|
await workflow.refreshSubscription(first.id)
|
|
#expect(workflow.subscriptions.first?.information == first.information)
|
|
#expect(workflow.subscriptions.first?.lastSucceededAt == first.lastSucceededAt)
|
|
#expect(workflow.tree == tree)
|
|
}
|
|
}
|
|
|
|
@Test func durableDocumentContainsOnlyAllowlistedInformationAndCredentialReferences() async throws
|
|
{
|
|
try await withWorkflow { workflow, store, credentials, fetcher in
|
|
fetcher.setBehavior(
|
|
.success(
|
|
Data(
|
|
#"""
|
|
{"version":1,
|
|
"servers":[{"server":"203.0.113.7",
|
|
"server_port":8388,
|
|
"method":"aes-256-gcm",
|
|
"password":"RAW-SERVER-PASSWORD",
|
|
"plugin":"v2ray-plugin",
|
|
"plugin_opts":"RAW-PLUGIN-OPTIONS"}],
|
|
"bytes_used":18446744073709551615,
|
|
"provider_token":"RAW-PROVIDER-TOKEN"}
|
|
"""#
|
|
.utf8)))
|
|
let first = try await workflow.createSubscription(
|
|
urlString: "https://p.example.com/sub?secret=RAW-URL-TOKEN")
|
|
#expect(first.information?.bytesUsed == UInt64.max)
|
|
let raw = try String(contentsOf: store.fileURL, encoding: .utf8)
|
|
for secret in [
|
|
"RAW-SERVER-PASSWORD", "RAW-PLUGIN-OPTIONS", "RAW-PROVIDER-TOKEN", "RAW-URL-TOKEN",
|
|
] {
|
|
#expect(!raw.contains(secret))
|
|
}
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: credentials)
|
|
#expect(reloaded.subscriptions.first?.information?.bytesUsed == UInt64.max)
|
|
}
|
|
}
|
|
|
|
@Test func oldDocumentWithoutInformationOrSuccessfulTimeLoadsWithoutGuessing() async throws {
|
|
try await withWorkflow { workflow, store, credentials, _ in
|
|
_ = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
var document = try #require(
|
|
JSONSerialization.jsonObject(with: Data(contentsOf: store.fileURL)) as? [String: Any])
|
|
var records = try #require(document["subscriptions"] as? [[String: Any]])
|
|
records[0].removeValue(forKey: "information")
|
|
records[0].removeValue(forKey: "lastSucceededAt")
|
|
document["subscriptions"] = records
|
|
try JSONSerialization.data(withJSONObject: document).write(to: store.fileURL)
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: credentials)
|
|
#expect(reloaded.subscriptions.count == 1)
|
|
#expect(reloaded.subscriptions.first?.information == nil)
|
|
#expect(reloaded.subscriptions.first?.lastSucceededAt == nil)
|
|
}
|
|
}
|
|
|
|
@Test func credentialFailureKeepsInformationAndSuccessfulTime() async throws {
|
|
try await withWorkflow { workflow, store, credentials, fetcher in
|
|
let first = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
let before = credentials.storageSnapshot
|
|
let rejecting = RejectingInformationCredentials(base: credentials)
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: rejecting, subscriptionFetcher: fetcher)
|
|
fetcher.setBehavior(
|
|
.success(
|
|
Data(
|
|
#"""
|
|
{"version":1,
|
|
"servers":[{"server":"203.0.113.7",
|
|
"server_port":8388,
|
|
"method":"aes-256-gcm",
|
|
"password":"REJECT-THIS-PASSWORD"}],
|
|
"bytes_used":100}
|
|
"""#
|
|
.utf8)))
|
|
await reloaded.refreshSubscription(first.id)
|
|
let failed = try #require(reloaded.subscriptions.first)
|
|
#expect(failed.information == first.information)
|
|
#expect(failed.lastSucceededAt == first.lastSucceededAt)
|
|
if case .failed(_, let failure) = failed.status {
|
|
#expect(failure == .commit(category: .credentials, rollback: .restored))
|
|
} else {
|
|
Issue.record("凭据失败应记失败态")
|
|
}
|
|
#expect(credentials.storageSnapshot == before)
|
|
#expect(try store.load().subscriptions.first?.information == first.information)
|
|
}
|
|
}
|
|
|
|
@Test func cancellationDuringCredentialWritesRollsBackWithoutPublishing() async throws {
|
|
try await withWorkflow { workflow, store, credentials, fetcher in
|
|
let first = try await workflow.createSubscription(urlString: "https://p.example.com/sub")
|
|
let before = credentials.storageSnapshot
|
|
let bytes = try Data(contentsOf: store.fileURL)
|
|
let reloaded = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: CancellingInformationCredentials(base: credentials),
|
|
subscriptionFetcher: fetcher)
|
|
fetcher.setBehavior(
|
|
.success(
|
|
Data(
|
|
#"""
|
|
{"version":1,"servers":[{"server":"203.0.113.7","server_port":8388,
|
|
"method":"aes-256-gcm","password":"CANCEL-DURING-SAVE"}],"bytes_used":100}
|
|
"""#.utf8)))
|
|
let refresh = Task { await reloaded.refreshSubscription(first.id) }
|
|
await refresh.value
|
|
#expect(reloaded.subscriptions.first == first)
|
|
#expect(credentials.storageSnapshot == before)
|
|
#expect(try Data(contentsOf: store.fileURL) == bytes)
|
|
}
|
|
}
|
|
|
|
private func withWorkflow(
|
|
_ body:
|
|
@MainActor (
|
|
CatalogWorkflow, CatalogFileStore, InMemoryCredentialStore, FakeSubscriptionFetcher
|
|
) async throws -> Void
|
|
) async throws {
|
|
let directory = FileManager.default.temporaryDirectory
|
|
.appendingPathComponent("subscription-information-\(UUID().uuidString)", isDirectory: true)
|
|
defer { try? FileManager.default.removeItem(at: directory) }
|
|
let store = CatalogFileStore(fileURL: directory.appendingPathComponent("catalog.json"))
|
|
let credentials = InMemoryCredentialStore()
|
|
let fetcher = FakeSubscriptionFetcher(
|
|
behavior: .success(
|
|
Data(#"{"version":1,"servers":[],"bytes_used":25,"bytes_remaining":75}"#.utf8)))
|
|
let workflow = makeCatalogWorkflow(
|
|
coordinator: CatalogCommitCoordinator(fileStore: store, runtime: FakeCatalogRuntime()),
|
|
credentials: credentials, subscriptionFetcher: fetcher)
|
|
try await body(workflow, store, credentials, fetcher)
|
|
}
|
|
}
|
|
|
|
private struct InformationGateFetcher: SubscriptionFetching {
|
|
let entered = AsyncGate()
|
|
let release = AsyncGate()
|
|
|
|
func fetch(_ url: URL) async throws -> Data {
|
|
entered.release()
|
|
await release.wait()
|
|
return Data(#"{"version":1,"servers":[],"bytes_used":100}"#.utf8)
|
|
}
|
|
}
|
|
|
|
private struct RejectingInformationCredentials: CredentialStoring {
|
|
let base: InMemoryCredentialStore
|
|
|
|
func save(_ secret: String, for reference: CredentialReference) throws {
|
|
guard secret != "REJECT-THIS-PASSWORD" else {
|
|
throw CredentialStoreError.keychainStatus(errSecAuthFailed)
|
|
}
|
|
try base.save(secret, for: reference)
|
|
}
|
|
|
|
func secret(for reference: CredentialReference) throws -> String? {
|
|
try base.secret(for: reference)
|
|
}
|
|
|
|
func delete(_ reference: CredentialReference) throws {
|
|
try base.delete(reference)
|
|
}
|
|
}
|
|
|
|
private struct CancellingInformationCredentials: CredentialStoring {
|
|
let base: InMemoryCredentialStore
|
|
|
|
func save(_ secret: String, for reference: CredentialReference) throws {
|
|
try base.save(secret, for: reference)
|
|
if secret == "CANCEL-DURING-SAVE" {
|
|
withUnsafeCurrentTask { $0?.cancel() }
|
|
}
|
|
}
|
|
|
|
func secret(for reference: CredentialReference) throws -> String? {
|
|
try base.secret(for: reference)
|
|
}
|
|
|
|
func delete(_ reference: CredentialReference) throws {
|
|
try base.delete(reference)
|
|
}
|
|
}
|