Merge pull request #2870 from SwiftPackageIndex/issue-2868

Issue 2868

Author: finestructure

Package.resolved

@@ -31,7 +31,7 @@ let package = Package(
         .package(url: "https://github.com/MrLotU/SwiftPrometheus.git", from: "1.0.0-alpha"),
         .package(url: "https://github.com/SwiftPackageIndex/CanonicalPackageURL.git", from: "0.0.8"),
         .package(url: "https://github.com/SwiftPackageIndex/DependencyResolution.git", from: "1.1.2"),
-        .package(url: "https://github.com/SwiftPackageIndex/SPIManifest.git", from: "1.1.0"),
+        .package(url: "https://github.com/SwiftPackageIndex/SPIManifest.git", from: "1.1.2"),
         .package(url: "https://github.com/SwiftPackageIndex/SemanticVersion.git", from: "0.3.0"),
         .package(url: "https://github.com/SwiftPackageIndex/ShellOut.git", from: "3.1.4"),
         .package(url: "https://github.com/apple/swift-package-manager.git", revision: "swift-5.9-RELEASE"),

Package.swift

@@ -37,9 +37,11 @@ enum ValidateSPIManifestController {
 
     static func validationResult(manifest: String) -> ValidateSPIManifest.ValidationResult {
         do {
-            return .valid(try SPIManifest.Manifest(yml: manifest))
-        } catch let error as DecodingError {
-            return .invalid("\(error)")
+            return .valid(try SPIManifest.Manifest.load(data: Data(manifest.utf8)))
+        } catch let ManifestError.decodingError(error) {
+            return .invalid("Decoding failed: \(error)")
+        } catch let ManifestError.fileTooLarge(size: size) {
+            return .invalid("File must not exceed \(SPIManifest.Manifest.maxByteSize) bytes. File size: \(size) bytes.")
         } catch {
             return .invalid(error.localizedDescription)
         }

Sources/App/Controllers/ValidateSPIManifestController.swift

@@ -29,7 +29,7 @@ enum ValidateSPIManifest {
             """
     }
 
-    enum ValidationResult {
+    enum ValidationResult: Equatable {
         case valid(SPIManifest.Manifest)
         case invalid(String)
 

Sources/App/Views/ValidateSPIManifest/ValidateSPIManifest+Model.swift

@@ -67,7 +67,8 @@ extension ValidateSPIManifest {
                                         .autofocus(true),
                                         .rows(15),
                                         .text(model.manifest),
-                                        .attribute(named: "maxlength", value: "\(SPIManifest.Manifest.maxByteSize)")
+                                        // allow more than maxByteSize so we can correctly report on files that are too large
+                                        .attribute(named: "maxlength", value: "\(SPIManifest.Manifest.maxByteSize + 100)")
                                     )
                                 ),
                                 .button(

Sources/App/Views/ValidateSPIManifest/ValidateSPIManifest+View.swift

@@ -0,0 +1,63 @@
+// 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 XCTest
+
+@testable import App
+
+import SPIManifest
+
+
+final class ValidateSPIManifestControllerTests: XCTestCase {
+
+    func test_validationResult_basic() throws {
+        let yml = ValidateSPIManifest.Model.placeholderManifest
+
+        // MUT
+        let res = ValidateSPIManifestController.validationResult(manifest: yml)
+
+        // validate
+        XCTAssertEqual(res, .valid(try SPIManifest.Manifest(yml: yml)))
+    }
+
+    func test_validationResult_decodingError() throws {
+        let yml = """
+            broken:
+            """
+
+        // MUT
+        let res = ValidateSPIManifestController.validationResult(manifest: yml)
+
+        // validate
+        XCTAssertEqual(res, .invalid("Decoding failed: Key not found: 'version'."))
+    }
+
+    func test_validationResult_tooLarge() throws {
+        let targets = (0..<200).map { "Target_\($0)" }.joined(separator: ", ")
+        let yml = """
+            version: 1
+            builder:
+              configs:
+                - documentation_targets: [\(targets)]
+            """
+        XCTAssert(yml.count > SPIManifest.Manifest.maxByteSize)
+
+        // MUT
+        let res = ValidateSPIManifestController.validationResult(manifest: yml)
+
+        // validate
+        XCTAssertEqual(res, .invalid("File must not exceed \(SPIManifest.Manifest.maxByteSize) bytes. File size: \(yml.count) bytes."))
+    }
+
+}

Tests/AppTests/ValidateSPIManifestControllerTests.swift

@@ -77,7 +77,7 @@ <h2 class="trimmed">Validate a Swift Package Index manifest</h2>
               <p>Enter the contents of a 
                 <code>.spi.yml</code> file for validation:
               </p>
-              <textarea name="manifest" autofocus rows="15" maxlength="1000">version: 1
+              <textarea name="manifest" autofocus rows="15" maxlength="1600">version: 1
 builder:
   configs:
     - documentation_targets: [Target1, Target2]</textarea>