summaryrefslogtreecommitdiff
path: root/pylint/test/unittest_utils.py
blob: 7034429bbcd6123bb479012a63999ae5fb95b6de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# Copyright (c) 2003-2016 LOGILAB S.A. (Paris, FRANCE).
# http://www.logilab.fr/ -- mailto:contact@logilab.fr
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING

import re
import unittest
import warnings

import astroid

from pylint import __pkginfo__
from pylint import utils
from pylint import interfaces
from pylint.checkers.utils import check_messages
from pylint.exceptions import InvalidMessageError


class PyLintASTWalkerTest(unittest.TestCase):
    class MockLinter(object):
        def __init__(self, msgs):
            self._msgs = msgs

        def is_message_enabled(self, msgid):
            return self._msgs.get(msgid, True)

    class Checker(object):
        def __init__(self):
            self.called = set()

        @check_messages('first-message')
        def visit_module(self, module):
            self.called.add('module')

        @check_messages('second-message')
        def visit_call(self, module):
            raise NotImplementedError

        @check_messages('second-message', 'third-message')
        def visit_assignname(self, module):
            self.called.add('assname')

        @check_messages('second-message')
        def leave_assignname(self, module):
            raise NotImplementedError

    def test_check_messages(self):
        linter = self.MockLinter({'first-message': True,
                                  'second-message': False,
                                  'third-message': True})
        walker = utils.PyLintASTWalker(linter)
        checker = self.Checker()
        walker.add_checker(checker)
        walker.walk(astroid.parse("x = func()"))
        self.assertEqual(set(['module', 'assname']), checker.called)

    def test_deprecated_methods(self):
        class Checker(object):
            def __init__(self):
                self.called = False

            @check_messages('first-message')
            def visit_assname(self, node):
                self.called = True

        linter = self.MockLinter({'first-message': True})
        walker = utils.PyLintASTWalker(linter)
        checker = Checker()
        walker.add_checker(checker)
        with warnings.catch_warnings(record=True):
            warnings.simplefilter('always')
            walker.walk(astroid.parse("x = 1"))

            self.assertFalse(checker.called)


class RegexBlacklistTest(unittest.TestCase):
    def test__basename_in_blacklist_re_match(self):
        patterns = [re.compile(".*enchilada.*"), re.compile("unittest_.*")]
        self.assertTrue(utils._basename_in_blacklist_re("unittest_utils.py", patterns))
        self.assertTrue(utils._basename_in_blacklist_re("cheese_enchiladas.xml", patterns))

    def test__basename_in_blacklist_re_nomatch(self):
        patterns = [re.compile(".*enchilada.*"), re.compile("unittest_.*")]
        self.assertFalse(utils._basename_in_blacklist_re("test_utils.py", patterns))
        self.assertFalse(utils._basename_in_blacklist_re("enchilad.py", patterns))


class MessagesStoreRegisterMessagesTest(unittest.TestCase):
    def setUp(self):
        self.store = utils.MessagesStore()

    def test_register_error_inconsistent_checker_id(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description'),
                'W4321': ('message two', 'msg-symbol-two', 'msg description'),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         r"Inconsistent checker part in message id 'W4321' (expected 'x12xx')")

    def test_register_error_new_id_duplicate_of_new(self):
        class CheckerOne(object):
            name = 'checker_one'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description.'),
                }
        class CheckerTwo(object):
            name = 'checker_two'
            msgs = {
                'W1234': ('message two', 'msg-symbol-two', 'another msg description.'),
                }
        self.store.register_messages(CheckerOne())
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(CheckerTwo())
        self.assertEqual(str(cm.exception),
                         "Message id 'W1234' is already defined")

    def test_register_error_new_id_duplicate_of_old(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1233': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1234', 'old-symbol')]}),
                'W1234': ('message one', 'msg-symbol-one', 'msg description'),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message id 'W1234' is already defined")

    def test_register_error_old_id_duplicate_of_new(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description'),
                'W1235': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1234', 'old-symbol')]}),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message id 'W1234' is already defined")

    def test_register_error_old_id_duplicate_of_old(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description',
                          {'old_names': [('W1201', 'old-symbol-one')]}),
                'W1235': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1201', 'old-symbol-two')]}),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message id 'W1201' is already defined")


    def test_register_error_new_symbol_duplicate_of_new(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol', 'msg description'),
                'W1235': ('message two', 'msg-symbol', 'msg description'),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message symbol 'msg-symbol' is already defined")

    def test_register_error_new_symbol_duplicate_of_old(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1233': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1230', 'msg-symbol-one')]}),
                'W1234': ('message one', 'msg-symbol-one', 'msg description'),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message symbol 'msg-symbol-one' is already defined")

    def test_register_error_old_symbol_duplicate_of_new(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description'),
                'W1235': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1230', 'msg-symbol-one')]}),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message symbol 'msg-symbol-one' is already defined")

    def test_register_error_old_symbol_duplicate_of_old(self):
        class Checker(object):
            name = 'checker'
            msgs = {
                'W1234': ('message one', 'msg-symbol-one', 'msg description',
                          {'old_names': [('W1230', 'old-symbol-one')]}),
                'W1235': ('message two', 'msg-symbol-two', 'msg description',
                          {'old_names': [('W1231', 'old-symbol-one')]}),
            }
        with self.assertRaises(InvalidMessageError) as cm:
            self.store.register_messages(Checker())
        self.assertEqual(str(cm.exception),
                         "Message alternate name 'old-symbol-one' is already defined")

class MessageDefinitionTest(unittest.TestCase):
    def test_create_invalid_msgid(self):
        with self.assertRaises(InvalidMessageError) as cm:
            utils.MessageDefinition('checker', 'W12345',
                                    'msg', 'descr', 'symbol', 'scope')
        self.assertEqual(str(cm.exception),
                         "Invalid message id 'W12345'")

    def test_create_invalid_message_type(self):
        with self.assertRaises(InvalidMessageError) as cm:
            utils.MessageDefinition('checker', 'Q1234',
                                    'msg', 'descr', 'symbol', 'scope')
        self.assertEqual(str(cm.exception),
                         "Bad message type Q in 'Q1234'")

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