Adding detect api changes workflow (#38)

goergisn · web-flow · commit 5bf99cdd209a · 2024-11-14T10:59:49.000+01:00
* adding detect api changes workflow

* Fixing run command

* debug loglevel

* echoing project folder

* better cloning output

* debug logging

* Better clone error logging

* adjusting git tests

* Adding support for macos + package swiftinterface

* Fixing tests

* Fixing unittests

* Adding platform docs to README.md

* Reducing code duplication

---------

Co-authored-by: Alex Guretzki &lt;alexander.guretzki@adyen.com&gt;
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -24,7 +24,7 @@ jobs:
         
     - name: 🛠️ Build with release configuration
       run: |
-        swift build --configuration release -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}
+        swift build --configuration release | xcpretty --utf --color && exit ${PIPESTATUS[0]}
         
     - uses: actions/upload-artifact@v4
       with:
diff --git a/.github/workflows/detect-api.changes.yml b/.github/workflows/detect-api.changes.yml
@@ -0,0 +1,65 @@
+name: 👀 Detect public API changes
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+    inputs:
+      new:
+        description: 'Branch/tag of the new/updated version'
+        required: true
+      old:
+        description: 'Branch/tag of the old/comparison version'
+        required: true
+      
+jobs:
+
+  build:
+    runs-on: macos-14 # Apple Silicon Runner
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: n1hility/cancel-previous-runs@v3
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Select latest Xcode
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: '15.4'
+        
+    - name: 🚚 Fetch repo
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        
+    - name: 🔍 Detect Changes
+      run: |
+        PROJECT_FOLDER=$PWD
+        echo $PROJECT_FOLDER
+        
+        NEW="${{ env.source }}~${{ env.githubRepo }}"
+        if [[ '${{ github.head_ref || env.noTargetBranch }}' == 'release/*' ]]
+        then
+            LATEST_TAG=$(git describe --tags --abbrev=0)
+            OLD="$LATEST_TAG~${{ env.githubRepo }}"
+        else
+            OLD="${{ env.target }}~${{ env.githubRepo }}"
+        fi
+        
+        swift run public-api-diff project --new "$NEW" --old "$OLD" --platform macos --output "$PROJECT_FOLDER/api_comparison.md" --log-level debug --log-output "$PROJECT_FOLDER/logs.txt"
+        cat "$PROJECT_FOLDER/logs.txt"
+        cat "$PROJECT_FOLDER/api_comparison.md" >> $GITHUB_STEP_SUMMARY
+      env:
+        source: '${{ github.event.inputs.new || github.head_ref }}'
+        target: '${{ github.event.inputs.old || github.event.pull_request.base.ref }}'
+        githubRepo: '${{github.server_url}}/${{github.repository}}.git'
+        noTargetBranch: 'no target branch'
+       
+    - if: ${{ github.event.pull_request.base.ref != '' }}
+      name: 📝 Comment on PR
+      uses: thollander/actions-comment-pull-request@v3
+      with:
+        file-path: "${{ github.workspace }}/api_comparison.md"
+        comment-tag: api_changes
+        mode: recreate
diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml
@@ -3,7 +3,7 @@
 # You can adjust the behavior by modifying this file.
 # For more information, see:
 # https://github.com/actions/stale
