Initial commit

Author: finestructure

.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

Package.swift

@@ -0,0 +1,32 @@
+// swift-tools-version: 5.6
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import PackageDescription
+
+let package = Package(
+    name: "spi-dependency-resolution",
+    products: [
+        .library(name: "DependencyResolution", targets: ["DependencyResolution"])
+    ],
+    dependencies: [],
+    targets: [
+        .target(name: "DependencyResolution"),
+        .testTarget(name: "DependencyResolutionTests",
+            dependencies: [.target(name: "DependencyResolution")]
+        )
+    ]
+)

README.md

@@ -0,0 +1,4 @@
+# spi-dependency-resolution
+
+Support package for SPI-Server, handling dependency resolution.
+

Sources/DependencyResolution/DependencyResolution.swift

@@ -0,0 +1,101 @@
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import Foundation
+
+public struct ResolvedDependency: Codable, Equatable {
+    public var packageName: String
+    public var repositoryURL: String
+
+    public init(packageName: String, repositoryURL: String) {
+        self.packageName = packageName
+        self.repositoryURL = repositoryURL
+    }
+}
+
+
+public protocol FileManager {
+    func contents(atPath: String) -> Data?
+    func fileExists(atPath: String) -> Bool
+}
+
+
+extension Foundation.FileManager: FileManager { }
+
+
+public func getResolvedDependencies(_ fileManager: FileManager = Foundation.FileManager.default, at path: String) -> [ResolvedDependency]? {
+    struct PackageResolved: Decodable {
+        //    object:
+        //      pins:
+        //        - package: String
+        //          repositoryURL: URL
+        //        - ...
+        //      version: 1
+        struct V1: Decodable {
+            var object: Object
+
+            struct Object: Decodable {
+                var pins: [Pin]
+
+                struct Pin: Decodable {
+                    var package: String
+                    var repositoryURL: URL
+                }
+            }
+        }
+
+        //    object:
+        //      pins:
+        //        - identity: String
+        //          location: URL
+        //        - ...
+        //      version: 1
+        struct V2: Decodable {
+            var pins: [Pin]
+
+            struct Pin: Decodable {
+                var identity: String
+                var location: URL
+            }
+        }
+    }
+
+    let filePath = URL(fileURLWithPath: path)
+        .appendingPathComponent("Package.resolved").path
+
+    guard fileManager.fileExists(atPath: filePath),
+          let json = fileManager.contents(atPath: filePath) else { return nil }
+    
+    if let packageResolvedV2 = try? JSONDecoder()
+        .decode(PackageResolved.V2.self, from: json) {
+        return packageResolvedV2.pins.map {
+            ResolvedDependency(
+                packageName: $0.identity,
+                repositoryURL: $0.location.absoluteString
+            )
+        }
+    }
+
+    if let packageResolvedV1 = try? JSONDecoder()
+        .decode(PackageResolved.V1.self, from: json) {
+        return packageResolvedV1.object.pins.map {
+            ResolvedDependency(
+                packageName: $0.package,
+                repositoryURL: $0.repositoryURL.absoluteString
+            )
+        }
+    }
+
+    return nil
+}

Tests/DependencyResolutionTests/DependencyResolutionTests.swift

@@ -0,0 +1,89 @@
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+@testable import DependencyResolution
+
+import XCTest
+
+
+/// Tests for utilities and extesions that don't each need a full separate test class
+class DependencyResolutionTests: XCTestCase {
+
+    func test_getResolvedDependencies_v1() throws {
+        // setup
+        struct TestFileManager: DependencyResolution.FileManager {
+            func contents(atPath: String) -> Data? {
+                Data("""
+                    {
+                      "object": {
+                        "pins": [
+                          {
+                            "package": "Yams",
+                            "repositoryURL": "https://github.com/jpsim/Yams.git",
+                            "state": {
+                              "branch": null,
+                              "revision": "01835dc202670b5bb90d07f3eae41867e9ed29f6",
+                              "version": "5.0.1"
+                            }
+                          }
+                        ]
+                      },
+                      "version": 1
+                    }
+                    """.utf8)
+            }
+            func fileExists(atPath: String) -> Bool { true }
+        }
+
+        // MUT
+        let deps = getResolvedDependencies(TestFileManager(),
+                                           at: "path ignored because we mock it")
+
+        // validate
+        XCTAssertEqual(deps?.count, 1)
+    }
+
+    func test_getResolvedDependencies_v2() throws {
+        // setup
+        struct TestFileManager: DependencyResolution.FileManager {
+            func contents(atPath: String) -> Data? {
+                Data("""
+                    {
+                      "pins" : [
+                        {
+                          "identity" : "swift-log",
+                          "kind" : "remoteSourceControl",
+                          "location" : "https://github.com/apple/swift-log.git",
+                          "state" : {
+                            "revision" : "6fe203dc33195667ce1759bf0182975e4653ba1c",
+                            "version" : "1.4.4"
+                          }
+                        }
+                      ],
+                      "version" : 2
+                    }
+                    """.utf8)
+            }
+            func fileExists(atPath: String) -> Bool { true }
+        }
+
+        // MUT
+        let deps = getResolvedDependencies(TestFileManager(),
+                                           at: "path ignored because we mock it")
+
+        // validate
+        XCTAssertEqual(deps?.count, 1)
+    }
+
+}