Merge pull request #3 from NeedleInAJayStack/fix/tests

Fixes tests & impoves platform isolation
NeedleInAJayStack · Jun 10, 2024 · 1302dbd · 1302dbd
2 parents bd945ee + 36c6fc3
commit 1302dbd
Show file tree

Hide file tree

Showing 29 changed files with 146 additions and 72 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -4,7 +4,7 @@ on:
   push: { branches: [ main ] }
 
 jobs:
-  darwin-test:
+  macos-test:
     runs-on: macos-latest
     steps:
       - uses: maxim-lobanov/setup-xcode@v1
@@ -13,11 +13,11 @@ jobs:
       - uses: actions/checkout@v2
       - name: Darwin build & test
         run: swift test --skip IntegrationTests
-  linux-build:
+  linux-test:
     runs-on: ubuntu-latest
     container:
       image: swift:latest
     steps:
       - uses: actions/checkout@v2
-      - name: Linux build
-        run: swift build --target HaystackClientNIO
+      - name: Linux build & test
+        run: swift test --skip IntegrationTests
diff --git a/Package.swift b/Package.swift
@@ -2,6 +2,7 @@
 
 import PackageDescription
 
+#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS) || os(visionOS)
 let package = Package(
     name: "Haystack",
     platforms: [
@@ -81,3 +82,60 @@ let package = Package(
         ),
     ]
 )
