wireshark/test/test.sh

#!/bin/bash
(set -o igncr) 2>/dev/null && set -o igncr; # comment is needed
#                                           # hack for cygwin bash
#                                           #  no-op for other
#
# Test various command line testable aspects of the Wireshark tools
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 2005 Ulf Lamping
#
# SPDX-License-Identifier: GPL-2.0-or-later
#

# an existing capture file
USE_COLOR=1
RUN_SUITE=""
PRINT_USAGE=0

# Ensure cygwin bin dir is on the path if running under it
if [[ $OSTYPE == "cygwin" ]]; then
	PATH="$PATH:/usr/bin"
fi

while getopts "chs:" OPTION ; do
	case $OPTION in
		c) USE_COLOR=0 ;;
		h) PRINT_USAGE=1 ;;
		s) RUN_SUITE="$OPTARG" ;;
		*) echo "Unknown option: " $OPTION $OPTARG
	esac
done

shift $(( $OPTIND - 1 ))

if [ $PRINT_USAGE -ne 0 ] ; then
        THIS=`basename $0`
        cat <<FIN
Usage: $THIS [-c] [-h] [-s <suite>]
  -c: Disable color output
  -h: Print this message and exit
  -s: Run a suite.  Must be one of:
      all
      capture
      clopts
      decryption
      fileformats
      io
      nameres
      prerequisites
      unittests
      wslua
      dissection
FIN
        exit 0
fi

MYDIR=$(dirname $0)
if [ -d run ]; then
	if [ -e run/tshark -o -e run/dumpcap -o -e run/rawshark ]; then
		WS_BIN_PATH=${WS_BIN_PATH:-$(cd run && pwd)}
		WS_QT_BIN_PATH=${WS_QT_BIN_PATH:-$WS_BIN_PATH}
	fi
fi
source $MYDIR/test-backend.sh
source $MYDIR/config.sh

# needed by some tests
TEST_OUTDIR="$(mktemp -d 2>/dev/null || mktemp -d ${TMPDIR:-/tmp}/wstest.XXXXXXXXXX)"
if [ $? -ne 0 ] || [ ! -d "$TEST_OUTDIR" ] || ! cd "$TEST_OUTDIR"; then
	# Error out if TEST_OUTDIR cannot be created
	echo "Failed to create directory '$TEST_OUTDIR'"
	exit 1
fi
TEST_OUTDIR_CLEAN=${TEST_OUTDIR_CLEAN:-1}

# Configuration paths
HOME_ENV="HOME"
HOME_PATH="$TEST_OUTDIR/home"
CONF_PATH="$HOME_PATH/.wireshark"

if [ "$WS_SYSTEM" == "Windows" ] ; then
	HOME_ENV="APPDATA"
	HOME_PATH="`cygpath -w $HOME_PATH`"
	CONF_PATH="$HOME_PATH/Wireshark"
	CAPTURE_DIR="`cygpath -w $CAPTURE_DIR`"
	TESTS_DIR="`cygpath -w $TESTS_DIR`"
fi

mkdir -p $CONF_PATH

source $TESTS_DIR/suite-clopts.sh
source $TESTS_DIR/suite-io.sh
source $TESTS_DIR/suite-capture.sh
source $TESTS_DIR/suite-unittests.sh
source $TESTS_DIR/suite-fileformats.sh
source $TESTS_DIR/suite-decryption.sh
source $TESTS_DIR/suite-nameres.sh
source $TESTS_DIR/suite-wslua.sh
source $TESTS_DIR/suite-mergecap.sh
source $TESTS_DIR/suite-text2pcap.sh
source $TESTS_DIR/suite-dissection.sh

test_cleanup() {
	if [ $TEST_OUTDIR_CLEAN = 1 ]; then
		# display contents of test outputs, ignore directory:
		# home (decryption suite)
		grep -r . --exclude-dir=home .
		rm -rf "$TEST_OUTDIR"
	elif ! rmdir "$TEST_OUTDIR" 2>/dev/null; then
		# if directory is non-empty, print directory
		echo "Test results are available in $TEST_OUTDIR"
	fi
}
trap test_cleanup EXIT

#check prerequisites
test_step_prerequisites() {

	NOTFOUND=0
	for i in "$WIRESHARK" "$TSHARK" "$CAPINFOS" "$MERGECAP" "$DUMPCAP" ; do
		if [ ! -x $i ]; then
			echo "Couldn't find $i"
			NOTFOUND=1
		fi
	done
	if [ $NOTFOUND -eq 1 ]; then
		test_step_failed "Tool not found"
		exit 1
	else
		test_step_ok
	fi
}

# Dump version information
test_step_tshark_version() {
	test_remark_add "Printing TShark version"
	$TESTS_DIR/run_and_catch_crashes $TSHARK -v
	RETURNVALUE=$?
	if [ ! $RETURNVALUE -eq $EXIT_OK ]; then
		test_step_failed "Failed to print version information"
		return
	fi
	test_step_ok
}


