recipes/copy_roller.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.
"""Automatically copy a file from one repository to another."""

from __future__ import annotations

import re
from typing import TYPE_CHECKING

import attrs
from PB.go.chromium.org.luci.buildbucket.proto import common as common_pb2
from PB.recipes.pigweed.copy_roller import InputProperties
from PB.recipe_modules.pigweed.checkout.options import (
    Options as CheckoutOptions,
)
from recipe_engine import post_process

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

DEPS = [
    'fuchsia/auto_roller',
    'pigweed/checkout',
    'recipe_engine/file',
    'recipe_engine/path',
    'recipe_engine/properties',
]

PROPERTIES = InputProperties


def RunSteps(  # pylint: disable=invalid-name
    api: recipe_api.RecipeScriptApi,
    props: InputProperties,
):
    # The checkout module will try to use trigger data to pull in a specific
    # patch. Since the triggering commit is in a different repository that
    # needs to be disabled.
    props.checkout_options.use_trigger = False
    checkout = api.checkout(props.checkout_options)

    project_dir = api.path.start_dir / 'project'
    project_checkout = api.checkout(
        CheckoutOptions(
            remote=props.source_project_remote,
            branch=props.source_project_branch or 'main',
            use_trigger=True,
        ),
        root=project_dir,
    )

    value = api.file.read_raw('read', project_dir / props.source_path)
    api.file.write_raw(
        'write',
        checkout.root / props.destination_path,
        value,
    )

    commit_message: str = f'roll: {props.destination_path}'

    try:
        value_string = value.decode().strip()
        if '\n' not in value_string:
            new_commit_message = f'{commit_message}: {value_string}'
            if len(new_commit_message) <= 72:
                commit_message = new_commit_message

    except UnicodeDecodeError:  # pragma: no cover
        pass

    change = api.auto_roller.attempt_roll(
        props.auto_roller_options,
        repo_dir=checkout.root,
        commit_message=commit_message,
    )

    return api.auto_roller.raw_result(change)


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

    def properties(**kwargs):
        props = InputProperties(**kwargs)
        props.source_project_remote = 'http://host/source'
        props.source_path = 'path/to/source.txt'
        props.destination_path = 'path/to/destination.txt'
        props.checkout_options.CopyFrom(api.checkout.git_options())
        props.auto_roller_options.CopyFrom(
            api.auto_roller.Options(remote=api.checkout.pigweed_repo)
        )
        return api.properties(props)

    yield api.test(
        'success',
        properties(),
        api.step_data('read', api.file.read_raw(b'v1.0')),
        api.auto_roller.success(),
    )