Add build warning when usage description key has empty string for value. rdar://129306042

Author: baujla

Sources/SWBTaskExecution/TaskActions/InfoPlistProcessorTaskAction.swift

@@ -632,6 +632,55 @@ public final class InfoPlistProcessorTaskAction: TaskAction
         return (.succeeded, messages)
     }
 
+    private let usageDescriptionStringKeys: Set<String> = [
+        "NFCReaderUsageDescription",
+        "NSAppleEventsUsageDescription",
+        "NSAppleMusicUsageDescription",
+        "NSBluetoothAlwaysUsageDescription",
+        "NSBluetoothPeripheralUsageDescription",
+        "NSBluetoothWhileInUseUsageDescription",
+        "NSCalendarsUsageDescription",
+        "NSCameraUsageDescription",
+        "NSContactsUsageDescription",
+        "NSDesktopFolderUsageDescription",
+        "NSDocumentsFolderUsageDescription",
+        "NSDownloadsFolderUsageDescription",
+        "NSFaceIDUsageDescription",
+        "NSFallDetectionUsageDescription",
+        "NSFileProviderDomainUsageDescription",
+        "NSFileProviderPresenceUsageDescription",
+        "NSFocusStatusUsageDescription",
+        "NSGKFriendListUsageDescription",
+        "NSHealthClinicalHealthRecordsShareUsageDescription",
+        "NSHealthShareUsageDescription",
+        "NSHealthUpdateUsageDescription",
+        "NSHomeKitUsageDescription",
+        "NSIdentityUsageDescription",
+        "NSLocalNetworkUsageDescription",
+        "NSLocationAlwaysAndWhenInUseUsageDescription",
+        "NSLocationAlwaysUsageDescription",
+        "NSLocationUsageDescription",
+        "NSLocationWhenInUseUsageDescription",
+        "NSMicrophoneUsageDescription",
+        "NSMotionUsageDescription",
+        "NSNearbyInteractionAllowOnceUsageDescription",
+        "NSNearbyInteractionUsageDescription",
+        "NSNetworkVolumesUsageDescription",
+        "NSPhotoLibraryAddUsageDescription",
+        "NSPhotoLibraryUsageDescription",
+        "NSRemindersUsageDescription",
+        "NSRemovableVolumesUsageDescription",
+        "NSSensorKitUsageDescription",
+        "NSSiriUsageDescription",
+        "NSSpeechRecognitionUsageDescription",
+        "NSSystemAdministrationUsageDescription",
+        "NSSystemExtensionUsageDescription",
+        "NSUserTrackingUsageDescription",
+        "NSVideoSubscriberAccountUsageDescription",
+        "NSVoIPUsageDescription",
+        "OSBundleUsageDescription",
+    ]
+
     /// Produce a collection of default Info.plist keys based on content in the project, taking platform and product type into account.
     /// Could be done through InfoPlistAdditions properties in product types, but that would result in more duplication at this point
     private func defaultInfoPlistContent(scope: MacroEvaluationScope, platform: Platform?, productType: ProductTypeSpec?) -> [String: PropertyListItem]
@@ -687,59 +736,9 @@ public final class InfoPlistProcessorTaskAction: TaskAction
             "LSApplicationCategoryType",
             "NSHumanReadableCopyright",
             "NSPrincipalClass",
-
-            // Usage Descriptions
-
             "ITSAppUsesNonExemptEncryption",
             "ITSEncryptionExportComplianceCode",
-            "NFCReaderUsageDescription",
-            "NSAppleEventsUsageDescription",
-            "NSAppleMusicUsageDescription",
-            "NSBluetoothAlwaysUsageDescription",
-            "NSBluetoothPeripheralUsageDescription",
-            "NSBluetoothWhileInUseUsageDescription",
-            "NSCalendarsUsageDescription",
-            "NSCameraUsageDescription",
-            "NSContactsUsageDescription",
-            "NSDesktopFolderUsageDescription",
-            "NSDocumentsFolderUsageDescription",
-            "NSDownloadsFolderUsageDescription",
-            "NSFaceIDUsageDescription",
-            "NSFallDetectionUsageDescription",
-            "NSFileProviderDomainUsageDescription",
-            "NSFileProviderPresenceUsageDescription",
-            "NSFocusStatusUsageDescription",
-            "NSGKFriendListUsageDescription",
-            "NSHealthClinicalHealthRecordsShareUsageDescription",
-            "NSHealthShareUsageDescription",
-            "NSHealthUpdateUsageDescription",
-            "NSHomeKitUsageDescription",
-            "NSIdentityUsageDescription",
-            "NSLocalNetworkUsageDescription",
-            "NSLocationAlwaysAndWhenInUseUsageDescription",
-            "NSLocationAlwaysUsageDescription",
             "NSLocationTemporaryUsageDescriptionDictionary",
-            "NSLocationUsageDescription",
-            "NSLocationWhenInUseUsageDescription",
-            "NSMicrophoneUsageDescription",
-            "NSMotionUsageDescription",
-            "NSNearbyInteractionAllowOnceUsageDescription",
-            "NSNearbyInteractionUsageDescription",
-            "NSNetworkVolumesUsageDescription",
-            "NSPhotoLibraryAddUsageDescription",
-            "NSPhotoLibraryUsageDescription",
-            "NSRemindersUsageDescription",
-            "NSRemovableVolumesUsageDescription",
-            "NSSensorKitPrivacyPolicyURL",
-            "NSSensorKitUsageDescription",
-            "NSSiriUsageDescription",
-            "NSSpeechRecognitionUsageDescription",
-            "NSSystemAdministrationUsageDescription",
-            "NSSystemExtensionUsageDescription",
-            "NSUserTrackingUsageDescription",
-            "NSVideoSubscriberAccountUsageDescription",
-            "NSVoIPUsageDescription",
-            "OSBundleUsageDescription",
 
             // macOS
 
