Support creating Info.plist for inner framework apple_static_xcframework (#2791)

Will generate an `Info.plist` for inner `.framework` directories inside
a static XCFramework when `infoplists` and `bundle_id` is provided (kept
optional for backward compatibility).

Closes #2456

Author: louwers

apple/internal/xcframework_rules.bzl

@@ -1163,10 +1163,21 @@ def _apple_static_xcframework_impl(ctx):
             split_attr = ctx.split_attr,
             split_attr_keys = link_output.split_attr_keys,
         )
+
+        # Collect top_level_infoplists only if bundle_id is set
+        top_level_infoplists = []
+        if ctx.attr.bundle_id:
+            top_level_infoplists = resources.collect(
+                attr = ctx.split_attr,
+                res_attrs = ["infoplists"],
+                split_attr_keys = link_output.split_attr_keys,
+            )
+
         partial_output = partial.call(partials.resources_partial(
             actions = actions,
             apple_mac_toolchain_info = apple_mac_toolchain_info,
             bundle_extension = ".framework",
+            bundle_id = ctx.attr.bundle_id,
             bundle_name = bundle_name,
             # TODO(b/174858377): Select which environment_plist to use based on Apple platform.
             environment_plist = ctx.file._environment_plist_ios,
@@ -1178,7 +1189,8 @@ def _apple_static_xcframework_impl(ctx):
             rule_descriptor = rule_descriptor,
             rule_label = label,
             targets_to_avoid = targets_to_avoid,
-            version = None,
+            top_level_infoplists = top_level_infoplists,
+            version = ctx.attr.version,
         ))
 
         if getattr(partial_output, "bundle_files", None):
@@ -1256,6 +1268,14 @@ apple_static_xcframework = rule_factory.create_apple_rule(
             deps_cfg = transition_support.xcframework_transition,
         ),
         {
+            "bundle_id": attr.string(
+                mandatory = False,
+                doc = """
+Optional bundle ID (reverse-DNS path followed by framework name) for each of the embedded frameworks.
+If present, this value will be embedded in an Info.plist within each framework bundle, similar to
+apple_xcframework (dynamic frameworks).
+""",
+            ),
             "executable_name": attr.string(
                 mandatory = False,
                 doc = """
@@ -1302,6 +1322,16 @@ values are `iphone` and `ipad` for `ios`; at least one must be specified if a pl
 Currently, this only affects processing of `ios` resources.
 """,
             ),
+            "infoplists": attr.label_list(
+                allow_empty = True,
+                allow_files = [".plist"],
+                cfg = transition_support.xcframework_transition,
+                doc = """
+A list of .plist files that will be merged to form the Info.plist for each of the embedded
+frameworks. Only used if bundle_id is provided.
+""",
+                mandatory = False,
+            ),
             "ios": attr.string_list_dict(
                 doc = """
 A dictionary of strings indicating which platform variants should be built for the `ios` platform (
@@ -1347,6 +1377,13 @@ An optional single .h file to use as the umbrella header for this framework. Usu
 will have the same name as this target, so that clients can load the header using the #import
 <MyFramework/MyFramework.h> format. If this attribute is not specified (the common use case), an
 umbrella header will be generated under the same name as this target.
+""",
+            ),
+            "version": attr.label(
+                providers = [[AppleBundleVersionInfo]],
+                doc = """
+An `apple_bundle_version` target that represents the version for this target. See
+[`apple_bundle_version`](https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-versioning.md#apple_bundle_version).
 """,
             ),
         },

doc/rules-apple.md

@@ -183,9 +183,9 @@ implementation of `apple_static_library` in Bazel core so that it can be removed
 <pre>
 load("@rules_apple//apple:apple.bzl", "apple_static_xcframework")
 
