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
|
# Copyright 2022 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.
"""Check the formatting of TODOs."""
import logging
from pathlib import Path
import re
from typing import Iterable, Pattern, Sequence, Union
from pw_presubmit import presubmit_context
from pw_presubmit.presubmit import filter_paths
from pw_presubmit.presubmit_context import PresubmitContext
_LOG: logging.Logger = logging.getLogger(__name__)
EXCLUDE: Sequence[str] = (
# Metadata
r'^docker/tag$',
r'\byarn.lock$',
# Data files
r'\.bin$',
r'\.csv$',
r'\.elf$',
r'\.gif$',
r'\.jpg$',
r'\.json$',
r'\.png$',
r'\.svg$',
r'\.xml$',
)
# todo-check: disable
BUGS_ONLY = re.compile(
r'(?:\bTODO\(b/\d+(?:, ?b/\d+)*\).*\w)|'
r'(?:\bTODO: b/\d+(?:, ?b/\d+)* - )'
)
BUGS_OR_USERNAMES = re.compile(
r"""
(?: # Legacy style.
\bTODO\(
(?:b/\d+|[a-z]+) # Username or bug.
(?:,[ ]?(?:b/\d+|[a-z]+))* # Additional usernames or bugs.
\)
.*\w # Explanation.
)|
(?: # New style.
\bTODO:[ ]
(?:
b/\d+| # Bug.
# Username@ with optional domain.
[a-z]+@(?:[a-z][-a-z0-9]*(?:\.[a-z][-a-z0-9]*)+)?
)
(?:,[ ]? # Additional.
(?:
b/\d+| # Bug.
# Username@ with optional domain.
[a-z]+@(?:[a-z][-a-z0-9]*(?:\.[a-z][-a-z0-9]*)+)?
)
)*
[ ]-[ ].*\w # Explanation.
)
""",
re.VERBOSE,
)
_TODO = re.compile(r'\bTODO\b')
# todo-check: enable
# If seen, ignore this line and the next.
_IGNORE = 'todo-check: ignore'
# Ignore a whole section. Please do not change the order of these lines.
_DISABLE = 'todo-check: disable'
_ENABLE = 'todo-check: enable'
def _process_file(ctx: PresubmitContext, todo_pattern: re.Pattern, path: Path):
with path.open() as ins:
_LOG.debug('Evaluating path %s', path)
enabled = True
prev = ''
try:
summary = []
for i, line in enumerate(ins, 1):
if _DISABLE in line:
enabled = False
elif _ENABLE in line:
enabled = True
if not enabled or _IGNORE in line or _IGNORE in prev:
prev = line
continue
if _TODO.search(line):
if not todo_pattern.search(line):
# todo-check: ignore
ctx.fail(f'Bad TODO on line {i}:', path)
ctx.fail(f' {line.strip()}')
summary.append(
f'{path.relative_to(ctx.root)}:{i}:{line.strip()}'
)
prev = line
if summary:
with ctx.failure_summary_log.open('w') as outs:
for line in summary:
print(line, file=outs)
except UnicodeDecodeError:
# File is not text, like a gif.
_LOG.debug('File %s is not a text file', path)
def create(
todo_pattern: re.Pattern = BUGS_ONLY,
exclude: Iterable[Union[Pattern[str], str]] = EXCLUDE,
):
"""Create a todo_check presubmit step that uses the given pattern."""
@filter_paths(exclude=exclude)
def todo_check(ctx: PresubmitContext):
"""Check that TODO lines are valid.""" # todo-check: ignore
ctx.paths = presubmit_context.apply_exclusions(ctx)
for path in ctx.paths:
_process_file(ctx, todo_pattern, path)
return todo_check
|
