recipe_modules/txt_roll/tests/full.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.

from __future__ import annotations

from PB.recipe_modules.pigweed.txt_roll.tests.full import InputProperties

DEPS = [
    "pigweed/checkout",
    "pigweed/roll_util",
    "pigweed/txt_roll",
    "recipe_engine/properties",
    "recipe_engine/step",
]

PROPERTIES = InputProperties


def RunSteps(  # pylint: disable=invalid-name
    api: recipe_api.RecipeScriptApi,
    props: InputProperties,
):
    checkout = api.checkout.fake_context()

    assert len(props.txt_entries) == 1
    txt_entry = props.txt_entries[0]

    rolls = api.txt_roll.update(checkout=checkout, txt_entry=txt_entry)

    if not rolls:
        with api.step.nest('nothing to roll, exiting'):
            return


def GenTests(api) -> Generator[recipe_test_api.TestData, None, None]:
    """Create tests."""

    def _url(x):
        assert ':' not in x
        return 'https://foo.googlesource.com/' + x

    def trigger(url, **kwargs):
        return api.checkout.ci_test_data(git_repo=_url(url), **kwargs)

    def properties(*txt_entries, **kwargs):
        props = InputProperties(**kwargs)
        props.txt_entries.extend(txt_entries)
        return api.properties(props)

    def commit_data(name, **kwargs):
        return api.roll_util.commit_data(
            name,
            api.roll_util.commit('a' * 40, 'foo\nbar\n\nChange-Id: I1111'),
            **kwargs,
        )

    yield api.test(
        'success',
        properties(api.txt_roll.entry(path='foo.txt', remote=_url("foo"))),
        api.roll_util.properties(commit_divider='--divider--'),
        trigger('foo'),
        api.roll_util.forward_roll(),
        commit_data('foo.txt', prefix=''),
    )

    yield api.test(
        'bad-trigger',
        properties(api.txt_roll.entry(path='foo.txt', remote=_url("foo"))),
        trigger('bar'),
        status='FAILURE',
    )

    yield api.test(
        'backwards',
        properties(api.txt_roll.entry(path='foo.txt', remote=_url("foo"))),
        api.roll_util.backward_roll(),
    )