ndk/test/result.py

#
# Copyright (C) 2017 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.
#
"""Test result classes."""
from typing import Any

import ndk.termcolor


# TODO: Need to resolve the circular import between this and ndk.test.types.
Test = Any


class TestResult:
    def __init__(self, test: Test):
        self.test = test

    def __repr__(self) -> str:
        return self.to_string(colored=False)

    def passed(self) -> bool:
        raise NotImplementedError

    def failed(self) -> bool:
        raise NotImplementedError

    def to_string(self, colored: bool = False) -> str:
        raise NotImplementedError


class Failure(TestResult):
    def __init__(self, test: Test, message: str) -> None:
        super().__init__(test)
        self.message = message

    def passed(self) -> bool:
        return False

    def failed(self) -> bool:
        return True

    def to_string(self, colored: bool = False) -> str:
        label = ndk.termcolor.maybe_color('FAIL', 'red', colored)
        return f'{label} {self.test.name} [{self.test.config}]: {self.message}'


class Success(TestResult):
    def passed(self) -> bool:
        return True

    def failed(self) -> bool:
        return False

    def to_string(self, colored: bool = False) -> str:
        label = ndk.termcolor.maybe_color('PASS', 'green', colored)
        return f'{label} {self.test.name} [{self.test.config}]'


class Skipped(TestResult):
    def __init__(self, test: Test, reason: str) -> None:
        super().__init__(test)
        self.reason = reason

    def passed(self) -> bool:
        return False

    def failed(self) -> bool:
        return False

    def to_string(self, colored: bool = False) -> str:
        label = ndk.termcolor.maybe_color('SKIP', 'yellow', colored)
        return f'{label} {self.test.name} [{self.test.config}]: {self.reason}'


class ExpectedFailure(TestResult):
    def __init__(self, test: Test, broken_config: str, bug: str) -> None:
        super().__init__(test)
        self.broken_config = broken_config
        self.bug = bug

    def passed(self) -> bool:
        return True

    def failed(self) -> bool:
        return False

    def to_string(self, colored: bool = False) -> str:
        label = ndk.termcolor.maybe_color('KNOWN FAIL', 'yellow', colored)
        return (f'{label} {self.test.name} [{self.test.config}]: '
                f'known failure for {self.broken_config} ({self.bug})')


class UnexpectedSuccess(TestResult):
    def __init__(self, test: Test, broken_config: str, bug: str) -> None:
        super().__init__(test)
        self.broken_config = broken_config
        self.bug = bug

    def passed(self) -> bool:
        return False

    def failed(self) -> bool:
        return True

    def to_string(self, colored: bool = False) -> str:
        label = ndk.termcolor.maybe_color('SHOULD FAIL', 'red', colored)
        return (f'{label} {self.test.name} [{self.test.config}]: '
                f'unexpected success for {self.broken_config} ({self.bug})')