run_all_unit_tests.sh

#! /bin/bash

# ######################################################################## #
# File:     run_all_unit_tests.sh
#
# Purpose:  Executes the unit-tests of a Python project regardless of
#           calling directory
#
# Created:  13th February 2019
# Updated:  14th September 2026
#
# Copyright (c) Matthew Wilson, 2019-2026
# All rights reserved
#
# 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.
#
# * Neither the names of the copyright holder nor the names of its
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# 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.
#
# ######################################################################## #


# constants

Source="${BASH_SOURCE[0]}"
while [ -h "$Source" ]; do

  Dir="$(cd -P "$(dirname "$Source")" && pwd)"
  Source="$(readlink "$Source")"
  [[ $Source != /* ]] && Source="$Dir/$Source"
done
Dir="$(cd -P "$( dirname "$Source" )" && pwd)"
Basename="$(basename "$Source")"

ProjectNameFile="$Dir/.sis/project_name.txt"
if [ -f "$ProjectNameFile" ]; then
  ProjectName=$(tr -d '[:space:]' < "$ProjectNameFile")
else
  ProjectName=$(basename "$Dir")
fi


AssumePython2=
IncludePython2InSearch=
PythonCommandPath=


# regular command-line handling


while [[ $# -gt 0 ]]
do

  case "$1" in

    --assume-python2)

      AssumePython2=1
      ;;
    --include-python2-in-search)

      IncludePython2InSearch=1
      ;;
    --python-cmd-path|-p)

      shift

      PythonCommandPath=$1
      ;;
    --help)

      [ -f "$Dir/.sis/script_info_lines.txt" ] && cat "$Dir/.sis/script_info_lines.txt"
      echo
      cat << EOF
USAGE: $Basename { | --help | [ --assume-python2 ] [ --include-python2-in-search ] [ --python-cmd-path <python-cmd-path> | -p <python-cmd-path> ] }

${ProjectName} unit tests

flags/options:

  --help
  shows this help and terminates

  --assume-python2
  uses the python2 command when no -p / --python-cmd-path is given

  --include-python2-in-search
  includes python2 in automatic interpreter discovery (after python3 and python)

  -p <python-cmd-path>
  --python-cmd-path <python-cmd-path>
  specifies explicitly the path of the Python command to be executed (rather than discover it)
EOF

      exit 0
      ;;
    *)

      >&2 echo "unrecognised argument; use --help for usage"

      exit 1
      ;;
  esac

  shift
done


# validate / discover python executable path

if [ "x_$PythonCommandPath" = "x_" ] && [ ! -z "$AssumePython2" ]; then

  PythonCommandPath=python2
fi

if [ "x_$PythonCommandPath" != "x_" ]; then

  # check the given command

  if ! { [ -x "$PythonCommandPath" ] || command -v "$PythonCommandPath" > /dev/null; }; then

    >&2 echo "given python-cmd-path '$PythonCommandPath' is not executable"

    exit 1
  fi
else

  # try and find a suitable command

  # Prefer a project-local venv when present (avoids Apple/Xcode python3 on
  # PATH, which must not be used for local install/test).
  if [ "x_$PythonCommandPath" = "x_" ]; then

    if [ -x "$Dir/.venv/bin/python" ]; then

      PythonCommandPath="$Dir/.venv/bin/python"

      echo "found project venv python '$PythonCommandPath'"
    fi
  fi

  if [ "x_$PythonCommandPath" = "x_" ]; then

    if [ "y_$PYTHON_COMMAND_PATH" != "y_" ]; then

      if command -v "$PYTHON_COMMAND_PATH" > /dev/null; then

        PythonCommandPath=$PYTHON_COMMAND_PATH
      fi
    fi
  fi

  if [ "x_$PythonCommandPath" = "x_" ]; then

    if [ "y_$PYTHON_CMD_PATH" != "y_" ]; then

      if command -v "$PYTHON_CMD_PATH" > /dev/null; then

        PythonCommandPath=$PYTHON_CMD_PATH
      fi
    fi
  fi

  if [ "x_$PythonCommandPath" = "x_" ]; then

    PossiblePythonCommands=(python3 python)

    if [ ! -z "$IncludePython2InSearch" ]; then

      PossiblePythonCommands+=(python2)
    fi

    for p in "${PossiblePythonCommands[@]}"
    do

      if command -v "$p" > /dev/null; then

        PythonCommandPath=$p

        echo "found valid python command '$p'"

        break
      fi
    done
  fi

  if [ "x_$PythonCommandPath" = "x_" ]; then

    if [ -z "$IncludePython2InSearch" ] && [ -z "$AssumePython2" ] && command -v python2 > /dev/null; then

      >&2 echo "only python2 was found on PATH; pass --include-python2-in-search to allow it during discovery, or --assume-python2 to use python2 explicitly"

      exit 1
    fi

    >&2 echo "no valid python command path discovered"

    exit 1
  fi
fi


# executing tests


# This will operate recursively as long as each subdirectory of $Dir/tests
# contains an __init__.py file (which may be empty)
"$PythonCommandPath" -m unittest discover -s "$Dir/tests"


# ############################## end of file ############################# #