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

import configparser
import dataclasses
import io
import re
from typing import TYPE_CHECKING

from PB.recipe_modules.pigweed.checkout.options import (
    Options as CheckoutOptions,
)
from recipe_engine import recipe_api

if TYPE_CHECKING:  # pragma: no cover
    from typing import Generator
    from PB.recipe_modules.pigweed.txt_roll.txt_entry import TxtEntry
    from RECIPE_MODULES.fuchsia.git_roll_util import api as git_roll_util_api
    from RECIPE_MODULES.pigweed.checkout import api as checkout_api


class TxtRollApi(recipe_api.RecipeApi):

    def update(
        self,
        checkout: checkout_api.CheckoutContext,
        txt_entry: TxtEntry,
    ) -> list[git_roll_util_api.Roll]:
        with self.m.step.nest(txt_entry.path):
            branch = txt_entry.branch or 'main'

            new_revision = self.m.git_roll_util.resolve_new_revision(
                txt_entry.remote,
                branch,
                checkout.remotes_equivalent,
            )

            full_txt_path = checkout.root / txt_entry.path

            old_revision = self.m.file.read_text(
                'read old revision',
                full_txt_path,
                test_data='1' * 40,
            ).strip()

            with self.m.step.nest('txt_path') as pres:
                pres.step_summary_text = repr(txt_entry.path)

            try:
                roll = self.m.git_roll_util.get_roll(
                    repo_url=txt_entry.remote,
                    repo_short_name=txt_entry.path,
                    old_rev=old_revision,
                    new_rev=new_revision,
                )

            except self.m.git_roll_util.BackwardsRollError:
                return []

            self.m.file.write_text(
                'write new revision', full_txt_path, f'{new_revision}\n'
            )

            return [roll]