Add support for generating PkgInfo for application bundle on iOS.

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 393 matching lines @@
 #       (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,
 #       default to ios_enable_code_signing if not defined.
 #

[Robert Sesek, 2016/12/09 15:55:08]

Document write_pkg_info ?

[sdefresne, 2016/12/09 16:03:06]

It will be removed in three CLs. It is undocumented on purpose :-)

 # For more information, see "gn help executable".
 template("ios_app_bundle") {
   _output_name = target_name
   _target_name = target_name
   if (defined(invoker.output_name)) {
     _output_name = invoker.output_name
   }
 
+  # TODO(sdefresne): some target downstream manually pack an PkgInfo, so
+  # allow controlling the generation of the PkgInfo file via an undocumented
+  # parameter until they are fixed.
+  _write_pkg_info = false
+  if (defined(invoker.write_pkg_info)) {
+    _write_pkg_info = invoker.write_pkg_info
+  }
+
+  assert(_write_pkg_info || !_write_pkg_info,
+         "prevents 'Assignment had no effect.' errors")

[Robert Sesek, 2016/12/09 15:55:07]

🙄

[sdefresne, 2016/12/09 16:03:06]

I know.

+
   _arch_executable_source = _target_name + "_arch_executable_sources"
   _arch_executable_target = _target_name + "_arch_executable"
   _lipo_executable_target = _target_name + "_executable"
 
   source_set(_arch_executable_source) {
     forward_variables_from(invoker,
                            "*",
                            [
                              "bundle_deps",
                              "bundle_deps_filter",
@@ skipping 194 matching lines @@
 
       sources = get_target_outputs(":$_generate_info_plist")
       outputs = [
         "{{bundle_root_dir}}/Info.plist",
       ]
       public_deps = [
         ":$_generate_info_plist",
       ]
     }
 
+    if (_write_pkg_info) {
+      _create_pkg_info = target_name + "_pkg_info"
+      action(_create_pkg_info) {
+        forward_variables_from(invoker, [ "testonly" ])
+        script = "//build/config/mac/write_pkg_info.py"
+        sources = get_target_outputs(":$_generate_info_plist")
+        outputs = [
+          # Cannot name the output PkgInfo as the name will not be unique if
+          # multiple ios_app_bundle are defined in the same BUILD.gn file. The
+          # file is renamed in the bundle_data outputs to the correct name.
+          "$target_gen_dir/$target_name",
+        ]
+        args = [ "--plist" ] + rebase_path(sources, root_build_dir) +
+               [ "--output" ] + rebase_path(outputs, root_build_dir)
+        deps = [
+          ":$_generate_info_plist",
+        ]
+      }
+
+      _bundle_data_pkg_info = target_name + "_bundle_data_pkg_info"
+      bundle_data(_bundle_data_pkg_info) {
+        forward_variables_from(invoker, [ "testonly" ])
+        sources = get_target_outputs(":$_create_pkg_info")
+        outputs = [
+          "{{bundle_resources_dir}}/PkgInfo",
+        ]
+        public_deps = [
+          ":$_create_pkg_info",
+        ]
+      }
+    }
+
     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"
       bundle_binary_output = _output_name
 
       if (!defined(bundle_deps)) {
         bundle_deps = []
       }
       bundle_deps += [ ":$_bundle_data_info_plist" ]
+      if (_write_pkg_info) {
+        bundle_deps += [ ":$_bundle_data_pkg_info" ]
+      }
 
       if (use_ios_simulator) {
         if (!defined(data_deps)) {
           data_deps = []
         }
         data_deps += [ "//testing/iossim" ]
       }
 
       if (!defined(product_type)) {
         product_type = "com.apple.product-type.application"
@@ skipping 739 matching lines @@
       "-rpath",
       "-Xlinker",
       "@loader_path/Frameworks",
     ]
   }
 }
 
 set_defaults("ios_xctest_test") {
   configs = default_executable_configs
 }