recipe_modules/util/test_api.py

# Copyright 2021 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 util."""

from __future__ import annotations

from recipe_engine import recipe_test_api


class UtilTestApi(recipe_test_api.RecipeTestApi):
    """Test API for util."""

    def change_comment(self, comment, prefix='gerrit'):
        if prefix and not prefix.endswith('.'):
            prefix += '.'
        return self.step_data(
            f'{prefix}list change comments',
            self.m.json.output({'/PATCHSET_LEVEL': [{'message': comment}]}),
        )