Update outputs.dsyms(...) to be able to handle the new dsymutil bundle outputs.

Add tests for macos_application and macos_command_line_application.
Use build_setting_labels flags to reference dsym_variant_flag in test rules when possible.

Cherry-pick: b27541a

Author: nglevin

apple/internal/ios_rules.bzl

@@ -517,7 +517,10 @@ def _ios_application_impl(ctx):
         rule_descriptor = rule_descriptor,
     )
 
-    dsyms = outputs.dsyms(processor_result = processor_result)
+    dsyms = outputs.dsyms(
+        platform_prerequisites = platform_prerequisites,
+        processor_result = processor_result,
+    )
 
     return [
         # TODO(b/121155041): Should we do the same for ios_framework and ios_extension?

apple/internal/macos_rules.bzl

@@ -436,7 +436,10 @@ def _macos_application_impl(ctx):
         predeclared_outputs = predeclared_outputs,
         rule_descriptor = rule_descriptor,
     )
-    dsyms = outputs.dsyms(processor_result = processor_result)
+    dsyms = outputs.dsyms(
+        platform_prerequisites = platform_prerequisites,
+        processor_result = processor_result,
+    )
 
     run_support.register_macos_executable(
         actions = actions,
@@ -2092,7 +2095,10 @@ def _macos_command_line_application_impl(ctx):
     if clang_rt_dylibs.should_package_clang_runtime(features = features):
         runfiles = clang_rt_dylibs.get_from_toolchain(ctx)
 
-    dsyms = outputs.dsyms(processor_result = processor_result)
+    dsyms = outputs.dsyms(
+        platform_prerequisites = platform_prerequisites,
+        processor_result = processor_result,
+    )
 
     return [
         new_applebinaryinfo(

apple/internal/outputs.bzl

@@ -109,13 +109,26 @@ def _executable(*, actions, label_name):
     """Returns a file reference for the executable that would be invoked with `bazel run`."""
     return actions.declare_file(label_name)
 
-def _dsyms(*, processor_result):
+def _dsyms(*, platform_prerequisites, processor_result):
     """Returns a depset of all of the dsyms from the result."""
-    dsyms = []
-    for provider in processor_result.providers:
-        if getattr(provider, "dsyms", None):
-            dsyms.append(provider.dsyms)
-    return depset(transitive = dsyms)
+    direct_dsyms = []
+    transitive_dsyms = []
+    dsym_variant_flag = platform_prerequisites.build_settings.dsym_variant_flag
+    if dsym_variant_flag == "bundle":
+        for provider in processor_result.providers:
+            # Sourcing fields from the public AppleDsymBundleInfo provider.
+            if getattr(provider, "direct_dsyms", None):
+                direct_dsyms.extend(provider.direct_dsyms)
+            if getattr(provider, "transitive_dsyms", None):
+                transitive_dsyms.append(provider.transitive_dsyms)
+    elif dsym_variant_flag == "flat":
+        for provider in processor_result.providers:
+            # Sourcing fields from the AppleDebugInfo provider, only visible to the rules.
+            if getattr(provider, "dsyms", None):
+                transitive_dsyms.append(provider.dsyms)
+    else:
+        fail("Internal Error: Unsupported dsym_variant_flag: {}".format(dsym_variant_flag))
+    return depset(direct_dsyms, transitive = transitive_dsyms)
 
 def _infoplist(*, actions, label_name, output_discriminator):
     """Returns a file reference for this target's Info.plist file."""

apple/internal/testing/apple_test_bundle_support.bzl

@@ -572,7 +572,10 @@ def _apple_test_bundle_impl(*, ctx, product_type):
         rule_descriptor = rule_descriptor,
     )
 
-    dsyms = outputs.dsyms(processor_result = processor_result)
+    dsyms = outputs.dsyms(
+        platform_prerequisites = platform_prerequisites,
+        processor_result = processor_result,
+    )
 
     # The processor outputs has all the extra outputs like dSYM files that we want to propagate, but
     # it also includes the archive artifact. This collects all the files that should be output from

apple/internal/visionos_rules.bzl

@@ -453,7 +453,10 @@ Resolved Xcode is version {xcode_version}.
         rule_descriptor = rule_descriptor,
     )
 
-    dsyms = outputs.dsyms(processor_result = processor_result)
+    dsyms = outputs.dsyms(
+        platform_prerequisites = platform_prerequisites,
+        processor_result = processor_result,
+    )
 
     return [
         DefaultInfo(

apple/internal/xcframework_rules.bzl

@@ -842,16 +842,20 @@ def _apple_xcframework_impl(ctx):
                 # Save a reference to those archives as file-friendly inputs to the bundler action.
                 framework_archive_files.append(depset([provider.archive]))
 
-            # Save the dSYMs.
-            if getattr(provider, "dsyms", None):
-                framework_output_files.append(depset(transitive = [provider.dsyms]))
-                framework_output_groups.append({"dsyms": provider.dsyms})
-
             # Save the linkmaps.
             if getattr(provider, "linkmaps", None):
                 framework_output_files.append(depset(transitive = [provider.linkmaps]))
                 framework_output_groups.append({"linkmaps": provider.linkmaps})
 
+            dsyms = outputs.dsyms(
+                platform_prerequisites = platform_prerequisites,
+                processor_result = processor_result,
+            )
+            if dsyms:
+                # Save the dSYMs.
+                framework_output_files.append(depset(transitive = [dsyms]))
+                framework_output_groups.append({"dsyms": dsyms})
+
         # Save additional library details for the XCFramework's root info plist.
         available_libraries.append(_available_library_dictionary(
             architectures = link_output.architectures,

test/starlark_tests/macos_application_tests.bzl

@@ -20,18 +20,21 @@ load(
 )
 load(
     "//test/starlark_tests/rules:analysis_output_group_info_files_test.bzl",
+    "analysis_output_group_info_dsymutil_bundle_files_test",
     "analysis_output_group_info_files_test",
 )
 load(
     "//test/starlark_tests/rules:analysis_runfiles_test.bzl",
     "analysis_runfiles_dsym_test",
+    "analysis_runfiles_dsymutil_bundle_test",
 )
 load(
     "//test/starlark_tests/rules:analysis_target_actions_test.bzl",
     "analysis_target_actions_test",
 )
 load(
     "//test/starlark_tests/rules:apple_dsym_bundle_info_test.bzl",
+    "apple_dsym_bundle_info_dsymutil_bundle_test",
     "apple_dsym_bundle_info_test",
 )
 load(
@@ -275,6 +278,15 @@ def macos_application_test_suite(name):
         ],
         tags = [name],
     )
+    analysis_output_group_info_dsymutil_bundle_files_test(
+        name = "{}_dsyms_output_group_dsymutil_bundle_files_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:app",
+        output_group_name = "dsyms",
+        expected_outputs = [
+            "app.app.dSYM",
+        ],
+        tags = [name],
+    )
     apple_dsym_bundle_info_test(
         name = "{}_dsym_bundle_info_files_test".format(name),
         target_under_test = "//test/starlark_tests/targets_under_test/macos:app",
@@ -286,6 +298,17 @@ def macos_application_test_suite(name):
         ],
         tags = [name],
     )
+    apple_dsym_bundle_info_dsymutil_bundle_test(
+        name = "{}_dsym_bundle_info_dsymutil_bundle_files_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:app",
+        expected_direct_dsyms = [
+            "app.app.dSYM",
+        ],
+        expected_transitive_dsyms = [
+            "app.app.dSYM",
+        ],
+        tags = [name],
+    )
 
     analysis_runfiles_dsym_test(
         name = "{}_runfiles_dsym_test".format(name),
@@ -297,6 +320,15 @@ def macos_application_test_suite(name):
         tags = [name],
     )
 
+    analysis_runfiles_dsymutil_bundle_test(
+        name = "{}_runfiles_dsymutil_bundle_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:app",
+        expected_runfiles = [
+            "third_party/bazel_rules/rules_apple/test/starlark_tests/targets_under_test/macos/darwin_arm64/app.app.dSYM",
+        ],
+        tags = [name],
+    )
+
     infoplist_contents_test(
         name = "{}_plist_test".format(name),
         target_under_test = "//test/starlark_tests/targets_under_test/macos:app",

test/starlark_tests/macos_command_line_application_tests.bzl

@@ -16,14 +16,17 @@
 
 load(
     "//test/starlark_tests/rules:analysis_output_group_info_files_test.bzl",
+    "analysis_output_group_info_dsymutil_bundle_files_test",
     "analysis_output_group_info_files_test",
 )
 load(
     "//test/starlark_tests/rules:analysis_runfiles_test.bzl",
     "analysis_runfiles_dsym_test",
+    "analysis_runfiles_dsymutil_bundle_test",
 )
 load(
     "//test/starlark_tests/rules:apple_dsym_bundle_info_test.bzl",
+    "apple_dsym_bundle_info_dsymutil_bundle_test",
     "apple_dsym_bundle_info_test",
 )
 load(
@@ -162,13 +165,29 @@ def macos_command_line_application_test_suite(name):
         ],
         tags = [name],
     )
+    analysis_output_group_info_dsymutil_bundle_files_test(
+        name = "{}_dsyms_output_group_dsymutil_bundle_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:cmd_app_basic",
+        output_group_name = "dsyms",
+        expected_outputs = [
+            "cmd_app_basic.dSYM",
+        ],
+        tags = [name],
+    )
     apple_dsym_bundle_info_test(
         name = "{}_dsym_bundle_info_files_test".format(name),
         target_under_test = "//test/starlark_tests/targets_under_test/macos:cmd_app_basic",
         expected_direct_dsyms = ["dSYMs/cmd_app_basic.dSYM"],
         expected_transitive_dsyms = ["dSYMs/cmd_app_basic.dSYM"],
         tags = [name],
     )
+    apple_dsym_bundle_info_dsymutil_bundle_test(
+        name = "{}_dsym_bundle_info_dsymutil_bundle_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:cmd_app_basic",
+        expected_direct_dsyms = ["cmd_app_basic.dSYM"],
+        expected_transitive_dsyms = ["cmd_app_basic.dSYM"],
+        tags = [name],
+    )
 
     infoplist_contents_test(
         name = "{}_infoplist_test".format(name),
@@ -203,6 +222,15 @@ def macos_command_line_application_test_suite(name):
         tags = [name],
     )
 
+    analysis_runfiles_dsymutil_bundle_test(
+        name = "{}_runfiles_dsymutil_bundle_test".format(name),
+        target_under_test = "//test/starlark_tests/targets_under_test/macos:cmd_app_basic",
+        expected_runfiles = [
+            "third_party/bazel_rules/rules_apple/test/starlark_tests/targets_under_test/macos/darwin_arm64/cmd_app_basic.dSYM",
+        ],
+        tags = [name],
+    )
+
     binary_contents_test(
         name = "{}_version_plist_test".format(name),
         build_type = "device",

test/starlark_tests/rules/analysis_runfiles_test.bzl

@@ -19,6 +19,10 @@ load(
     "analysistest",
     "unittest",
 )
+load(
+    "//apple/build_settings:build_settings.bzl",
+    "build_settings_labels",
+)
 
 def _analysis_runfiles_test_impl(ctx):
     "Test that runfiles of the given target under test is properly set."
@@ -62,7 +66,15 @@ def make_analysis_runfiles_test_rule(
 # A generic analysis_runfiles_test with no custom settings.
 analysis_runfiles_test = make_analysis_runfiles_test_rule()
 
-# An analysis_runfiles_test that generates dsyms.
+# An analysis_runfiles_test that generates "flat file" dSYMs.
 analysis_runfiles_dsym_test = make_analysis_runfiles_test_rule(config_settings = {
+    build_settings_labels.dsym_variant_flag: "flat",
+    "//command_line_option:apple_generate_dsym": "true",
+    "//command_line_option:macos_cpus": "arm64",
+})
+
+# An analysis_runfiles_test that generates dSYMs bundles using dsymutil.
+analysis_runfiles_dsymutil_bundle_test = make_analysis_runfiles_test_rule(config_settings = {
+    build_settings_labels.dsym_variant_flag: "bundle",
     "//command_line_option:apple_generate_dsym": "true",
 })