+#else
+let package = Package(
+    name: "Haystack",
+    products: [
+        .library(
+            name: "Haystack",
+            targets: ["Haystack"]
+        ),
+        .library(
+            name: "HaystackClientNIO",
+            targets: [
+                "HaystackClient",
+                "HaystackClientNIO"
+            ]
+        ),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "3.0.0"),
+        .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.9.0")
+    ],
+    targets: [
+        .target(
+            name: "Haystack",
+            dependencies: []
+        ),
+        .target(
+            name: "HaystackClient",
+            dependencies: [
+                "Haystack",
+                .product(name: "Crypto", package: "swift-crypto"),
+            ]
+        ),
+        .target(
+            name: "HaystackClientNIO",
+            dependencies: [
+                "Haystack",
+                "HaystackClient",
+                .product(name: "AsyncHTTPClient", package: "async-http-client"),
+            ]
+        ),
+
+        // Tests
+        .testTarget(
+            name: "HaystackTests",
+            dependencies: ["Haystack"]
+        ),
+        .testTarget(
+            name: "HaystackClientTests",
+            dependencies: ["HaystackClient"]
+        ),
+        .testTarget(
+            name: "HaystackClientNIOIntegrationTests",
+            dependencies: ["HaystackClientNIO"]
+        ),
+    ]
+)
+#endif
diff --git a/Sources/Haystack/Coord.swift b/Sources/Haystack/Coord.swift
@@ -39,7 +39,7 @@ extension Coord: Codable {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#coord)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -68,7 +68,7 @@ extension Coord: Codable {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#coord)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(latitude, forKey: .lat)
         try container.encode(longitude, forKey: .lng)

diff --git a/Sources/Haystack/Date.swift b/Sources/Haystack/Date.swift
@@ -73,7 +73,7 @@ extension Date {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#date)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -110,7 +110,7 @@ extension Date {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#date)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(isoString, forKey: .val)
     }

diff --git a/Sources/Haystack/DateTime.swift b/Sources/Haystack/DateTime.swift
@@ -206,7 +206,7 @@ extension DateTime {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#dateTime)
     public init(from decoder: Decoder) throws {
-        guard let container = try? decoder.container(keyedBy: Self.CodingKeys) else {
+        guard let container = try? decoder.container(keyedBy: Self.CodingKeys.self) else {
             throw DecodingError.typeMismatch(
                 Self.self,
                 .init(
@@ -248,7 +248,7 @@ extension DateTime {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#dateTime)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         let isoString: String
         if hasMilliseconds {

diff --git a/Sources/Haystack/Grid.swift b/Sources/Haystack/Grid.swift
@@ -76,7 +76,7 @@ extension Grid {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#grid)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -110,7 +110,7 @@ extension Grid {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#grid)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(meta, forKey: .meta)
         if cols.isEmpty {

diff --git a/Sources/Haystack/Marker.swift b/Sources/Haystack/Marker.swift
@@ -33,7 +33,7 @@ extension Marker {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#marker)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -58,7 +58,7 @@ extension Marker {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#marker)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
     }
 }
diff --git a/Sources/Haystack/NA.swift b/Sources/Haystack/NA.swift
@@ -33,7 +33,7 @@ extension NA {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#na)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -58,7 +58,7 @@ extension NA {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#na)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
     }
 }
diff --git a/Sources/Haystack/Number.swift b/Sources/Haystack/Number.swift
@@ -70,7 +70,7 @@ extension Number {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#number)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -129,7 +129,7 @@ extension Number {
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#number)
     public func encode(to encoder: Encoder) throws {
         if unit != nil || val.isNaN || val.isInfinite {
-            var container = encoder.container(keyedBy: Self.CodingKeys)
+            var container = encoder.container(keyedBy: Self.CodingKeys.self)
             try container.encode(Self.kindValue, forKey: ._kind)
 
             if val.isNaN {

diff --git a/Sources/Haystack/Ref.swift b/Sources/Haystack/Ref.swift
@@ -45,7 +45,7 @@ extension Ref {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#ref)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -74,7 +74,7 @@ extension Ref {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#ref)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(val, forKey: .val)
         try container.encode(dis, forKey: .dis)

diff --git a/Sources/Haystack/Remove.swift b/Sources/Haystack/Remove.swift
@@ -27,7 +27,7 @@ extension Remove {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#remove)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -52,7 +52,7 @@ extension Remove {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#remove)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
     }
 }
diff --git a/Sources/Haystack/Symbol.swift b/Sources/Haystack/Symbol.swift
@@ -37,7 +37,7 @@ extension Symbol {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#symbol)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -63,7 +63,7 @@ extension Symbol {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#symbol)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(val, forKey: .val)
     }

diff --git a/Sources/Haystack/Time.swift b/Sources/Haystack/Time.swift
@@ -100,7 +100,7 @@ extension Time {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#date)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -137,7 +137,7 @@ extension Time {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#time)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(isoString, forKey: .val)
     }

diff --git a/Sources/Haystack/Uri.swift b/Sources/Haystack/Uri.swift
@@ -32,7 +32,7 @@ extension Uri {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#uri)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -58,7 +58,7 @@ extension Uri {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#uri)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(val, forKey: .val)
     }

diff --git a/Sources/Haystack/XStr.swift b/Sources/Haystack/XStr.swift
@@ -39,7 +39,7 @@ extension XStr {
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#xstr)
     public init(from decoder: Decoder) throws {
-        if let container = try? decoder.container(keyedBy: Self.CodingKeys) {
+        if let container = try? decoder.container(keyedBy: Self.CodingKeys.self) {
             guard try container.decode(String.self, forKey: ._kind) == Self.kindValue else {
                 throw DecodingError.typeMismatch(
                     Self.self,
@@ -68,7 +68,7 @@ extension XStr {
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#xstr)
     public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: Self.CodingKeys)
+        var container = encoder.container(keyedBy: Self.CodingKeys.self)
         try container.encode(Self.kindValue, forKey: ._kind)
         try container.encode(type, forKey: .type)
         try container.encode(val, forKey: .val)

diff --git a/Sources/HaystackClientNIO/Client+HTTPClient.swift b/Sources/HaystackClientNIO/Client+HTTPClient.swift
@@ -18,9 +18,9 @@ public extension Client {
         username: String,
         password: String,
         format: DataFormat = .zinc,
-        eventLoopGroup: EventLoopGroup
+        httpClient: HTTPClient
     ) throws {
-        let fetcher = HTTPClient(eventLoopGroupProvider: .shared(eventLoopGroup)).haystackFetcher()
+        let fetcher = httpClient.haystackFetcher()
         try self.init(
             baseUrl: baseUrl,
             username: username,

diff --git a/Tests/HaystackClientNIOIntegrationTests/HaystackClientNIOIntegrationTests.swift b/Tests/HaystackClientNIOIntegrationTests/HaystackClientNIOIntegrationTests.swift
@@ -1,24 +1,30 @@
-import XCTest
+import AsyncHTTPClient
 import Haystack
 import HaystackClientNIO
 import NIO
+import XCTest
 
 /// To use these tests, run a [Haxall](https://github.com/haxall/haxall) server and set the username and password
 /// in the `HAYSTACK_USER` and `HAYSTACK_PASSWORD` environment variables
 final class HaystackClientNIOIntegrationTests: XCTestCase {
-    var client: Client = try! Client(
-        baseUrl: "http://localhost:8080/api/",
-        username: ProcessInfo.processInfo.environment["HAYSTACK_USER"] ?? "su",
-        password: ProcessInfo.processInfo.environment["HAYSTACK_PASSWORD"] ?? "su",
-        eventLoopGroup: MultiThreadedEventLoopGroup(numberOfThreads: 1)
-    )
+    let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
+    var httpClient: HTTPClient!
+    var client: Client!
 
     override func setUp() async throws {
+        httpClient = HTTPClient(eventLoopGroupProvider: .shared(eventLoopGroup))
+        client = try Client(
+            baseUrl: "http://localhost:8080/api/",
+            username: ProcessInfo.processInfo.environment["HAYSTACK_USER"] ?? "su",
+            password: ProcessInfo.processInfo.environment["HAYSTACK_PASSWORD"] ?? "su",
+            httpClient: httpClient
+        )
         try await client.open()
     }
 
     override func tearDown() async throws {
         try await client.close()
+        try httpClient.syncShutdown()
     }
 
     func testCloseAndOpen() async throws {

diff --git a/Tests/HaystackTests/CoordTests.swift b/Tests/HaystackTests/CoordTests.swift
@@ -13,10 +13,11 @@ final class CoordTests: XCTestCase {
         let value = try Coord(latitude: 40, longitude: -111.84)
         let jsonString = #"{"_kind":"coord","lat":40,"lng":-111.84}"#
 
+        // Must encode/decode b/c JSON ordering is not deterministic
         let encodedData = try JSONEncoder().encode(value)
         XCTAssertEqual(
-            String(data: encodedData, encoding: .utf8),
-            jsonString
+            try JSONDecoder().decode(Coord.self, from: encodedData),
+            value
         )
 
         let decodedData = try XCTUnwrap(jsonString.data(using: .utf8))