Add optional parameter entitlements_targets to iOS template.

build/config/ios/rules.gni

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import("//build/config/ios/ios_sdk.gni")
 import("//build/config/mac/base_rules.gni")
 import("//build/config/mac/symbols.gni")
 import("//build/toolchain/toolchain.gni")
 
 # Invokes lipo on multiple arch-specific binaries to create a fat binary.
@@ skipping 139 matching lines @@
 #       (optional) string, base name of the binary generated by the
 #       bundle_binary_target target, defaults to the target name.
 #
 #   extra_system_frameworks
 #       (optional) list of system framework to copy to the bundle.
 #
 #   enable_code_signing
 #       (optional) boolean, control whether code signing is enabled or not,
 #       default to ios_enable_code_signing if not defined.
 #
+#   entitlements_path:
+#       (optional) path to the template to use to generate the application
+#       entitlements by performing variable substitutions, defaults to
+#       //build/config/ios/entitlements.plist.
+#
+#   entitlements_target:
+#       (optional) label of the target generating the application
+#       entitlements; cannot be defined at the same time as entitlements_path.
+#
 template("create_signed_bundle") {
   assert(defined(invoker.product_type),
          "product_type must be defined for $target_name")
   assert(defined(invoker.bundle_extension),
          "bundle_extension must be defined for $target_name")
   assert(defined(invoker.bundle_binary_target),
          "bundle_binary_target must be defined for $target_name")
 
   _target_name = target_name
   _output_name = target_name
   if (defined(invoker.output_name)) {
     _output_name = invoker.output_name
   }
 
   _bundle_binary_target = invoker.bundle_binary_target
   _bundle_binary_output = get_label_info(_bundle_binary_target, "name")
   if (defined(invoker.bundle_binary_output)) {
     _bundle_binary_output = invoker.bundle_binary_output
   }
 
   _bundle_extension = invoker.bundle_extension
   _bundle_root_dir = "$root_out_dir/$_output_name$_bundle_extension"
 
-  _entitlements_path = "//build/config/ios/entitlements.plist"
-  if (defined(invoker.entitlements_path)) {
-    _entitlements_path = invoker.entitlements_path
+  if (!defined(invoker.entitlements_target)) {
+    _entitlements_path = "//build/config/ios/entitlements.plist"
+    if (defined(invoker.entitlements_path)) {
+      _entitlements_path = invoker.entitlements_path
+    }
+  } else {
+    assert(!defined(invoker.entitlements_path),
+           "Cannot define both entitlements_path and entitlements_target " +
+               "for $target_name")
+
+    _entitlements_target_outputs =
+        get_target_outputs(invoker.entitlements_target)
+    _entitlements_path = _entitlements_target_outputs[0]

[Olivier, 2016/11/04 08:49:39]

Should it be documented somewhere that target that generate entitlements must
put it in the first output?
Can there be a way to specify what output to consider?

[Dirk Pranke, 2016/11/04 17:12:11]

Seems like a good suggestion (at least the first part, about documenting).

   }
 
   _enable_code_signing = ios_enable_code_signing
   if (defined(invoker.enable_code_signing)) {
     _enable_code_signing = invoker.enable_code_signing
   }
 
   create_bundle(_target_name) {
     forward_variables_from(invoker,
                            [
@@ skipping 16 matching lines @@
       public_deps = []
     }
     public_deps += [ _bundle_binary_target ]
 
     if (defined(invoker.bundle_deps)) {
       if (!defined(deps)) {
         deps = []
       }
       deps += invoker.bundle_deps
     }
+    if (defined(invoker.entitlements_target)) {
+      if (!defined(deps)) {
+        deps = []
+      }
+      deps += [ invoker.entitlements_target ]
+    }
 
     code_signing_script = "//build/config/ios/codesign.py"
     code_signing_sources = [
       _entitlements_path,
       get_label_info(_bundle_binary_target, "target_out_dir") +
           "/$_bundle_binary_output",
     ]
     code_signing_outputs = [ "$_bundle_root_dir/$_output_name" ]
     if (_enable_code_signing) {
       code_signing_outputs +=
@@ skipping 130 matching lines @@
 #   info_plist_target:
 #       (optional) string, if the info_plist is generated from an action,
 #       rather than a regular source file, specify the target name in lieu
 #       of info_plist. The two arguments are mutually exclusive.
 #
 #   entitlements_path:
 #       (optional) path to the template to use to generate the application
 #       entitlements by performing variable substitutions, defaults to
 #       //build/config/ios/entitlements.plist.
 #
+#   entitlements_target:
+#       (optional) label of the target generating the application
+#       entitlements; cannot be defined at the same time as entitlements_path.
+#
 #   bundle_extension:
 #       (optional) bundle extension including the dot, default to ".app".
 #
 #   product_type
 #       (optional) string, product type for the generated Xcode project,
 #       default to "com.apple.product-type.application". Should generally
 #       not be overridden.
 #
 #   enable_code_signing
 #       (optional) boolean, control whether code signing is enabled or not,
@@ skipping 13 matching lines @@
 
   source_set(_arch_executable_source) {
     forward_variables_from(invoker,
                            "*",
                            [
                              "bundle_deps",
                              "bundle_deps_filter",
                              "bundle_extension",
                              "enable_code_signing",
                              "entitlements_path",
+                             "entitlements_target",
                              "extra_substitutions",
                              "extra_system_frameworks",
                              "info_plist",
                              "info_plist_target",
                              "output_name",
                              "product_type",
                              "visibility",
                            ])
 
     visibility = [ ":$_arch_executable_target" ]
   }
 
   if (current_toolchain == default_toolchain || use_ios_simulator) {
     _generate_entitlements_target = _target_name + "_gen_entitlements"
     _generate_entitlements_output =
         get_label_info(":$_generate_entitlements_target($default_toolchain)",
                        "target_out_dir") + "/$_output_name.xcent"
   }
 
   executable(_arch_executable_target) {
     forward_variables_from(invoker,
                            "*",
                            [
                              "bundle_deps",
                              "bundle_deps_filter",
                              "bundle_extension",
                              "enable_code_signing",
                              "entitlements_path",
+                             "entitlements_target",
                              "extra_substitutions",
                              "extra_system_frameworks",
                              "info_plist",
                              "info_plist_target",
                              "output_name",
                              "product_type",
                              "sources",
                              "visibility",
                            ])
 
@@ skipping 89 matching lines @@
                              [
                                "extra_substitutions",
                                "info_plist",
                                "info_plist_target",
                              ])
 
       executable_name = _output_name
     }
 
     if (current_toolchain == default_toolchain) {
-      _entitlements_path = "//build/config/ios/entitlements.plist"
-      if (defined(invoker.entitlements_path)) {
-        _entitlements_path = invoker.entitlements_path
+      if (!defined(invoker.entitlements_target)) {
+        _entitlements_path = "//build/config/ios/entitlements.plist"
+        if (defined(invoker.entitlements_path)) {
+          _entitlements_path = invoker.entitlements_path
+        }
+      } else {
+        assert(!defined(invoker.entitlements_path),
+               "Cannot define both entitlements_path and entitlements_target" +
+                   "for $_target_name")
+
+        _entitlements_target_outputs =
+            get_target_outputs(invoker.entitlements_target)
+        _entitlements_path = _entitlements_target_outputs[0]
       }
 
       action(_generate_entitlements_target) {
         _gen_info_plist_outputs = get_target_outputs(":$_generate_info_plist")
         _info_plist_path = _gen_info_plist_outputs[0]
 
         script = "//build/config/ios/codesign.py"
         deps = [
           ":$_generate_info_plist",
         ]
+        if (defined(invoker.entitlements_target)) {
+          deps += [ invoker.entitlements_target ]
+        }
         sources = [
           _entitlements_path,
           _info_plist_path,
         ]
         outputs = [
           _generate_entitlements_output,
         ]
 
         args = []
         if (!use_system_xcode) {
@@ skipping 26 matching lines @@
     create_signed_bundle(_target_name) {
       forward_variables_from(invoker,
                              [
                                "bundle_deps",
                                "bundle_deps_filter",
                                "bundle_extension",
                                "data_deps",
                                "deps",
                                "enable_code_signing",
                                "entitlements_path",
+                               "entitlements_target",
                                "extra_system_frameworks",
                                "product_type",
                                "public_configs",
                                "public_deps",
                                "testonly",
                                "visibility",
                              ])
 
       output_name = _output_name
       bundle_binary_target = ":$_lipo_executable_target"
@@ skipping 754 matching lines @@
       "-rpath",
       "-Xlinker",
       "@loader_path/Frameworks",
     ]
   }
 }
 
 set_defaults("ios_xctest_test") {
   configs = default_executable_configs
 }