kumquat-buildroot/utils/checkpackagelib/lib_shellscript.py

from checkpackagelib.lib import ConsecutiveEmptyLines  # noqa: F401
from checkpackagelib.lib import EmptyLastLine          # noqa: F401
from checkpackagelib.lib import NewlineAtEof           # noqa: F401
from checkpackagelib.lib import TrailingSpace          # noqa: F401
from checkpackagelib.tool import Shellcheck            # noqa: F401
utils/check-package: check all shell scripts Currently only SysV init scripts are checked using shellcheck and a few other rules (e.g. variable naming, file naming). Extend the check using shellcheck to all shell scripts in the tree. This is actually limited to the list of directories that check-package knows that can check, but that list can be expanded later. In order to apply the check to all shell scripts, use python3-magic to determine the file type. Unfortunately, there are two different python modules called "magic". Support both by detecting which one is installed and defining get_filetype accordingly. Keep testing first for name pattern, and only in the case there is no match, check the file type. This ensures, for instance, that SysV init scripts follow specific rules. Apply these checks for shell scripts: - shellcheck; - trailing space; - consecutive empty lines; - empty last line on file; - newline at end of file. Update the list of ignored warnings. Do not add unit tests since no function was added, they were just reused. But expand the runtime test for check-package using as fixture a file that generates a shellcheck warning. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> [Arnout: support both variants of the "magic" module] Signed-off-by: Arnout Vandecappelle <arnout@mind.be> 2022-07-31 21:35:14 +02:00			`from checkpackagelib.lib import ConsecutiveEmptyLines # noqa: F401`
			`from checkpackagelib.lib import EmptyLastLine # noqa: F401`
			`from checkpackagelib.lib import NewlineAtEof # noqa: F401`
			`from checkpackagelib.lib import TrailingSpace # noqa: F401`
			`from checkpackagelib.tool import Shellcheck # noqa: F401`