build/bazel_sdk/bazel_rules_fuchsia/fuchsia/private/assembly/providers.bzl

# Copyright 2022 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Assembly related Providers."""

load("//fuchsia/private:providers.bzl", _FuchsiaProductBundleInfo = "FuchsiaProductBundleInfo")

FuchsiaAssembledPackageInfo = provider(
    "Packages that can be included into a product. It consists of the package and the corresponding config data.",
    fields = {
        "package": "The base package",
        "configs": "A list of configs that is attached to packages",
        "files": "Files needed by package and config files.",
    },
)

FuchsiaConfigDataInfo = provider(
    "The  config data which is used in assembly.",
    fields = {
        "source": "Config file on host",
        "destination": "A String indicating the path to find the file in the package on the target",
    },
)

FuchsiaProductConfigInfo = provider(
    doc = "A product-info used to containing the product_config.json and deps.",
    fields = {
        "product_config": "The JSON product configuration file.",
        "build_type": "The build type of the product.",
    },
)

FuchsiaBoardInputBundleInfo = provider(
    doc = "A board input bundle info used to containing the board input bundle directory",
    fields = {
        "config": "The config file located in the root directory containing Board Input Bundle.",
        "files": "All files belong to Board Input Bundles",
    },
)

def _board_config_info_init(*, board_config):
    if not board_config:
        fail("board_config may not be empty")
    return {"board_config": board_config}

FuchsiaBoardConfigInfo, _new_board_config_info = provider(
    doc = "A board-info used to containing only the board_config.json",
    fields = {
        "board_config": "The JSON board configuration file.",
    },
    init = _board_config_info_init,
)

def _board_config_directory_info_init(*, config_directory):
    if not config_directory:
        fail("config_directory may not be empty")
    return {"config_directory": config_directory}

FuchsiaBoardConfigDirectoryInfo, _new_board_config_directory_info = provider(
    doc = "A prebuilt board configuration in a directory, containing the board_config.json and deps",
    fields = {
        "config_directory": "The directory containing the board_config file and the main HardwareSupportBundle",
    },
    init = _board_config_directory_info_init,
)

FuchsiaAssemblyConfigInfo = provider(
    doc = "Private provider that includes a single JSON configuration file.",
    fields = {
        "config": "JSON configuration file",
    },
)

FuchsiaSizeCheckerInfo = provider(
    doc = """Size reports created by size checker tool.""",
    fields = {
        "size_budgets": "size_budgets.json file",
        "size_report": "size_report.json file",
        "verbose_output": "verbose version of size report file",
    },
)

FuchsiaVirtualDeviceInfo = provider(
    doc = "A virtual device spec file which is a single JSON configuration file.",
    fields = {
        "device_name": "Name of the virtual device",
        "config": "JSON configuration file",
        "template": "QEMU start up arguments template",
    },
)

FuchsiaProductAssemblyBundleInfo = provider(
    doc = """A bundle of files used by product assembly.""",
    fields = {
        "root": "The root directory for these artifacts",
        "files": "All files contained in the bundle",
    },
)

FuchsiaProductImageInfo = provider(
    doc = "Info needed to pave a Fuchsia image",
    fields = {
        "images_out": "images out directory",
        "product_assembly_out": "product assembly out directory",
        "platform_aibs": "platform aibs file listing path to platform AIBS",
        "build_type": "The build type of the product",
    },
)

FuchsiaUpdatePackageInfo = provider(
    doc = "Info for created update package",
    fields = {
        "update_out": "update out directory",
    },
)

FuchsiaProductAssemblyInfo = provider(
    doc = "Info populated by product assembly",
    fields = {
        "product_assembly_out": "product assembly out directory",
        "platform_aibs": "platform aibs file listing path to platform AIBS",
        "build_type": "The build type of the product",
    },
)

FuchsiaProductBundleInfo = _FuchsiaProductBundleInfo

FuchsiaPartitionInfo = provider(
    doc = "Mapping of images to partitions.",
    fields = {
        "partition": "partition in dict",
    },
)

FuchsiaScrutinyConfigInfo = provider(
    doc = "A set of scrutiny configs.",
    fields = {
        "bootfs_files": "Set of files expected in bootfs",
        "bootfs_packages": "Set of packages expected in bootfs",
        "kernel_cmdline": "Set of cmdline args expected to be passed to the kernel",
        "component_tree_config": "Tree of expected component routes",
        "routes_config_golden": "Config file for route resources validation",
        "component_resolver_allowlist": "Allowlist of components that can be resolved using privileged component resolvers",
        "component_route_exceptions": "Allowlist of all capability routes that are exempt from route checking",
        "static_packages": "Set of base and cache packages expected in the fvm",
        "structured_config_policy": "File describing the policy of structured config",
        "pre_signing_policy": "File describing the policy of checks required before signing",
        "pre_signing_goldens_dir": "Path to directory containing golden files for pre-signing checks",
        "pre_signing_goldens": "List of golden files for pre-signing checks to be used as build inputs",
    },
)

FuchsiaRepositoryKeysInfo = provider(
    doc = "A directory containing Fuchsia TUF repository keys.",
    fields = {"dir": "Path to the directory"},
)

FuchsiaOmahaOtaConfigInfo = provider(
    doc = "OTA configuration data for products that use the Omaha client.",
    fields = {
        "channels": "The omaha channel configuration data.",
        "tuf_repositories": "A dict of TUF repository configurations, by hostname.",
    },
)