Support Starlark rules_android (#1333)

* Support Starlark rules_android

* Revert

* Formatting

* Add missing _lcov_merger attr

* More clean up

* More clean up and fixes

* More cleanup

* More cleanup

* More cleanup

* More cleanup and fixes

* More

* Fixes

* More fixes

* More fixes

* Fixes

Author: Bencodes

examples/android/MODULE.bazel

@@ -7,6 +7,11 @@ bazel_dep(name = "rules_java", version = "8.9.0")
 bazel_dep(name = "rules_kotlin", version = "1.9.5")
 bazel_dep(name = "rules_jvm_external", version = "6.6")
 
+android_sdk_repository_extension = use_extension("@rules_android//rules/android_sdk_repository:rule.bzl", "android_sdk_repository_extension")
+use_repo(android_sdk_repository_extension, "androidsdk")
+
+register_toolchains("@androidsdk//:sdk-toolchain", "@androidsdk//:all")
+
 maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
 maven.install(
     name = "maven_rules_kotlin_example",

examples/android/libKtAndroid/src/test/java/examples/android/lib/BUILD.bazel

@@ -3,7 +3,7 @@ load("@rules_kotlin//kotlin:android.bzl", "kt_android_local_test")
 kt_android_local_test(
     name = "SomeTest",
     srcs = ["SomeTest.kt"],
-    associates = ["//libKtAndroid:my_kt_kt"],
+    associates = ["//libKtAndroid:my_kt"],
     custom_package = "examples.android.lib",
     jvm_flags = [
         "-Djava.security.manager=allow",

kotlin/android.bzl

@@ -1,6 +1,9 @@
 load(
-    "//kotlin/internal/jvm:android.bzl",
+    "//kotlin/internal/jvm:kt_android_library.bzl",
     _kt_android_library = "kt_android_library",
+)
+load(
+    "//kotlin/internal/jvm:kt_android_local_test.bzl",
     _kt_android_local_test = "kt_android_local_test",
 )
 

kotlin/internal/jvm/android.bzl

@@ -11,123 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-load(
-    "@rules_android//android:rules.bzl",
-    _android_library = "android_library",
-    _android_local_test = "android_local_test",
-)
-load(
-    "//kotlin/internal/jvm:jvm.bzl",
-    _kt_jvm_library = "kt_jvm_library",
-)
+load(":kt_android_library.bzl", _kt_android_library = "kt_android_library")
+load(":kt_android_local_test_impl.bzl", _kt_android_local_test = "kt_android_local_test")
 
-_ANDROID_SDK_JAR = "%s" % Label("//third_party:android_sdk")
-
-def _kt_android_artifact(
-        name,
-        srcs = [],
-        deps = [],
-        resources = [],
-        plugins = [],
-        associates = [],
-        module_name = "",
-        kotlinc_opts = None,
-        javac_opts = None,
-        enable_data_binding = False,
-        tags = [],
-        exec_properties = None,
-        **kwargs):
-    """Delegates Android related build attributes to the native rules but uses the Kotlin builder to compile Java and
-    Kotlin srcs. Returns a sequence of labels that a wrapping macro should export.
-    """
-    base_name = name + "_base"
-    kt_name = name + "_kt"
-
-    # TODO(bazelbuild/rules_kotlin/issues/273): This should be retrieved from a provider.
-    base_deps = [_ANDROID_SDK_JAR] + deps
-
-    _android_library(
-        name = base_name,
-        visibility = ["//visibility:private"],
-        exports = base_deps,
-        deps = deps if enable_data_binding else [],
-        enable_data_binding = enable_data_binding,
-        tags = tags,
-        exec_properties = exec_properties,
-        **kwargs
-    )
-    _kt_jvm_library(
-        name = kt_name,
-        srcs = srcs,
-        deps = [base_name] + base_deps,
-        resources = resources,
-        plugins = plugins,
-        associates = associates,
-        module_name = module_name,
-        testonly = kwargs.get("testonly", default = False),
-        visibility = ["//visibility:public"],
-        kotlinc_opts = kotlinc_opts,
-        javac_opts = javac_opts,
-        tags = tags,
-        exec_properties = exec_properties,
-    )
-    return [base_name, kt_name]
-
-def kt_android_library(name, exports = [], visibility = None, exec_properties = None, **kwargs):
-    """Creates an Android sandwich library.
-
-    `srcs`, `deps`, `plugins` are routed to `kt_jvm_library` the other android
-    related attributes are handled by the native `android_library` rule.
-    """
-
-    _android_library(
-        name = name,
-        exports = exports + _kt_android_artifact(name, exec_properties = exec_properties, **kwargs),
-        visibility = visibility,
-        tags = kwargs.get("tags", default = None),
-        testonly = kwargs.get("testonly", default = 0),
-        exec_properties = exec_properties,
-    )
-
-def kt_android_local_test(
-        name,
-        jvm_flags = None,
-        manifest = None,
-        manifest_values = None,
-        test_class = None,
-        size = None,
-        data = None,
-        timeout = None,
-        flaky = False,
-        shard_count = None,
-        visibility = None,
-        testonly = True,
-        exec_properties = None,
-        nocompress_extensions = None,
-        **kwargs):
-    """Creates a testable Android sandwich library.
-
-    `srcs`, `deps`, `plugins`, `associates` are routed to `kt_jvm_library` the other android
-    related attributes are handled by the native `android_library` rule while the test attributes
-    are picked out and handled by the `android_local_test` rule.
-    """
-
-    _android_local_test(
-        name = name,
-        deps = kwargs.get("deps", []) + _kt_android_artifact(name = name, testonly = testonly, exec_properties = exec_properties, **kwargs),
-        jvm_flags = jvm_flags,
-        test_class = test_class,
-        visibility = visibility,
-        size = size,
-        data = data,
-        timeout = timeout,
-        flaky = flaky,
-        shard_count = shard_count,
-        custom_package = kwargs.get("custom_package", default = None),
-        manifest = manifest,
-        manifest_values = manifest_values,
-        tags = kwargs.get("tags", default = None),
-        testonly = testonly,
-        exec_properties = exec_properties,
-        nocompress_extensions = nocompress_extensions,
-    )
+kt_android_library = _kt_android_library
+kt_android_local_test = _kt_android_local_test

kotlin/internal/jvm/compile.bzl

@@ -272,7 +272,7 @@ def _fold_jars_action(ctx, rule_kind, toolchains, output_jar, input_jars, action
         toolchain = _TOOLCHAIN_TYPE,
     )
 
-def _resourcejar_args_action(ctx):
+def _resourcejar_args_action(ctx, extra_resources = {}):
     res_cmd = []
     for f in ctx.files.resources:
         target_path = _adjust_resources_path(f.short_path, ctx.attr.resource_strip_prefix)
@@ -283,20 +283,31 @@ def _resourcejar_args_action(ctx):
             f_path = f.path,
         )
         res_cmd.extend([line])
+
+    for key, value in extra_resources.items():
+        target_path = _adjust_resources_path(value.short_path, ctx.label.package)
+        if target_path[0] == "/":
+            target_path = target_path[1:]
+        line = "{target_path}={res_path}\n".format(
+            res_path = value.path,
+            target_path = key,
+        )
+        res_cmd.extend([line])
+
     zipper_args_file = ctx.actions.declare_file("%s_resources_zipper_args" % ctx.label.name)
     ctx.actions.write(zipper_args_file, "".join(res_cmd))
     return zipper_args_file
 
-def _build_resourcejar_action(ctx):
+def _build_resourcejar_action(ctx, extra_resources = {}):
     """sets up an action to build a resource jar for the target being compiled.
     Returns:
         The file resource jar file.
     """
     resources_jar_output = ctx.actions.declare_file(ctx.label.name + "-resources.jar")
-    zipper_args = _resourcejar_args_action(ctx)
+    zipper_args = _resourcejar_args_action(ctx, extra_resources)
     ctx.actions.run_shell(
         mnemonic = "KotlinZipResourceJar",
-        inputs = ctx.files.resources + [zipper_args],
+        inputs = ctx.files.resources + extra_resources.values() + [zipper_args],
         tools = [ctx.executable._zipper],
         outputs = [resources_jar_output],
         command = "{zipper} c {resources_jar_output} @{path}".format(
@@ -570,27 +581,57 @@ def _run_kt_builder_action(
 
 # MAIN ACTIONS #########################################################################################################
 
-def kt_jvm_produce_jar_actions(ctx, rule_kind):
+def _kt_jvm_produce_jar_actions(ctx, rule_kind, extra_resources = {}):
+    """Setup The actions to compile a jar and if any resources or resource_jars were provided to merge these in with the
+    compilation output.
+
+    Returns:
+        see `kt_jvm_compile_action`.
+    """
+    deps = getattr(ctx.attr, "deps", [])
+    associates = getattr(ctx.attr, "associates", [])
+    _fail_if_invalid_associate_deps(associates, deps)
+    compile_deps = _jvm_deps_utils.jvm_deps(
+        ctx,
+        toolchains = _compiler_toolchains(ctx),
+        associate_deps = associates,
+        deps = deps,
+        exports = getattr(ctx.attr, "exports", []),
+        runtime_deps = getattr(ctx.attr, "runtime_deps", []),
+    )
+
+    outputs = struct(
+        jar = ctx.outputs.jar,
+        srcjar = ctx.outputs.srcjar,
+    )
+
+    # Setup the compile action.
+    return _kt_jvm_produce_output_jar_actions(
+        ctx,
+        rule_kind = rule_kind,
+        compile_deps = compile_deps,
+        outputs = outputs,
+        extra_resources = extra_resources,
+    )
+
+def _kt_jvm_produce_output_jar_actions(
+        ctx,
+        rule_kind,
+        compile_deps,
+        outputs,
+        extra_resources = {}):
     """This macro sets up a compile action for a Kotlin jar.
 
     Args:
         ctx: Invoking rule ctx, used for attr, actions, and label.
         rule_kind: The rule kind --e.g., `kt_jvm_library`.
+        compile_deps: The rule kind --e.g., `kt_jvm_library`.
     Returns:
         A struct containing the providers JavaInfo (`java`) and `kt` (KtJvmInfo). This struct is not intended to be
         used as a legacy provider -- rather the caller should transform the result.
     """
     toolchains = _compiler_toolchains(ctx)
     srcs = _partitioned_srcs(ctx.files.srcs)
-    _fail_if_invalid_associate_deps(ctx.attr.associates, ctx.attr.deps)
-    compile_deps = _jvm_deps_utils.jvm_deps(
-        ctx,
-        toolchains = toolchains,
-        associate_deps = ctx.attr.associates,
-        deps = ctx.attr.deps,
-        exports = getattr(ctx.attr, "exports", []),
-        runtime_deps = getattr(ctx.attr, "runtime_deps", []),
-    )
 
     annotation_processors = _plugin_mappers.targets_to_annotation_processors(ctx.attr.plugins + ctx.attr.deps)
     ksp_annotation_processors = _plugin_mappers.targets_to_ksp_annotation_processors(ctx.attr.plugins + ctx.attr.deps)
@@ -627,12 +668,12 @@ def kt_jvm_produce_jar_actions(ctx, rule_kind):
     annotation_processing = outputs_struct.annotation_processing
 
     # If this rule has any resources declared setup a zipper action to turn them into a jar.
-    if len(ctx.files.resources) > 0:
-        output_jars.append(_build_resourcejar_action(ctx))
+    if len(ctx.files.resources) + len(extra_resources) > 0:
+        output_jars.append(_build_resourcejar_action(ctx, extra_resources))
     output_jars.extend(ctx.files.resource_jars)
 
     # Merge outputs into final runtime jar.
-    output_jar = ctx.actions.declare_file(ctx.label.name + ".jar")
+    output_jar = outputs.jar
     _fold_jars_action(
         ctx,
         rule_kind = rule_kind,
@@ -644,7 +685,7 @@ def kt_jvm_produce_jar_actions(ctx, rule_kind):
 
     source_jar = java_common.pack_sources(
         ctx.actions,
-        output_source_jar = ctx.outputs.srcjar,
+        output_source_jar = outputs.srcjar,
         sources = srcs.kt + srcs.java,
         source_jars = srcs.src_jars + generated_src_jars,
         java_toolchain = toolchains.java,
@@ -928,14 +969,15 @@ def _create_annotation_processing(annotation_processors, ap_class_jar, ap_source
         )
     return None
 
-def export_only_providers(ctx, actions, attr, outputs):
+def _export_only_providers(ctx, actions, attr, outputs):
     """_export_only_providers creates a series of forwarding providers without compilation overhead.
 
     Args:
         ctx: kt_compiler_ctx
         actions: invoking rule actions,
         attr: kt_compiler_attributes,
         outputs: kt_compiler_outputs
+
     Returns:
         kt_compiler_result
     """
@@ -987,3 +1029,11 @@ def export_only_providers(ctx, actions, attr, outputs):
             extensions = ["kt", "java"],
         ),
     )
+
+compile = struct(
+    compiler_toolchains = _compiler_toolchains,
+    verify_associates_not_duplicated_in_deps = _fail_if_invalid_associate_deps,
+    export_only_providers = _export_only_providers,
+    kt_jvm_produce_output_jar_actions = _kt_jvm_produce_output_jar_actions,
+    kt_jvm_produce_jar_actions = _kt_jvm_produce_jar_actions,
+)

kotlin/internal/jvm/impl.bzl

@@ -24,8 +24,7 @@ load(
 )
 load(
     "//kotlin/internal/jvm:compile.bzl",
-    "export_only_providers",
-    _kt_jvm_produce_jar_actions = "kt_jvm_produce_jar_actions",
+    _compile = "compile",
 )
 load(
     "//kotlin/internal/utils:utils.bzl",
@@ -41,6 +40,7 @@ def _make_providers(ctx, providers, runfiles_targets, transitive_files = depset(
     files = [ctx.outputs.jar]
     if providers.java.outputs.jdeps:
         files.append(providers.java.outputs.jdeps)
+
     return [
         providers.java,
         providers.kt,
@@ -224,7 +224,7 @@ def kt_jvm_library_impl(ctx):
         )
     return _make_providers(
         ctx,
-        _kt_jvm_produce_jar_actions(ctx, "kt_jvm_library") if ctx.attr.srcs or ctx.attr.resources else export_only_providers(
+        _compile.kt_jvm_produce_jar_actions(ctx, "kt_jvm_library") if ctx.attr.srcs or ctx.attr.resources else _compile.export_only_providers(
             ctx = ctx,
             actions = ctx.actions,
             outputs = ctx.outputs,
@@ -234,7 +234,7 @@ def kt_jvm_library_impl(ctx):
     )
 
 def kt_jvm_binary_impl(ctx):
-    providers = _kt_jvm_produce_jar_actions(ctx, "kt_jvm_binary")
+    providers = _compile.kt_jvm_produce_jar_actions(ctx, "kt_jvm_binary")
     jvm_flags = []
     if hasattr(ctx.fragments.java, "default_jvm_opts"):
         jvm_flags = ctx.fragments.java.default_jvm_opts
@@ -269,7 +269,7 @@ _SPLIT_STRINGS = [
 ]
 
 def kt_jvm_junit_test_impl(ctx):
-    providers = _kt_jvm_produce_jar_actions(ctx, "kt_jvm_test")
+    providers = _compile.kt_jvm_produce_jar_actions(ctx, "kt_jvm_test")
     runtime_jars = depset(ctx.files._bazel_test_runner, transitive = [providers.java.transitive_runtime_jars])
 
     coverage_runfiles = []

kotlin/internal/jvm/jvm.bzl

@@ -249,6 +249,7 @@ _common_attr = utils.add_dicts(
             providers = [_JavacOptions],
             mandatory = False,
         ),
+        "_use_auto_exec_groups": attr.bool(default = False),
     },
 )
 
@@ -659,3 +660,8 @@ kt_plugin_cfg = rule(
         ),
     },
 )
+
+attrs = struct(
+    lib_common_attr = _lib_common_attr,
+    runnable_common_attr = _runnable_common_attr,
+)

kotlin/internal/jvm/jvm_deps.bzl

@@ -21,9 +21,9 @@ load("//kotlin/internal/utils:sets.bzl", _sets = "sets")
 def _java_info(target):
     return target[JavaInfo] if JavaInfo in target else None
 
-def _jvm_deps(ctx, toolchains, associate_deps, deps, exports = [], runtime_deps = []):
+def _jvm_deps(ctx, toolchains, associate_deps, deps = [], deps_java_infos = [], exports = [], runtime_deps = []):
     """Encapsulates jvm dependency metadata."""
-    dep_infos = [_java_info(d) for d in deps] + [toolchains.kt.jvm_stdlibs]
+    dep_infos = deps_java_infos + [_java_info(d) for d in deps] + [toolchains.kt.jvm_stdlibs]
 
     associates = _associate_utils.get_associates(ctx, toolchains = toolchains, associates = associate_deps)