Adding logging to Shell + switching to macos for reference packages

goergisn · goergisn · commit c32f61eb2138 · 2025-04-30T11:48:32.000+02:00
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -124,6 +124,7 @@ let package = Package(
         ),
         .target(
             name: "ShellModule",
+            dependencies: ["PADLogging"],
             path: "Sources/Shared/Package/ShellModule"
         ),
         .target(
diff --git a/ReferencePackages/.DS_Store b/ReferencePackages/.DS_Store
diff --git a/ReferencePackages/ReferencePackage/Package.swift b/ReferencePackages/ReferencePackage/Package.swift
@@ -5,7 +5,7 @@ import PackageDescription
 
 let package = Package(
     name: "ReferencePackage",
-    platforms: [.iOS(.v17)],
+    platforms: [.macOS(.v14)],
     products: [
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
diff --git a/ReferencePackages/UpdatedPackage/Package.swift b/ReferencePackages/UpdatedPackage/Package.swift
@@ -5,7 +5,7 @@ import PackageDescription
 
 let package = Package(
     name: "ReferencePackage",
-    platforms: [.iOS(.v17)],
+    platforms: [.macOS(.v14)],
     products: [
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
diff --git a/ReferencePackages/UpdatedPackage/Sources/ReferencePackage/ReferencePackage.swift b/ReferencePackages/UpdatedPackage/Sources/ReferencePackage/ReferencePackage.swift
@@ -224,3 +224,11 @@ public extension CustomEnum where T == String {
         return nil
     }
 }
+
+@available(macOS 14, *)
+public enum NewEnumAvailableInVersion17: String, Codable, Equatable {
+    case case1 = "Case 1"
+    
+    @available(macOS 15, *)
+    public func laterAvailableFunction(){}
+}
diff --git a/Sources/PublicModules/PADPackageFileAnalyzer/SwiftPackageFileAnalyzer.swift b/Sources/PublicModules/PADPackageFileAnalyzer/SwiftPackageFileAnalyzer.swift
@@ -30,14 +30,14 @@ public struct SwiftPackageFileAnalyzer: SwiftPackageFileAnalyzing {
     public init(logger: (any Logging)? = nil) {
         self.init(
             fileHandler: FileManager.default,
-            shell: Shell(),
+            shell: Shell(logger: logger),
             logger: logger
         )
     }
 
     package init(
         fileHandler: FileHandling = FileManager.default,
-        shell: ShellHandling = Shell(),
+        shell: ShellHandling,
         logger: (any Logging)? = nil
     ) {
         self.fileHandler = fileHandler
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift b/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift
@@ -50,7 +50,7 @@ public struct ProjectBuilder {
             platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             fileHandler: FileManager.default,
-            shell: Shell(),
+            shell: Shell(logger: logger),
             logger: logger
         )
     }
@@ -60,7 +60,7 @@ public struct ProjectBuilder {
         platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         fileHandler: any FileHandling = FileManager.default,
-        shell: any ShellHandling = Shell(),
+        shell: any ShellHandling,
         logger: (any Logging)?
     ) {
         self.projectType = projectType
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectSetup/ProjectSetupHelper.swift b/Sources/PublicModules/PADProjectBuilder/ProjectSetup/ProjectSetupHelper.swift
@@ -26,7 +26,7 @@ struct ProjectSetupHelper: ProjectSetupHelping {
     init(
         workingDirectoryPath: String,
         randomStringGenerator: any RandomStringGenerating = RandomStringGenerator(),
-        shell: any ShellHandling = Shell(),
+        shell: any ShellHandling,
         fileHandler: any FileHandling = FileManager.default,
         logger: (any Logging)?
     ) {
@@ -75,6 +75,7 @@ extension ProjectSetupHelper {
     ) async throws -> (old: URL, new: URL) {
         let projectSetupHelper = ProjectSetupHelper(
             workingDirectoryPath: workingDirectoryPath,
+            shell: Shell(logger: logger),
             logger: logger
         )
 
diff --git a/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift b/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift
@@ -31,7 +31,7 @@ struct XcodeTools {
     private let logger: Logging?
 
     init(
-        shell: ShellHandling = Shell(),
+        shell: ShellHandling,
         fileHandler: FileHandling = FileManager.default,
         logger: Logging?
     ) {
@@ -81,7 +81,7 @@ struct XcodeTools {
         }
 
         let command = commandComponents.joined(separator: " ")
-
+        
         return try await Task {
             logger?.log("📦 Archiving \(scheme) from \(projectDirectoryPath)", from: String(describing: Self.self))
 
diff --git a/Sources/Shared/Package/ShellModule/Shell.swift b/Sources/Shared/Package/ShellModule/Shell.swift
@@ -5,6 +5,7 @@
 //
 
 import Foundation
+import PADLogging
 
 package protocol ShellHandling {
 
@@ -14,7 +15,13 @@ package protocol ShellHandling {
 
 package struct Shell: ShellHandling {
 
-    package init() {}
+    private let logger: Logging?
+    
+    package init(
+        logger: Logging?
+    ) {
+        self.logger = logger
+    }
 
     @discardableResult
     package func execute(_ command: String) -> String {
@@ -29,6 +36,8 @@ package struct Shell: ShellHandling {
         task.standardInput = nil
         task.launch()
 
+        logger?.debug("👾 \(command)", from: String(describing: Self.self))
+        
         let data = pipe.fileHandleForReading.readDataToEndOfFile()
         return String(data: data, encoding: .utf8) ?? ""
     }
diff --git a/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift b/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift
@@ -32,7 +32,7 @@ public struct SwiftInterfaceFileLocator {
     ) {
         self.init(
             fileHandler: FileManager.default,
-            shell: Shell(),
+            shell: Shell(logger: logger),
             logger: logger
         )
     }
diff --git a/Tests/IntegrationTests/ReferencePackageTests.swift b/Tests/IntegrationTests/ReferencePackageTests.swift
@@ -8,6 +8,8 @@
 @testable import PADOutputGenerator
 @testable import PADProjectBuilder
 @testable import PADSwiftInterfaceDiff
+@testable import PADLogging
+import ShellModule
 import XCTest
 
 class ReferencePackageTests: XCTestCase {
@@ -24,19 +26,22 @@ class ReferencePackageTests: XCTestCase {
             return // Nothing to build
         }
 
-        let xcodeTools = XcodeTools(logger: nil)
+        let xcodeTools = XcodeTools(
+            shell: Shell(logger: nil),
+            logger: nil
+        )
 
         _ = try await xcodeTools.archive(
             projectDirectoryPath: oldReferencePackageDirectory.path(),
             scheme: "ReferencePackage",
             projectType: .swiftPackage,
-            platform: .iOS
+            platform: .macOS
         )
         _ = try await xcodeTools.archive(
             projectDirectoryPath: newReferencePackageDirectory.path(),
             scheme: "ReferencePackage",
             projectType: .swiftPackage,
-            platform: .iOS
+            platform: .macOS
         )
     }
 
@@ -64,7 +69,7 @@ class ReferencePackageTests: XCTestCase {
             newVersionName: "new_public",
             warnings: []
         )
-
+        
         let expectedLines = sanitizeOutput(expectedOutput).components(separatedBy: "\n")
         let markdownOutputLines = sanitizeOutput(markdownOutput).components(separatedBy: "\n")
         
@@ -131,9 +136,9 @@ private extension ReferencePackageTests {
         var interfaceFilePath: String {
             switch self {
             case .public:
-                "\(XcodeTools.Constants.derivedDataPath)/Build/Products/Debug-iphoneos/ReferencePackage.swiftmodule/arm64-apple-ios.swiftinterface"
+                "\(XcodeTools.Constants.derivedDataPath)/Build/Products/Debug/ReferencePackage.swiftmodule/arm64-apple-macos.swiftinterface"
             case .private:
-                "\(XcodeTools.Constants.derivedDataPath)/Build/Products/Debug-iphoneos/ReferencePackage.swiftmodule/arm64-apple-ios.private.swiftinterface"
+                "\(XcodeTools.Constants.derivedDataPath)/Build/Products/Debug/ReferencePackage.swiftmodule/arm64-apple-macos.private.swiftinterface"
             }
         }
     }
diff --git a/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-private.md b/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-private.md
@@ -1,11 +1,29 @@
+<<<<<<< Updated upstream
 # ⚠️ 56 public changes detected ⚠️
 _Comparing `new_private` to `old_private`_
 <table><tr><td>❇️</td><td><b>32 Additions</b></td></tr><tr><td>🔀</td><td><b>22 Modifications</b></td></tr><tr><td>❌</td><td><b>2 Removals</b></td></tr></table>
+=======
+# ⚠️ 58 public changes detected ⚠️
+_Comparing `new_private` to `old_private`_
+<table><tr><td>❇️</td><td><b>34 Additions</b></td></tr><tr><td>🔀</td><td><b>22 Modifications</b></td></tr><tr><td>❌</td><td><b>2 Removals</b></td></tr></table>
+>>>>>>> Stashed changes
 
 ---
 ## `ReferencePackage`
 #### ❇️ Added
 ```javascript
+@available(macOS 14, *)
+public enum NewEnumAvailableInVersion17: Swift.Codable, Swift.Equatable, Swift.Hashable, Swift.RawRepresentable, Swift.String {
+  @available(macOS 14, *)
+  public typealias RawValue = Swift.String
+  @available(macOS 15, *)
+  public func laterAvailableFunction() -> Swift.Void
+  case case1
+  public init?(rawValue: Swift.String)
+  public var rawValue: Swift.String { get }
+}
+```
+```javascript
 @resultBuilder
 public struct SomeResultBuilder {
   public static func buildBlock(_ components: Swift.String) -> Swift.String
diff --git a/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md b/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md
@@ -1,11 +1,29 @@
+<<<<<<< Updated upstream
 # ⚠️ 47 public changes detected ⚠️
 _Comparing `new_public` to `old_public`_
 <table><tr><td>❇️</td><td><b>29 Additions</b></td></tr><tr><td>🔀</td><td><b>16 Modifications</b></td></tr><tr><td>❌</td><td><b>2 Removals</b></td></tr></table>
+=======
+# ⚠️ 49 public changes detected ⚠️
+_Comparing `new_public` to `old_public`_
+<table><tr><td>❇️</td><td><b>31 Additions</b></td></tr><tr><td>🔀</td><td><b>16 Modifications</b></td></tr><tr><td>❌</td><td><b>2 Removals</b></td></tr></table>
+>>>>>>> Stashed changes
 
 ---
 ## `ReferencePackage`
 #### ❇️ Added
 ```javascript
+@available(macOS 14, *)
+public enum NewEnumAvailableInVersion17: Swift.Codable, Swift.Equatable, Swift.Hashable, Swift.RawRepresentable, Swift.String {
+  @available(macOS 14, *)
+  public typealias RawValue = Swift.String
+  @available(macOS 15, *)
+  public func laterAvailableFunction() -> Swift.Void
+  case case1
+  public init?(rawValue: Swift.String)
+  public var rawValue: Swift.String { get }
+}
+```
+```javascript
 @resultBuilder
 public struct SomeResultBuilder {
   public static func buildBlock(_ components: Swift.String) -> Swift.String
diff --git a/Tests/UnitTests/SwiftPackageFileAnalyzerTests.swift b/Tests/UnitTests/SwiftPackageFileAnalyzerTests.swift
@@ -7,6 +7,7 @@
 @testable import PADCore
 @testable import PADPackageFileAnalyzer
 @testable import PADProjectBuilder
+import ShellModule
 
 @testable import SwiftPackageFileHelperModule
 
@@ -261,6 +262,7 @@ class SwiftPackageFileAnalyzerTests: XCTestCase {
         }
         let projectAnalyzer = SwiftPackageFileAnalyzer(
             fileHandler: fileHandler,
+            shell: Shell(logger: nil),
             logger: nil
         )
 

Original file line number	Diff line number	Diff line change
`@@ -224,3 +224,11 @@ public extension CustomEnum where T == String {`
`224`	`224`	`return nil`
`225`	`225`	`}`
`226`	`226`	`}`
	`227`	`+`
	`228`	`+@available(macOS 14, *)`
	`229`	`+public enum NewEnumAvailableInVersion17: String, Codable, Equatable {`
	`230`	`+ case case1 = "Case 1"`
	`231`	`+`
	`232`	`+ @available(macOS 15, *)`
	`233`	`+ public func laterAvailableFunction(){}`
	`234`	`+}`