build.sh

#!/bin/bash

TOP_DIR=$(readlink --canonicalize $(dirname $0))

: ${BUILD_DIR:=${TOP_DIR}/build}
: ${INSTALL_DIR:=${TOP_DIR}/install}
: ${VERBOSE_MAKEFILE:=no}

LOG_FILE="${TOP_DIR}/build.log"

help() {
    cat <<EOF
Usage:

This script can be used to build and test the progress library.  The script has to
be given a command. Known commands are:

create          - Create the build and install directories ('build' and 'install')
configure       - Configure the build system
compile         - Compile the sources
install         - Install the compiled sources
testing         - Run the test suite
docs            - Generate the API documentation
indent          - Indent the sources
check_indent    - Check the indentation of the sources
dist            - Generate a tar file (this only works with git)

The following environment variables can be set to influence the configuration
step and the build:

EOF
    set_defaults
    echo "CMAKE_BUILD_TYPE   {Release,Debug}          (default is ${CMAKE_BUILD_TYPE})"
    echo "BML_PREFIX_PATH    Path to include          (default is ${BML_PREFIX_PATH})"
    echo "CC                 Path to C compiler       (default is ${CC})"
    echo "CXX                Path to C++ compiler     (default is ${CXX})"
    echo "FC                 Path to Fortran compiler (default is ${FC})"
    echo "PROGRESS_OPENMP    {yes,no}                 (default is ${PROGRESS_OPENMP})"
    echo "PROGRESS_MPI       {yes,no}                 (default is ${PROGRESS_MPI})"
    echo "PROGRESS_CINTERFACE{yes,no}                 (default is ${PROGRESS_CINTERFACE})"
    echo "PROGRESS_TESTING   {yes,no}                 (default is ${PROGRESS_TESTING})"
    echo "PROGRESS_EXAMPLES  {yes,no}                 (default is ${PROGRESS_EXAMPLES})"
    echo "PROGRESS_BENCHMARKS {yes,no}                (default is ${PROGRESS_BENCHMARKS})"
    echo "PROGRESS_GRAPHLIB  {yes,no}                 (default is ${PROGRESS_GRAPHLIB})"
    echo "PROGRESS_SP2TC     {Fortran,C++,no}         (default is ${PROGRESS_SP2TC})"
    echo "BUILD_DIR          Path to build dir        (default is ${BUILD_DIR})"
    echo "INSTALL_DIR        Path to install dir      (default is ${INSTALL_DIR})"
    echo "EXTRA_FCFLAGS      Extra fortran flags      (default is '${EXTRA_FCFLAGS}')"
    echo "EXTRA_LINK_FLAGS   Any extra link flag      (default is '${EXTRA_LINK_FLAGS}')"
    echo "SANITY_CHECK       Add sanity checks        (default is ${SANITY_CHECK})"
    echo "PROGRESS_NONMPI_PRECOMMAND Command to prepend to tests (default is ${PROGRESS_NONMPI_PRECOMMAND})"
    echo "PROGRESS_NONMPI_PRECOMMAND_ARGS  Arguments for prepend command (default is ${PROGRESS_NONMPI_PRECOMMAND_ARGS})"
}

set_defaults() {
    : ${CMAKE_BUILD_TYPE:=Release}
    : ${CMAKE_PREFIX_PATH:=""}
    : ${BML_PREFIX_PATH:=""}
    : ${CC:=gcc}
    : ${CXX:=g++}
    : ${FC:=gfortran}
    : ${PROGRESS_OPENMP:=yes}
    : ${PROGRESS_MPI:=no}
    : ${PROGRESS_CINTERFACE:=yes}
    : ${PROGRESS_TESTING:=no}
    : ${PROGRESS_EXAMPLES:=no}
    : ${PROGRESS_BENCHMARKS:=no}
    : ${PROGRESS_GRAPHLIB:=no}
    : ${EXTRA_FCFLAGS:=}
    : ${PROGRESS_SP2TC:=no}
    : ${EXTRA_LINK_FLAGS:=""}
    : ${SANITY_CHECK:=no}
    : ${PROGRESS_NONMPI_PRECOMMAND:=""}
    : ${PROGRESS_NONMPI_PRECOMMAND_ARGS:=""}
}

