build-one.sh

#!/bin/bash

# The Build all script is intended for checking projects and solutions
# uploaded to a GIT repo for continuous integration checks.

# It looks for solutions to exercises in a "solutions" folder
# in a set of standard locations:

LOCATIONS=". .. $HOME"
SOL_PATH=". exercises *_exercises *_exercises/exercises"

# Solutions must be in folder names starting or ending with a digit and optional letter.
# If a solution folder contains a MakeLists.txt file a CMake build is run
# in the solution folder. If the solution contains an SConstruct file a
# scons build is run. Otherwise the build-one.sh command is run to
# build the solution.

set -o nounset 
set -o errexit

# configurable variables

CMAKE_BUILD="./build.sh reset"
SCONS_BUILD="scons -c; scons"

# command line options for RTOS

SCONS_RTOS="$SCONS_BUILD --rtos"
BUILD=
BUILD_RTOS=

SOURCES="src include"
BACKUP=src.bak

function err_exit {
  [[ -n ${1:-} ]] && echo "$1" >&2
  echo >&2 <<EOT
Build script for exercise solutions
Usage: $0 [-q|--quiet] [--scons|--cmake] [-cnn] [-c++nn] [-A|--all]  [ NN ]
  where NN is the chapter number, or
  -A --all        to build all solutions
  -c --copy       copy without building the solution
  -v --verbose    show diagnostic trace messages
  -q --quiet      to suppress output messages, a build failure is always reported
  --Cnn           pass C version to build.sh also --c
  --C++nn         pass C++ version to build.sh also --c++ --cpp --CPP
  --scons --cmake to override default build system
EOT
  exit 1
}

function trace {
  [[ -z $QUIET ]] && echo $1
  : # required due to bug in handling &&
}

function get_solutions {
  SOLDIR=
  for loc in $LOCATIONS; do
    for dir in $SOL_PATH ; do
      sol=$(echo $loc/$dir/solutions)
      [[ -d $sol ]] && SOLDIR=$sol && break
    done
    [[ -n $SOLDIR ]] && break
  done
  [[ -z $SOLDIR ]] && err_exit "Cannot find solutions folder"
  : # required due to bug in handling &&
}

function get_all_exercises {
  EXERCISES=
  EXDIR=$(ls "$1" | egrep '^[0-9]|[0-9][A-Z]?$') 
  for ex in $EXDIR; do
    n=$(echo $ex | sed -rn 's/^(0?[1-9][0-9]?[^0-9])|(0?[1-9][0-9]?[A-Z]?)$/\1\2/p')
    EXERCISES="$EXERCISES $n"
  done
}


VERBOSE=
EXERCISES=
SOLDIR=
REDIR=/dev/stdout
QUIET=
EX=
COPY=

[[ -z $SOLDIR ]] && get_solutions 
[[ -z $SOLDIR ]] && err_exit "Cannot find solutions folder"

for arg; do
  case "$arg" in
    -A|--all) 
      ALL=1
      get_solutions 
      get_all_exercises $SOLDIR
      ;;
    -c|--copy)
      COPY=1
      ;;
    -v|--verbose) 
      VERBOSE=y
      ;;
    -q|--quiet) 
      REDIR=/dev/null
      QUIET=y
      ;;
    --scons) 
      [[ -n $BUILD ]] && err_exit "Cannot specify more than one build system"
      [[ ! -f SConstruct ]] && err_exit "Missing SConstruct file required by scons"
      BUILD="$SCONS_BUILD"
      BUILD_RTOS="$SCONS_RTOS"
      ;;
    --cmake) 
      [[ -n $BUILD ]] && err_exit "Cannot specify more than one build system"
      [[ ! -f CMakeLists.txt ]] && err_exit "Missing CMakeLists.txt file required by cmake"
      BUILD="$CMAKE_BUILD"
      BUILD_RTOS="$CMAKE_BUILD"
      ;;
    --[cC][0-9][0-9])
      BUILD="$CMAKE_BUILD $arg"
      BUILD_RTOS="$CMAKE_BUILD"
      ;;
    --[cC]++[0-9][0-9]|--cpp[0-9][0-9]|--CPP[0-9][0-9])
      BUILD="$CMAKE_BUILD $arg"
      BUILD_RTOS="$CMAKE_BUILD $arg"
      ;;
    --help|-h|-\?) 
      err_exit 
      ;;
    *) 
      [[ -n $EX ]] && err_exit "Cannot specify another solution after '$EX'"
      EX="$arg"
      ;;
  esac
