recipe_modules/bazel_roll/tests/retrieve_attributes.py

# Copyright 2024 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, 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.
"""Test of git behavior in bazel_roll module's retrieve_attributes() method."""

from __future__ import annotations

from typing import TYPE_CHECKING

from PB.recipe_modules.pigweed.bazel_roll.tests.update_value import (
    UpdateValueProperties,
)
from PB.recipe_modules.pigweed.checkout import options as checkout_pb2
from recipe_engine import post_process

if TYPE_CHECKING:  # pragma: no cover
    from typing import Generator
    from recipe_engine import config_types, recipe_test_api

DEPS = [
    'pigweed/bazel_roll',
    'pigweed/checkout',
    'recipe_engine/path',
    'recipe_engine/properties',
    'recipe_engine/step',
]

PROPERTIES = UpdateValueProperties


def RunSteps(api, props):
    options = checkout_pb2.Options(
        remote="https://pigweed.googlesource.com/super"
    )
    equiv = checkout_pb2.EquivalentRemotes()
    equiv.remotes.append("https://pigweed.googlesource.com/pigweed/pigweed")
    equiv.remotes.append("https://pigweed.googlesource.com/pigweed/equiv")
    options.equivalent_remotes.append(equiv)
    checkout = api.checkout(options)

    entries = api.bazel_roll.retrieve_attributes(
        project_value=props.project_remote,
        path=api.path.start_dir / (props.workspace_path or 'WORKSPACE'),
        matches=checkout.remotes_equivalent,
        title_keys=('name', 'module_name'),
    )

    api.step.empty('debug').presentation.step_summary_text = repr(entries)

    for entry in entries:
        name = entry.pop('name', '_unnamed_')
        with api.step.nest(name):
            for key, value in entry.items():
                pres = api.step.empty(key).presentation
                pres.step_summary_text = value


def GenTests(api) -> Generator[recipe_test_api.TestData, None, None]:
    def properties(**kwargs):
        return api.properties(UpdateValueProperties(**kwargs))

    def _url(x: str = 'pigweed/pigweed'):
        assert ':' not in x
        return f'https://pigweed.googlesource.com/{x}'

    yield api.test(
        'success',
        properties(project_remote=_url('pigweed/pigweed')),
        api.post_process(post_process.MustRun, 'pigweed'),
        api.post_process(post_process.MustRun, 'pigweed.remote'),
        api.post_process(post_process.MustRun, 'pigweed.commit'),
        api.post_process(
            post_process.MustRun,
            'pigweed.git_repository_attribute_test',
        ),
    )