recipe_modules/property_roll/test_api.py

# Copyright 2026 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 property_roll."""

from __future__ import annotations

from collections.abc import Sequence

from recipe_engine import recipe_test_api

from PB.recipe_modules.pigweed.property_roll.property_entry import PropertyEntry


class PropertyRollTestApi(recipe_test_api.RecipeTestApi):
    """Test API for property_roll."""

    def entry(
        self,
        dest: str,
        *,
        project: str | None = None,
        bucket: str = 'ci',
        builder: str = 'foo-builder',
        properties: Sequence[str] = (),
    ) -> PropertyEntry:
        """Returns a helper PropertyEntry message."""
        return PropertyEntry(
            project=project or 'pigweed',
            bucket=bucket,
            builder=builder,
            properties=list(properties),
            destination_path=dest,
        )