done

[[ -z $EXERCISES && -z "$EX" ]] && err_exit "Please supply a solution number or name on the command line"
[[ -n $EXERCISES && -n "$EX" ]] && err_exit "Cannot specify solution '$EX' and --all"

if [[ -z $EXERCISES ]]; then
  case "$EX" in
    [1-9]|[1-9][A-Z]) 
      EXERCISES="0$EX"
      ;;
    [0-9][0-9]|[0-9][0-9][A-Z]) 
      EXERCISES="$EX"
      ;;
    *)
      if [[ ! -d "$SOLDIR/$EX" ]]; then
        err_exit "Invalid solution number: $EX"
      fi
      EXERCISES="$EX"
      ;;
  esac
fi

# clean/create backup folder

if [[ -f CMakeLists.txt || -f SConstruct ]]; then
  for src in $SOURCES; do
    dir="$BACKUP/$src"
    if [[ -d "$dir" ]]; then
      rm -rf "$dir"/* 2>/dev/null
    else
      trace "Making backup folder $dir"
      mkdir -p $dir
    fi
  done
else
  err_exit "please run this script inside the root of your workspace"
fi

for EX in $EXERCISES; do
  # find solution folder name
  if [[ -d "$SOLDIR/$EX" ]]; then
    EXDIR=$EX
  else
    EXDIR=$(ls "$SOLDIR" | egrep "^0?${EX}[^0-9]|0?${EX}$") || true
    [[ -z $EXDIR ]] && err_exit "No solution provided for exercise $EX"
    (cd $SOLDIR; ls -d $EXDIR); 
    N=$(cd $SOLDIR; ls -d $EXDIR | wc -l)
    (( N > 1 )) && err_exit "Multiple solutions for exercise $EX
    Please specify number and letter, or the full solution name"
  fi

  for src in $SOURCES; do
    trace "Moving source files to $BACKUP/$src"
    mv "$src"/* "$BACKUP/$src" 2>/dev/null || true
  done

  # handle different solution layouts
  
  if [[ -d "$SOLDIR/$EXDIR/src" ]]; then
    for dir in $SOURCES; do
      from="$SOLDIR/$EXDIR/$dir"
      [[ ! -d $from && $dir == include ]] && from="$SOLDIR/$EXDIR/inc"
      if [[ -d "$from" ]]; then
          trace "Copying solution files from $from"
          cp -f "$from"/* $dir 2>/dev/null || true
      fi
    done 
  else
    trace "Copying solution files from $SOLDIR/$EXDIR"
    cp -f "$SOLDIR/$EXDIR"/* src 2>/dev/null || true
  fi

  if [[ -z $COPY ]]; then
    # run build
    RTOS=
    if grep -iq 'feabhOS[a-z_0-9]*\.h' include/*.h src/*.c src/*.cpp 2>/dev/null; then
      RTOS=1
    fi
    
    if [[ -n $VERBOSE ]]; then
      echo "checking $EX" >&2
    fi
    
    set +o errexit

    if [[ -n $BUILD ]]; then
      [[ -n $RTOS ]] && BUILD="$BUILD_RTOS"
      trace "Building solutions using $BUILD"
      (eval $(echo "$BUILD")) >$REDIR 2>&1
    elif [[ -f CMakeLists.txt ]]; then
      trace "Running cmake build: $CMAKE_BUILD"
      (eval $(echo "$CMAKE_BUILD")) >$REDIR 2>&1
    elif [[ -f SConstruct ]]; then
      [[ -n $RTOS ]] && SCONS_BUILD="$SCONS_RTOS"
      trace "Running scons build: $SCONS_BUILD"
      (eval $(echo "$SCONS_BUILD")) >$REDIR 2>&1
    else
      err_exit "Cannot file suitable build configuration file"
    fi
    status=$?
    if [[ $status != 0 ]]; then
      echo "Build failed for solution '$EXDIR'"
      exit $status
    else
      echo "Build succeded for solution '$EXDIR'"
    fi
    set -o errexit
  fi
done