Support launchdplists

Add support for both BwB and BwX for the `launchdplists` rules_apple attribute.

Author: luispadron

examples/command_line/tool/BUILD

@@ -12,6 +12,7 @@ macos_command_line_application(
         "export_symbol_list.exp",
     ],
     infoplists = ["Info.plist"],
+    launchdplists = ["Launchd.plist"],
     minimum_os_version = "11.0",
     visibility = ["//visibility:public"],
     deps = [":tool.library"],

examples/command_line/tool/Launchd.plist

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>com.example.tool</string>
+    <key>ProgramArguments</key>
+    <array>
+        <string>arg1</string>
+        <string>arg2</string>
+    </array>
+    <key>KeepAlive</key>
+    <true/>
+</dict>
+</plist>

test/internal/launchd_plists/BUILD

@@ -0,0 +1,9 @@
+load(
+    ":get_file_from_objc_provider_tests.bzl",
+    "get_file_from_objc_provider_test_suite",
+)
+load(":get_file_tests.bzl", "get_file_test_suite")
+
+get_file_from_objc_provider_test_suite(name = "get_file_from_objc_provider")
+
+get_file_test_suite(name = "get_file")

test/internal/launchd_plists/get_file_from_objc_provider_tests.bzl

@@ -0,0 +1,40 @@
+"""Tests for `launchd_plists.get_file_from_objc_provider`."""
+
+load("@bazel_skylib//lib:unittest.bzl", "asserts", "unittest")
+
+# buildifier: disable=bzl-visibility
+load("//xcodeproj/internal:launchd_plists.bzl", "launchd_plists")
+
+def _get_file_from_objc_provider_test(ctx):
+    env = unittest.begin(ctx)
+
+    launchd_plist_file = ctx.actions.declare_file("Launchd.plist")
+    ctx.actions.write(launchd_plist_file, content = "")
+    launchd_plist_path = launchd_plist_file.path
+
+    linkopt_list = [
+        "-Wl,-sectcreate,__TEXT,__launchd_plist,{}".format(launchd_plist_path),
+    ]
+    link_inputs_list = [launchd_plist_file]
+    linkopt_depset = depset(linkopt_list)
+    link_inputs_depset = depset(link_inputs_list)
+
+    objc_prov = apple_common.new_objc_provider(
+        linkopt = linkopt_depset,
+        link_inputs = link_inputs_depset,
+    )
+
+    actual = launchd_plists.get_file_from_objc_provider(objc_prov)
+    asserts.equals(env, launchd_plist_file, actual)
+
+    return unittest.end(env)
+
+get_file_from_objc_provider_test = unittest.make(
+    _get_file_from_objc_provider_test,
+)
+
+def get_file_from_objc_provider_test_suite(name):
+    return unittest.suite(
+        name,
+        get_file_from_objc_provider_test,
+    )

test/internal/launchd_plists/get_file_tests.bzl

@@ -0,0 +1,40 @@
+"""Tests for `launchd_plists.get_file`."""
+
+load("@bazel_skylib//lib:unittest.bzl", "asserts", "unittest")
+
+# buildifier: disable=bzl-visibility
+load("//xcodeproj/internal:launchd_plists.bzl", "launchd_plists")
+
+def _get_file_from_apple_executable_binary_test(ctx):
+    env = unittest.begin(ctx)
+
+    launchd_plist_file = ctx.actions.declare_file("Launchd.plist")
+    ctx.actions.write(launchd_plist_file, content = "")
+
+    linkopt_list = [
+        "-Wl,-sectcreate,__TEXT,__launchd_plist,{}".format(launchd_plist_file.path),
+    ]
+    link_inputs_list = [launchd_plist_file]
+    linkopt_depset = depset(linkopt_list)
+    link_inputs_depset = depset(link_inputs_list)
+
+    objc_prov = apple_common.new_objc_provider(
+        linkopt = linkopt_depset,
+        link_inputs = link_inputs_depset,
+    )
+
+    executable_binary_prov = apple_common.AppleExecutableBinary(objc = objc_prov)
+    target = {apple_common.AppleExecutableBinary: executable_binary_prov}
+
+    actual = launchd_plists.get_file(target)
+    asserts.equals(env, launchd_plist_file, actual)
+
+    return unittest.end(env)
+
+get_file_from_apple_executable_binary_test = unittest.make(_get_file_from_apple_executable_binary_test)
+
+def get_file_test_suite(name):
+    return unittest.suite(
+        name,
+        get_file_from_apple_executable_binary_test,
+    )

xcodeproj/internal/default_automatic_target_processing_aspect.bzl

@@ -63,6 +63,7 @@ def _default_automatic_target_processing_aspect_impl(target, ctx):
     entitlements = None
     exported_symbols_lists = []
     infoplists = []
