libraries/annotations/src/py/DesktopTest.py

#  Copyright (C) 2024 The Android Open Source Project
#
#  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
#
#       http://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.

"""DesktopTest decorator."""

from typing import List


class DesktopTest(object):
  """Marks the type of test with purpose of asserting Desktop requirements and cujs.

  Args:
      requirements: the list of Desktop requirements.
      cujs: the list of Desktop cujs.
      manual: The list of manual tests that this test case provides full or
        partial coverage for. This is used to track the automation progress of
        manual tests.
      alpeid: The list of alpe (context: b/447658460) ids that this test case provides coverage for.
        To override the test count, an entry of the form "test_count:N" can be
        added, where N is the number of tests. This is intended for generator
        functions that generate multiple tests but are counted as one.

  Example with requirements and cujs:
      @DesktopTest(requirements=['D-0-1', 'D-0-2'], cujs=['cuj-1', 'cuj-2'])

  Example with alpeid and test_count override:
      @DesktopTest(alpeid=['gpu-1', 'gpu-2', 'test_count:5'])

  Example with alpeid without test_count override:
      @DesktopTest(alpeid=['gpu-1', 'gpu-2'])
  """

  def __init__(
      self,
      requirements: List[str] = [],
      cujs: List[str] = [],
      manual: List[str] = [],
      alpeid: List[str] = [],
  ):
    self._requirements = requirements
    self._cujs = cujs
    self._manual = manual
    self._alpeid = alpeid

  def __call__(self, func):
    return func