javier
13b9c74a38
CI / Build and test (push) Canceled after 0s
Documentation / Build documentation (push) Canceled after 0s
Documentation / Deploy to GitHub Pages (push) Canceled after 0s
This PR contains the work done to fix a cancellation-mapping bug in `AmiiboLiveClient`, bring the client under offline test coverage, add the conformances SwiftUI and persistence need, and moves CI and documentation publishing to GitHub Actions. All public API changes are additive.
### Fix
- `AmiiboLiveClient` reported an early task cancellation as `.unknown("CancellationError()")`. The OpenAPI runtime wraps every error in `ClientError`, so the `CancellationError` check never matched; it now also checks the wrapped error and throws `.cancelled`.
### Tests
- `ThrowingTransport` and `StubTransport` test doubles let the live client run offline. New tests cover error mapping, HTTP status → error mapping, `oneOf` object-vs-list decoding, `"amiibo": null`, sorting, filter → query encoding, `Platform`/`Release` mapping, and the date transcoder.
- Models gained `package` memberwise initializers so tests can build real fixtures without `@testable`. These are not public API.
- The test target now depends on `OpenAPIRuntime` and `HTTPTypes` (both already in the dependency graph).
### API
- Models are `Codable` and `Identifiable` (`Amiibo.id` is its `identifier`; the key/name models use `key`).
- Filters are `Hashable`.
### Documentation
- Doc comments trimmed library-wide; one repeated `- Throws:` sentence appeared 24 times. `Library.md` and the README tightened to match.
### CI and docs publishing
- `ci.yml`: build and offline tests on PRs and pushes to `main`.
- `live-tests.yml`: weekly and on-demand run against the live API.
- `docs.yml`: builds DocC on PRs, deploys to GitHub Pages on `main`. Pinned to Xcode 26 because swift-docc-plugin 1.5.0 fails to launch its tools under Xcode 27.
- The generated `docs/` folder (327 files) is removed from the repository and ignored.
Reviewed-on: #31
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
79 lines
2.0 KiB
Swift
79 lines
2.0 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the Amiibo Service open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the Amiibo Service project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of Amiibo Service project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
@testable import AmiiboService
|
|
import Foundation
|
|
import Testing
|
|
|
|
@Suite("ISO Date Time Transcoder")
|
|
struct ISODateTimeTranscoderTests {
|
|
|
|
// MARK: Properties
|
|
|
|
private let transcoder = ISODateTimeTranscoder()
|
|
|
|
// MARK: Decode tests
|
|
|
|
@Test("decodes a timestamp as UTC")
|
|
func decodesTimestamp() throws {
|
|
// GIVEN
|
|
let string = "2026-07-24T12:34:56.123000"
|
|
|
|
// WHEN
|
|
let date = try transcoder.decode(string)
|
|
|
|
// THEN
|
|
#expect(abs(date.timeIntervalSince(.utc(2026, 7, 24, 12, 34, 56)) - 0.123) < 0.001)
|
|
}
|
|
|
|
@Test("decodes a date-only string as midnight UTC")
|
|
func decodesDate() throws {
|
|
// GIVEN
|
|
let string = "2014-11-21"
|
|
|
|
// WHEN
|
|
let date = try transcoder.decode(string)
|
|
|
|
// THEN
|
|
#expect(date == .utc(2014, 11, 21))
|
|
}
|
|
|
|
@Test("throws a decoding error for an unsupported string", arguments: [
|
|
"", "2014-11", "2014-11-21T12:34:56", "2014-11-21T12:34:56Z", "21/11/2014", "yesterday"
|
|
])
|
|
func throwsForUnsupportedString(string: String) {
|
|
// GIVEN
|
|
// WHEN
|
|
// THEN
|
|
#expect(throws: DecodingError.self) {
|
|
try transcoder.decode(string)
|
|
}
|
|
}
|
|
|
|
// MARK: Encode tests
|
|
|
|
@Test("encodes a date as a timestamp")
|
|
func encodesTimestamp() throws {
|
|
// GIVEN
|
|
let date: Date = .utc(2026, 7, 24, 12, 34, 56)
|
|
|
|
// WHEN
|
|
let string = try transcoder.encode(date)
|
|
|
|
// THEN
|
|
#expect(string == "2026-07-24T12:34:56.000000")
|
|
}
|
|
|
|
}
|