recipe_modules/submodule_roll/test_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.
"""Test API for submodule_roll."""

from __future__ import annotations

from PB.recipe_modules.pigweed.submodule_roll.submodule import SubmoduleEntry
from recipe_engine import recipe_test_api


class SubmoduleRollTestApi(recipe_test_api.RecipeTestApi):
    """Test API for submodule_roll."""

    def _url(self, x):
        if x.startswith(('https://', 'sso://', '.')):
            return x
        return 'https://foo.googlesource.com/' + x

    def submodules(self, *subs):
        res = []
        for sub in subs:
            if isinstance(sub, str):
                res.append(SubmoduleEntry(path=sub))
            elif isinstance(sub, dict):
                res.append(SubmoduleEntry(**sub))
            else:
                raise ValueError(repr(sub))  # pragma: no cover
        return res

    def gitmodules(self, **submodules):
        branches = {}
        for k, v in submodules.items():
            if k.endswith('_branch'):
                branches[k.replace('_branch', '')] = v

        for x in branches:
            del submodules[f'{x}_branch']

        text = []
        for k, v in submodules.items():
            text.append(
                '[submodule "{0}"]\n\tpath = {0}\n\turl = {1}\n'.format(
                    k, self._url(v)
                )
            )
            if k in branches:
                text.append(f'\tbranch = {branches[k]}\n')

        return self.step_data(
            'read .gitmodules', self.m.file.read_text(''.join(text))
        )

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