tools/checkusage.sh - master - niceSOFT/util-linux

tools/checkusage.sh
202 строки4 KB
Thomas Weißschuh
treewide: use bash from PATH
23 апр 2026, 17:08
23 апр 2026, 17:08cf514a2
#!/usr/bin/env bash

## This script is potentially dangerous! Don't run it on
## arbitrary commands.

export LC_ALL=C

if [ "$#" -lt 1 ]; then
	echo "usage: $0 program..." >&2
	echo "       or try 'make checkusage' to check all built programs" >&2
	exit 1
fi

top_srcdir="$(realpath -qLs "${1:-.}")"
if [ -d "${top_srcdir}" ]; then
	shift 1
else
	echo "directory '${top_srcdir}' not found" >&2
	exit 1
fi
builddir="."
cmds=$(echo $@ | tr ' ' '\n' | sort)

# set env to dump all output to files
test -z "$CU_DUMP" || rm -f /tmp/checkusage--{help,version,unknownopt}

## Set alternative options for --help, --version
## or --unknownopt. "x" means "not implemented".
##
## Examples:
##   alt_whereis__help="-h"  # in past whereis(1) had no longopt for --help
##   alt_more__help="x"      # more(1) had neither --help nor -h

alt_fsck__unknownopt="x" # fsck passes unknown opts to fsck.ext4, etc.
alt_mkfs__unknownopt="x" # dito
alt_kill__unknownopt="inval pids" # trick, kill does not use errtryhelp()
if [ $(id -ru) -eq 0 ]; then
	alt_sulogin__unknownopt="x" # would hang at pwd prompt
fi

function exec_option {
	local cmdb=$1
	local cmd=$2
	opt=$3
	local tofile="/tmp/checkusage$opt"

	local alt="alt_${cmdb}${opt}"
	alt=${alt//-/_}
	alt=${alt//./_}
	alt=$(eval printf -- \"\$${alt}\")
	if test -n "$alt"; then
		if test "$alt" = "x"; then
			return 1
		fi
		opt=$alt
	fi

	test -z "$CU_DUMP" || {
		echo "##########################################################"
		echo "#### $cmdb"
		$cmd $opt
	} >> "$tofile" 2>&1

	out=$("$cmd" $opt 2>/dev/null)
	err=$("$cmd" $opt 2>&1 >/dev/null)
	ret=$?

	# hardcoded ... nologin should always return false
	if test "$cmdb" = "nologin" &&
			test "$opt" = "--help" -o "$opt" = "--version"; then
		if test "$ret" -eq 0 -o "$ret" -ge 128; then
			echo "$cmdb, $opt, should return false: $ret"
		fi
		ret=0
	fi

	return 0
}


function check_help {
	local cb=$1
	local c=$2

	if ! exec_option "$cb" "$c" --help; then
		return 1
	fi

	if test $ret != 0; then
		echo "$cb: $opt, returns error"
	else
		if test -z "$out"; then
			echo "$cb: $opt, no stdout"
		fi
		if test -n "$err"; then
			echo "$cb: $opt, non-empty stderr"
		fi
	fi
	return 0
}

function check_version {
	local cb=$1
	local c=$2

	if ! exec_option "$cb" "$c" --version; then
		return 1
	fi

	if test $ret != 0; then
		echo "$cb: $opt, returns error"
	else
		if test -z "$out"; then
			echo "$cb: $opt, no stdout"
		fi
		if test -n "$err"; then
			echo "$cb: $opt, non-empty stderr"
		fi
	fi
}

function check_unknownopt {
	local cb=$1
	local c=$2
	local nohelp=$3

	if ! exec_option "$cb" "$c" --unknownopt; then
		return 1
	fi

	if test $ret = 0; then
		echo "$cb: $opt, returns no error"
	elif test $ret -ge 128; then
		echo "$cb: $opt, abnormal exit: $ret"
	fi
	if test -n "$out"; then
		echo "$cb: $opt, non-empty stdout"
	fi
	if test -z "$err"; then
		echo "$cb: $opt, no stderr"
	elif test -z "$nohelp" -o "$nohelp" != "yes"; then
		out_len=$(echo "$out" | wc -l)
		err_len=$(echo "$err" | wc -l)
		if test "$err_len" -gt 2; then
			echo "$cb: $opt, stderr too long: $err_len"
		elif test "$err_len" -lt 2; then
			echo "$cb: $opt, stderr too short: $err_len"
		fi
	fi
}

function check_usage_long_options_completeness {
	local prog="$1"

	prog_long_opts="$( TOP_SRCDIR="${top_srcdir}" "${top_srcdir}"/tools/get-options.sh "$prog" \
			| sed -e 's/^$//' -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')"

	if [[ "$?" != "0" || -z "$prog_long_opts" ]]; then
		echo "Failed to get long options for $prog"
		return 1
	fi

	if [ "$prog_long_opts" == "ENOTSUP" ]; then
		return 0
	fi

	usage_long_opts="$( "${builddir}"/"$prog" --help \
			| grep -o -P '^.*[[:space:]]*--(?![^[:alnum:]])[A-Za-z-.0-9_]*' \
			| grep -o -P '[[:space:]]*--(?![^[:alnum:]])[A-Za-z-.0-9_]*' \
			| sed -e 's/^$//' -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' \
			| sort \
			| uniq \
			)"

	res="$( comm -23 <(echo "${prog_long_opts}") <(echo "${usage_long_opts}") )"
	if [ -n "$res" ]; then
		printf "%s\n%s\n" "${prog} (missing/extraneous option(s) in usage):" "$res"
		return 1
	fi

	return 0
}

rc=0
for cb in $cmds; do
	c="$builddir/$cb"
	if ! type "$c" &>/dev/null; then
		echo "$cb: does not exist"
		continue
	fi

	nohelp="no"
	if ! check_help "$cb" "$c"; then
		nohelp="yes"
	fi
	check_version "$cb" "$c"
	check_unknownopt "$cb" "$c" "$nohelp"

	check_usage_long_options_completeness "$cb" || ((rc++))
done

exit $rc