gather_metrics.sh

#!/usr/bin/env bash


usage()
{
   echo
   echo "gather_metrics.sh [options]"
   echo
   echo
   echo "Run the 'metrics.utility gather-multi' tool using the gather_cli docker image"
   echo "Processes all of the repositories found in the REPOS_FOLDER to"
   echo "  creates a new run of data to be recorded as RUN_NAME"
   echo "  beginning at START_DATE in each of the repostories"
   echo
   echo "Options:"
   echo
   echo " -h, --help"
   echo "      Show this help"
   echo
   echo " --tool-help"
   echo "      Pass '--help' to tool"
   echo
   echo " -n, --run-name"
   echo "      Name the run of metrics collection."
   echo "      Defaults to the current date."
   echo
   echo " -w, --weeks, -s, --steps"
   echo "      Weeks to step back in time from the start date. Metrics are gathered at each step."
   echo "      Defaults to ${STEPS}."
   echo
   echo " -d, --start-date"
   echo "      Start date for the gathering."
   echo "      Metrics collection for each repository will be started as close this this date as possible."
   echo "      Defaults to the current date."
   echo
   echo " -c, --config-file"
   echo "      A team configuraton file. See the Code Analysis documentation for details."
   echo "      Defaults to No File Defined."
   echo
   echo " -r, --repos-folder"
   echo "      The base folder that holds all of the repositories to be analyzed."
   echo "      Defaults to the current folder."
   echo
   echo " -o, --output-folder"
   echo "      The output folder where all the collected metrics data will be written."
   echo "      See the Code Analysis documentation for information in the structure and content."
   echo "      Required. Cannot be blank."
   echo
   echo " -i, --image"
   echo "      The docker image to use."
   echo "      Defaults to '${DOCKER_IMAGE}'"
   echo "      The image MUST be a 'gather-cli' image."
   echo
   echo "Be sure each repository is currently on the branch you are interested in evaluating"
   echo
   echo "Before using:"
   echo "   (you probably need to be OFF the VPN to do this)"
   echo "   Authenticate with docker registry (currently hosted by LeadingAgile)"
   echo "      Using azure cli (brew install azure-cli)"
   echo "         az login"
   echo "         az acr login --name leadingagilestudios"
   echo "   Get the docker image"
   echo "      docker pull leadingagilestudios.azurecr.io/analysis/gather-cli:0.3.3"
   echo
   echo
   echo "Example: "
   echo
   echo '      ./gather_metrics.sh --run-name "Q4_2021" --weeks 52 --start-date "2021-12-31" --repos-folder ~/projects/repositories --output-folder ~/projects/reports/'
   echo
}

DEBUG=false
RUN_NAME="$(date +"%Y-%m-%d_%H-%M-%S%z")"
START_DATE="$(date +"%Y-%m-%d")"
STEPS=52
CONFIG_FILE=
REPOS_FOLDER="$(pwd)"
OUTPUT_FOLDER=
DOCKER_IMAGE="leadingagilestudios.azurecr.io/analysis/gather-cli:0.3.3"
TOOL_HELP=false

while (( "$#" )); do
   case "${1}" in

   --help|-h|-[?])
      usage
      exit 0
      ;;

   --tool-help)
      TOOL_HELP=true
      shift
      break
      ;;

   --debug)
      DEBUG=true
      shift
      ;;

   -n|--run-name)
      RUN_NAME="$2"
      shift; shift
      ;;
   -n=*|--run-name=*)
      RUN_NAME="${1##*=}"
      shift
      ;;

   -s|-w|--steps|--weeks)
      STEPS="$2"
      shift; shift
      ;;
   -s=*|-w=*|--steps=*|--weeks=*)
      STEPS="${1##*=}"
      shift
      ;;

   -d|--start-date)
      START_DATE="$2"
      shift; shift
      ;;
   -d=*|--start-date=*)
      START_DATE="${1##*=}"
      shift
      ;;

   -c|--config-file)
      CONFIG_FILE="$2"
      shift; shift
      ;;
   -c=*|--config-file=*)
      CONFIG_FILE="${1##*=}"
      shift
      ;;

   -r|--repos-folder)
      REPOS_FOLDER="$2"
      shift; shift
      ;;
   -r=*|--repos-folder=*)
      REPOS_FOLDER="${1##*=}"
      shift
      ;;

   -o|--output-folder)
      OUTPUT_FOLDER="$2"
      shift; shift
      ;;
   -o=*|--output-folder=*)
      OUTPUT_FOLDER="${1##*=}"
      shift
      ;;

   -i|--image)
      DOCKER_IMAGE="$2"
      shift; shift
      ;;
   -i=*|--image=*)
      DOCKER_IMAGE="${1##*=}"
      shift
      ;;

   *)
      echo "Unknown parameter: '$1'"
      usage
      exit 0
      ;;
   esac
done

if ${DEBUG}; then
   echo
   echo "DOCKER_IMAGE='${DOCKER_IMAGE}'"
   echo "RUN_NAME='${RUN_NAME}'"
   echo "START_DATE='${START_DATE}'"
   echo "STEPS='${STEPS}'"
   echo "CONFIG_FILE='${CONFIG_FILE}'"
   echo "REPOS_FOLDER='${REPOS_FOLDER}'"
   echo "OUTPUT_FOLDER='${OUTPUT_FOLDER}'"
   echo
fi

if ${TOOL_HELP}; then
    docker run -it --rm \
            "${DOCKER_IMAGE}" \
            --help

    exit 0

else
    if [[ -z "${REPOS_FOLDER}" ]] || [[ ! -d "${REPOS_FOLDER}" ]]; then
    echo "Folder for repositories is not defined or does not exist: '${REPOS_FOLDER}'"
    exit 1
    fi

    if [[ -z "${OUTPUT_FOLDER}" ]] || [[ ! -d "${OUTPUT_FOLDER}" ]]; then
    echo "Output folder for results is not defined or does not exist: '${OUTPUT_FOLDER}'"
    exit 1
    fi

    if [[ -z "${DOCKER_IMAGE}" ]] || [[ -z "$(docker image ls -q "${DOCKER_IMAGE}")" ]]; then
    echo "Docker image name is not defined or the image is not available from docker: '${DOCKER_IMAGE}'"
    exit 1
    fi

    { time docker run -it --rm \
        -v "${REPOS_FOLDER}":/opt/repos \
        -v "${OUTPUT_FOLDER}":/opt/output \
        "${DOCKER_IMAGE}" \
        --start-date "${START_DATE}" \
        --run-name "${RUN_NAME}" \
        --steps "${STEPS}" \
        --team-config "${CONFIG_FILE}" \
    ; } \
        2>&1 | tee "${OUTPUT_FOLDER}/console.log"
fi