-name: Manage stale issues
+name: 🏷️ Manage stale issues
 
 on:
   schedule:
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -0,0 +1,36 @@
+disabled_rules:
+  - trailing_whitespace
+  - nesting
+  - todo
+  - for_where
+
+excluded:
+  - Build
+  - .build
+  - Tests
+  - Internal
+  - Docs
+  - Demo
+  - Package.swift
+  - DerivedData
+  - Carthage
+  - TempProject
+  - Scripts
+
+line_length:
+  ignores_function_declarations: true
+  ignores_urls: true
+  warning: 140
+  
+file_length:
+  warning: 500
+  
+function_parameter_count:
+  warning: 10
+  error: 15
+  
+identifier_name:
+  min_length:
+    warning: 2
+  max_length:
+    warning: 40
diff --git a/README.md b/README.md
@@ -21,18 +21,20 @@ This method requires an iOS 17.5 Simulator to be installed
 ```
 swift run public-api-diff
     project
+    --platform iOS
     --new "develop~https://github.com/Adyen/adyen-ios.git"
     --old "5.12.0~https://github.com/Adyen/adyen-ios.git"
 ```
 
 <details><summary><b>--help:</b></summary>
 
 ```
-USAGE: public-api-diff project --new <new> --old <old> [--scheme <scheme>] [--swift-interface-type <swift-interface-type>] [--output <output>] [--log-output <log-output>] [--log-level <log-level>]
+USAGE: public-api-diff project --new <new> --old <old> --platform <platform> [--scheme <scheme>] [--swift-interface-type <swift-interface-type>] [--output <output>] [--log-output <log-output>] [--log-level <log-level>]
 
 OPTIONS:
   --new <new>             Specify the updated version to compare to
   --old <old>             Specify the old version to compare to
+  --platform <platform>   The platform to build the project for (iOS/macOS)
   --scheme <scheme>       [Optional] Which scheme to build (Needed when
                           comparing 2 xcode projects)
   --swift-interface-type <swift-interface-type>
diff --git a/Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift b/Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift
@@ -14,6 +14,7 @@ extension SwiftInterfaceType: ExpressibleByArgument {
         switch argument {
         case "public": self = .public
         case "private": self = .private
+        case "package": self = .package
         default: return nil
         }
     }
diff --git a/Sources/ExecutableTargets/CommandLineTool/ProjectToOutputCommand.swift b/Sources/ExecutableTargets/CommandLineTool/ProjectToOutputCommand.swift
@@ -29,6 +29,9 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
     @Option(help: "Specify the old version to compare to")
     public var old: String
 
+    @Option(help: "The platform to build the project for (iOS/macOS)")
+    public var platform: ProjectPlatform
+
     /// The (optional) scheme to build
     ///
     /// Needed when comparing 2 xcode projects
@@ -74,6 +77,7 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
                 oldSource: oldSource,
                 newSource: newSource,
                 projectType: projectType,
+                platform: platform,
                 swiftInterfaceType: swiftInterfaceType,
                 logger: logger
             )
@@ -136,12 +140,14 @@ private extension ProjectToOutputCommand {
         oldSource: ProjectSource,
         newSource: ProjectSource,
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         logger: any Logging
     ) async throws -> ProjectBuilder.Result {
 
         let projectBuilder = ProjectBuilder(
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             logger: logger
         )
@@ -207,3 +213,22 @@ private extension ProjectToOutputCommand {
         )
     }
 }
+
+extension ProjectPlatform: ExpressibleByArgument {
+
+    static var mapping: [String: ProjectPlatform] = [
+        "iOS": .iOS,
+        "macOS": .macOS
+    ]
+    
+    public init?(argument: String) {
+        for (key, value) in Self.mapping {
+            if argument.compare(key, options: .caseInsensitive) == .orderedSame {
+                self = value
+                return
+            }
+        }
+
+        return nil
+    }
+}
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift b/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift
@@ -33,18 +33,21 @@ public struct ProjectBuilder {
     }
 
     private let projectType: ProjectType
+    private let platform: ProjectPlatform
     private let swiftInterfaceType: SwiftInterfaceType
     private let fileHandler: any FileHandling
     private let shell: any ShellHandling
     private let logger: (any Logging)?
 
     public init(
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         logger: (any Logging)? = nil
     ) {
         self.init(
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             fileHandler: FileManager.default,
             shell: Shell(),
@@ -54,12 +57,14 @@ public struct ProjectBuilder {
 
     init(
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         fileHandler: any FileHandling = FileManager.default,
         shell: any ShellHandling = Shell(),
         logger: (any Logging)?
     ) {
         self.projectType = projectType
+        self.platform = platform
         self.swiftInterfaceType = swiftInterfaceType
         self.fileHandler = fileHandler
         self.shell = shell
@@ -99,6 +104,7 @@ public struct ProjectBuilder {
         let producer = SwiftInterfaceProducer(
             workingDirectoryPath: workingDirectoryPath,
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             fileHandler: fileHandler,
             shell: shell,
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectPlatform.swift b/Sources/PublicModules/PADProjectBuilder/ProjectPlatform.swift
@@ -0,0 +1,12 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+/// The platform to build the project on
+public enum ProjectPlatform {
+
+    case macOS
+    case iOS
+}
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectSetup/Git.swift b/Sources/PublicModules/PADProjectBuilder/ProjectSetup/Git.swift
@@ -18,7 +18,7 @@ internal enum GitError: LocalizedError, Equatable {
     var errorDescription: String? {
         switch self {
         case let .couldNotClone(branchOrTag, repository):
-            "Could not clone \(repository) @ \(branchOrTag) - Please check the provided information"
+            "Could not clone \(repository) @ \(branchOrTag) - Please check the debug logs for more information"
         }
     }
 }
@@ -50,9 +50,12 @@ internal struct Git {
     func clone(_ repository: String, at branchOrTag: String, targetDirectoryPath: String) throws {
         logger?.log("🐱 Cloning \(repository) @ \(branchOrTag) into \(targetDirectoryPath)", from: String(describing: Self.self))
         let command = "git clone -b \(branchOrTag) \(repository) \(targetDirectoryPath)"
-        shell.execute(command)
-
-        guard fileHandler.fileExists(atPath: targetDirectoryPath) else {
+        
+        let shellOutput = shell.execute(command)
+        logger?.debug(shellOutput, from: String(describing: Self.self))
+        
+        let directoryContents = try? fileHandler.contentsOfDirectory(atPath: targetDirectoryPath)
+        guard let directoryContents, !directoryContents.isEmpty else {
             throw GitError.couldNotClone(branchOrTag: branchOrTag, repository: repository)
         }
     }
diff --git a/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/SwiftInterfaceProducer.swift b/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/SwiftInterfaceProducer.swift
@@ -22,6 +22,7 @@ struct SwiftInterfaceProducer {
 
     let workingDirectoryPath: String
     let projectType: ProjectType
+    let platform: ProjectPlatform
     let swiftInterfaceType: SwiftInterfaceType
     let fileHandler: any FileHandling
     let shell: any ShellHandling
@@ -122,12 +123,14 @@ extension SwiftInterfaceProducer {
         let newDerivedDataPath = try await xcodeTools.archive(
             projectDirectoryPath: newProjectDirectoryPath,
             scheme: scheme,
-            projectType: projectType
+            projectType: projectType,
+            platform: platform
         )
         let oldDerivedDataPath = try await xcodeTools.archive(
             projectDirectoryPath: oldProjectDirectoryPath,
             scheme: scheme,
-            projectType: projectType
+            projectType: projectType,
+            platform: platform
         )
 
         return (newDerivedDataPath, oldDerivedDataPath)
diff --git a/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift b/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift
@@ -49,16 +49,28 @@ struct XcodeTools {
     func archive(
         projectDirectoryPath: String,
         scheme: String,
-        projectType: ProjectType
+        projectType: ProjectType,
+        platform: ProjectPlatform
     ) async throws -> String {
+        
         var commandComponents = [
             "cd \(projectDirectoryPath);",
             "xcodebuild clean build -scheme \"\(scheme)\"",
-            "-destination \"generic/platform=iOS\"",
             "-derivedDataPath \(Constants.derivedDataPath)",
-            "-sdk `\(Constants.simulatorSdkCommand)`",
             "BUILD_LIBRARY_FOR_DISTRIBUTION=YES"
         ]
+        
+        switch platform {
+        case .iOS:
+            commandComponents += [
+                "-sdk `\(Constants.simulatorSdkCommand)`",
+                "-destination \"generic/platform=iOS\""
+            ]
+        case .macOS:
+            commandComponents += [
+                "-destination \"generic/platform=macOS\""
+            ]
+        }
 
         switch projectType {
         case .swiftPackage:
diff --git a/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageDescription.swift b/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageDescription.swift
@@ -127,14 +127,19 @@ package extension SwiftPackageDescription.Dependency {
         // TODO: Which other requirements exist?
 
         package let exact: [String]?
+        package let range: [[String: String]]?
     }
 }
 
 extension SwiftPackageDescription.Dependency.Requirement: CustomStringConvertible {
 
     package var description: String {
-        if let exactVersion = exact?.first {
-            return "exact: \"\(exactVersion)\""
+        if let version = exact?.first {
+            return "exact: \"\(version)\""
+        }
+        
+        if let lowerUpper = range?.first, let lower = lowerUpper["lower_bound"], let upper = lowerUpper["upper_bound"] {
+            return "\"\(lower)\"..<\"\(upper)\""
         }
 
         return "UNKNOWN_REQUIREMENT"
@@ -155,6 +160,7 @@ package extension SwiftPackageDescription {
             case library = "library"
             case binary = "binary"
             case test = "test"
+            case executable = "executable"
         }
 
         package let name: String
@@ -208,6 +214,7 @@ extension SwiftPackageDescription.Target.TargetType: CustomStringConvertible {
         case .binary: "binaryTarget"
         case .library: "target"
         case .test: "testTarget"
+        case .executable: "executableTarget"
         }
     }
 }
diff --git a/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageFileHelper.swift b/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageFileHelper.swift
diff --git a/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift b/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift
diff --git a/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceType.swift b/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceType.swift
diff --git a/Tests/IntegrationTests/ReferencePackageTests.swift b/Tests/IntegrationTests/ReferencePackageTests.swift
diff --git a/Tests/UnitTests/GitTests.swift b/Tests/UnitTests/GitTests.swift
diff --git a/Tests/UnitTests/XcodeToolsTests.swift b/Tests/UnitTests/XcodeToolsTests.swift

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ extension SwiftInterfaceType: ExpressibleByArgument {`
`14`	`14`	`switch argument {`
`15`	`15`	`case "public": self = .public`
`16`	`16`	`case "private": self = .private`
	`17`	`+ case "package": self = .package`
`17`	`18`	`default: return nil`
`18`	`19`	`}`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ internal enum GitError: LocalizedError, Equatable {`
`18`	`18`	`var errorDescription: String? {`
`19`	`19`	`switch self {`
`20`	`20`	`case let .couldNotClone(branchOrTag, repository):`
`21`		`- "Could not clone \(repository) @ \(branchOrTag) - Please check the provided information"`
	`21`	`+ "Could not clone \(repository) @ \(branchOrTag) - Please check the debug logs for more information"`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`	`}`
`@@ -50,9 +50,12 @@ internal struct Git {`
`50`	`50`	`func clone(_ repository: String, at branchOrTag: String, targetDirectoryPath: String) throws {`
`51`	`51`	`logger?.log("🐱 Cloning \(repository) @ \(branchOrTag) into \(targetDirectoryPath)", from: String(describing: Self.self))`
`52`	`52`	`let command = "git clone -b \(branchOrTag) \(repository) \(targetDirectoryPath)"`
`53`		`- shell.execute(command)`
`54`		`-`
`55`		`- guard fileHandler.fileExists(atPath: targetDirectoryPath) else {`
	`53`	`+`
	`54`	`+ let shellOutput = shell.execute(command)`
	`55`	`+ logger?.debug(shellOutput, from: String(describing: Self.self))`
	`56`	`+`
	`57`	`+ let directoryContents = try? fileHandler.contentsOfDirectory(atPath: targetDirectoryPath)`
	`58`	`+ guard let directoryContents, !directoryContents.isEmpty else {`
`56`	`59`	`throw GitError.couldNotClone(branchOrTag: branchOrTag, repository: repository)`
`57`	`60`	`}`
`58`	`61`	`}`