updated test resource files

Author: Eldi Cano

Package.swift

@@ -27,7 +27,6 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
         .package(url: "https://github.com/Apodini/ApodiniTypeInformation.git", .upToNextMinor(from: "0.2.0")),
         .package(url: "https://github.com/kylef/PathKit.git", .exact("0.9.2")),
         .package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0"),

Sources/ApodiniMigrator/Migrator/Migrator.swift

@@ -47,15 +47,14 @@ public struct Migrator {
     private let objectJSONs: [String: JSONValue]
     /// Encoder configuration of the new version as calculated by the `networkingMigrator`
     private let encoderConfiguration: EncoderConfiguration
-    /// A flag to indicate whether the template empty test file should be used, or the one that handles encoding and decodin of the models (not configurable, for dev only)
 
     /// Initializes a new Migrator instance
     /// - Parameters:
     ///    - packageName: name of the package
     ///    - packagePath: path of the package
     ///    - documentPath: path where the document is located
     ///    - migrationGuide: migration guide
-    public init(packageName: String, packagePath: String, documentPath: String, migrationGuide: MigrationGuide) throws {
+    public init(packageName: String, packagePath: String, documentPath: String, migrationGuide: MigrationGuide = .empty) throws {
         self.packageName = packageName.trimmingCharacters(in: .whitespaces).without("/").upperFirst
         self.packagePath = packagePath.asPath
         document = try Document.decode(from: documentPath.asPath)
@@ -101,7 +100,7 @@ public struct Migrator {
     }
 
     /// Triggeres the rendering of migrated content of the library and persists changes
-    public func migrate() throws {
+    public func run() throws {
         logger.info("Preparing project directories...")
         try directories.build()
 

Sources/ApodiniMigrator/Templates/Package.md

@@ -12,7 +12,7 @@ let package = Package(
             .library(name: "___PACKAGE_NAME___", targets: ["___PACKAGE_NAME___"])
     ],
     dependencies: [
-            .package(url: "https://github.com/Apodini/ApodiniMigrator.git", .branch("develop"))
+            .package(url: "https://github.com/Apodini/ApodiniMigrator.git", .upToNextMinor(from: "0.1.0"))
     ],
     targets: [
         .target(

Sources/ApodiniMigratorCLI/Generate.swift

@@ -34,10 +34,9 @@ struct Generate: ParsableCommand {
             let generator = try migrator.init(
                 packageName: packageName,
                 packagePath: targetDirectory,
-                documentPath: documentPath,
-                migrationGuide: .empty
+                documentPath: documentPath
             )
-            try generator.migrate()
+            try generator.run()
             logger.info("Package \(packageName) was generated successfully. You can open the package via \(packageName)/Package.swift")
         } catch {
             logger.error("Package generation failed with error: \(error)")

Sources/ApodiniMigratorCLI/Migrate.swift

@@ -41,7 +41,7 @@ struct Migrate: ParsableCommand {
                 documentPath: documentPath,
                 migrationGuide: migrationGuide
             )
-            try migrator.migrate()
+            try migrator.run()
             logger.info("Package \(packageName) was migrated successfully. You can open the package via \(packageName)/Package.swift")
         } catch {
             logger.error("Package migration failed with error: \(error)")

Sources/ApodiniMigratorCore/WebService/Endpoint.swift

@@ -44,7 +44,7 @@ public struct Endpoint: Value, DeltaIdentifiable {
         response: TypeInformation,
         errors: [ErrorCode]
     ) {
-        self.handlerName = handlerName
+        self.handlerName = handlerName.without(strings: ">", "<", ",")
         var identifier = deltaIdentifier
         if !identifier.split(string: ".").compactMap({ Int($0) }).isEmpty {
             identifier = handlerName.lowerFirst

Sources/ApodiniMigratorShared/Extensions/String+Extensions.swift

@@ -99,6 +99,13 @@ public extension String {
         with("", insteadOf: string)
     }
 
+    /// Replaces occurrencies of `strings` with an empty string
+    func without(strings: String...) -> String {
+        var result = self
+        strings.forEach { result = result.without($0) }
+        return result
+    }
+    
     /// Replaces occurrencies of `target` with `replacement`
     func with(_ replacement: String, insteadOf target: String) -> String {
         replacingOccurrences(of: target, with: replacement)

Tests/ApodiniMigratorTests/ClientLibraryGenerationMigrationTests.swift

@@ -0,0 +1,97 @@
+//
+// This source file is part of the Apodini open source project
+//
+// SPDX-FileCopyrightText: 2019-2021 Paul Schmiedmayer and the Apodini project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
+//
+// SPDX-License-Identifier: MIT
+//
+
+import XCTest
+@testable import ApodiniMigrator
+
+final class ClientLibraryGenerationMigrationTests: ApodiniMigratorXCTestCase {
+    func testV1LibraryGeneration() throws {
+        let document = try Documents.v1.instance() as Document
+        let migrator = XCTAssertNoThrowWithResult(try Migrator(
+            packageName: "QONECTIQ",
+            packagePath: testDirectory,
+            documentPath: Documents.v1.path.string
+        ))
+        
+        XCTAssertNoThrow(try migrator.run())
+        
+        let swiftFiles = try testDirectoryPath.recursiveSwiftFiles().map { $0.lastComponent }
+                
+        let modelNames = document.allModels().map { $0.typeString + .swift }
+        
+        modelNames.forEach { XCTAssert(swiftFiles.contains($0)) }
+        
+        let endpointFileNames = document.endpoints.map { $0.response.nestedTypeString + "+Endpoint" + .swift }.unique()
+        
+        endpointFileNames.forEach { XCTAssert(swiftFiles.contains($0)) }
+        
+        XCTAssert(swiftFiles.contains("Handler.swift"))
+        XCTAssert(swiftFiles.contains("NetworkingService.swift"))
+        XCTAssert(swiftFiles.contains("QONECTIQTests.swift"))
+    }
+    
+    func testV2LibraryGeneration() throws {
+        let document = try Documents.v2.instance() as Document
+        let migrator = XCTAssertNoThrowWithResult(try Migrator(
+            packageName: "QONECTIQ",
+            packagePath: testDirectory,
+            documentPath: Documents.v2.path.string
+        ))
+        
+        XCTAssertNoThrow(try migrator.run())
+        
+        let swiftFiles = try testDirectoryPath.recursiveSwiftFiles().map { $0.lastComponent }
+                
+        let modelNames = document.allModels().map { $0.typeString + .swift }
+        
+        modelNames.forEach { XCTAssert(swiftFiles.contains($0)) }
+        
+        let endpointFileNames = document.endpoints.map { $0.response.nestedTypeString + "+Endpoint" + .swift }.unique()
+        
+        endpointFileNames.forEach { XCTAssert(swiftFiles.contains($0)) }
+        
+        XCTAssert(swiftFiles.contains("Handler.swift"))
+        XCTAssert(swiftFiles.contains("NetworkingService.swift"))
+        XCTAssert(swiftFiles.contains("QONECTIQTests.swift"))
+    }
+    
+    func testMigratorThrowIncompatibleMigrationGuide() throws {
+        let migrationGuide = try Documents.migrationGuide.instance() as MigrationGuide
+        XCTAssertThrows(try Migrator(packageName: "Test", packagePath: testDirectory, documentPath: Documents.v2.path.string, migrationGuide: migrationGuide))
+    }
+    
+    func testPackageMigration() throws {
+        let migrationGuide = try MigrationGuide.decode(from: try Documents.migrationGuide.data())
+        let migrator = XCTAssertNoThrowWithResult(try Migrator(
+            packageName: "TestMigPackage",
+            packagePath: testDirectory,
+            documentPath: Documents.v1.path.string,
+            migrationGuide: migrationGuide
+        ))
+        
+        XCTAssertNoThrow(try migrator.run())
+        XCTAssert(try testDirectoryPath.recursiveSwiftFiles().isNotEmpty)
+    }
+    
+    func testMigrationGuideThrowing() throws {
+        XCTAssertThrows(try MigrationGuide.from(Path(#file), .init(.endpoints)))
+        XCTAssertThrows(try MigrationGuide.from("", ""))
+    }
+    
+    func testMigrationGuideGeneration() throws {
+        let doc1 = try Documents.v1.instance() as Document
+        let doc2 = try Documents.v2.instance() as Document
+        
+        let migrationGuide = MigrationGuide(for: doc1, rhs: doc2)
+        try (testDirectoryPath + "migration_guide.yaml").write(migrationGuide.yaml)
+
+        let decoded = try MigrationGuide.decode(from: testDirectoryPath + "migration_guide.yaml")
+        XCTAssertEqual(decoded, migrationGuide)
+        XCTAssertNotEqual(decoded, .empty)
+    }
+}