Add suppress-code-coverage flag for builds

Signed-off-by: sebastian.shanus <sebastian.shanus@robinhood.com>

Author: sebastianv1

test/internal/pbxproj_partials/write_pbxproj_prefix_tests.bzl

@@ -48,6 +48,7 @@ def _write_pbxproj_prefix_test_impl(ctx):
         colorize = ctx.attr.colorize,
         config = ctx.attr.config,
         default_xcode_configuration = ctx.attr.default_xcode_configuration,
+        suppress_coverage_build = ctx.attr.suppress_coverage_build,
         execution_root_file = ctx.attr.execution_root_file,
         generator_name = "a_generator_name",
         import_index_build_indexstores = (
@@ -153,6 +154,7 @@ write_pbxproj_prefix_test = unittest.make(
         "post_build_script": attr.string(),
         "pre_build_script": attr.string(),
         "project_options": attr.string_dict(mandatory = True),
+        "suppress_coverage_build": attr.bool(mandatory = True),
         "resolved_repositories_file": attr.string(mandatory = True),
         "separate_index_build_output_base": attr.bool(mandatory = True),
         "target_ids_list": attr.string(mandatory = True),
@@ -182,6 +184,7 @@ def write_pbxproj_prefix_test_suite(name):
             colorize = False,
             config,
             default_xcode_configuration,
+            suppress_coverage_build = False,
             execution_root_file,
             import_index_build_indexstores,
             index_import,
@@ -208,6 +211,7 @@ def write_pbxproj_prefix_test_suite(name):
             colorize = colorize,
             config = config,
             default_xcode_configuration = default_xcode_configuration,
+            suppress_coverage_build = suppress_coverage_build,
             execution_root_file = execution_root_file,
             import_index_build_indexstores = import_index_build_indexstores,
             index_import = index_import,
@@ -277,6 +281,8 @@ def write_pbxproj_prefix_test_suite(name):
             "some/path/to/index_import",
             # separateIndexBuildOutputBase
             "0",
+            # suppressCoverageBuild
+            "0",
             # resolvedRepositoriesFile
             "some/path/to/resolved_repositories_file",
             # minimumXcodeVersion
@@ -349,6 +355,8 @@ def write_pbxproj_prefix_test_suite(name):
             "some/path/to/index_import",
             # separateIndexBuildOutputBase
             "1",
+            # suppressCoverageBuild
+            "0",
             # resolvedRepositoriesFile
             "some/path/to/resolved_repositories_file",
             # minimumXcodeVersion

tools/generators/pbxproj_prefix/src/Generator/Arguments.swift

@@ -42,6 +42,12 @@ Path to a file that contains the absolute path to the Bazel execution root.
         )
         var separateIndexBuildOutputBase: Bool
 
+        @Argument(
+            help: "Whether to suppress coverage builds even when CLANG_COVERAGE_MAPPING is set.",
+            transform: { $0 == "1" }
+        )
+        var suppressCoverageBuild: Bool
+
         @Argument(
             help: """
 Path to a file that contains a string for the `RESOLVED_REPOSITORIES` build \

tools/generators/pbxproj_prefix/src/Generator/Environment.swift

@@ -31,6 +31,7 @@ extension Generator {
 
         let pbxProjectBuildSettings: (
             _ config: String,
+            _ suppressCoverageBuild: Bool,
             _ importIndexBuildIndexstores: Bool,
             _ legacyIndexImport: String,
             _ indexImport: String,

tools/generators/pbxproj_prefix/src/Generator/Generator.swift

@@ -49,6 +49,7 @@ struct Generator {
         let pbxProjectPrefixPartial = environment.pbxProjectPrefixPartial(
             /*buildSettings:*/ environment.pbxProjectBuildSettings(
                 /*config:*/ arguments.config,
+                /*suppressCoverageBuild:*/ arguments.suppressCoverageBuild,
                 /*importIndexBuildIndexstores:*/ arguments
                     .importIndexBuildIndexstores,
                 /*legacyIndexImport:*/ arguments.legacyIndexImport,

tools/generators/pbxproj_prefix/src/Generator/PBXProjectBuildSettings.swift

@@ -21,6 +21,7 @@ extension Generator {
     ///   - workspace: The absolute path to the Bazel workspace.
     static func pbxProjectBuildSettings(
         config: String,
+        suppressCoverageBuild: Bool,
         importIndexBuildIndexstores: Bool,
         legacyIndexImport: String,
         indexImport: String,
@@ -175,6 +176,14 @@ extension Generator {
                 value: #""$(PROJECT_DIR)/../..""#
             ),
         ]
+        if suppressCoverageBuild {
+            buildSettings.append(
+                .init(
+                    key: "BAZEL_SUPPRESS_COVERAGE_BUILD",
+                    value: "YES"
+                )
+            )
+        }
         if separateIndexBuildOutputBase {
             buildSettings.append(contentsOf: [
                 .init(

tools/generators/pbxproj_prefix/test/PBXProjectBuildSettingsTests.swift

@@ -84,6 +84,7 @@ class PBXProjectBuildSettingsTests: XCTestCase {
 
         let buildSettings = Generator.pbxProjectBuildSettings(
             config: config,
+            suppressCoverageBuild: false,
             importIndexBuildIndexstores: importIndexBuildIndexstores,
             legacyIndexImport: legacyIndexImport,
             indexImport: indexImport,
@@ -100,6 +101,94 @@ class PBXProjectBuildSettingsTests: XCTestCase {
         XCTAssertNoDifference(buildSettings, expectedBuildSettings)
     }
 
+    func testSuppressCoverageBuild() {
+        let config = "rxcp_custom_config"
+        let importIndexBuildIndexstores = false
+        let legacyIndexImport = "external/legacy-index-import"
+        let indexImport = "external/index-import"
+        let indexingProjectDir = "/some/indexing/project dir"
+        let projectDir = "/some/project dir"
+        let resolvedRepositories = #""" "/tmp/workspace""#
+        let workspace = "/Users/TimApple/Star Board"
+
+        let expectedBuildSettings = #"""
+{
+				ALWAYS_SEARCH_USER_PATHS = NO;
+				ASSETCATALOG_COMPILER_GENERATE_ASSET_SYMBOLS = NO;
+				BAZEL_CONFIG = rxcp_custom_config;
+				BAZEL_SUPPRESS_COVERAGE_BUILD = YES;
+				BAZEL_EXTERNAL = "$(BAZEL_OUTPUT_BASE)/external";
+				BAZEL_INTEGRATION_DIR = "$(INTERNAL_DIR)/bazel";
+				BAZEL_LLDB_INIT = "$(HOME)/.lldbinit-rules_xcodeproj";
+				BAZEL_OUT = "$(PROJECT_DIR)/bazel-out";
+				BAZEL_OUTPUT_BASE = "$(_BAZEL_OUTPUT_BASE:standardizepath)";
+				BAZEL_WORKSPACE_ROOT = "$(SRCROOT)";
+				BUILD_DIR = "$(SYMROOT)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)";
+				BUILD_MARKER_FILE = "$(OBJROOT)/build_marker";
+				BUILD_WORKSPACE_DIRECTORY = "$(SRCROOT)";
+				CC = "$(BAZEL_INTEGRATION_DIR)/clang.sh";
+				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_MODULES_AUTOLINK = NO;
+				CODE_SIGNING_ALLOWED = NO;
+				CODE_SIGN_STYLE = Manual;
+				CONFIGURATION_BUILD_DIR = "$(BUILD_DIR)/$(BAZEL_PACKAGE_BIN_DIR)";
+				COPY_PHASE_STRIP = NO;
+				CXX = "$(BAZEL_INTEGRATION_DIR)/clang.sh";
+				DEBUG_INFORMATION_FORMAT = dwarf;
+				DSTROOT = "$(PROJECT_TEMP_DIR)";
+				ENABLE_DEBUG_DYLIB = NO;
+				ENABLE_DEFAULT_SEARCH_PATHS = NO;
+				ENABLE_STRICT_OBJC_MSGSEND = YES;
+				ENABLE_USER_SCRIPT_SANDBOXING = NO;
+				GCC_OPTIMIZATION_LEVEL = 0;
+				IMPORT_INDEX_BUILD_INDEXSTORES = NO;
+				INDEX_DATA_STORE_DIR = "$(INDEX_DATA_STORE_DIR)";
+				INDEX_FORCE_SCRIPT_EXECUTION = YES;
+				INDEX_IMPORT = "$(BAZEL_EXTERNAL)/index-import";
+				INSTALL_PATH = "$(BAZEL_PACKAGE_BIN_DIR)/$(TARGET_NAME)/bin";
+				INTERNAL_DIR = "$(PROJECT_FILE_PATH)/rules_xcodeproj";
+				LD = "$(BAZEL_INTEGRATION_DIR)/ld";
+				LDPLUSPLUS = "$(BAZEL_INTEGRATION_DIR)/ld";
+				LD_DYLIB_INSTALL_NAME = "";
+				LD_OBJC_ABI_VERSION = "";
+				LD_RUNPATH_SEARCH_PATHS = "";
+				LEGACY_INDEX_IMPORT = "$(BAZEL_EXTERNAL)/legacy-index-import";
+				LIBTOOL = "$(BAZEL_INTEGRATION_DIR)/libtool";
+				ONLY_ACTIVE_ARCH = YES;
+				PROJECT_DIR = "/some/project dir";
+				RESOLVED_REPOSITORIES = "\"\" \"/tmp/workspace\"";
+				RULES_XCODEPROJ_BUILD_MODE = bazel;
+				SRCROOT = "/Users/TimApple/Star Board";
+				SUPPORTS_MACCATALYST = NO;
+				SWIFT_EXEC = "$(BAZEL_INTEGRATION_DIR)/swiftc";
+				SWIFT_OBJC_INTERFACE_HEADER_NAME = "";
+				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
+				SWIFT_USE_INTEGRATED_DRIVER = NO;
+				SWIFT_VERSION = 5.0;
+				TAPI_EXEC = /usr/bin/true;
+				TARGET_TEMP_DIR = "$(PROJECT_TEMP_DIR)/$(BAZEL_PACKAGE_BIN_DIR)/$(COMPILE_TARGET_NAME)";
+				USE_HEADERMAP = NO;
+				VALIDATE_WORKSPACE = NO;
+				_BAZEL_OUTPUT_BASE = "$(PROJECT_DIR)/../..";
+			}
+"""#
+
+        let buildSettings = Generator.pbxProjectBuildSettings(
+            config: config,
+            suppressCoverageBuild: true,
+            importIndexBuildIndexstores: importIndexBuildIndexstores,
+            legacyIndexImport: legacyIndexImport,
+            indexImport: indexImport,
+            indexingProjectDir: indexingProjectDir,
+            separateIndexBuildOutputBase: false,
+            projectDir: projectDir,
+            resolvedRepositories: resolvedRepositories,
+            workspace: workspace,
+            createBuildSettingsAttribute: CreateBuildSettingsAttribute()
+        )
+        XCTAssertNoDifference(buildSettings, expectedBuildSettings)
+    }
+
     func testSeparateIndexOutputBase() {
         // Arrange
 
@@ -181,6 +270,7 @@ class PBXProjectBuildSettingsTests: XCTestCase {
 
         let buildSettings = Generator.pbxProjectBuildSettings(
             config: config,
+            suppressCoverageBuild: false,
             importIndexBuildIndexstores: importIndexBuildIndexstores,
             legacyIndexImport: legacyIndexImport,
             indexImport: indexImport,

xcodeproj/BUILD

@@ -45,6 +45,12 @@ string_flag(
     visibility = ["//visibility:public"],
 )
 
+bool_flag(
+    name = "suppress_coverage_build",
+    build_setting_default = False,
+    visibility = ["//visibility:public"],
+)
+
 bool_flag(
     name = "separate_index_build_output_base",
     build_setting_default = False,

xcodeproj/internal/pbxproj_partials.bzl

@@ -659,6 +659,7 @@ def _write_pbxproj_prefix(
         colorize,
         config,
         default_xcode_configuration,
+        suppress_coverage_build,
         execution_root_file,
         generator_name,
         import_index_build_indexstores,
@@ -685,6 +686,8 @@ def _write_pbxproj_prefix(
         config: The name of the `.bazelrc` config.
         default_xcode_configuration: The name of the the Xcode configuration to
             use when building, if not overridden by custom schemes.
+        suppress_coverage_build: Whether or not to disable coverage builds even
+            when `CLANG_COVERAGE_MAPPING` is set.
         execution_root_file: A `File` containing the absolute path to the Bazel
             execution root.
         generator_name: The name of the `xcodeproj` generator target.
@@ -749,6 +752,9 @@ def _write_pbxproj_prefix(
     # separateIndexBuildOutputBase
     args.add(TRUE_ARG if separate_index_build_output_base else FALSE_ARG)
 
+    # suppressCoverageBuild
+    args.add(TRUE_ARG if suppress_coverage_build else FALSE_ARG)
+
     # resolvedRepositoriesFile
     args.add(resolved_repositories_file)
 

xcodeproj/internal/templates/generate_bazel_dependencies.sh

@@ -121,7 +121,7 @@ if [ "$ACTION" == "indexbuild" ]; then
   apply_sanitizers=0
 elif [ "${ENABLE_PREVIEWS:-}" == "YES" ]; then
   readonly config="${BAZEL_CONFIG}_swiftuipreviews"
-elif [ "${CLANG_COVERAGE_MAPPING:-}" == YES ]; then
+elif [ "${CLANG_COVERAGE_MAPPING:-}" == YES ] && [ "${BAZEL_SUPPRESS_COVERAGE_BUILD:-}" != YES ]; then
   # Code coverage build
   #
   # CLANG_COVERAGE_MAPPING is set to YES when the active scheme's test action has code coverage enabled. It is configured

xcodeproj/internal/templates/generator.BUILD.bazel

@@ -31,6 +31,7 @@ xcodeproj(
     runner_label = "%runner_label%",
     scheme_autogeneration_mode = "%scheme_autogeneration_mode%",
     scheme_autogeneration_config = %scheme_autogeneration_config%,
+    suppress_coverage_build = %suppress_coverage_build%,
     separate_index_build_output_base = %separate_index_build_output_base%,
     storekit_configurations_map = %storekit_configurations_map%,
     tags = %tags%,