add code coverage option on test_options

Signed-off-by: Lucas Romano <[email protected]> Signed-off-by: Lucas Romano <[email protected]>
MobileNativeFoundation · Nov 19, 2024 · b4e0ee1 · b4e0ee1
1 parent f4fa898
commit b4e0ee1
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 9 deletions.
diff --git a/docs/bazel.md b/docs/bazel.md
@@ -280,7 +280,7 @@ Creates a value for the [`scheme_autogeneration_config`](xcodeproj-scheme_autoge
 | Name  | Description | Default Value |
 | :------------- | :------------- | :------------- |
 | <a id="xcschemes.autogeneration_config-scheme_name_exclude_patterns"></a>scheme_name_exclude_patterns |  A `list` of regex patterns used to skip creating matching autogenerated schemes.<br><br>Example:<br><br><pre><code class="language-starlark">xcodeproj(&#10;    ...&#10;    scheme_name_exclude_patterns = xcschemes.autogeneration_config(&#10;        scheme_name_exclude_patterns = [&#10;            ".*somePattern.*",&#10;            "^AnotherPattern.*",&#10;        ],&#10;    ),&#10;)</code></pre>   |  `None` |
-| <a id="xcschemes.autogeneration_config-test"></a>test |  Options to use for the test action.<br><br>Example:<br><br>```starlark xcodeproj(     ...     scheme_autogeneration_config = xcschemes.autogeneration_config(         test = xcschemes.autogeneration.test(             options = xcschemes.test_options(                 app_language = "en",                 app_region = "US",             )         )     ) )   |  `None` |
+| <a id="xcschemes.autogeneration_config-test"></a>test |  Options to use for the test action.<br><br>Example:<br><br>```starlark xcodeproj(     ...     scheme_autogeneration_config = xcschemes.autogeneration_config(         test = xcschemes.autogeneration.test(             options = xcschemes.test_options(                 app_language = "en",                 app_region = "US",                 code_coverage = False,             )         )     ) )   |  `None` |
 
 **RETURNS**
 
@@ -551,7 +551,7 @@ Defines the Test action.
 ## xcschemes.test_options
 
 <pre>
-xcschemes.test_options(<a href="#xcschemes.test_options-app_language">app_language</a>, <a href="#xcschemes.test_options-app_region">app_region</a>)
+xcschemes.test_options(<a href="#xcschemes.test_options-app_language">app_language</a>, <a href="#xcschemes.test_options-app_region">app_region</a>, <a href="#xcschemes.test_options-code_coverage">code_coverage</a>)
 </pre>
 
 Defines the test options for a custom scheme.
@@ -563,6 +563,7 @@ Defines the test options for a custom scheme.
 | :------------- | :------------- | :------------- |
 | <a id="xcschemes.test_options-app_language"></a>app_language |  Language to set in scheme.<br><br>Defaults to system settings if not set.   |  `None` |
 | <a id="xcschemes.test_options-app_region"></a>app_region |  Region to set in scheme.<br><br>Defaults to system settings if not set.   |  `None` |
+| <a id="xcschemes.test_options-code_coverage"></a>code_coverage |  Whether to enable code coverage.<br><br>If `True`, code coverage will be enabled.   |  `False` |
 
 
 <a id="xcschemes.test_target"></a>

diff --git a/examples/integration/xcodeproj_targets.bzl b/examples/integration/xcodeproj_targets.bzl
@@ -155,6 +155,7 @@ SCHEME_AUTOGENERATION_CONFIG = xcschemes.autogeneration_config(
         options = xcschemes.test_options(
             app_language = "en",
             app_region = "US",
+            code_coverage = False,
         ),
     ),
 )
@@ -247,6 +248,7 @@ XCSCHEMES = [
             test_options = xcschemes.test_options(
                 app_language = "en",
                 app_region = "US",
+                code_coverage = False,
             ),
             test_targets = [
                 "//iOSApp/Test/SwiftUnitTests:iOSAppSwiftUnitTests",

diff --git a/test/internal/xcschemes/info_constructors_tests.bzl b/test/internal/xcschemes/info_constructors_tests.bzl
@@ -271,6 +271,7 @@ def info_constructors_test_suite(name):
         expected_info = struct(
             app_language = "",
             app_region = "",
+            code_coverage = "0",
         ),
     )
 
@@ -281,12 +282,14 @@ def info_constructors_test_suite(name):
         info = xcscheme_infos_testable.make_test_options(
             app_language = "en",
             app_region = "US",
+            code_coverage = "0",
         ),
 
         # Expected
         expected_info = struct(
             app_language = "en",
             app_region = "US",
+            code_coverage = "0",
         ),
     )
 
@@ -756,6 +759,7 @@ def info_constructors_test_suite(name):
             options = xcscheme_infos_testable.make_test_options(
                 app_language = "en",
                 app_region = "US",
+                code_coverage = "0",
             ),
             test_targets = [
                 xcscheme_infos_testable.make_test_target("tt 9"),
@@ -793,6 +797,7 @@ def info_constructors_test_suite(name):
             options = xcscheme_infos_testable.make_test_options(
                 app_language = "en",
                 app_region = "US",
+                code_coverage = "0",
             ),
             test_targets = [
                 xcscheme_infos_testable.make_test_target("tt 9"),

diff --git a/test/internal/xcschemes/infos_from_json_tests.bzl b/test/internal/xcschemes/infos_from_json_tests.bzl
@@ -956,6 +956,7 @@ def infos_from_json_test_suite(name):
                     options = struct(
                         app_language = "en",
                         app_region = "US",
+                        code_coverage = "0",
                     ),
                     test_targets = [
                         "tt 1 label",
@@ -1048,6 +1049,7 @@ def infos_from_json_test_suite(name):
                     options = xcscheme_infos_testable.make_test_options(
                         app_language = "en",
                         app_region = "US",
+                        code_coverage = "0",
                     ),
                     test_targets = [
                         xcscheme_infos_testable.make_test_target("sim tt 1"),

diff --git a/test/internal/xcschemes/utils.bzl b/test/internal/xcschemes/utils.bzl
@@ -24,6 +24,7 @@ def _dict_to_test_options_info(d):
     return struct(
         app_language = d["app_language"],
         app_region = d["app_region"],
+        code_coverage = d["code_coverage"],
     )
 
 def _dict_to_launch_target_info(d):

diff --git a/test/internal/xcschemes/write_schemes_tests.bzl b/test/internal/xcschemes/write_schemes_tests.bzl
@@ -614,6 +614,7 @@ def write_schemes_test_suite(name):
                     options = xcscheme_infos_testable.make_test_options(
                         app_language = "en",
                         app_region = "US",
+                        code_coverage = "0",
                     ),
                     test_targets = [
                         xcscheme_infos_testable.make_test_target(
@@ -1090,6 +1091,8 @@ def write_schemes_test_suite(name):
                 "",
                 # - test - app_region
                 "",
+                # - test - code_coverage
+                "0",
                 # - test - xcodeConfiguration
                 "",
                 # - run - buildTargets
@@ -1191,6 +1194,8 @@ def write_schemes_test_suite(name):
                 "en",
                 # - test - app_region
                 "US",
+                # - test - code_coverage
+                "0",
                 # - test - xcodeConfiguration
                 "Test",
                 # - run - buildTargets
@@ -1320,6 +1325,8 @@ def write_schemes_test_suite(name):
                 "",
                 # - test - app_region
                 "",
+                # - test - code_coverage
+                "0",
                 # - test - xcodeConfiguration
                 "",
                 # - run - buildTargets

diff --git a/tools/generators/lib/XCScheme/src/CreateTestAction.swift b/tools/generators/lib/XCScheme/src/CreateTestAction.swift
@@ -12,6 +12,7 @@ public struct CreateTestAction {
     public func callAsFunction(
         appLanguage: String?,
         appRegion: String?,
+        codeCoverage: Bool,
         buildConfiguration: String,
         commandLineArguments: [CommandLineArgument],
         enableAddressSanitizer: Bool,
@@ -29,6 +30,7 @@ public struct CreateTestAction {
         return callable(
             /*appLanguage:*/ appLanguage,
             /*appRegion:*/ appRegion,
+            /*codeCoverage:*/ codeCoverage,
             /*buildConfiguration:*/ buildConfiguration,
             /*commandLineArguments:*/ commandLineArguments,
             /*enableAddressSanitizer:*/ enableAddressSanitizer,
@@ -52,6 +54,7 @@ extension CreateTestAction {
     public typealias Callable = (
         _ appLanguage: String?,
         _ appRegion: String?,
+        _ codeCoverage: Bool,
         _ buildConfiguration: String,
         _ commandLineArguments: [CommandLineArgument],
         _ enableAddressSanitizer: Bool,
@@ -70,6 +73,7 @@ extension CreateTestAction {
     public static func defaultCallable(
         appLanguage: String?,
         appRegion: String?,
+        codeCoverage: Bool,
         buildConfiguration: String,
         commandLineArguments: [CommandLineArgument],
         enableAddressSanitizer: Bool,
@@ -118,6 +122,9 @@ buildConfiguration = "\#(buildConfiguration)"
         if let appRegion {
             components.append("region = \"\(appRegion)\"")
         }
+        if codeCoverage {
+            components.append("codeCoverageEnabled = \"YES\"")
+        }
 
         let macroExpansion: String
         if let macroReference {

diff --git a/tools/generators/lib/XCScheme/test/CreateTestActionTests.swift b/tools/generators/lib/XCScheme/test/CreateTestActionTests.swift
@@ -417,11 +417,45 @@ final class CreateTestActionTests: XCTestCase {
 
         XCTAssertNoDifference(action, expectedAction)
     }
+
+    func test_codeCoverageEnable() {
+        // Arrange
+
+        let buildConfiguration = "Release"
+        let useLaunchSchemeArgsEnv = false
+
+        let expectedAction = #"""
+   <TestAction
+      buildConfiguration = "Release"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "NO"
+      language = "en"
+      region = "US">
+      <Testables>
+      </Testables>
+   </TestAction>
+"""#
+
+        // Act
+
+        let action = createTestActionWithDefaults(
+            appLanguage: "en",
+            appRegion: "US",
+            buildConfiguration: buildConfiguration,
+            useLaunchSchemeArgsEnv: useLaunchSchemeArgsEnv
+        )
+
+        // Assert
+
+        XCTAssertNoDifference(action, expectedAction)
+    }
 }
 
 private func createTestActionWithDefaults(
     appLanguage: String? = nil,
     appRegion: String? = nil,
+    codeCoverage: Bool = false,
     buildConfiguration: String,
     commandLineArguments: [CommandLineArgument] = [],
     enableAddressSanitizer: Bool = false,
@@ -439,6 +473,7 @@ private func createTestActionWithDefaults(
     return CreateTestAction.defaultCallable(
         appLanguage: appLanguage,
         appRegion: appRegion,
+        codeCoverage: codeCoverage,
         buildConfiguration: buildConfiguration,
         commandLineArguments: commandLineArguments,
         enableAddressSanitizer: enableAddressSanitizer,

diff --git a/tools/generators/xcschemes/src/Generator/AutogenerationConfigArguments.swift b/tools/generators/xcschemes/src/Generator/AutogenerationConfigArguments.swift
@@ -4,6 +4,7 @@ import ToolCommon
 struct AutogenerationConfigArguments {
     let appLanguage: String?
     let appRegion: String?
+    let codeCoverage: Bool
     let schemeNameExcludePatterns: [String]
 
     static func parse(
@@ -21,6 +22,11 @@ struct AutogenerationConfigArguments {
            as: String?.self,
           in: url
       )
+      let codeCoverage = try rawArgs.consumeArg(
+          "code-coverage",
+           as: Bool.self,
+          in: url
+      )
       let schemeNameExcludePatterns = try rawArgs.consumeArgs(
           "scheme-name-exclude-patterns",
           in: url
@@ -29,6 +35,7 @@ struct AutogenerationConfigArguments {
       return AutogenerationConfigArguments(
         appLanguage: appLanguage,
         appRegion: appRegion,
+        codeCoverage: codeCoverage,
         schemeNameExcludePatterns: schemeNameExcludePatterns
       )
     }

diff --git a/tools/generators/xcschemes/src/Generator/CreateCustomSchemeInfos.swift b/tools/generators/xcschemes/src/Generator/CreateCustomSchemeInfos.swift
@@ -639,6 +639,11 @@ set
             as: String?.self,
             in: url
         )
+        let codeCoverage = try consumeArg(
+            "test-code-coverage",
+            as: Bool.self,
+            in: url
+        )
         let xcodeConfiguration = try consumeArg(
             "test-xcode-configuration",
             as: String?.self,
@@ -719,7 +724,8 @@ set
             enableThreadPerformanceChecker: enableThreadPerformanceChecker,
             environmentVariables: environmentVariables,
             options: .init(appLanguage: appLanguage,
-                           appRegion: appRegion),
+                           appRegion: appRegion,
+                           codeCoverage: codeCoverage),
             testTargets: testTargets,
             useRunArgsAndEnv: useRunArgsAndEnv,
             xcodeConfiguration: xcodeConfiguration

diff --git a/tools/generators/xcschemes/src/Generator/CreateScheme.swift b/tools/generators/xcschemes/src/Generator/CreateScheme.swift
@@ -362,6 +362,7 @@ extension Generator.CreateScheme {
             testAction: createTestAction(
                 appLanguage: schemeInfo.test.options?.appLanguage,
                 appRegion: schemeInfo.test.options?.appRegion,
+                codeCoverage: schemeInfo.test.options?.codeCoverage ?? false,
                 buildConfiguration: schemeInfo.test.xcodeConfiguration ??
                     defaultXcodeConfiguration,
                 commandLineArguments: schemeInfo.test.commandLineArguments,

diff --git a/tools/generators/xcschemes/src/Generator/Generator.swift b/tools/generators/xcschemes/src/Generator/Generator.swift
@@ -58,7 +58,8 @@ struct Generator {
             targetsByID: targetsByID,
             targetsByKey: targetsByKey,
             testOptions: .init(appLanguage: autogenerationConfigArguments.appLanguage, 
-                               appRegion: autogenerationConfigArguments.appRegion)
+                               appRegion: autogenerationConfigArguments.appRegion,
+                               codeCoverage: autogenerationConfigArguments.codeCoverage)
         )
 
         let filteredAutomaticSchemeInfos = try automaticSchemeInfos.filter { scheme in

diff --git a/tools/generators/xcschemes/src/Generator/SchemeInfo.swift b/tools/generators/xcschemes/src/Generator/SchemeInfo.swift
@@ -38,6 +38,7 @@ struct SchemeInfo: Equatable {
         struct Options: Equatable {
             let appLanguage: String?
             let appRegion: String?
+            let codeCoverage: Bool
         }
 
         let buildTargets: [Target]

diff --git a/tools/generators/xcschemes/test/CreateAutomaticSchemeInfoTests.swift b/tools/generators/xcschemes/test/CreateAutomaticSchemeInfoTests.swift
@@ -727,7 +727,7 @@ final class CreateAutomaticSchemeInfoTests: XCTestCase {
                 enableMainThreadChecker: false,
                 enableThreadPerformanceChecker: false,
                 environmentVariables: baseEnvironmentVariables,
-                options: .init(appLanguage: "en", appRegion: "US"),
+                options: .init(appLanguage: "en", appRegion: "US", codeCoverage: false),
                 testTargets: [.init(target: test, isEnabled: true)],
                 useRunArgsAndEnv: false,
                 xcodeConfiguration: nil
@@ -761,7 +761,7 @@ final class CreateAutomaticSchemeInfoTests: XCTestCase {
 
         let schemeInfo = try createAutomaticSchemeInfoWithDefaults(
             target: test,
-            testOptions: .init(appLanguage: "en", appRegion: "US")
+            testOptions: .init(appLanguage: "en", appRegion: "US", codeCoverage: false)
         )
 
         // Assert

diff --git a/xcodeproj/internal/xcodeproj_incremental_rule.bzl b/xcodeproj/internal/xcodeproj_incremental_rule.bzl
@@ -219,7 +219,7 @@ def _write_autogeneration_config_file(
     args = actions.args()
     args.set_param_file_format("multiline")
 
-    args.add_all(config.get("test_options", ["", ""]))
+    args.add_all(config.get("test_options", ["", "", False]))
     args.add_all(
         config.get("scheme_name_exclude_patterns", []),
         omit_if_empty = False,

diff --git a/xcodeproj/internal/xcschemes/xcscheme_infos.bzl b/xcodeproj/internal/xcschemes/xcscheme_infos.bzl
@@ -52,10 +52,12 @@ def _make_diagnostics(
 def _make_test_options(
         *,
         app_region = EMPTY_STRING,
-        app_language = EMPTY_STRING):
+        app_language = EMPTY_STRING,
+        code_coverage = FALSE_ARG):
     return struct(
         app_region = app_region,
         app_language = app_language,
+        code_coverage = code_coverage,
     )
 
 def _make_launch_target(
@@ -312,6 +314,7 @@ def _options_info_from_dict(options):
     return _make_test_options(
         app_region = options["app_region"],
         app_language = options["app_language"],
+        code_coverage = options["code_coverage"],
     )
 
 def _env_infos_from_dict(env):