test_compatibility_layer.sh

#!/bin/bash

EESSI_REPO_DIR=${EESSI_CVMFS_REPO:-/cvmfs/software.eessi.io}
EESSI_VERSION=${EESSI_VERSION:-2023.06}
EESSI_ARCH=${EESSI_CPU_FAMILY:-$(uname -m)}
EESSI_OS=${EESSI_OS_TYPE:-linux}

display_help() {
  echo "usage: $0 [OPTIONS]"
  echo "OPTIONS:"
  echo "    -a | --arch ARCHITECTURE"
  echo "        Architecture of compatibility layer to be tested"
  echo "        [default: \$EESSI_CPU_FAMILY or current host's architecture]"
  echo ""
  echo "    -h | --help"
  echo "        display this usage information"
  echo ""
  echo "    -o | --os"
  echo "        Operating system of compatibility to be tested"
  echo "        [default: \$EESSI_OS_TYPE or linux]"
  echo ""
  echo "    -r | --repository REPO"
  echo "        CVMFS repository [default: \$EESSI_CVMFS_REPO or software.eessi.io]"
  echo "        Note that this has to be mounted as /cvmfs/${REPOSITORY}!"
  echo ""
  echo "    -v | --version VERSION"
  echo "        version of EESSI stack to be tested [default: \$EESSI_VERSION or 2023.06]"
  echo ""
  echo "    --verbose"
  echo "        increase verbosity of output [default: not set]"
  echo
}

POSITIONAL_ARGS=()

while [[ $# -gt 0 ]]; do
  case $1 in
    -a|--arch)
      EESSI_ARCH="$2"
      shift 2
      ;;
    -h|--help)
      display_help
      exit 0
      ;;
    -o|--os)
      EESSI_OS="$2"
      shift 2
      ;;
    -r|--repository)
      EESSI_REPO_DIR="/cvmfs/$2"
      shift 2
      ;;
    -v|--version)
      EESSI_VERSION="$2"
      shift 2
      ;;
    --verbose)
      VERBOSE="-vvv"
      shift 1
      ;;
    -*|--*)
      fatal_error "Unknown option: $1" "${CMDLINE_ARG_UNKNOWN_EXITCODE}"
      ;;
    *)  # No more options
      POSITIONAL_ARGS+=("$1") # save positional arg
      shift
      ;;
  esac
done

set -- "${POSITIONAL_ARGS[@]}"


COMPAT_LAYER_PREFIX="${EESSI_REPO_DIR}/versions/${EESSI_VERSION}/compat/${EESSI_OS}/${EESSI_ARCH}"
if [ ! -d ${COMPAT_LAYER_PREFIX} ]; then
    echo "Directory ${COMPAT_LAYER_PREFIX} does not exist, please provide a correct path, version, and architecture."
    exit 1
fi
if [ ! -f ${COMPAT_LAYER_PREFIX}/startprefix ]; then
    echo "Cannot find a startprefix file in ${COMPAT_LAYER_PREFIX}!"
    exit 1
fi
[[ ${VERBOSE} == '-vvv' ]] && echo "Using compatibility layer in ${COMPAT_LAYER_PREFIX}."

# We assume that this script is located in a directory containing a full checkout of the git repo,
# and verify this by checking for the existance of the ReFrame test script.
SCRIPT_DIR=$(dirname $(realpath $0))
if [ ! -f "${SCRIPT_DIR}/test/compat_layer.py" ]; then
    echo "ReFrame test script compat_layer.py cannot be found!"
    echo "Make sure to run this script from a directory containing a the compatibility-layer git repository."
    exit 1
fi

# Check if ReFrame is already available, and otherwise we try to pip install it
if ! command -v "reframe" &> /dev/null; then
  REFRAME_TMPDIR=$(mktemp -t -d eessi.XXXXXXXXXX)
  [[ ${VERBOSE} == '-vvv' ]] && echo "ReFrame command not found, trying to install it to a temporary directory ${REFRAME_TMPDIR}..."
  if command -v "pip3" &> /dev/null; then
    pip3 install --ignore-installed -t ${REFRAME_TMPDIR} reframe-hpc &> /dev/null
    export PYTHONPATH=${REFRAME_TMPDIR}
    export PATH="${REFRAME_TMPDIR}/bin/:${PATH}"
  else
    echo "Neither Reframe nor pip3 is available, please install ReFrame manually and add it to your \$PATH."
    exit 1
  fi
fi

[[ ${VERBOSE} == '-vvv' ]] && echo "Trying to run 'reframe --version' as sanity check..."
if ! reframe --version &> /dev/null; then
  echo "Cannot run ReFrame, giving up. Please install it manually and add it to your \$PATH."
  exit 1
fi

[[ ${VERBOSE} == '-vvv' ]] && echo "Running the tests with: reframe -r -v -c ${SCRIPT_DIR}/test/compat_layer.py"
export EESSI_REPO_DIR EESSI_VERSION EESSI_ARCH EESSI_OS
export RFM_PREFIX=$PWD/reframe_runs
reframe --nocolor -r -v -c ${SCRIPT_DIR}/test/compat_layer.py

if [ ! -z ${REFRAME_TMPDIR} ] && [ -d ${REFRAME_TMPDIR} ]; then
  [[ ${VERBOSE} == '-vvv' ]] && echo "Removing temporary ReFrame installation directory ${REFRAME_TMPDIR}..."
  rm -rf ${REFRAME_TMPDIR}
fi