build.sh

#!/usr/bin/env bash

#
# \file 			build.sh
# \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
# \edited           n/a
# \created			2017-09-27
# \last-modified	2017-11-27
# \brief 			Bash script for building/installing the source code.
# \details
#		See README.md in root dir for more info.

# Get script path
script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

# 3rd party imports
. ${script_dir}/lib/shflags

# User imports
. ${script_dir}/lib/utilities.sh

printInfo "=========================================================================================="
printInfo "=================================== MFixedPoint build.sh ================================="
printInfo "=========================================================================================="

set +e

# Define the command-line arguments
DEFINE_boolean 'install' 'false' 'Do you want to [i]nstall the software onto your local system after build?' 'i'
DEFINE_boolean 'coverage' 'false' 'Do you want to record test [c]overage metrics?' 'c'

# parse the command-line
FLAGS "$@" || exit 1
eval set -- "${FLAGS_ARGV}"

# Any subsequent commands which fail will cause the shell script to exit immediately
# WARNING: Make sure to only activate this AFTER shflags has parsed command-line arguments
set -e

printInfo "install = ${FLAGS_install}"
printInfo "coverage = ${FLAGS_coverage}"

BUILD_DIRECTORY_NAME="build"

# This will only make the build directory if it doesn't already
# exist. If it does exist, there is likely to be build artifacts
# in there already.
printInfo "Making and/or changing into build directory (${script_dir}/../${BUILD_DIRECTORY_NAME}/)..."
mkdir -p ${script_dir}/../${BUILD_DIRECTORY_NAME}/
cd ${script_dir}/../${BUILD_DIRECTORY_NAME}/

if [[ "$FLAGS_coverage" == $FLAGS_TRUE ]]; then
    printInfo 'Invoking cmake with -DCOVERAGE=1...'
    cmake -DCOVERAGE=1 ..
else
    printInfo 'Invoking cmake without -DCOVERAGE=1...'
    cmake ..
fi

printInfo 'Invoking make...'
make -j8

printInfo 'Running unit tests...'
make -j8 run_unit_tests

if [[ "$FLAGS_coverage" == $FLAGS_TRUE ]]; then
    printInfo 'Running coverage report...'
    make -j8 MFixedPoint_coverage
    lcov --directory . --capture --output-file coverage.info # capture coverage info
    lcov --remove coverage.info '/usr/*' --output-file coverage.info # filter out system
    lcov --remove coverage.info '*/test/*' --output-file coverage.info # filter out test
    lcov --list coverage.info #debug info

    printInfo "Uploading coverage data..."

    # Uploading report to CodeCov
    # NOTE: This only works when invoked on TravisCI
    bash <(curl -s https://codecov.io/bash) -f coverage.info || echo "Codecov did not collect coverage reports"
fi

if [[ "$FLAGS_install" == $FLAGS_TRUE ]]; then
	printInfo "Installing MFixedPoint onto local system..."
    sudo make install
fi