rh/results_unittest.py

#!/usr/bin/env python3
# Copyright 2023 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.

"""Unittests for the results module."""

from pathlib import Path
import sys
import unittest


THIS_FILE = Path(__file__).resolve()
THIS_DIR = THIS_FILE.parent
sys.path.insert(0, str(THIS_DIR.parent))

# We have to import our local modules after the sys.path tweak.  We can't use
# relative imports because this is an executable program, not a module.
# pylint: disable=wrong-import-position
import rh
import rh.results
import rh.utils


COMPLETED_PROCESS_PASS = rh.utils.CompletedProcess(returncode=0)
COMPLETED_PROCESS_FAIL = rh.utils.CompletedProcess(returncode=1)
COMPLETED_PROCESS_WARN = rh.utils.CompletedProcess(returncode=77)


class HookResultTests(unittest.TestCase):
    """Verify behavior of HookResult object."""

    def test_error_warning(self):
        """Check error & warning handling."""
        # No errors.
        result = rh.results.HookResult("hook", "project", "HEAD", False)
        self.assertFalse(result)
        self.assertFalse(result.is_warning())

        # An error.
        result = rh.results.HookResult("hook", "project", "HEAD", True)
        self.assertTrue(result)
        self.assertFalse(result.is_warning())


class HookCommandResultTests(unittest.TestCase):
    """Verify behavior of HookCommandResult object."""

    def test_error_warning(self):
        """Check error & warning handling."""
        # No errors.
        result = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_PASS
        )
        self.assertFalse(result)
        self.assertFalse(result.is_warning())

        # An error.
        result = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_FAIL
        )
        self.assertTrue(result)
        self.assertFalse(result.is_warning())

        # A warning.
        result = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_WARN
        )
        self.assertFalse(result)
        self.assertTrue(result.is_warning())

        # A warning via kwarg.
        result = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_FAIL, warning=True
        )
        self.assertFalse(result)
        self.assertTrue(result.is_warning())


class ProjectResultsTests(unittest.TestCase):
    """Verify behavior of ProjectResults object."""

    def test_error_warning(self):
        """Check error & warning handling."""
        # No errors.
        result = rh.results.ProjectResults("project", "workdir", [])
        self.assertFalse(result)

        # Warnings are not errors.
        result.add_results(
            [
                rh.results.HookResult("hook", "project", "HEAD", False),
                rh.results.HookCommandResult(
                    "hook", "project", "HEAD", COMPLETED_PROCESS_WARN
                ),
            ]
        )
        self.assertFalse(result)

        # Errors are errors.
        result.add_results(
            [
                rh.results.HookResult("hook", "project", "HEAD", True),
            ]
        )
        self.assertTrue(result)

    def test_shared_results_list(self):
        """Check that ProjectResults instances do not share the results list."""
        result1 = rh.results.ProjectResults("project1", "workdir1", [])
        result2 = rh.results.ProjectResults("project2", "workdir2", [])

        result1.add_results(
            [rh.results.HookResult("hook", "project", "HEAD", True)]
        )

        self.assertEqual(len(result1.results), 1)
        self.assertEqual(len(result2.results), 0)

    def test_fixups(self):
        """Check fixups handling."""
        result = rh.results.ProjectResults("project", "workdir", [])

        # A warning with a fixup.
        warn_fix = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_WARN, fixup_cmd=["fix"]
        )
        # An error with a fixup.
        err_fix = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_FAIL, fixup_cmd=["fix"]
        )
        # A warning WITHOUT a fixup.
        warn_no_fix = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_WARN
        )
        # An error WITHOUT a fixup.
        err_no_fix = rh.results.HookCommandResult(
            "hook", "project", "HEAD", COMPLETED_PROCESS_FAIL
        )

        result.add_results([warn_fix, err_fix, warn_no_fix, err_no_fix])

        fixups = list(result.fixups)
        self.assertIn(warn_fix, fixups)
        self.assertIn(err_fix, fixups)
        self.assertNotIn(warn_no_fix, fixups)
        self.assertNotIn(err_no_fix, fixups)


if __name__ == "__main__":
    unittest.main()