history.sh

#! /bin/sh
#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2018-2025 Gavin D. Howard and contributors.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

script="$0"

testdir=$(dirname "$script")

. "$testdir/../scripts/functions.sh"

# Just print the usage and exit with an error. This can receive a message to
# print.
# @param 1  A message to print.
usage() {
	if [ $# -eq 1 ]; then
		printf '%s\n\n' "$1"
	fi
	printf 'usage: %s dir -a|idx [exe args...]\n' "$script"
	exit 1
}

# If Python does not exist, then just skip.
py=$(command -v python3)
err=$?

if [ "$err" -ne 0 ]; then

	py=$(command -v python)
	err=$?

	if [ "$err" -ne 0 ]; then
		printf 'Could not find Python 3.\n'
		printf 'Skipping %s history tests...\n' "$d"
		exit 0
	fi
fi

if [ "$#" -lt 2 ]; then
	usage "Not enough arguments; expect 2 arguments"
fi

# d is "bc" or "dc"
d="$1"
shift
check_d_arg "$d"

# idx is either an index of the test to run or "-a". If it is "-a", then all
# tests are run.
idx="$1"
shift

if [ "$#" -gt 0 ]; then

	# exe is the executable to run.
	exe="$1"
	shift
	check_exec_arg "$exe"

else
	exe="$testdir/../bin/$d"
	check_exec_arg "$exe"
fi

if [ "$d" = "bc" ]; then
	flip="! %s"
	addone="%s + 1"
else
	flip="%s Np"
	addone="%s 1+p"
fi

# Set the test range correctly for all tests or one test. st is the start index.
if [ "$idx" = "-a" ]; then
	idx=$("$py" "$testdir/history.py" "$d" -a)
	idx=$(printf '%s - 1\n' "$idx" | bc)
	st=0
else
	st="$idx"
fi

# Run all of the tests.
for i in $(seq "$st" "$idx"); do

	printf 'Running %s history test %d...' "$d" "$i"

	for j in $(seq 1 5); do

		"$py" "$testdir/history.py" "$d" "$i" "$exe" "$@"
		err="$?"

		if [ "$err" -eq 0 ]; then
			break
		fi

	done

	checktest_retcode "$d" "$err" "$d history test $i"

	printf 'pass\n'

done