1
0
mirror of https://github.com/pi-hole/pi-hole synced 2024-12-22 14:58:08 +00:00

Adding failing shellcheck test and results

Should be useful for showing others why other changes were made in the next commit.
This commit is contained in:
diginc 2016-10-10 23:18:05 -05:00
parent a03caea549
commit 97c44042e1
2 changed files with 153 additions and 0 deletions

View File

@ -0,0 +1,140 @@
============================= test session starts ==============================
platform linux2 -- Python 2.7.6, pytest-2.9.2, py-1.4.31, pluggy-0.3.1 -- /usr/bin/python
cachedir: .cache
rootdir: /home/a/opensource/pi-hole, inifile:
plugins: cov-2.3.0, bdd-2.17.0, xdist-1.14, testinfra-1.4.0
collecting ... collected 7 items
test/test_000_build_containers.py::test_build_pihole_image[test/debian.Dockerfile-pytest_pihole:debian] PASSED
test/test_000_build_containers.py::test_build_pihole_image[test/centos.Dockerfile-pytest_pihole:centos] PASSED
test/test_automated_install.py::test_setupVars_are_sourced_to_global_scope[debian] PASSED
test/test_automated_install.py::test_setupVars_are_sourced_to_global_scope[centos] PASSED
test/test_automated_install.py::test_setupVars_saved_to_file[debian] PASSED
test/test_automated_install.py::test_setupVars_saved_to_file[centos] PASSED
test/test_shellcheck.py::test_scripts_pass_shellcheck FAILED
=================================== FAILURES ===================================
_________________________ test_scripts_pass_shellcheck _________________________
def test_scripts_pass_shellcheck():
''' Make sure shellcheck does not find anything wrong with our shell scripts '''
shellcheck = "find . -name 'basic-install.sh' | while read file; do shellcheck \"$file\"; done;"
results = run_local(shellcheck)
print results.stdout
> assert '' == results.stdout
E assert '' == '\nIn ./automated install/bas...C may run when A is true.\n\n'
E +
E + In ./automated install/basic-install.sh line 79:
E + INSTALLER_DEPS=( apt-utils whiptail git dhcpcd5)
E + ^-- SC2034: INSTALLER_DEPS appears unused. Verify it or export it.
E +
E +
E + In ./automated install/basic-install.sh line 80:
E + PIHOLE_DEPS=( dnsutils bc dnsmasq lighttpd ${phpVer}-common ${phpVer}-cgi curl unzip wget sudo netcat cron iproute2 )
E + ^-- SC2034: PIHOLE_DEPS appears unused. Verify it or export it.
E Detailed information truncated (91 more lines), use "-vv" to show
test/test_shellcheck.py:13: AssertionError
----------------------------- Captured stdout call -----------------------------
In ./automated install/basic-install.sh line 79:
INSTALLER_DEPS=( apt-utils whiptail git dhcpcd5)
^-- SC2034: INSTALLER_DEPS appears unused. Verify it or export it.
In ./automated install/basic-install.sh line 80:
PIHOLE_DEPS=( dnsutils bc dnsmasq lighttpd ${phpVer}-common ${phpVer}-cgi curl unzip wget sudo netcat cron iproute2 )
^-- SC2034: PIHOLE_DEPS appears unused. Verify it or export it.
In ./automated install/basic-install.sh line 86:
dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed" || ${PKG_INSTALL} "$1"
^-- SC2016: Expressions don't expand in single quotes, use double quotes for that.
In ./automated install/basic-install.sh line 100:
INSTALLER_DEPS=( iproute net-tools procps-ng newt git )
^-- SC2034: INSTALLER_DEPS appears unused. Verify it or export it.
In ./automated install/basic-install.sh line 101:
PIHOLE_DEPS=( epel-release bind-utils bc dnsmasq lighttpd lighttpd-fastcgi php-common php-cli php curl unzip wget findutils cronie sudo nmap-ncat )
^-- SC2034: PIHOLE_DEPS appears unused. Verify it or export it.
In ./automated install/basic-install.sh line 120:
while [ "$(ps a | awk '{print $1}' | grep "$pid")" ]; do
^-- SC2143: Instead of [ -n $(foo | grep bar) ], use foo | grep -q bar .
In ./automated install/basic-install.sh line 214:
chooseInterfaceOptions=$("${chooseInterfaceCmd[@]}" "${interfacesArray[@]}" 2>&1 >/dev/tty)
^-- SC2069: The order of the 2>&1 and the redirect matters. The 2>&1 has to be last.
In ./automated install/basic-install.sh line 241:
choices=$("${cmd[@]}" "${options[@]}" 2>&1 >/dev/tty)
^-- SC2069: The order of the 2>&1 and the redirect matters. The 2>&1 has to be last.
In ./automated install/basic-install.sh line 354:
cp "${IFCFG_FILE}" "${IFCFG_FILE}".backup-"$(date +%Y-%m-%d-%H%M%S)"
^-- SC2140: The double quotes around this do nothing. Remove or escape them.
In ./automated install/basic-install.sh line 408:
DNSchoices=$("${DNSChooseCmd[@]}" "${DNSChooseOptions[@]}" 2>&1 >/dev/tty)
^-- SC2069: The order of the 2>&1 and the redirect matters. The 2>&1 has to be last.
In ./automated install/basic-install.sh line 585:
systemctl stop "${1}" &> /dev/null & spinner $! || true
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 587:
service "${1}" stop &> /dev/null & spinner $! || true
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 598:
systemctl restart "${1}" &> /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 600:
service "${1}" restart &> /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 610:
systemctl enable "${1}" &> /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 612:
update-rc.d "${1}" defaults &> /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 631:
${UPDATE_PKG_CACHE} &> /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 688:
git clone -q --depth 1 "${2}" "${1}" > /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 696:
git pull -q > /dev/null & spinner $!
^-- SC2086: Double quote to prevent globbing and word splitting.
In ./automated install/basic-install.sh line 761:
id -u pihole &> /dev/null && echo "::: User 'pihole' already exists" || (echo "::: User 'pihole' doesn't exist. Creating..." && useradd -r -s /usr/sbin/nologin pihole)
^-- SC2015: Note that A && B || C is not if-then-else. C may run when A is true.
===================== 1 failed, 6 passed in 20.79 seconds ======================

13
test/test_shellcheck.py Normal file
View File

@ -0,0 +1,13 @@
import pytest
import testinfra
run_local = testinfra.get_backend(
"local://"
).get_module("Command").run
def test_scripts_pass_shellcheck():
''' Make sure shellcheck does not find anything wrong with our shell scripts '''
shellcheck = "find . -name 'basic-install.sh' | while read file; do shellcheck \"$file\"; done;"
results = run_local(shellcheck)
print results.stdout
assert '' == results.stdout