mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 13:21:25 -07:00
Add support for enhanced code-smell tests. (#36332)
* Add support for enhanced code-smell tests: - Path selection handled by ansible-test. - Optional path filtering based on extension. - Optional path filtering based on prefixes. - Optional lint friendly output. * Enhance no-assert code-smell test. * Enhance no-tests-as-filters code-smell test.
This commit is contained in:
parent
ce80485ecd
commit
2b6ac4561b
5 changed files with 105 additions and 53 deletions
|
@ -1,40 +1,29 @@
|
|||
#!/usr/bin/env python
|
||||
from __future__ import print_function
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
|
||||
from collections import defaultdict
|
||||
|
||||
PATH = 'lib/ansible'
|
||||
ASSERT_RE = re.compile(r'.*(?<![-:a-zA-Z#][ -])\bassert\b(?!:).*')
|
||||
|
||||
all_matches = defaultdict(list)
|
||||
|
||||
for dirpath, dirnames, filenames in os.walk(PATH):
|
||||
for filename in filenames:
|
||||
path = os.path.join(dirpath, filename)
|
||||
if not os.path.isfile(path) or not path.endswith('.py'):
|
||||
continue
|
||||
def main():
|
||||
failed = False
|
||||
|
||||
for path in sys.argv[1:]:
|
||||
with open(path, 'r') as f:
|
||||
for i, line in enumerate(f.readlines()):
|
||||
matches = ASSERT_RE.findall(line)
|
||||
|
||||
if matches:
|
||||
all_matches[path].append((i + 1, line.index('assert') + 1, matches))
|
||||
failed = True
|
||||
lineno = i + 1
|
||||
colno = line.index('assert') + 1
|
||||
print('%s:%d:%d: raise AssertionError instead of: %s' % (path, lineno, colno, matches[0][colno - 1:]))
|
||||
|
||||
if failed:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if all_matches:
|
||||
print('Use of assert in production code is not recommended.')
|
||||
print('Python will remove all assert statements if run with optimizations')
|
||||
print('Alternatives:')
|
||||
print(' if not isinstance(value, dict):')
|
||||
print(' raise AssertionError("Expected a dict for value")')
|
||||
|
||||
for path, matches in all_matches.items():
|
||||
for line_matches in matches:
|
||||
for match in line_matches[2]:
|
||||
print('%s:%d:%d: %s' % ((path,) + line_matches[:2] + (match,)))
|
||||
sys.exit(1)
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue