build.sh

#!/bin/bash
#
# Builder – Compile scripts for local installs of software packages.
# Copyright (C) 2020 Forschungszentrum Jülich GmbH, INM-6
#
# Builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Builder.  If not, see <https://www.gnu.org/licenses/>.
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
set -euo pipefail
if [ -z "${BUILDER_PATH+x}" ]; then
	BUILDER_PATH="$(dirname "$(realpath "$0")")"
fi
# Use ~/.buildrc as default config, unless specified explicitly in an
# environment variable.
BUILDER_CONFIG="${BUILDER_CONFIG:-${HOME}/.buildrc}"


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Comman line parsing

FORCE=false
SILENT=false
SKIPBUILD=false
GET=false

PACKAGE=${1:-help}
shift || true
case "$PACKAGE" in
*help | -h)
	cat <<ENDHELP
Usage: build -h|--help
       build configure
       build [-f | -s | -g] <package> [<version>] [<variant>] [<suffix>]

  Install software as given in a build plan identifed by <package>, <version>
  and optional <variant> and <suffix>. If no <variant> is given, the "default"
  variant will be built. Note that you need to specify <variant> if you want to
  pass <suffix>. If no <suffix> is given, the <variant> will be built.

Options:

  -h or --help       this text is printed
  configure          installs ~/.buildrc or the file pointed to by BUILDER_CONFIG and exits
  --dry-run          skip build
  -s or --silent     skip build if installation folder exists
  -f or --force      rebuild even if installation folder exists, delete source folder if it exits
  -g or --get        only download the package source files, adding --silent
                     or -s results in dowloading the package files silently

  Builder  Copyright (C) 2020  Dennis Terhorst, Forschungszentrum Jülich GmbH/INM-6
  This program comes with ABSOLUTELY NO WARRANTY; for details type 'build help'.
  This is free software, and you are welcome to redistribute it under certain
  conditions; see '${BUILDER_PATH}/LICENSE' for details.

ENDHELP
	exit 0
	;;
-f | --force)
	PACKAGE=$1
	if [ $PACKAGE = -s ] || [ $PACKAGE = --silent ] ; then
		echo "ERROR: force and silent options are mutually exclusive!"
		exit 1
	fi
	FORCE=true
	shift
	;;
-s | --silent)
	PACKAGE=$1
	if [ $PACKAGE = -f ] || [ $PACKAGE = --force ] ; then
		echo "ERROR: force and silent options are mutually exclusive!"
		exit 1
	fi
	SILENT=true
	shift
	;;
-g | --get)
	PACKAGE=$1
	GET=true
	shift
	if [ $PACKAGE = -s ] || [ $PACKAGE = --silent ] ; then
		SILENT=true
		PACKAGE=$1
		shift
	fi
	;;
--dry-run)
	PACKAGE=$1
	SKIPBUILD=true
	shift
	echo ">>> skip build (dry run)"
	;;
esac


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Setup Builder configuration

if [ "${PACKAGE}" == "configure" -a -e "${BUILDER_CONFIG}" ]; then
	cat <<ENDNOTICE
!!!
!!! ${BUILDER_CONFIG} already exists.
!!!
!!! Edit manually or delete it to install a new default configuration.
!!!
ENDNOTICE
fi
if [ ! -e "${BUILDER_CONFIG}" ]; then
	echo ">>> installing default configuration '${BUILDER_CONFIG}'..."
	cat >"${BUILDER_CONFIG}" <<ENDRC
#
# This is the configuration file for Builder
# (auto-generated on $(date))
#
# If you use environment or Builder internal variables to define paths, you
# have to escape the dollar '\\\$' to defer evaluation to the actual build
# time.
#
# Builder internal variables are evaluated in the following order:
# SOURCE, TARGET, BUILD, LOG
# Each definition can reference only preceeding ones.

# storage of all build plans
PLANFILE_PATH="\${PLANFILE_PATH:-${BUILDER_PATH}/plans}"

# storage of all package archives (like .tar.gz files)
PACKAGE_CACHE="\${HOME}/builder-cache/packages"

# temporary storage of source files (extracted from tar-balls)
SOURCE_PATH="\${HOME}/builder-cache/src"

# location for out-of-tree builds
BUILD_PATH="\${HOME}/builder-cache/build"

# install path (usually used as --prefix)
TARGET_PATH="\${TARGET_PATH:-\${HOME}/install}"