prerequisites_suite() {
	test_step_add "Prerequisites settings" test_step_prerequisites
	test_step_add "Version information" test_step_tshark_version
}

test_suite() {
	test_suite_add "Prerequisites" prerequisites_suite
	test_suite_add "Command line options" clopt_suite
	test_suite_add "File I/O" io_suite
	test_suite_add "Capture" capture_suite
	test_suite_add "Unit tests" unittests_suite
	test_suite_add "Decryption" decryption_suite
	test_suite_add "Name Resolution" name_resolution_suite
	test_suite_add "Lua API" wslua_suite
	test_suite_add "Mergecap" mergecap_suite
	test_suite_add "File formats" fileformats_suite
	test_suite_add "Text2pcap" text2pcap_suite
	test_suite_add "Dissection" dissection_suite
}


#test_set_output OFF # doesn't work
#test_set_output DOTTED
test_set_output VERBOSE


#test_suite_run "TShark command line options" clopt_suite
#test_suite_run "TShark capture" capture_suite


# all
#test_suite_run "All" test_suite
#test_suite_show "All" test_suite

if [ -n "$RUN_SUITE" ] ; then
	case $RUN_SUITE in
		"all")
			test_suite_run "All" test_suite
			exit $? ;;
		"capture")
			test_suite_run "Capture" capture_suite
			exit $? ;;
		"clopts")
			test_suite_run "Command line options" clopt_suite
			exit $? ;;
		"decryption")
			test_suite_run "Decryption" decryption_suite
			exit $? ;;
		"fileformats")
			test_suite_run "File formats" fileformats_suite
			exit $? ;;
		"io")
			test_suite_run "File I/O" io_suite
			exit $? ;;
		"nameres")
			test_suite_run "Name Resolution" name_resolution_suite
			exit $? ;;
		"prerequisites")
			test_suite_run "Prerequisites" prerequisites_suite
			exit $? ;;
		"unittests")
			test_suite_run "Unit tests" unittests_suite
			exit $? ;;
		"wslua")
			test_suite_run "Lua API" wslua_suite
			exit $? ;;
		"text2pcap")
			test_suite_run "Text2pcap" text2pcap_suite
			exit $? ;;
		"dissection")
			test_suite_run "Dissection" dissection_suite
			exit $? ;;
	esac
fi

MENU_LEVEL=0

menu_title[0]="All"
menu_function[0]=test_suite

echo "----------------------------------------------------------------------"

for ((a=0; a <= 100000000000 ; a++))
do
	TEST_STEPS[0]=0			# number of steps of a specific nesting level

	#echo $current_title $current_function
	test_suite_show "${menu_title[MENU_LEVEL]}" "${menu_function[MENU_LEVEL]}"
	if [ $MENU_LEVEL -gt 0 ]; then
		echo "T or Enter:  Run suite"
	else
	echo "1-$TEST_STEPS : Select suite"
	fi

	# DBG
	#echo "Menu level: $MENU_LEVEL"
	#echo "Menu Title: ${menu_title[MENU_LEVEL]}"
	#echo "Menu Function: ${menu_function[MENU_LEVEL]}"
	#echo "Test title size: ${#test_title[@]}"
	# END DBG

	if [[ ! $MENU_LEVEL -eq 0 ]]; then
		echo "U    : Up"
	fi
	echo "Q    : Quit"
	echo ""
	read key
	newl=$'\x0d'
	echo "$newl----------------------------------------------------------------------"

	TEST_STEPS[0]=0			# number of steps of a specific nesting level

	#echo $key
	case "$key" in
		"Q" | "q")
		exit 0
	;;
		"T" | "t" | "")
LIMIT_RUNS=1
for ((a_runs=1; a_runs <= LIMIT_RUNS ; a_runs++))  # Double parentheses, and "LIMIT" with no "$".
do
		test_suite_run "${menu_title[MENU_LEVEL]}" "${menu_function[MENU_LEVEL]}"
done
		echo "----------------------------------------------------------------------"
	;;
		"U" | "u")
		if [[ ! $MENU_LEVEL -eq 0 ]]; then
			let "MENU_LEVEL -= 1"
			#echo "----------------------------------------------------------------------"
		fi
	;;
		## Now we're only interested in digits when the menu level is at the top (0)
		[0-9]*)
		if [ $MENU_LEVEL -eq 0 ]; then
			if [ $key -le ${#test_title[@]} ]; then
				let "MENU_LEVEL += 1"
				menu_title[MENU_LEVEL]=${test_title[$key]}
				menu_function[MENU_LEVEL]=${test_function[$key]}
			fi
		fi
	;;
	esac
done

# Editor modelines
#
# Local Variables:
# sh-basic-offset: 8
# tab-width: 8
# indent-tabs-mode: t
# End:
#
# ex: set shiftwidth=8 tabstop=8 noexpandtab:
# :indentSize=8:tabSize=8:noTabs=false: