Merge pull request #102 from Adyen/notify-on-empty-targets

Highlighting if empty targets are provided

Author: goergisn

.github/workflows/run-tests.yml

@@ -21,8 +21,8 @@ jobs:
     - name: Select latest Xcode
       uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '15.4'
+        xcode-version: '16.1'
 
     - name: 🛠️ Run All Tests
       run: |
-        xcodebuild test -scheme public-api-diff -destination "platform=iOS,name=Any iOS Device" -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}
+        xcodebuild test -scheme public-api-diff-Package -destination "platform=macOS" -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}

Sources/PublicModules/PADOutputGenerator/MarkdownOutputGenerator.swift

@@ -25,7 +25,7 @@ public struct MarkdownOutputGenerator: OutputGenerating {
         let changes = Self.changeLines(changesPerModule: changesPerTarget)
 
         var lines = [
-            Self.title(changesPerTarget: changesPerTarget)
+            Self.title(changesPerTarget: changesPerTarget, allTargets: allTargets)
         ]
 
         if let oldVersionName, let newVersionName {
@@ -46,7 +46,7 @@ public struct MarkdownOutputGenerator: OutputGenerating {
             lines += changes + [separator]
         }
 
-        if let allTargets {
+        if let allTargets, !allTargets.isEmpty {
             lines += [
                 Self.analyzedModulesInfo(allTargets: allTargets)
             ]
@@ -60,7 +60,15 @@ public struct MarkdownOutputGenerator: OutputGenerating {
 
 private extension MarkdownOutputGenerator {
 
-    static func title(changesPerTarget: [String: [Change]]) -> String {
+    static func title(
+        changesPerTarget: [String: [Change]],
+        allTargets: [String]?
+    ) -> String {
+        
+        if let allTargets, allTargets.isEmpty {
+            // We got targets but the list is empty -> Show an error
+            return "# ‼️ No analyzable targets detected"
+        }
 
         if changesPerTarget.keys.isEmpty {
             return "# ✅ No changes detected"

Sources/PublicModules/PADOutputGenerator/OutputGenerating.swift

@@ -15,7 +15,7 @@ public protocol OutputGenerating<OutputType> {
     /// Generates an output from input parameters
     /// - Parameters:
     ///   - changesPerTarget: A list of changes per target/module
-    ///   - allTargets: A list of all targets/modules that were analysed in previous steps
+    ///   - allTargets: A list of all targets/modules that were analysed in previous steps - if targets are provided but the list is empty it is treated like a failure
     ///   - oldVersionName: The name of the old/reference version
     ///   - newVersionName: The name of the new/updated version
     ///   - warnings: A list of warnings produced in previous steps

Tests/UnitTests/OutputGeneratorTests.swift

@@ -27,6 +27,7 @@ class OutputGeneratorTests: XCTestCase {
             newVersionName: "new_source",
             warnings: []
         )
+        
         XCTAssertEqual(output, expectedOutput)
     }
 
@@ -57,10 +58,11 @@ class OutputGeneratorTests: XCTestCase {
             newVersionName: "new_source",
             warnings: []
         )
+        
         XCTAssertEqual(output, expectedOutput)
     }
 
-    func test_multipleChanges_multipleModules() {
+    func multipleChanges_multipleModules() {
 
         let expectedOutput = """
         # ⚠️ 4 public changes detected ⚠️
@@ -109,6 +111,60 @@ class OutputGeneratorTests: XCTestCase {
             newVersionName: "new_source",
             warnings: []
         )
+        
+        XCTAssertEqual(output, expectedOutput)
+    }
+    
+    struct AllTargetsExpectation {
+        let allTargets: [String]?
+        let expectedTitle: String
+        let expectedTargetSection: String
+    }
+
+    func test_allTargets_shouldChangeOutputAsExpected() {
+        
+        let testExpectations: [AllTargetsExpectation] = [
+            .init(
+                allTargets: [],
+                expectedTitle: "‼️ No analyzable targets detected",
+                expectedTargetSection: ""
+            ),
+            .init(
+                allTargets: nil,
+                expectedTitle: "✅ No changes detected",
+                expectedTargetSection: ""
+            ),
+            .init(
+                allTargets: ["SomeTarget"],
+                expectedTitle: "✅ No changes detected",
+                expectedTargetSection: "\n**Analyzed targets:** SomeTarget"
+            )
+        ]
+        
+        testExpectations.forEach { argument in
+            allTargets_shouldChangeOutputAsExpected(argument: argument)
+        }
+    }
+    
+    private func allTargets_shouldChangeOutputAsExpected(argument: AllTargetsExpectation) {
+        
+        let expectedOutput = """
+        # \(argument.expectedTitle)
+        _Comparing `new_source` to `old_repository @ old_branch`_
+
+        ---\(argument.expectedTargetSection)
+        """
+        
+        let outputGenerator = MarkdownOutputGenerator()
+        
+        let output = outputGenerator.generate(
+            from: [:],
+            allTargets: argument.allTargets,
+            oldVersionName: "old_repository @ old_branch",
+            newVersionName: "new_source",
+            warnings: []
+        )
+        
         XCTAssertEqual(output, expectedOutput)
     }
 }

Tests/public-api-diff.xctestplan

@@ -45,13 +45,15 @@
   },
   "testTargets" : [
     {
+      "parallelizable" : true,
       "target" : {
         "containerPath" : "container:",
         "identifier" : "IntegrationTests",
         "name" : "IntegrationTests"
       }
     },
     {
+      "parallelizable" : true,
       "target" : {
         "containerPath" : "container:",
         "identifier" : "UnitTests",