die() {
    echo "fatal error"
    if [[ -f "${BUILD_DIR}/CMakeFiles/CMakeOutput.log" ]]; then
        echo "appending CMake output"
        echo "*********** CMake Output ***********" >> ${LOG_FILE}
        cat "${BUILD_DIR}/CMakeFiles/CMakeOutput.log" >> ${LOG_FILE}
    fi
    if [[ -f "${BUILD_DIR}/CMakeFiles/CMakeError.log" ]]; then
        echo "appending CMake error"
        echo "*********** CMake Error ***********" >> ${LOG_FILE}
        cat "${BUILD_DIR}/CMakeFiles/CMakeError.log" >> ${LOG_FILE}
    fi
    echo "the output from this build was written to ${LOG_FILE}"
    if [[ $# -gt 1 ]]; then
        exit $1
    else
        exit 1
    fi
}

check_pipe_error() {
    if [[ ${PIPESTATUS[0]} -ne 0 ]]; then
        die ${PIPESTATUS[0]}
    fi
}

create() {
    mkdir -v -p "${BUILD_DIR}" || die
    mkdir -v -p "${INSTALL_DIR}" || die
}

configure() {
    set_defaults
    cd "${BUILD_DIR}"
    if [[ -f "${BUILD_DIR}/CMakeCache.txt" ]]; then
        rm -v "${BUILD_DIR}/CMakeCache.txt" || die
    fi
    ${CMAKE:=cmake} .. \
        -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" \
	${CMAKE_PREFIX_PATH:+-DCMAKE_PREFIX_PATH="${CMAKE_PREFIX_PATH}"} \
        -DBML_PREFIX_PATH="${BML_PREFIX_PATH}" \
        -DCMAKE_C_COMPILER="${CC}" \
        -DCMAKE_CXX_COMPILER="${CXX}" \
        -DCMAKE_Fortran_COMPILER="${FC}" \
        ${CMAKE_C_FLAGS:+-DCMAKE_C_FLAGS="${CMAKE_C_FLAGS}"} \
        ${CMAKE_CXX_FLAGS:+-DCMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS}"} \
        ${CMAKE_Fortran_FLAGS:+-DCMAKE_Fortran_FLAGS="${CMAKE_Fortran_FLAGS}"} \
        -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \
        -DPROGRESS_OPENMP="${PROGRESS_OPENMP}" \
        -DPROGRESS_MPI="${PROGRESS_MPI}" \
        -DBUILD_SHARED_LIBS="${BUILD_SHARED_LIBS:=no}" \
        -DPROGRESS_TESTING="${PROGRESS_TESTING}" \
        -DPROGRESS_EXAMPLES="${PROGRESS_EXAMPLES}" \
        -DPROGRESS_BENCHMARKS="${PROGRESS_BENCHMARKS}" \
        -DPROGRESS_GRAPHLIB="${PROGRESS_GRAPHLIB}" \
        -DPROGRESS_SP2TC="${PROGRESS_SP2TC}" \
        -DEXTRA_FCFLAGS="${EXTRA_FCFLAGS}" \
        -DEXTRA_LINK_FLAGS="${EXTRA_LINK_FLAGS}" \
        -DCMAKE_VERBOSE_MAKEFILE=${VERBOSE_MAKEFILE} \
        -DSANITY_CHECK=${SANITY_CHECK} \
        -DPROGRESS_NONMPI_PRECOMMAND=${PROGRESS_NONMPI_PRECOMMAND} \
        -DPROGRESS_NONMPI_PRECOMMAND_ARGS=${PROGRESS_NONMPI_PRECOMMAND_ARGS} \
        | tee -a "${LOG_FILE}"
    check_pipe_error
    cd "${TOP_DIR}"
}

compile() {
    make -C "${BUILD_DIR}" | tee -a "${LOG_FILE}"
    check_pipe_error
}

docs() {
    make -C "${BUILD_DIR}" docs 2>&1 | tee -a "${LOG_FILE}"
    check_pipe_error
    #make -C "${BUILD_DIR}/doc/latex" 2>&1 | tee -a "${LOG_FILE}"
    #check_pipe_error
    #if test -f "${BUILD_DIR}/doc/latex/refman.pdf"; then
    #cp -v "${BUILD_DIR}/doc/latex/refman.pdf" "${TOP_DIR}/bml-manual.pdf"
    #fi
}

install() {
    make -C "${BUILD_DIR}" install 2>&1 | tee -a "${LOG_FILE}"
    check_pipe_error
}

testing() {
    cd "${BUILD_DIR}"
    ctest --output-on-failure 2>&1 | tee -a "${LOG_FILE}"
    check_pipe_error
    cd "${TOP_DIR}"
}

indent() {
    cd "${TOP_DIR}"
    "${TOP_DIR}/indent.sh" 2>&1 | tee --append "${LOG_FILE}"
    check_pipe_error
}

check_indent() {
    cd "${TOP_DIR}"
    "${TOP_DIR}/indent.sh" 2>&1 | tee --append "${LOG_FILE}"
    check_pipe_error
    git diff 2>&1 | tee --append "${LOG_FILE}"
    check_pipe_error
    LINES=$(git diff | wc -l)
    if test ${LINES} -gt 0; then
        echo "sources were not formatted correctly"
        die
    fi
}

dist() {
    make -C "${BUILD_DIR}" dist 2>&1 | tee -a "${LOG_FILE}"
    check_pipe_error
}

echo "Writing output to ${LOG_FILE}"

if [[ $# -gt 0 ]]; then
    if [[ "$1" = "-h" || "$1" = "--help" ]]; then
        help
        exit 0
    fi

    case "$1" in
        "create")
            create
            ;;
        "configure")
            create
            configure
            ;;
        "docs")
            create
            configure
            docs
            ;;
        "compile")
            create
            configure
            compile
            ;;
        "install")
            create
            configure
            install
            ;;
        "testing")
            create
            configure
            install
            testing
            ;;
        "indent")
            indent
            ;;
        "check_indent")
            create
            check_indent
            ;;
        "dist")
            create
            configure
            dist
            ;;
        *)
            echo "unknown command $1"
            exit 1
            ;;
    esac
else
    echo "missing action"
    help
fi

echo "The output was written to ${LOG_FILE}"