mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
05220d693d
* Add text/binary file support to code smell tests. * Enhance line-endings code smell test. * Enhance no-smart-quotes code-smell test. * Enhance shebang code-smell test.
75 lines
2.2 KiB
Python
Executable file
75 lines
2.2 KiB
Python
Executable file
#!/usr/bin/env python
|
|
|
|
import os
|
|
import sys
|
|
|
|
|
|
def main():
|
|
allowed = set([
|
|
b'#!/bin/bash -eu',
|
|
b'#!/bin/bash -eux',
|
|
b'#!/bin/bash',
|
|
b'#!/bin/sh',
|
|
b'#!/usr/bin/env bash',
|
|
b'#!/usr/bin/env fish',
|
|
b'#!/usr/bin/env pwsh',
|
|
b'#!/usr/bin/env python',
|
|
b'#!/usr/bin/make -f',
|
|
])
|
|
|
|
module_shebangs = {
|
|
'': b'#!/usr/bin/python',
|
|
'.py': b'#!/usr/bin/python',
|
|
'.ps1': b'#!powershell',
|
|
}
|
|
|
|
skip = set([
|
|
'hacking/cherrypick.py',
|
|
])
|
|
|
|
for path in sys.argv[1:] or sys.stdin.read().splitlines():
|
|
if path in skip:
|
|
continue
|
|
|
|
with open(path, 'rb') as path_fd:
|
|
shebang = path_fd.readline().strip()
|
|
|
|
if not shebang:
|
|
continue
|
|
|
|
if not shebang.startswith(b'#!'):
|
|
continue
|
|
|
|
is_module = False
|
|
|
|
if path.startswith('lib/ansible/modules/'):
|
|
is_module = True
|
|
elif path.startswith('test/integration/targets/'):
|
|
dirname = os.path.dirname(path)
|
|
|
|
if dirname.endswith('/library') or dirname in (
|
|
# non-standard module library directories
|
|
'test/integration/targets/module_precedence/lib_no_extension',
|
|
'test/integration/targets/module_precedence/lib_with_extension',
|
|
):
|
|
is_module = True
|
|
|
|
if is_module:
|
|
ext = os.path.splitext(path)[1]
|
|
expected_shebang = module_shebangs.get(ext)
|
|
expected_ext = ' or '.join(['"%s"' % k for k in module_shebangs])
|
|
|
|
if expected_shebang:
|
|
if shebang == expected_shebang:
|
|
continue
|
|
|
|
print('%s:%d:%d: expected module shebang "%s" but found: %s' % (path, 1, 1, expected_shebang, shebang))
|
|
else:
|
|
print('%s:%d:%d: expected module extension %s but found: %s' % (path, 0, 0, expected_ext, ext))
|
|
else:
|
|
if shebang not in allowed:
|
|
print('%s:%d:%d: unexpected non-module shebang: %s' % (path, 1, 1, shebang))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|