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
|
# Copyright (C) 2021-2022, Benjamin Drung <bdrung@posteo.de>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""Run shellcheck on Shell code."""
import os
import subprocess
import sys
import unittest
from . import get_path, unittest_verbosity
SHELL_SCRIPTS = ["hooks/disable-units", "hooks/enable-units"]
class ShellcheckTestCase(unittest.TestCase):
"""
This unittest class provides a test that runs the shellcheck
on Shell source code.
"""
@unittest.skipIf(os.environ.get("SKIP_LINTERS"), "requested via SKIP_LINTERS env variable")
def test_shellcheck(self) -> None:
"""Test: Run shellcheck on Shell source code."""
cmd = ["shellcheck"] + [get_path(s) for s in SHELL_SCRIPTS]
if unittest_verbosity() >= 2:
sys.stderr.write(f"Running following command:\n{' '.join(cmd)}\n")
with subprocess.Popen(
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True
) as process:
out, err = process.communicate()
if process.returncode != 0: # pragma: no cover
msgs = []
if err:
msgs.append(
f"shellcheck exited with code {process.returncode} "
f"and has unexpected output on stderr:\n{err.decode().rstrip()}"
)
if out:
msgs.append(f"shellcheck found issues:\n{out.decode().rstrip()}")
if not msgs:
msgs.append(
f"shellcheck exited with code {process.returncode} "
"and has no output on stdout or stderr."
)
self.fail("\n".join(msgs))
|
