126 lines
4.6 KiB
Python
Executable File
126 lines
4.6 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
import os
|
|
import stat
|
|
import sys
|
|
|
|
|
|
def main():
|
|
standard_shebangs = set([
|
|
b'#!/bin/bash -eu',
|
|
b'#!/bin/bash -eux',
|
|
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',
|
|
])
|
|
|
|
integration_shebangs = set([
|
|
b'#!/bin/sh',
|
|
b'#!/usr/bin/env bash',
|
|
b'#!/usr/bin/env python',
|
|
])
|
|
|
|
module_shebangs = {
|
|
'': b'#!/usr/bin/python',
|
|
'.py': b'#!/usr/bin/python',
|
|
'.ps1': b'#!powershell',
|
|
}
|
|
|
|
skip = set([
|
|
'test/integration/targets/collections/collection_root_user/ansible_collections/testns/testcoll/plugins/modules/win_csbasic_only.ps1',
|
|
'test/integration/targets/collections/collection_root_user/ansible_collections/testns/testcoll/plugins/modules/win_selfcontained.ps1',
|
|
'test/integration/targets/collections/collection_root_user/ansible_collections/testns/testcoll/plugins/modules/win_uses_coll_csmu.ps1',
|
|
'test/integration/targets/collections/collection_root_user/ansible_collections/testns/testcoll/plugins/modules/win_uses_coll_psmu.ps1',
|
|
'test/integration/targets/win_module_utils/library/legacy_only_new_way_win_line_ending.ps1',
|
|
'test/integration/targets/win_module_utils/library/legacy_only_old_way_win_line_ending.ps1',
|
|
'test/utils/shippable/timing.py',
|
|
'test/integration/targets/old_style_modules_posix/library/helloworld.sh',
|
|
# The following are Python 3.6+. Only run by release engineers
|
|
'hacking/build-ansible',
|
|
])
|
|
|
|
# see https://unicode.org/faq/utf_bom.html#bom1
|
|
byte_order_marks = (
|
|
(b'\x00\x00\xFE\xFF', 'UTF-32 (BE)'),
|
|
(b'\xFF\xFE\x00\x00', 'UTF-32 (LE)'),
|
|
(b'\xFE\xFF', 'UTF-16 (BE)'),
|
|
(b'\xFF\xFE', 'UTF-16 (LE)'),
|
|
(b'\xEF\xBB\xBF', 'UTF-8'),
|
|
)
|
|
|
|
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()
|
|
mode = os.stat(path).st_mode
|
|
executable = (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH) & mode
|
|
|
|
if not shebang or not shebang.startswith(b'#!'):
|
|
if executable:
|
|
print('%s:%d:%d: file without shebang should not be executable' % (path, 0, 0))
|
|
|
|
for mark, name in byte_order_marks:
|
|
if shebang.startswith(mark):
|
|
print('%s:%d:%d: file starts with a %s byte order mark' % (path, 0, 0, name))
|
|
break
|
|
|
|
continue
|
|
|
|
is_module = False
|
|
is_integration = False
|
|
|
|
if path.startswith('lib/ansible/modules/'):
|
|
is_module = True
|
|
elif path.startswith('lib/') or path.startswith('test/runner/lib/'):
|
|
if executable:
|
|
print('%s:%d:%d: should not be executable' % (path, 0, 0))
|
|
|
|
if shebang:
|
|
print('%s:%d:%d: should not have a shebang' % (path, 0, 0))
|
|
|
|
continue
|
|
elif path.startswith('test/integration/targets/'):
|
|
is_integration = True
|
|
|
|
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:
|
|
if executable:
|
|
print('%s:%d:%d: module should not be executable' % (path, 0, 0))
|
|
|
|
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 is_integration:
|
|
allowed = integration_shebangs
|
|
else:
|
|
allowed = standard_shebangs
|
|
|
|
if shebang not in allowed:
|
|
print('%s:%d:%d: unexpected non-module shebang: %s' % (path, 1, 1, shebang))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|