# module install path. If defined and a template file
# '<package>/<version>/<variant>.module' exists, it will be filled and copied
# to '<MODULE_INSTALL_PATH>/<package>/<version>/<variant>'.
MODULE_INSTALL_PATH="\${MODULE_INSTALL_PATH:-\${HOME}/modules}"

# path where to store logfiles of the build
LOG_PATH="\\\${BUILD}/logs"

# define the number of cores to use in standard build_package()
#MAKE_THREADS=\$(( \$(nproc) / 4 ))
ENDRC
	cat "${BUILDER_CONFIG}"
	cat <<ENDNOTE
!!!
!!! You probably want to modify at least the \$TARGET_PATH in your
!!! configuration in '${BUILDER_CONFIG}'.
!!!
ENDNOTE
	echo -e "\n>>> default configuration has been written to"
	echo -e "    ${BUILDER_CONFIG}\n"
	if [ "$PACKAGE" != "configure" ]; then
		echo "!!! Please check that the guessed paths are correct and"
		echo "!!! rerun the build command."
		echo -e "\n>>> Stopping here, to be sure."
		exit 1
	fi
fi

# load configuration
if [ -r "${BUILDER_CONFIG}" ]; then
	. "${BUILDER_CONFIG}"
else
	echo "ERROR: Could not read ${BUILDER_CONFIG}"
	exit 1
fi

# load Builder function library
if [ ! -r "${BUILDER_PATH}/build_functions.sh" ]; then
	echo "ERROR: could not find Builder functions!"
	exit 1
fi
. "${BUILDER_PATH}/build_functions.sh"
if [ "${PACKAGE}" == "configure" ]; then
	exit 1
fi


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# set up builder variables for the plan files
if [ -z ${1+x} ]; then
	log_warning ">>>"
	log_warning ">>> No version specified!"
	guess="$(ls -1 "${PLANFILE_PATH}/${PACKAGE}" | grep '^[0-9]\+\.[0-9]\+.*' | sort -V | tail -n1)"
	log_warning ">>> Guessing you want the latest available version:"
	log_warning ">>>    ${PACKAGE}-${guess}"
	log_warning ">>>"
	VERSION="${guess}"
else
	VERSION="${1}"	# keep version as $1 in $@ to hand it to the build scripts!
fi
VARIANT="${2:-default}"	# optional variant
PLAN="${PLANFILE_PATH}/${PACKAGE}/${VERSION}/${VARIANT}" # set plan path

if [ ! -z "${3:-}" ]
then
	VARIANT="${VARIANT}_${3}"    # append suffix to variant if suffix not empty
fi

log_status ">>> set up build of ${PACKAGE} ${VERSION} (${VARIANT} variant)..."
if version_gt $BASH_VERSION 4.4; then
	SOURCE="${SOURCE_PATH@P}/${PACKAGE}-${VERSION}"
	TARGET="${TARGET_PATH@P}/${PACKAGE}/${VERSION}/${VARIANT}"
	BUILD="${BUILD_PATH@P}/${PACKAGE}/${VERSION}/${VARIANT}"
	LOG="${LOG_PATH@P}"
else
	SOURCE="$(eval echo "${SOURCE_PATH}/${PACKAGE}-${VERSION}")"
	TARGET="$(eval echo "${TARGET_PATH}/${PACKAGE}/${VERSION}/${VARIANT}")"
	BUILD="$(eval echo "${BUILD_PATH}/${PACKAGE}/${VERSION}/${VARIANT}")"
	LOG="$(eval echo "${LOG_PATH}")"
fi


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Load the build plan
log_status ">>> loading the build plan..."
. "${PLAN}"

log_status ">>> build environment information"
builder_info

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Run build sequence
if [ -d "${BUILD}" ] && [ $SILENT = true ]; then
	SKIPBUILD=true
fi
if [ $FORCE = false ] && [ $SILENT = false ]  ; then
	log_success "\nPRESS ENTER TO START"
	read
fi
if [ $SKIPBUILD = true ] ; then
	log_success ">>> package already built and rebuild is skipped due to slient mode."
	log_success ">>>\n>>> nothing to do.\n>>>"
	exit 0
fi

source_get
if [ $GET = true ] ; then
	exit 0
fi
source_prepare
build_prepare
build_package
build_test
build_install
build_install_test
module_install

log_success ">>>\n>>> done.\n>>>"