@@ -759,6 +758,7 @@ public final class InfoPlistProcessorTaskAction: TaskAction
             // iOS
 
             "LSSupportsOpeningDocumentsInPlace",
+            "NSSensorKitPrivacyPolicyURL",
             "NSSupportsLiveActivities",
             "NSSupportsLiveActivitiesFrequentUpdates",
             "UIApplicationSupportsIndirectInputEvents",
@@ -791,7 +791,7 @@ public final class InfoPlistProcessorTaskAction: TaskAction
             // Sticker Packs
 
             "NSStickerSharingLevel",
-        ]
+        ] + usageDescriptionStringKeys
 
         for key in generatedInfoPlistKeys {
             updateContentWithInfoPlistKeyMacroValue(&content, key)
@@ -1511,9 +1511,27 @@ public final class InfoPlistProcessorTaskAction: TaskAction
             }
         }
 
+        validateUsageStringDefinitions(plistDict, outputDelegate: outputDelegate)
         return true
     }
 
+    private func validateUsageStringDefinitions(_ plistDict: [String: PropertyListItem], outputDelegate: any TaskOutputDelegate) {
+        let usageStringPlistEntries = plistDict.filter { key, _ in
+            usageDescriptionStringKeys.contains(key)
+        }
+
+        for (key, value) in usageStringPlistEntries {
+            switch value {
+            case .plString(let stringValue):
+                if stringValue.isEmpty {
+                    outputDelegate.emitWarning("The value for \(key) must be a non-empty string.")
+                }
+            default:
+                outputDelegate.emitWarning("The value for \(key) must be of type string, but is \(value.typeDisplayString.withIndefiniteArticle).")
+            }
+        }
+    }
+
     /// Scans the path for an `PrivacyInfo.xcprivacy` file and returns the `Path` to that file, if found. Otherwise, returns `nil`.
     private func scanForPrivacyFile(at path: Path, fs: any FSProxy) -> Path? {
         do {

Tests/SWBTaskExecutionTests/InfoPlistProcessorTaskTests.swift

@@ -2371,4 +2371,49 @@ fileprivate struct InfoPlistProcessorTaskTests: CoreBasedTests {
             XCTAssertEqualPropertyListItems(dict["CFBundleIcons~ipad"], expectedMerge)
         }
     }
+
+    @Test
+    func usageDescriptionKeyWarning() async throws {
+        let core = try await getCore()
+        let scope = try createMockScope { namespace, table in
+            try namespace.declareBooleanMacro("GENERATE_INFOPLIST_FILE")
+            table.push(try #require(namespace.lookupMacroDeclaration("GENERATE_INFOPLIST_FILE") as? BooleanMacroDeclaration), literal: true)
+            try table.remove(namespace.declareStringMacro("MARKETING_VERSION"))
+        }
+        let platformName = "iphoneos"
+        let platform = try #require(core.platformRegistry.lookup(name: platformName), "invalid platform name '\(platformName)'")
+        let executionDelegate = MockExecutionDelegate(core: try await getCore())
+
+        let action = InfoPlistProcessorTaskAction(try prepareContext(InfoPlistProcessorTaskActionContext(scope: scope, productType: nil, platform: platform, sdk: core.sdkRegistry.lookup(platformName), sdkVariant: nil, cleanupRequiredArchitectures: []), fs: executionDelegate.fs))
+        let task = Task(forTarget: nil, ruleInfo: [], commandLine: ["builtin-infoPlistUtility", "-expandbuildsettings", "-platform", platformName, "/tmp/input.plist", "-o", "/tmp/output.plist"], workingDirectory: Path.root.join("tmp"), outputs: [], action: action, execDescription: "Copy Info.plist")
+
+        // Write the test files.
+        try executionDelegate.fs.createDirectory(Path.root.join("tmp"))
+        try await executionDelegate.fs.writePlist(Path("/tmp/input.plist"), .plDict([
+            "CFBundleIconName": .plString(""),
+            "NSHomeKitUsageDescription": .plString(""),
+            "NSSiriUsageDescription": .plBool(true),
+            "NSFaceIDUsageDescription": .plString("Used for authentication."),
+        ]))
+
+        let outputDelegate = MockTaskOutputDelegate()
+        let result = await action.performTaskAction(
+            task,
+            dynamicExecutionDelegate: MockDynamicTaskExecutionDelegate(),
+            executionDelegate: executionDelegate,
+            clientDelegate: MockTaskExecutionClientDelegate(),
+            outputDelegate: outputDelegate
+        )
+
+        guard result == .succeeded else {
+            Issue.record("task failed; errors: \(outputDelegate.errors)")
+            return
+        }
+
+        let warnings = outputDelegate.warnings
+
+        #expect(warnings.count == 2)
+        #expect(warnings.contains("warning: The value for NSHomeKitUsageDescription must be a non-empty string."))
+        #expect(warnings.contains("warning: The value for NSSiriUsageDescription must be of type string, but is a boolean."))
+    }
 }