Add rules for building SDK frameworks for explicit module compilation

.bazelrc

@@ -36,6 +36,12 @@ build --features apple.arm64_simulator_use_device_deps
 # Note - tree artifacts needs to be on
 build:lldb_ios_test --spawn_strategy=standalone --apple_platform_type=ios --define=apple.experimental.tree_artifact_outputs=1
 
+# Configure for explicit module compilation
+# also requires setting EXPLICIT_MODULE env variable to generate the frameworks repo.
+build:explicit_modules --features=swift.use_c_modules
+build:explicit_modules --features=swift.emit_c_module
+build:explicit_modules --action_env=EXPLICIT_MODULES=1
+
 # Delete the VM test suite for github
 build --deleted_packages tests/ios/vmd
 

.github/workflows/tests.yml

@@ -131,3 +131,36 @@ jobs:
         run: .github/workflows/xcode_select.sh
       - name: Build App
         run: bazelisk build -s tests/ios/app/App --apple_platform_type=ios --ios_minimum_os=10.2  --ios_multi_cpus=i386,x86_64
+  explicit_module_tests:
+    name: Build and Test w/ explicit modules
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v3
+      - name: Select Xcode
+        run: .github/workflows/xcode_select.sh
+      - name: Build and Test
+        run: |
+          # Host config
+          bazelisk test -k --local_test_jobs=1 \
+          --config=explicit_modules -- \
+          //... -//tests/ios/... \
+          -//tests/macos/xcconfig:used_as_condition_xcconfig
+
+          # `deleted_packages` is needed below in order to override the value of the .bazelrc file
+          bazelisk test -k --local_test_jobs=1 --apple_platform_type=ios --deleted_packages='' \
+          --config=explicit_modules -- \
+          //tests/ios/... \
+          -//tests/ios/frameworks/mixed-source/custom-module-map:CustomModuleMapTests \
+          -//tests/ios/frameworks/mixed-source/only-source:MixedSourceTest \
+          -//tests/ios/frameworks/target-xib-resource-bundle:TargetXIBTests \
+          -//tests/ios/frameworks/testonly:MixedSourceTest                 \
+          -//tests/ios/frameworks/dynamic/... \
+          -//tests/ios/frameworks/sources-with-prebuilt-binaries/... \
+          -//tests/ios/frameworks/mixed-source/... \
+          -//tests/ios/xcodeproj/...
+
+      - uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: bazel-testlogs
+          path: bazel-testlogs

BUILD.bazel

@@ -1,6 +1,6 @@
 # Pull buildifer.mac as an http_file, then depend on the file group to make an
 # executable
-load("@build_bazel_rules_swift//swift/internal:feature_names.bzl", "SWIFT_FEATURE_USE_GLOBAL_INDEX_STORE")
+load("@build_bazel_rules_swift//swift/internal:feature_names.bzl", "SWIFT_FEATURE_USE_C_MODULES", "SWIFT_FEATURE_USE_GLOBAL_INDEX_STORE")
 load("//rules:features.bzl", "feature_names")
 load("@bazel_skylib//lib:selects.bzl", "selects")
 
@@ -19,6 +19,13 @@ config_setting(
     },
 )
 