+    launchdplists = []
     bazel_build_mode_error = None
     non_arc_srcs = []
     pch = None
@@ -117,6 +118,8 @@ def _default_automatic_target_processing_aspect_impl(target, ctx):
             exported_symbols_lists = ["exported_symbols_lists"]
         if "infoplists" in attrs:
             infoplists = ["infoplists"]
+        if "launchdplists" in attrs:
+            launchdplists = ["launchdplists"]
         xcode_targets = {"deps": [target_type.compile]}
     elif AppleFrameworkImportInfo in target:
         xcode_targets = {"deps": [target_type.compile]}
@@ -153,6 +156,7 @@ def _default_automatic_target_processing_aspect_impl(target, ctx):
             bundle_id = bundle_id,
             provisioning_profile = provisioning_profile,
             infoplists = infoplists,
+            launchdplists = launchdplists,
             entitlements = entitlements,
             bazel_build_mode_error = bazel_build_mode_error,
         ),

xcodeproj/internal/input_files.bzl

@@ -64,6 +64,8 @@ def _is_categorized_attr(attr, *, automatic_target_info):
         return True
     elif attr in automatic_target_info.exported_symbols_lists:
         return True
+    elif attr in automatic_target_info.launchdplists:
+        return True
     else:
         return False
 
@@ -177,6 +179,9 @@ def _collect(
                 # We don't need to include a generated one, as we already use
                 # the Bazel generated one, which is one step further generated
                 extra_files.append(file_path(file))
+        elif attr in automatic_target_info.launchdplists:
+            if file.is_source:
+                extra_files.append(file_path(file))
         elif attr == automatic_target_info.entitlements:
             # We use `append` instead of setting a single value because
             # assigning to `entitlements` creates a new local variable instead
@@ -353,6 +358,7 @@ def _from_resource_bundle(bundle):
         resource_bundles = depset(),
         resource_bundle_dependencies = bundle.dependencies,
         infoplists = depset(),
+        launchdplists = depset(),
         entitlements = None,
         exported_symbols_lists = depset(),
         xccurrentversions = depset(),

xcodeproj/internal/launchd_plists.bzl

@@ -0,0 +1,32 @@
+"""API to retrieve a launchd plist file from a `Target`."""
+
+load(":link_opts.bzl", "link_opts")
+
+def _get_file_from_objc_provider(objc_provider):
+    """
+    Retrieves the launchd plist from the TEXT section provided by the ObjcProvider.
+    """
+
+    launchd_plist_section = link_opts.get_section(
+        objc_provider.linkopt.to_list(),
+        "__TEXT",
+        "__launchd_plist",
+    )
+
+    if launchd_plist_section == None:
+        return None
+
+    # Retrieve the info plist file from the link inputs
+    for file in objc_provider.link_inputs.to_list():
+        if file.path == launchd_plist_section.file:
+            return file
+    return None
+
+def _get_file(target):
+    if apple_common.AppleExecutableBinary in target:
+        return _get_file_from_objc_provider(target[apple_common.AppleExecutableBinary].objc)
+    return None
+
+launchd_plists = struct(
+    get_file = _get_file,
+)

xcodeproj/internal/providers.bzl

@@ -38,6 +38,10 @@ A sequence of attribute names to collect `File`s from for the
         "infoplists": """\
 A sequence of attribute names to collect `File`s from for the `infoplists`-like
 attributes.
+""",
+        "launchdplists": """\
+A sequence of attribute names to collect `File`s from for the `launchdplists`-like
+attributes.
 """,
         "non_arc_srcs": """\
 A sequence of attribute names to collect `File`s from for `non_arc_srcs`-like

xcodeproj/internal/top_level_targets.bzl

@@ -8,6 +8,7 @@ load(":collections.bzl", "set_if_true")
 load(":configuration.bzl", "get_configuration")
 load(":files.bzl", "file_path", "join_paths_ignoring_empty")
 load(":info_plists.bzl", "info_plists")
+load(":launchd_plists.bzl", "launchd_plists")
 load(":input_files.bzl", "input_files")
 load(":linker_input_files.bzl", "linker_input_files")
 load(":opts.bzl", "process_opts")
@@ -194,6 +195,12 @@ def process_top_level_target(
         info_plist = file_path(info_plist_file)
         additional_files.append(info_plist_file)
 
+    launcd_plist = None
+    launchd_plist_file = launchd_plists.get_file(target)
+    if launchd_plist_file:
+        launchd_plist = file_path(launchd_plist_file)
+        additional_files.append(launchd_plist_file)
+
     provisioning_profiles.process_attr(
         ctx = ctx,
         automatic_target_info = automatic_target_info,