-apple_static_xcframework(<a href="#apple_static_xcframework-name">name</a>, <a href="#apple_static_xcframework-deps">deps</a>, <a href="#apple_static_xcframework-avoid_deps">avoid_deps</a>, <a href="#apple_static_xcframework-bundle_name">bundle_name</a>, <a href="#apple_static_xcframework-executable_name">executable_name</a>, <a href="#apple_static_xcframework-families_required">families_required</a>,
-                         <a href="#apple_static_xcframework-ios">ios</a>, <a href="#apple_static_xcframework-macos">macos</a>, <a href="#apple_static_xcframework-minimum_deployment_os_versions">minimum_deployment_os_versions</a>, <a href="#apple_static_xcframework-minimum_os_versions">minimum_os_versions</a>, <a href="#apple_static_xcframework-public_hdrs">public_hdrs</a>,
-                         <a href="#apple_static_xcframework-umbrella_header">umbrella_header</a>)
+apple_static_xcframework(<a href="#apple_static_xcframework-name">name</a>, <a href="#apple_static_xcframework-deps">deps</a>, <a href="#apple_static_xcframework-avoid_deps">avoid_deps</a>, <a href="#apple_static_xcframework-bundle_id">bundle_id</a>, <a href="#apple_static_xcframework-bundle_name">bundle_name</a>, <a href="#apple_static_xcframework-executable_name">executable_name</a>,
+                         <a href="#apple_static_xcframework-families_required">families_required</a>, <a href="#apple_static_xcframework-infoplists">infoplists</a>, <a href="#apple_static_xcframework-ios">ios</a>, <a href="#apple_static_xcframework-macos">macos</a>, <a href="#apple_static_xcframework-minimum_deployment_os_versions">minimum_deployment_os_versions</a>,
+                         <a href="#apple_static_xcframework-minimum_os_versions">minimum_os_versions</a>, <a href="#apple_static_xcframework-public_hdrs">public_hdrs</a>, <a href="#apple_static_xcframework-umbrella_header">umbrella_header</a>, <a href="#apple_static_xcframework-version">version</a>)
 </pre>
 
 Generates an XCFramework with static libraries for third-party distribution.
@@ -198,15 +198,18 @@ Generates an XCFramework with static libraries for third-party distribution.
 | <a id="apple_static_xcframework-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
 | <a id="apple_static_xcframework-deps"></a>deps |  A list of files directly referencing libraries to be represented for each given platform split in the XCFramework. These libraries will be embedded within each platform split.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | required |  |
 | <a id="apple_static_xcframework-avoid_deps"></a>avoid_deps |  A list of library targets on which this framework depends in order to compile, but the transitive closure of which will not be linked into the framework's binary, nor bundled into final XCFramework.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional |  `[]`  |
+| <a id="apple_static_xcframework-bundle_id"></a>bundle_id |  Optional bundle ID (reverse-DNS path followed by framework name) for each of the embedded frameworks. If present, this value will be embedded in an Info.plist within each framework bundle, similar to apple_xcframework (dynamic frameworks).   | String | optional |  `""`  |
 | <a id="apple_static_xcframework-bundle_name"></a>bundle_name |  The desired name of the XCFramework bundle (without the extension) and the binaries for all embedded static libraries. If this attribute is not set, then the name of the target will be used instead.   | String | optional |  `""`  |
 | <a id="apple_static_xcframework-executable_name"></a>executable_name |  The desired name of the executable, if the bundle has an executable. If this attribute is not set, then the name of the `bundle_name` attribute will be used if it is set; if not, then the name of the target will be used instead.   | String | optional |  `""`  |
 | <a id="apple_static_xcframework-families_required"></a>families_required |  A list of device families supported by this extension, with platforms such as `ios` as keys. Valid values are `iphone` and `ipad` for `ios`; at least one must be specified if a platform is defined. Currently, this only affects processing of `ios` resources.   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | optional |  `{}`  |