+config_setting(
+    name = "explicit_modules",
+    values = {
+        "features": SWIFT_FEATURE_USE_C_MODULES,
+    },
+)
+
 config_setting(
     name = "virtualize_frameworks",
     values = {

WORKSPACE

@@ -105,7 +105,6 @@ load_framework_dependencies()
 load("//tools/toolchains/xcode_configure:xcode_configure.bzl", "xcode_configure")
 
 xcode_configure(
-    remote_xcode_label = "",
     xcode_locator_label = "//tools/toolchains/xcode_configure:xcode_locator.m",
 )
 

rules/legacy_xcodeproj.bzl

@@ -348,7 +348,7 @@ def _xcodeproj_aspect_impl(target, ctx):
             swift_info = target[SwiftInfo]
             swift_defines.append(depset(_collect_swift_defines(swift_info.direct_modules)))
             swift_defines.append(depset(_collect_swift_defines(swift_info.transitive_modules.to_list())))
-            swift_module_paths = [m.swift.swiftmodule.path for m in target[SwiftInfo].direct_modules]
+            swift_module_paths = [m.swift.swiftmodule.path for m in target[SwiftInfo].direct_modules if m.swift]
         providers.append(
             _SrcsInfo(
                 srcs = depset(srcs, transitive = _get_attr_values_for_name(deps, _SrcsInfo, "srcs")),

rules/library.bzl

@@ -561,7 +561,7 @@ def apple_library(name, library_tools = {}, export_private_headers = True, names
     tags_manual = tags if "manual" in tags else tags + _MANUAL
     platforms = kwargs.pop("platforms", None)
     private_deps = [] + kwargs.pop("private_deps", [])
-    lib_names = []
+    lib_names = ["@xcode_sdk_frameworks"]
     fetch_default_xcconfig = library_tools["fetch_default_xcconfig"](name, default_xcconfig_name, **kwargs) if default_xcconfig_name else {}
     copts_by_build_setting = copts_by_build_setting_with_defaults(xcconfig, fetch_default_xcconfig, xcconfig_by_build_setting)
     enable_framework_vfs = kwargs.pop("enable_framework_vfs", False) or namespace_is_module_name
@@ -915,13 +915,10 @@ def apple_library(name, library_tools = {}, export_private_headers = True, names
 
     if swift_sources:
         additional_swift_copts.extend(("-Xcc", "-I."))
-        if module_map:
-            # Frameworks find the modulemap file via the framework vfs overlay
-            if not namespace_is_module_name:
-                additional_swift_copts += ["-Xcc", "-fmodule-map-file=" + "$(execpath " + module_map + ")"]
-            additional_swift_copts.append(
-                "-import-underlying-module",
-            )
+
+        # Frameworks find the modulemap file via the framework vfs overlay
+        if module_map and not namespace_is_module_name:
+            additional_swift_copts += ["-Xcc", "-fmodule-map-file=" + "$(execpath " + module_map + ")"]
         swiftc_inputs = other_inputs + objc_hdrs + objc_private_hdrs
         if module_map:
             swiftc_inputs.append(module_map)
@@ -971,11 +968,14 @@ def apple_library(name, library_tools = {}, export_private_headers = True, names
             copts = copts_by_build_setting.swift_copts + swift_copts + select({
                 "@build_bazel_rules_ios//:virtualize_frameworks": framework_vfs_swift_copts,
                 "//conditions:default": framework_vfs_swift_copts if enable_framework_vfs else [],
+            }) + select({
+                "@build_bazel_rules_ios//:explicit_modules": [],
+                "//conditions:default": ["-import-underlying-module"] if module_map else [],
             }) + additional_swift_copts,
             deps = deps + private_deps + lib_names + select({
                 "@build_bazel_rules_ios//:virtualize_frameworks": [framework_vfs_overlay_name_swift],
                 "//conditions:default": [framework_vfs_overlay_name_swift] if enable_framework_vfs else [],
-            }),
+            }) + (["@xcode_sdk_frameworks//:XCTest"] if testonly else []),
             swiftc_inputs = swiftc_inputs,
             features = ["swift.no_generated_module_map", "swift.use_pch_output_dir"] + select({
                 "@build_bazel_rules_ios//:virtualize_frameworks": ["swift.vfsoverlay"],

rules/repositories.bzl

@@ -111,6 +111,7 @@ swift_binary(
     name = "arm64-to-sim",
     srcs = glob(["Sources/arm64-to-sim/*.swift"]),
     visibility = ["//visibility:public"],
+    deps = ["@xcode_sdk_frameworks"],
 )
         """,
     )

rules/third_party/xcbuildkit_repositories.bzl

@@ -83,7 +83,7 @@ swift_library(
         name = name,
         srcs = ",\n".join(['"%s"' % x for x in srcs]),
         defines = ",\n".join(['"%s"' % x for x in defines]),
-        deps = ",\n".join(['"%s"' % namespaced_dep_name(x) for x in deps]),
+        deps = ",\n".join(['"%s"' % namespaced_dep_name(x) for x in deps] + ['"@xcode_sdk_frameworks"']),
         copts = ",\n".join(['"%s"' % x for x in copts]),
     ))
 

tests/ios/frameworks/mixed-source/swift-library-compatibility/BUILD.bazel

@@ -6,6 +6,7 @@ swift_library(
     srcs = ["empty.swift"],
     deps = [
         "//tests/ios/frameworks/objc:ObjcFramework",
+        "@xcode_sdk_frameworks",
     ],
 )
 

tests/ios/xcodeproj/fixtures/test_custom_output_path_expected_diff.txt

@@ -1,13 +1,13 @@
 diff -r ./tests/ios/xcodeproj/Test-LLDB-Logs-Project.xcodeproj/project.pbxproj ./tests/ios/xcodeproj/custom_output_path/Test-LLDB-Logs-Project.xcodeproj/project.pbxproj
-45c45
+47c47
 < 			path = ../../..;
 ---
 > 			path = ../../../..;
-211c211
+213c213
 < 				BAZEL_WORKSPACE_ROOT = $SRCROOT/../../..;
 ---
 > 				BAZEL_WORKSPACE_ROOT = $SRCROOT/../../../..;
-268c268
+270c270
 < 				BAZEL_WORKSPACE_ROOT = $SRCROOT/../../..;
 ---
 > 				BAZEL_WORKSPACE_ROOT = $SRCROOT/../../../..;

tools/toolchains/xcode_configure/xcode_configure.bzl

@@ -17,166 +17,10 @@
    installed on the local host.
 """
 
-_EXECUTE_TIMEOUT = 120
-
-def _search_string(fullstring, prefix, suffix):
-    """Returns the substring between two given substrings of a larger string.
-
-    Args:
-      fullstring: The larger string to search.
-      prefix: The substring that should occur directly before the returned string.
-      suffix: The substring that should occur directly after the returned string.
-    Returns:
-      A string occurring in fullstring exactly prefixed by prefix, and exactly
-      terminated by suffix. For example, ("hello goodbye", "lo ", " bye") will
-      return "good". If there is no such string, returns the empty string.
-    """
-
-    prefix_index = fullstring.find(prefix)
-    if (prefix_index < 0):
-        return ""
-    result_start_index = prefix_index + len(prefix)
-    suffix_index = fullstring.find(suffix, result_start_index)
-    if (suffix_index < 0):
-        return ""
-    return fullstring[result_start_index:suffix_index]
-
-def _search_sdk_output(output, sdkname):
-    """Returns the sdk version given xcodebuild stdout and an sdkname."""
-    return _search_string(output, "(%s" % sdkname, ")")
-
-def _xcode_version_output(repository_ctx, name, version, aliases, developer_dir):
-    """Returns a string containing an xcode_version build target."""
-    build_contents = ""
-    decorated_aliases = []
-    error_msg = ""
-    for alias in aliases:
-        decorated_aliases.append("'%s'" % alias)
-    xcodebuild_result = repository_ctx.execute(
-        ["xcrun", "xcodebuild", "-version", "-sdk"],
-        _EXECUTE_TIMEOUT,
-        {"DEVELOPER_DIR": developer_dir},
-    )
-    if (xcodebuild_result.return_code != 0):
-        error_msg = (
-            "Invoking xcodebuild failed, developer dir: {devdir} ," +
-            "return code {code}, stderr: {err}, stdout: {out}"
-        ).format(
-            devdir = developer_dir,
-            code = xcodebuild_result.return_code,
-            err = xcodebuild_result.stderr,
-            out = xcodebuild_result.stdout,
-        )
-        fail(error_msg)
+load(":xcode_locator.bzl", "run_xcode_locator", "search_string", "xcode_version_output")
+load(":xcode_sdk_frameworks.bzl", "xcode_sdk_frameworks")
 
-    ios_sdk_version = _search_sdk_output(xcodebuild_result.stdout, "iphoneos")
-    tvos_sdk_version = _search_sdk_output(xcodebuild_result.stdout, "appletvos")
-    macos_sdk_version = _search_sdk_output(xcodebuild_result.stdout, "macosx")
-    watchos_sdk_version = _search_sdk_output(xcodebuild_result.stdout, "watchos")
-    build_contents += "xcode_version(\n  name = '%s'," % name
-    build_contents += "\n  version = '%s'," % version
-    if aliases:
-        build_contents += "\n  aliases = [%s]," % " ,".join(decorated_aliases)
-    if ios_sdk_version:
-        build_contents += "\n  default_ios_sdk_version = '%s'," % ios_sdk_version
-    if tvos_sdk_version:
-        build_contents += "\n  default_tvos_sdk_version = '%s'," % tvos_sdk_version
-    if macos_sdk_version:
-        build_contents += "\n  default_macos_sdk_version = '%s'," % macos_sdk_version
-    if watchos_sdk_version:
-        build_contents += "\n  default_watchos_sdk_version = '%s'," % watchos_sdk_version
-    build_contents += "\n)\n"
-    return build_contents
-
-VERSION_CONFIG_STUB = "xcode_config(name = 'host_xcodes')"
-
-def run_xcode_locator(repository_ctx, xcode_locator_src_label):
-    """Generates xcode-locator from source and runs it.
-
-    Builds xcode-locator in the current repository directory.
-    Returns the standard output of running xcode-locator with -v, which will
-    return information about locally installed Xcode toolchains and the versions
-    they are associated with.
-
-    This should only be invoked on a darwin OS, as xcode-locator cannot be built
-    otherwise.
-
-    Args:
-      repository_ctx: The repository context.
-      xcode_locator_src_label: The label of the source file for xcode-locator.
-    Returns:
-      A list representing installed xcode toolchain information. Each
-      element of the list is a struct containing information for one installed
-      toolchain. This is an empty list if there was an error building or
-      running xcode-locator.
-    """
-    xcodeloc_src_path = str(repository_ctx.path(xcode_locator_src_label))
-    env = repository_ctx.os.environ
-    xcrun_result = repository_ctx.execute([
-        "env",
-        "-i",
-        "DEVELOPER_DIR={}".format(env.get("DEVELOPER_DIR", default = "")),
-        "xcrun",
-        "--sdk",
-        "macosx",
-        "clang",
-        "-mmacosx-version-min=10.9",
-        "-fobjc-arc",
-        "-framework",
-        "CoreServices",
-        "-framework",
-        "Foundation",
-        "-o",
-        "xcode-locator-bin",
-        xcodeloc_src_path,
-    ], _EXECUTE_TIMEOUT)
-
-    if (xcrun_result.return_code != 0):
-        suggestion = ""
-        if "Agreeing to the Xcode/iOS license" in xcrun_result.stderr:
-            suggestion = ("(You may need to sign the xcode license." +
-                          " Try running 'sudo xcodebuild -license')")
-        error_msg = (
-            "Generating xcode-locator-bin failed. {suggestion} " +
-            "return code {code}, stderr: {err}, stdout: {out}"
-        ).format(
-            suggestion = suggestion,
-            code = xcrun_result.return_code,
-            err = xcrun_result.stderr,
-            out = xcrun_result.stdout,
-        )
-        fail(error_msg.replace("\n", " "))
-
-    xcode_locator_result = repository_ctx.execute(
-        ["./xcode-locator-bin", "-v"],
-        _EXECUTE_TIMEOUT,
-    )
-    if (xcode_locator_result.return_code != 0):
-        error_msg = (
-            "Invoking xcode-locator failed, " +
-            "return code {code}, stderr: {err}, stdout: {out}"
-        ).format(
-            code = xcode_locator_result.return_code,
-            err = xcode_locator_result.stderr,
-            out = xcode_locator_result.stdout,
-        )
-
-        fail(error_msg.replace("\n", " "))
-    xcode_toolchains = []
-
-    # xcode_dump is comprised of newlines with different installed xcode versions,
-    # each line of the form <version>:<comma_separated_aliases>:<developer_dir>.
-    xcode_dump = xcode_locator_result.stdout
-    for xcodeversion in xcode_dump.split("\n"):
-        if ":" in xcodeversion:
-            infosplit = xcodeversion.split(":")
-            toolchain = struct(
-                version = infosplit[0],
-                aliases = infosplit[1].split(","),
-                developer_dir = infosplit[2],
-            )
-            xcode_toolchains.append(toolchain)
-    return xcode_toolchains
+_EXECUTE_TIMEOUT = 120
 
 def _darwin_build_file(repository_ctx):
     """Evaluates local system state to create xcode_config and xcode_version targets."""
@@ -198,8 +42,8 @@ def _darwin_build_file(repository_ctx):
     default_xcode_version = ""
     default_xcode_build_version = ""
     if xcodebuild_result.return_code == 0:
-        default_xcode_version = _search_string(xcodebuild_result.stdout, "Xcode ", "\n")
-        default_xcode_build_version = _search_string(
+        default_xcode_version = search_string(xcodebuild_result.stdout, "Xcode ", "\n")
+        default_xcode_build_version = search_string(
             xcodebuild_result.stdout,
             "Build version ",
             "\n",
@@ -213,13 +57,14 @@ def _darwin_build_file(repository_ctx):
         aliases = toolchain.aliases
         developer_dir = toolchain.developer_dir
         target_name = "version%s" % version.replace(".", "_")
-        buildcontents += _xcode_version_output(
+        version_output = xcode_version_output(
             repository_ctx,
             target_name,
             version,
             aliases,
             developer_dir,
         )
+        buildcontents += version_output
         target_label = "':%s'" % target_name
         target_names.append(target_label)
         if (version.startswith(default_xcode_version) and
@@ -249,6 +94,8 @@ def _darwin_build_file(repository_ctx):
         buildcontents += "\n)\n"
     return buildcontents
 
+VERSION_CONFIG_STUB = "xcode_config(name = 'host_xcodes')"
+
 def _impl(repository_ctx):
     """Implementation for the local_config_xcode repository rule.
 
@@ -285,3 +132,7 @@ def xcode_configure(xcode_locator_label, remote_xcode_label = None):
         xcode_locator = xcode_locator_label,
         remote_xcode = remote_xcode_label,
     )
+    xcode_sdk_frameworks(
+        name = "xcode_sdk_frameworks",
+        xcode_locator = xcode_locator_label,
+    )