carbon-lang/toolchain/install/pkg_helpers.bzl

# Part of the Carbon Language project, under the Apache License v2.0 with LLVM
# Exceptions. See /LICENSE for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

"""Rule to create variables for package naming."""

load("@rules_pkg//pkg:providers.bzl", "PackageVariablesInfo")
load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
load("@rules_python//python:defs.bzl", "py_test")
load("//bazel/version:compute_version.bzl", "VERSION_ATTRS", "compute_version")

def _pkg_naming_variables_impl(ctx):
    # TODO: Add support for digging the target CPU out of the toolchain here,
    # remapping it to a more canonical name, and add that to the variables. The
    # Bazel target CPU is already directly available, but it isn't likely
    # canonical.
    # TODO: Include the target OS as well as the target CPU. This likely needs
    # similar re-mapping as the CPU does.
    return PackageVariablesInfo(values = {
        "version": compute_version(ctx),
    })

pkg_naming_variables = rule(
    implementation = _pkg_naming_variables_impl,
    attrs = VERSION_ATTRS,
)

def pkg_tar_and_test(name_base, package_file_name_base, test_data, test_install_marker, **kwargs):
    """Create a `pkg_tar` and a test for both `.tar` and `.tar.gz` extensions.

    Args:
        name_base:
            The base name of the rules and tests. Will have `tar` or `tar_gz` added
            and then `_rule` for the `pkg_tar` and `_test` for the test.
        package_file_name_base:
            The base of the `package_file_name` attribute to `pkg_tar`. The file
            extensions will be appended after a `.`.
        test_data:
            The test data to verify the tar file against.
        test_install_marker:
            The install marker within the test data to locate the installation.
        **kwargs:
            Passed to `pkg_tar` for all the rest of its attributes.
    """
    for file_ext in ["tar", "tar.gz"]:
        target_ext = file_ext.replace(".", "_")
        tar_target = name_base + "_" + target_ext + "_rule"
        pkg_tar(
            name = tar_target,
            extension = file_ext,
            package_file_name = package_file_name_base + "." + file_ext,
            # The compressed tar is slow, exclude building and testing that.
            tags = ["manual"] if file_ext == "tar.gz" else [],
            **kwargs
        )

        py_test(
            name = name_base + "_" + target_ext + "_test",
            size = "small",
            srcs = ["toolchain_tar_test.py"],
            data = [":" + tar_target, test_install_marker] + test_data,
            args = [
                "$(location :{})".format(tar_target),
                "$(location {})".format(test_install_marker),
            ],
            main = "toolchain_tar_test.py",
            # The compressed tar is slow, exclude building and testing that.
            tags = ["manual"] if file_ext == "tar.gz" else [],
        )