tests/utils/run-in-py-env.sh

   1 #!/bin/bash
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-only
   4 #
   5 # Copyright (C) 2017-2023 Philippe Proulx <pproulx@efficios.com>
   6 # Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
   7
   8 if [ -n "${BT_TESTS_SRCDIR:-}" ]; then
   9         UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
  10 else
  11         UTILSSH="$(dirname "$0")/../utils/utils.sh"
  12 fi
  13
  14 # shellcheck source=../utils/utils.sh
  15 source "$UTILSSH"
  16
  17 usage() {
  18         echo "Usage: run-in-py-utils-bt2-env.sh COMMAND [ARGS]..."
  19         echo ""
  20         echo "Runs the command \`COMMAND\` with the arguments \`ARGS\` within an environment"
  21         echo "which can import the testing Python modules (in \`tests/utils/python\`) and the"
  22         echo "built \`bt2\` Python package."
  23         echo ""
  24         echo "NOTE: If you build out of tree, export and set the \`BT_TESTS_BUILDDIR\`"
  25         echo "environment variable to the built \`tests\` directory."
  26 }
  27
  28 if [ -z "$*" ]; then
  29         usage
  30         exit 1
  31 fi
  32
  33 # Sanity check that the BT_TESTS_BUILDDIR value makes sense.
  34 if [ ! -f "$BT_TESTS_BUILDDIR/Makefile" ]; then
  35         fold -w 80 -s <<- END
  36         $0: BT_TESTS_BUILDDIR does not point to a valid directory (\`$BT_TESTS_BUILDDIR/Makefile\` does not exist).
  37
  38         If building out-of-tree, set BT_TESTS_BUILDDIR to point to the \`tests\` directory in the build tree.
  39         END
  40         exit 1
  41 fi
  42
  43 bt_run_in_py_env "${@}"