Code linting with shellcheck

check.sh

@@ -45,12 +45,12 @@ col_set() {
 	fi
 	if [ "$color" -gt 0 ]
 	then
-		tput setaf $1
+		tput setaf "$1"
 	fi
 }
 
 log() {
-	echo "$(col_set $3)[$(printf "%7s" "$1")]$(col_reset) $2"
+	echo "$(col_set "$3")[$(printf "%7s" "$1")]$(col_reset) $2"
 }
 
 datetime() {
@@ -58,7 +58,7 @@ datetime() {
 }
 
 logdate() {
-	echo "$(date -Iseconds) $(col_set $3)[$(printf "%7s" "$1")]$(col_reset) $2"
+	echo "$(date -Iseconds) $(col_set "$3")[$(printf "%7s" "$1")]$(col_reset) $2"
 }
 
 fail() {
@@ -150,7 +150,6 @@ TC_RUN() {
 	_test_setup
 	cmd=$1
 	shift
-	args=""
 	case $#
 	in
 		1)$cmd "$1";;
@@ -159,10 +158,9 @@ TC_RUN() {
 		4)$cmd "$1" "$2" "$3" "$4";;
 		*)fail "To many arguments for $cmd"
 	esac
-	#$cmd $args
 
-	tc_run=$(expr $tc_run + 1)
-	total_run=$(expr $total_run + 1)
+	tc_run=$(( tc_run + 1))
+	total_run=$(( total_run + 1))
 	if [ "$test_status" -ne 0 ]
 	then
 		err_type="FAIL"
@@ -170,14 +168,14 @@ TC_RUN() {
 		then
 			err_type="ERR"
 		fi
-		tc_fail=$(expr $tc_fail + 1)
-		total_fail=$(expr $total_fail + 1)
+		tc_fail=$(( tc_fail + 1))
+		total_fail=$(( total_fail + 1))
 		logdate $err_type "$tc_name: $test_msg" 1 >&2
 	elif [ "$verbose" -gt 1 ]
 	then
 		logdate OK "$tc_name: $test_msg" 2
 	else
-		echo -n '.'
+		printf '.'
 	fi
 }
 
@@ -186,7 +184,7 @@ CHECK_START() {
 }
 
 CHECK_REPORT() {
-	if [ "$verbose" -eq 0 -a "$tc_fail" -eq "0" ]
+	if [ "$verbose" -eq 0 ] && [ "$tc_fail" -eq "0" ]
 	then
 		echo "" # for dot printed with -n
 	fi
@@ -221,7 +219,7 @@ _check_http_status() {
 	fi
 	shift 1
 
-	status=$(curl -s -o /dev/null -w "%{http_code}" $* $url)
+	status=$(curl -s -o /dev/null -w "%{http_code}" "$@" "$url")
 	if [ "$status" -ne "$expt" ]
 	then
 		fail "Check http status $expt for $url : $status returned" 
@@ -234,24 +232,24 @@ _check_http_status() {
 check_http_status() {
 	# $1 url
 	# $2 status
-	_check_http_status $1 $2
+	_check_http_status "$1" "$2"
 }
 
 check_http_200() {
-	_check_http_status $1 200
+	_check_http_status "$1" 200
 }
 
 check_https_cert() {
 	# Check that SSL Cert is valid
 	# $1 URL
-	status=$(curl -s -o /dev/null -w "%{http_code}" https://$1)
+	status=$(curl -s -o /dev/null -w "%{http_code}" "https://$1")
 	rep=$?
 	if [ "$rep" -eq 0 ]
 	then
 		success "https://$1 cert verified"
 		return
 	fi
-	status=$(curl -k -s -o /dev/null -q "%{http_code}" https://$1)
+	status=$(curl -k -s -o /dev/null -q "%{http_code}" "https://$1")
 	rep=$?
 	if [ "$rep" -eq 0 ]
 	then
@@ -273,15 +271,16 @@ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 		<xsl:template match="/">
 				<xsl:value-of select="/html/head/title"/>
 		</xsl:template>
-</xsl:stylesheet>' > $tmpxsl
+</xsl:stylesheet>' > "$tmpxsl"
 
 	tmphtml=$(mktemp -t html.XXXXXXXXX)
 
-	curl --silent $url > $tmphtml
-	title=$(xsltproc --html --novalid $tmpxsl $tmphtml 2>/dev/null)
-	if [ "$?" -ne "0" ]
+	curl --silent "$url" > "$tmphtml"
+	if title=$(xsltproc --html --novalid "$tmpxsl" "$tmphtml" 2>/dev/null)
 	then
-		title=$(xsltproc --novalid $tmpxsl $tmphtml 2>/dev/null)
+		:
+	else
+		title=$(xsltproc --novalid "$tmpxsl" "$tmphtml" 2>/dev/null)
 	fi
 
 	if [ "$title" = "$expt" ]
@@ -291,7 +290,7 @@ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 		fail "$url HTML title is '$title' but '$expt' expected"
 	fi
 
-	rm $tmpxsl $tmphtml 2>/dev/null
+	rm "$tmpxsl" "$tmphtml" 2>/dev/null
 }
 
 check_audiostream() {
@@ -299,12 +298,12 @@ check_audiostream() {
 	# and attempt to decode it.
 	# $1 Stream URL
 
-	MPLAYER="`which mplayer`"
-	MPV="`which mpv`"
-	if [ -x $MPLAYER ]
+	MPLAYER="$(which mplayer)"
+	MPV="$(which mpv)"
+	if [ -x "$MPLAYER" ]
 	then
 		check_audiostream_mplayer "$1"
-	elif [ -x $MPV ]
+	elif [ -x "$MPV" ]
 	then
 		check_audiostream_mpv "$1"
 	else
@@ -327,21 +326,21 @@ check_audiostream_mplayer() {
 	MPLAYER="$3"
 	if [ -z "$MPLAYER" ]
 	then
-		MPLAYER="`which mplayer`"
+		MPLAYER="$(which mplayer)"
 	fi
 
 	sz_kb="${sz}kb"
-	expt_sz="`expr $sz \* 8`"
+	expt_sz="$(( sz * 8 ))"
 
 	if [ "$verbose" -gt 1 ]
 	then
 		logdate INFO "$tc_name: Running mplayer on '$1' for $sz_kb" 3
 	fi
 
-	$MPLAYER -endpos $sz_kb -ao pcm:file=$tmpfile "$1" 1>/dev/null 2>/dev/null
-	res=$?
-	bytes=$(du -b $tmpfile | cut -f1)
-	rm $tmpfile 2>/dev/null
+	$MPLAYER -endpos "$sz_kb" -ao "pcm:file=$tmpfile" "$1" 1>/dev/null 2>/dev/null
+	res="$?"
+	bytes=$(du -b "$tmpfile" | cut -f1)
+	rm "$tmpfile" 2>/dev/null
 
 	if [ "$bytes" -lt $expt_sz ]
 	then
@@ -370,7 +369,7 @@ check_audiostream_mpv() {
 	MPV="$3"
 	if [ -z "$MPV" ]
 	then
-		MPV="`which mpv`"
+		MPV="$(which mpv)"
 	fi
 
 
@@ -378,19 +377,19 @@ check_audiostream_mpv() {
 	then
 		logdate INFO "$tc_name: Running mpv on '$1' for ${time}s" 3
 	fi
-	start_time=`date "+%s"`
+	start_time=$(date "+%s")
 	$MPV --vo=null --ao=null --o=/dev/null --of=wav --length $time "$1" 1> /dev/null 2>/dev/null
 	res=$?
-	stop_time=`date "+%s"`
-	run_time=`expr $stop_time - $start_time`
+	stop_time=$(date "+%s")
+	run_time=$(( stop_time - start_time))
 
-	if [ $run_time -lt $time ]
+	if [ "$run_time" -lt "$time" ]
 	then
 		fail "mpv stopped running ${run_time} after launch but ${time}s should be received"
 		return
 	fi
 	
-	if [ $res -eq 0 ]
+	if [ "$res" -eq 0 ]
 	then
 		success "mpv retrieved ${time}s of stream on $1"
 	else
@@ -399,7 +398,7 @@ check_audiostream_mpv() {
 }
 
 check_ping() {
-	ns=$1
+	hostname=$1
 	count=$2
 	proto="$3"
 	if [ -z "$count" ]
@@ -408,19 +407,18 @@ check_ping() {
 	fi
 	case "$proto" in
 		ipv4)
-			proto="-4";;
+			protoping="ping -4";;
 		ipv6)
-			proto="-6";;
+			protoping="ping -6";;
 		*)
-			proto="";;
+			protoping="ping";;
 	esac
-	ping $proto -i 0.2 -c $count $ns 2>/dev/null >/dev/null
-	res=$?
-	if [ "$res" -ne 0 ]
+
+	if $protoping -i 0.2 -c "$count" "$hostname" >/dev/null
 	then
-		fail "unable to ping '$ns'"
+		success "successfully send $count ping to '$hostname'"
 	else
-		success "successfully send $count ping to '$ns'"
+		fail "unable to ping '$hostname'"
 	fi
 }
 
@@ -489,9 +487,9 @@ check_imaps() {
 
 check_git_repo() {
 	tmpdir=$(mktemp -d -t check_git.XXXXXXXXX)
-	git clone $1 $tmpdir 2>/dev/null 1>/dev/null
-	res=$?
-	rm -Rf $tmpdir
+	git clone "$1" "$tmpdir" 2>/dev/null 1>/dev/null
+	res="$?"
+	rm -Rf "$tmpdir"
 	if [ "$res" -ne 0 ]
 	then
 		fail "unable to clone git repo '$1'"
@@ -509,13 +507,13 @@ __xmpp_probe() {
 	timeout=$2
 	type=$3
 
-	payload="<?xml version=\"1.0\"?>\n<stream:stream xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\" xmlns=\"jabber:$type\" to=\"${1}\" xml:lang=\"en\" xmlns:xml=\"http://www.w3.org/XML/1998/namespace\">\n"
+	payload=$(printf "%s" "<?xml version=\"1.0\"?>\n<stream:stream xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\" xmlns=\"jabber:$type\" to=\"${1}\" xml:lang=\"en\" xmlns:xml=\"http://www.w3.org/XML/1998/namespace\">\n")
 	if [ "$verbose" -gt 2 ]
 	then
-		echo -e $payload | sed -e "s/^/$(datetime) [  DEBUG] Sent : /" >&2
+		echo "$payload" | sed -e "s/^/$(datetime) [  DEBUG] Sent : /" >&2
 	fi
-	echo -e $payload
-	sleep $timeout
+	echo "$payload"
+	sleep "$timeout"
 }
 
 _xmpp_probe() {
@@ -526,21 +524,21 @@ _xmpp_probe() {
 
 	tmpres=$(mktemp -t xmpp_probe.XXXXXXXXX)
 
-	echo "$(__xmpp_probe $serv $timeout $type| nc -q2 $serv $port)</stream:stream>" | xmllint --format - > $tmpres
+	echo "$(__xmpp_probe "$serv" "$timeout" "$type"| nc -q2 "$serv" "$port")</stream:stream>" | xmllint --format - > "$tmpres"
 	if [ "$verbose" -gt 2 ]
 	then
-		cat $tmpres | sed -e "s/^/$(datetime) [  DEBUG] Recv : /" >&2
+		sed -e "s/^/$(datetime) [  DEBUG] Recv : /" >&2 < "$tmpres"
 	fi
-	cat $tmpres
-	rm $tmpres
+	cat "$tmpres"
+	rm "$tmpres"
 }
 
 _check_xmpp_ns() {
 	ns1=$1
 	expt_ns=$2
 	expt_port=$3
-	dnsq="_xmpp-${4}._tcp.$1"
-	rep="$(dig $dnsq srv +short | cut -d" " -f3,4)"
+	dnsq="_xmpp-${4}._tcp.${ns1}"
+	rep="$(dig "$dnsq" srv +short | cut -d" " -f3,4)"
 	if [ "$rep" = "$expt_port ${expt_ns}." ]
 	then
 		success "$dnsq = '$rep'"
@@ -582,7 +580,7 @@ _check_xmpp_server() {
 		logdate INFO "$tc_name: Connecting to XMPP $serv $tpe port $port (timeout=${timeout}s)" 3
 	fi
 
-	stream=$(_xmpp_probe $serv $port $timeout $type| head -n2 | tail -n1)
+	stream=$(_xmpp_probe "$serv" "$port" "$timeout" "$type"| head -n2 | tail -n1)
 	if [ -z "$stream" ]
 	then
 		fail "Empty reply from $serv:$port"
@@ -591,9 +589,9 @@ _check_xmpp_server() {
 
 	if [ "$type" = "client" ]
 	then
-		infos=$(echo $stream | sed -E 's/^<([^ ]+).* xmlns="([^"]+)".* from="([^"]+)" .*$/\1 \2 \3/')
+		infos=$(echo "$stream" | sed -E 's/^<([^ ]+).* xmlns="([^"]+)".* from="([^"]+)" .*$/\1 \2 \3/')
 	else
-		infos="$(echo $stream | sed -E 's/^<([^ ]+).* xmlns="([^"]+)" .*$/\1 \2/') $serv"
+		infos="$(echo "$stream" | sed -E 's/^<([^ ]+).* xmlns="([^"]+)" .*$/\1 \2/') $serv"
 	fi
 
 	if echo "$infos" | grep "jabber:$type" >/dev/null
@@ -621,7 +619,7 @@ check_xmpp_ssl() {
 		port=5222
 	fi
 
-	openssl s_client -connect $serv:$port </dev/null -starttls xmpp >/dev/null 2>/dev/null
+	openssl s_client -connect "$serv:$port" </dev/null -starttls xmpp >/dev/null 2>/dev/null
 	rep=$?
 	if [ "$rep" -eq 0 ]
 	then
@@ -644,14 +642,14 @@ check_ssh_nc() {
 		port=22
 	fi
 
-	rep="$(nc -w1 $host $port </dev/null)"
+	rep="$(nc -w1 "$host" "$port" </dev/null)"
 	res=$?
 	if [ "$res" -ne "0" ]
 	then
 		fail "Netcat unable to connect to $host:$port"
 		return
 	fi
-	if echo $rep | grep "^SSH-2.0-OpenSSH" >/dev/null
+	if echo "$rep" | grep "^SSH-2.0-OpenSSH" >/dev/null
 	then
 		success "OpenSSH replied on $host:$port"
 	else
@@ -675,7 +673,7 @@ check_ssh_key() {
 		keytype="rsa"
 	fi
 
-	key=$(ssh-keyscan -p $port -t $keytype $host 2>/dev/null | cut -d " " -f3)
+	key=$(ssh-keyscan -p $port -t "$keytype" "$host" 2>/dev/null | cut -d " " -f3)
 
 	if [ -z "$key" ]
 	then

example.sh

@@ -12,9 +12,10 @@ verbose=0
 exit_on_fail=1
 color=1
 
-OPTS=$(getopt -o vcnh --long verbose,continue,no-color,help: -n 'parse-options' -- "$@")
-if [ "$?" -ne "0" ]
+if OPTS=$(getopt -o vcnh --long verbose,continue,no-color,help: -n 'parse-options' -- "$@")
 then
+	:
+else
 	echo ""
 	usage
 	exit 1
@@ -24,7 +25,7 @@ for o in $OPTS
 do
 	case "$o"
 	in
-		-v | --verbose ) verbose=$(expr $verbose + 1);;
+		-v | --verbose ) verbose=$(( verbose + 1 ));;
 		-c | --continue ) exit_on_fail=0;;
 		-n | --no-color ) color=0;;
 		-h | --help ) usage; exit 0;;