File: test_except_checks.py

package info (click to toggle)
python-hacking 4.1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 380 kB
  • sloc: python: 1,503; sh: 38; makefile: 23
file content (244 lines) | stat: -rw-r--r-- 8,010 bytes parent folder | download | duplicates (2)
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
232
233
234
235
236
237
238
239
240
241
242
243
244
# 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.

import textwrap
from unittest import mock

import pycodestyle

from hacking.checks import except_checks
from hacking import tests


class ExceptChecksTest(tests.TestCase):

    def _assert_has_errors(self, code, checker, expected_errors=None,
                           filename=None):
        actual_errors = [e[:3] for e in
                         self._run_check(code, checker, filename)]
        self.assertEqual(expected_errors or [], actual_errors)

    # We are patching pycodestyle so that only the check under test is actually
    # installed.
    @mock.patch('pycodestyle._checks',
                {'physical_line': {}, 'logical_line': {}, 'tree': {}})
    def _run_check(self, code, checker, filename=None):
        pycodestyle.register_check(checker)

        lines = textwrap.dedent(code).lstrip().splitlines(True)

        checker = pycodestyle.Checker(filename=filename, lines=lines)
        # NOTE(sdague): the standard reporter has printing to stdout
        # as a normal part of check_all, which bleeds through to the
        # test output stream in an unhelpful way. This blocks that printing.
        with mock.patch('pycodestyle.StandardReport.get_file_results'):
            checker.check_all()
        checker.report._deferred_print.sort()
        return checker.report._deferred_print

    def test_hacking_assert_true_instance(self):
        self.assertEqual(
            len(list(except_checks.hacking_assert_true_instance(
                "self.assertTrue(isinstance(e, "
                "exception.BuildAbortException))"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_instance(
                "self.assertTrue()"
            ))),
            0)

    def test_hacking_assert_equal_in(self):
        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(a in b, True)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual('str' in 'string', True)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(any(a==1 for a in b), True)"
            ))),
            0)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(a in b, True)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual('str' in 'string', True)"
            ))),
            1)

        self.assertEqual(len(list(except_checks.hacking_assert_equal_in(
            "self.assertEqual(any(a==1 for a in b, True))"
        ))),
            0)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(a in b, False)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual('str' in 'string', False)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(any(a==1 for a in b), False)"
            ))),
            0)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(a in b, False)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual('str' in 'string', False)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_in(
                "self.assertEqual(any(a==1 for a in b, False))"
            ))),
            0)

    def test_hacking_assert_true_or_false_with_in_or_not_in(self):
        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A in B)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertFalse(A in B)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A not in B)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertFalse(A not in B)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A in B, 'some message')"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertFalse(A in B, 'some message')"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A not in B, 'some message')"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertFalse(A not in B, 'some message')"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A in 'some string with spaces')"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(A in ['1', '2', '3'])"
            ))),
            1)

        self.assertEqual(len(
            list(except_checks.hacking_assert_true_or_false_with_in(
                 "self.assertTrue(A in [1, 2, 3])"
                 ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(any(A > 5 for A in B))"
            ))),
            0)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertTrue(any(A > 5 for A in B), 'some message')"
            ))),
            0)

        self.assertEqual(
            len(list(except_checks.hacking_assert_true_or_false_with_in(
                "self.assertFalse(some in list1 and some2 in list2)"
            ))),
            0)

    def test_hacking_oslo_assert_raises_regexp(self):
        code = """
               self.assertRaisesRegexp(ValueError,
                                       "invalid literal for.*XYZ'$",
                                       int,
                                       'XYZ')
               """
        self._assert_has_errors(
            code,
            except_checks.hacking_assert_raises_regexp, expected_errors=[
                (1, 0, "H213")
            ])

    def test_hacking_assert_equal_type(self):
        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_type(
                "self.assertEqual(type(als['QuicAssist']), list)"
            ))),
            1)

        self.assertEqual(
            len(list(except_checks.hacking_assert_equal_type(
                "self.assertTrue()"
            ))),
            0)