run

#!/usr/bin/env bash

# Much of this copied from Nick Janetakis
# https://github.com/nickjj/docker-django-example/blob/main/run

set -eo pipefail

DC="${DC:-exec}"

# If we're running in CI we need to disable TTY allocation for docker compose
# commands that enable it by default, such as exec and run.
TTY=""
if [[ ! -t 1 ]]; then
  TTY="-T"
fi

# We need to pass this in to docker compose when we run tests and coverage:
TEST_ENV_ARGS="-e ALLOWED_HOSTS=* -e DEBUG=FALSE -e MEDIA_ROOT=/code/tests/_media -e PEPYS_USE_AWS_FOR_MEDIA=False -e PEPYS_LOG_LEVEL=CRITICAL"


# -----------------------------------------------------------------------------
# Helper functions start with _ and aren't listed in this script's help menu.
# -----------------------------------------------------------------------------

function _dc {
  docker compose "${DC}" ${TTY} "${@}"
}

function _build_run_down {
  docker compose build
  docker compose run ${TTY} "${@}"
  docker compose down
}


# -----------------------------------------------------------------------------

function cmd {
  # Run any command you want in the web container
  _dc web "${@}"
}


function manage {
  # Run any manage.py commands
  cmd python manage.py "${@}"
}


function tests {
  # Run the Django tests
  _dc ${TEST_ENV_ARGS} web python manage.py test "${@}" --parallel
}


function ruff {
  # Run ruff over the code
  cmd ruff check . "${@}"
}


function coverage {
  # Run the tests and generate a coverage report in htmlcov/
  _dc ${TEST_ENV_ARGS} web coverage run --concurrency=multiprocessing manage.py test --parallel
  _dc ${TEST_ENV_ARGS} web coverage combine
  _dc ${TEST_ENV_ARGS} web coverage html
}


function sp {
  # Run the shell_plus command from django-extensions
  manage shell_plus --ipython
}


function shell {
  # Start a Shell session in the web container
  cmd bash "${@}"
}


function psql {
  # Connect to PostgreSQL with psql
  # shellcheck disable=SC1091
  . .env
  _dc db psql -U "${POSTGRES_USER}" -d "${POSTGRES_DB}" "${@}"
}


# function redis-cli {
#   # Connect to Redis with redis-cli
#   _dc redis redis-cli "${@}"
# }


function pipsync {
  # Install/uninstall/update packages
  cmd pip-sync "${@}"
}


function yarn:outdated {
  # List any installed yarn packages that are outdated
  _dc yarn outdated
}


function yarn:upgrade {
  # Upgrade yarn dependencies.
  _dc yarn upgrade
}


# function yarn:install {
#   # Install yarn dependencies and write lock file
#   # (untested)
#   _build_run_down webpack yarn install
# }


function help {
  printf "%s <task> [args]\n\nTasks:\n" "${0}"

  compgen -A function | grep -v "^_" | cat -n

  printf "\nExtended help:\n  Each task has comments for general usage\n"
}

# This idea is heavily inspired by: https://github.com/adriancooney/Taskfile
TIMEFORMAT=$'\nTask completed in %3lR'
time "${@:-help}"