+| <a id="apple_static_xcframework-infoplists"></a>infoplists |  A list of .plist files that will be merged to form the Info.plist for each of the embedded frameworks. Only used if bundle_id is provided.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional |  `[]`  |
 | <a id="apple_static_xcframework-ios"></a>ios |  A dictionary of strings indicating which platform variants should be built for the `ios` platform ( `device` or `simulator`) as keys, and arrays of strings listing which architectures should be built for those platform variants (for example, `x86_64`, `arm64`) as their values.   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | optional |  `{}`  |
 | <a id="apple_static_xcframework-macos"></a>macos |  A list of strings indicating which architecture should be built for the macOS platform (for example, `x86_64`, `arm64`).   | List of strings | optional |  `[]`  |
 | <a id="apple_static_xcframework-minimum_deployment_os_versions"></a>minimum_deployment_os_versions |  A dictionary of strings indicating the minimum deployment OS version supported by the target, represented as a dotted version number (for example, "9.0") as values, with their respective platforms such as `ios` as keys. This is different from `minimum_os_versions`, which is effective at compile time. Ensure version specific APIs are guarded with `available` clauses.   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional |  `{}`  |
 | <a id="apple_static_xcframework-minimum_os_versions"></a>minimum_os_versions |  A dictionary of strings indicating the minimum OS version supported by the target, represented as a dotted version number (for example, "8.0") as values, with their respective platforms such as `ios` as keys.   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | required |  |
 | <a id="apple_static_xcframework-public_hdrs"></a>public_hdrs |  A list of files directly referencing header files to be used as the publicly visible interface for each of these embedded libraries. These header files will be embedded within each platform split, typically in a subdirectory such as `Headers`.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional |  `[]`  |
 | <a id="apple_static_xcframework-umbrella_header"></a>umbrella_header |  An optional single .h file to use as the umbrella header for this framework. Usually, this header will have the same name as this target, so that clients can load the header using the #import <MyFramework/MyFramework.h> format. If this attribute is not specified (the common use case), an umbrella header will be generated under the same name as this target.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
+| <a id="apple_static_xcframework-version"></a>version |  An `apple_bundle_version` target that represents the version for this target. See [`apple_bundle_version`](https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-versioning.md#apple_bundle_version).   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
 
 
 <a id="apple_static_xcframework_import"></a>

test/starlark_tests/apple_static_xcframework_tests.bzl

@@ -291,6 +291,21 @@ def apple_static_xcframework_test_suite(name):
         tags = [name],
     )
 
+    archive_contents_test(
+        name = "{}_ios_inner_framework_infoplist_test".format(name),
+        build_type = "device",
+        target_under_test = "//test/starlark_tests/targets_under_test/apple:ios_static_xcframework_with_bundle_id",
+        plist_test_file = "$BUNDLE_ROOT/ios-arm64/ios_static_xcframework_with_bundle_id.framework/Info.plist",
+        plist_test_values = {
+            "CFBundleIdentifier": "com.example.static.framework",
+            "CFBundleExecutable": "ios_static_xcframework_with_bundle_id",
+            "CFBundleShortVersionString": "2.1",
+            "CFBundleVersion": "2.1.0",
+            "MinimumOSVersion": common.min_os_ios.baseline,
+        },
+        tags = [name],
+    )
+
     directory_test(
         name = "{}_ios_static_library_xcframework_tree_artifact_test".format(name),
         build_settings = {

test/starlark_tests/targets_under_test/apple/BUILD

@@ -1654,3 +1654,27 @@ apple_static_xcframework(
     tags = common.fixture_tags,
     deps = [":fmwk_lib"],
 )
+
+apple_bundle_version(
+    name = "static_xcframework_version",
+    build_version = "2.1.0",
+    short_version_string = "2.1",
+    tags = common.fixture_tags,
+)
+
+apple_static_xcframework(
+    name = "ios_static_xcframework_with_bundle_id",
+    bundle_id = "com.example.static.framework",
+    infoplists = ["//test/starlark_tests/resources:Info.plist"],
+    ios = {
+        "simulator": ["x86_64"],
+        "device": ["arm64"],
+    },
+    minimum_os_versions = {
+        "ios": common.min_os_ios.baseline,
+    },
+    public_hdrs = ["//test/starlark_tests/resources:shared.h"],
+    tags = common.fixture_tags,
+    version = ":static_xcframework_version",
+    deps = [":fmwk_lib"],
+)