test_generated_index.sh

#!/bin/bash

output_dir="$1"
if [ -e "${output_dir}" ]; then
    echo "ERROR: Output directory exists. This script requires that it not exist already." 1>&2
    exit 1
fi
mkdir -p "${output_dir}"

set -xeo pipefail

# Setup venv for the generator script.
venv_dir="${output_dir}/.venv"
python3.9 -m venv "${venv_dir}"
"${venv_dir}/bin/pip" install -r ./requirements.txt

# Generate the Pants PyPi-compatible index.
mkdir -p "${output_dir}/public/simple"
"${venv_dir}/bin/python" ./generate_index.py > "${output_dir}/public/simple/index.html"

# Serve a copy of the generated index on port 8080.
python3.9 -m http.server -d "${output_dir}/public" --bind 127.0.0.1 8080 &

# Setup another virtual environment in temporary directory and install a version of Pants into it.
# Note: The Python version (e.g., 3.9) must match the Python version required by the version of Pants
#  to be installed as a test, or else Pip will otherwise ignore the Pants version and fail.
pants_venv_dir="${output_dir}/pants-venv"
python3.9 -m venv "${pants_venv_dir}"
"${pants_venv_dir}/bin/pip" install -vv \
  --extra-index-url=http://127.0.0.1:8080/simple/ \
  pantsbuild.pants==2.18.0a0

# Verify that the Pants console script is in the expected location.
if [ ! -f "${pants_venv_dir}/bin/pants" ]; then
    echo "TEST FAILED: Expected the `pants` console script to be installed into the virtual environment's `bin` directory." 1>&2
    exit 1
fi

# Verify that the Pants version file is in the expected location.
if [ ! -f "${pants_venv_dir}/lib/python3.9/site-packages/pants/version.py" ]; then
    echo "TEST FAILED: Expected the Pants `version.py` to be installed into the virtual environment's site-packages." 1>&2
    exit 1
fi

echo "TEST SUCCESS!"