pw_presubmit/py/presubmit_test.py

#!/usr/bin/env python3
# Copyright 2020 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.
"""Tests for presubmit tools."""

import dataclasses
import re
import unittest

from pw_presubmit import presubmit


class TestFileFilter(unittest.TestCase):
    """Test FileFilter class"""
    @dataclasses.dataclass
    class TestData:
        filter: presubmit.FileFilter
        value: str
        expected: bool

    test_scenarios = (
        TestData(presubmit.FileFilter(endswith=('bar', 'foo')), 'foo', True),
        TestData(presubmit.FileFilter(endswith=('bar', 'boo')), 'foo', False),
        TestData(
            presubmit.FileFilter(exclude=(re.compile('a/.+'), ),
                                 name=('foo', )), '/a/b/c/foo', False),
        TestData(
            presubmit.FileFilter(exclude=(re.compile('x/.+'), ),
                                 name=('foo', )), '/a/b/c/foo', True),
        TestData(
            presubmit.FileFilter(exclude=(re.compile('a+'), re.compile('b+'))),
            'cccc', True),
        TestData(presubmit.FileFilter(name=('foo', )), 'foo', True),
        TestData(presubmit.FileFilter(name=('foo', )), 'food', False),
        TestData(presubmit.FileFilter(name=(re.compile('foo'), )), 'foo',
                 True),
        TestData(presubmit.FileFilter(name=(re.compile('foo'), )), 'food',
                 False),
        TestData(presubmit.FileFilter(name=(re.compile('fo+'), )), 'foo',
                 True),
        TestData(presubmit.FileFilter(name=(re.compile('fo+'), )), 'fd',
                 False),
        TestData(presubmit.FileFilter(suffix=('.exe', )), 'a/b.py/foo.exe',
                 True),
        TestData(presubmit.FileFilter(suffix=('.py', )), 'a/b.py/foo.exe',
                 False),
        TestData(presubmit.FileFilter(suffix=('.exe', )), 'a/b.py/foo.py.exe',
                 True),
        TestData(presubmit.FileFilter(suffix=('.py', )), 'a/b.py/foo.py.exe',
                 False),
        TestData(presubmit.FileFilter(suffix=('.a', '.b')), 'foo.b', True),
        TestData(presubmit.FileFilter(suffix=('.a', '.b')), 'foo.c', False),
    )

    def test_matches(self):
        for test_num, test_data in enumerate(self.test_scenarios):
            with self.subTest(i=test_num):
                self.assertEqual(test_data.filter.matches(test_data.value),
                                 test_data.expected)


def _fake_function_1(_):
    """Fake presubmit function."""


def _fake_function_2(_):
    """Fake presubmit function."""


class ProgramsTest(unittest.TestCase):
    """Tests the presubmit Programs abstraction."""
    def setUp(self):
        self._programs = presubmit.Programs(
            first=[_fake_function_1, (), [(_fake_function_2, )]],
            second=[_fake_function_2],
        )

    def test_empty(self):
        self.assertEqual({}, presubmit.Programs())

    def test_access_present_members(self):
        self.assertEqual('first', self._programs['first'].name)
        self.assertEqual((_fake_function_1, _fake_function_2),
                         tuple(self._programs['first']))

        self.assertEqual('second', self._programs['second'].name)
        self.assertEqual((_fake_function_2, ), tuple(self._programs['second']))

    def test_access_missing_member(self):
        with self.assertRaises(KeyError):
            _ = self._programs['not_there']

    def test_all_steps(self):
        self.assertEqual(
            {
                '_fake_function_1': _fake_function_1,
                '_fake_function_2': _fake_function_2,
            }, self._programs.all_steps())


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