Merge pull request mattpolzin#198 from mattpolzin/remove-fine-json-requirement

Remove FineJSON test requirement

Author: mattpolzin

.github/workflows/tests.yml

@@ -31,6 +31,23 @@ jobs:
       uses: actions/checkout@v2
     - name: Run tests
       run: swift test --enable-test-discovery
+  linux-5_4-plus:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        image:
+          - swift:5.4-xenial
+          - swift:5.4-bionic
+          - swift:5.4-focal
+          - swift:5.4-centos8
+          - swift:5.4-amazonlinux2
+    container: ${{ matrix.image }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Run tests (without test discovery flag)
+      run: swift test -Xswiftc -Xfrontend -Xswiftc -sil-verify-none
   osx:
     runs-on: macOS-latest
     steps:

Package.resolved

@@ -14,16 +14,15 @@ let package = Package(
             targets: ["OpenAPIKit"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/jpsim/Yams.git", from: "4.0.0"), // just for tests
-        .package(url: "https://github.com/omochi/FineJSON.git", from: "1.14.0") // just for tests
+        .package(url: "https://github.com/jpsim/Yams.git", from: "4.0.0") // just for tests
     ],
     targets: [
         .target(
             name: "OpenAPIKit",
             dependencies: []),
         .testTarget(
             name: "OpenAPIKitTests",
-            dependencies: ["OpenAPIKit", "Yams", "FineJSON"]),
+            dependencies: ["OpenAPIKit", "Yams"]),
         .testTarget(
             name: "OpenAPIKitCompatibilitySuite",
             dependencies: ["OpenAPIKit", "Yams"]),
@@ -35,7 +34,7 @@ let package = Package(
             dependencies: ["OpenAPIKit"]),
         .testTarget(
             name: "OrderedDictionaryTests",
-            dependencies: ["OpenAPIKit", "Yams", "FineJSON"]),
+            dependencies: ["OpenAPIKit", "Yams"]),
         .testTarget(
             name: "AnyCodableTests",
             dependencies: ["OpenAPIKit"])

Package.swift

@@ -77,7 +77,9 @@ You can use this same validation system to dig arbitrarily deep into an OpenAPI
 ### A note on dictionary ordering
 The **Foundation** library's `JSONEncoder` and `JSONDecoder` do not make any guarantees about the ordering of keyed containers. This means decoding a JSON OpenAPI Document and then encoding again might result in the document's various hashed structures being in a different order.
 
-If retaining order is important for your use-case, I recommend the [**Yams**](https://github.com/jpsim/Yams) and [**FineJSON**](https://github.com/omochi/FineJSON) libraries for YAML and JSON respectively.
+If retaining order is important for your use-case, I recommend the [**Yams**](https://github.com/jpsim/Yams) and [**FineJSON**](https://github.com/omochi/FineJSON) libraries for YAML and JSON respectively. Also keep in mind that JSON is entirely valid YAML and therefore you will likely get good results from Yams decoding of JSON as well (it just won't _encode_ as valid JSON). 
+
+The Foundation JSON encoding and decoding will be the most stable and battle-tested option with Yams as a pretty well established and stable option as well. FineJSON is lesser used (to my knowledge) but I have had success with it in the past.
 
 ### OpenAPI Document structure
 The types used by this library largely mirror the object definitions found in the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md) version 3.0.3. The [Project Status](#project-status) lists each object defined by the spec and the name of the respective type in this library.

README.md

@@ -22,18 +22,15 @@ final class GitHubAPICampatibilityTests: XCTestCase {
 
     override func setUp() {
         /*
-         NOTE: As of GitHub's OpenAPI documentation v 2.22, they started to nest
-            their schema components in a bit of an unusual way. not clear to me that
-            the thing they are doing is disallowed by the spec, but definitely weird.
-
-            At any rate, it fails here for now so I will pin this to version 2.21 and
-            revisit later.
+         NOTE: As of 2/17/2021 the latest released version of GitHub's API documentation
+                does not pass but the latest commit does; I will pin this test to that
+                commit for now.
          */
         if githubAPI == nil {
             githubAPI = Result {
                 try YAMLDecoder().decode(
                     OpenAPI.Document.self,
-                    from: String(contentsOf: URL(string: "https://raw.githubusercontent.com/github/rest-api-description/v1.0.0-rc.1/descriptions/ghes-2.21/ghes-2.21.yaml")!)
+                    from: String(contentsOf: URL(string: "https://raw.githubusercontent.com/github/rest-api-description/e4f28959fbc6c9fc4eea823b495061dded87e84d/descriptions/ghes-3.0/ghes-3.0.yaml")!)
                 )
             }
         }
@@ -69,8 +66,8 @@ final class GitHubAPICampatibilityTests: XCTestCase {
         // contact name is Support
         XCTAssertEqual(apiDoc.info.contact?.name, "Support")
 
-        // contact URL was parsed as https://support.github.com
-        XCTAssertEqual(apiDoc.info.contact?.url, URL(string: "https://support.github.com")!)
+        // contact URL was parsed as https://support.github.com/contact
+        XCTAssertEqual(apiDoc.info.contact?.url, URL(string: "https://support.github.com/contact")!)
 
         // no contact email is provided
         XCTAssert(apiDoc.info.contact?.email?.isEmpty ?? true)
@@ -149,6 +146,6 @@ final class GitHubAPICampatibilityTests: XCTestCase {
         let resolvedDoc = try apiDoc.locallyDereferenced().resolved()
 
         XCTAssertEqual(resolvedDoc.routes.count, apiDoc.paths.count)
-        XCTAssertEqual(resolvedDoc.endpoints.count, 550)
+        XCTAssertEqual(resolvedDoc.endpoints.count, 664)
     }
 }

Tests/OpenAPIKitCompatibilitySuite/GitHubAPITests.swift

@@ -320,24 +320,17 @@ extension OperationTests {
             ]
         )
 
-        let encodedOperation = String(
-            data: try orderStableEncode(operation),
-            encoding: .utf8
-        )!
+        let encodedOperation = try orderStableYAMLEncode(operation)
 
         XCTAssertEqual(
             encodedOperation,
             """
-            {
-              "responses": {
-                "404": {
-                  "$ref": "#/components/responses/404"
-                },
-                "200": {
-                  "$ref": "#/components/responses/200"
-                }
-              }
-            }
+            responses:
+              404:
+                $ref: '#/components/responses/404'
+              200:
+                $ref: '#/components/responses/200'
+
             """
         )
 
@@ -348,24 +341,17 @@ extension OperationTests {
             ]
         )
 
-        let encodedOperation2 = String(
-            data: try orderStableEncode(operation2),
-            encoding: .utf8
-            )!
+        let encodedOperation2 = try orderStableYAMLEncode(operation2)
 
         XCTAssertEqual(
             encodedOperation2,
             """
-            {
-              "responses": {
-                "200": {
-                  "$ref": "#/components/responses/200"
-                },
-                "404": {
-                  "$ref": "#/components/responses/404"
-                }
-              }
-            }
+            responses:
+              200:
+                $ref: '#/components/responses/200'
+              404:
+                $ref: '#/components/responses/404'
+
             """
         )
     }

Tests/OpenAPIKitTests/Operation/OperationTests.swift

@@ -6,7 +6,7 @@
 //
 
 import Foundation
-import FineJSON
+import Yams
 import XCTest
 
 fileprivate let foundationTestEncoder = { () -> JSONEncoder in
@@ -32,12 +32,12 @@ func orderUnstableTestStringFromEncoding<T: Encodable>(of entity: T) throws -> S
     return String(data: try orderUnstableEncode(entity), encoding: .utf8)
 }
 
-fileprivate let fineJSONTestEncoder = { () -> FineJSONEncoder in
-    return FineJSONEncoder()
+fileprivate let yamsTestEncoder = { () -> YAMLEncoder in
+    return YAMLEncoder()
 }()
 
-func orderStableEncode<T: Encodable>(_ value: T) throws -> Data {
-    return try fineJSONTestEncoder.encode(value)
+func orderStableYAMLEncode<T: Encodable>(_ value: T) throws -> String {
+    return try yamsTestEncoder.encode(value)
 }
 
 fileprivate let foundationTestDecoder = { () -> JSONDecoder in
@@ -57,12 +57,12 @@ func orderUnstableDecode<T: Decodable>(_ type: T.Type, from data: Data) throws -
     return try foundationTestDecoder.decode(T.self, from: data)
 }
 
-fileprivate let fineJSONTestDecoder = { () -> FineJSONDecoder in
-    return FineJSONDecoder()
+fileprivate let yamsTestDecoder = { () -> YAMLDecoder in
+    return YAMLDecoder()
 }()
 
 func orderStableDecode<T: Decodable>(_ type: T.Type, from data: Data) throws -> T {
-    return try fineJSONTestDecoder.decode(T.self, from: data)
+    return try yamsTestDecoder.decode(T.self, from: data)
 }
 
 func assertJSONEquivalent(_ str1: String?, _ str2: String?, file: StaticString = #file, line: UInt = #line) {