Merge "Adding docs for IPv6 underlay deployments"
[apex.git] / ci / build.sh
index fd5bffe..af065b1 100755 (executable)
-#!/bin/bash
-set -e
+#!/bin/sh
 ##############################################################################
-# Copyright (c) 2015 Ericsson AB and others.
-# stefan.k.berg@ericsson.com
-# jonas.bjurel@ericsson.com
-# dradez@redhat.com
+# Copyright (c) 2016 Dan Radez (Red Hat) and others.
+#
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Apache License, Version 2.0
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 
-trap 'echo "Exiting ..."; \
-if [ -f ${LOCK_FILE} ]; then \
-   if [ $(cat ${LOCK_FILE}) -eq $$ ]; then \
-      rm -f ${LOCK_FILE}; \
-   fi; \
-fi;' EXIT
+set -e
 
-############################################################################
-# BEGIN of usage description
-#
-usage ()
+display_usage ()
 {
 cat << EOF
 $0 Builds the Apex OPNFV Deployment Toolchain
 
-usage: $0 [-s spec-file] [-c cache-URI] [-l log-file] [-f Flags] build-directory
+usage: $0 [ -c cache_dir ] -r release_name [ --iso | --rpms ]
 
 OPTIONS:
-  -s spec-file ($BUILD_SPEC), define the build-spec file, default ../build/config.mk
-  -c cache base URI ($BUILD_CACHE_URI), specifies the base URI to a build cache to be used/updated - the name is automatically generated from the md5sum of the spec-file, http://, ftp://, file://[absolute path] suported.
-
-  -l log-file ($BUILD_LOG), specifies the output log-file (stdout and stderr), if not specified logs are output to console as normal
-  -v version tag to be applied to the build result
-  -r alternative remote access method script/program. curl is default.
-  -t run small build-script unit test.
-  -T run large build-script unit test.
-  -f build flags ($BUILD_FLAGS):
-     o s: Do nothing, succeed
-     o f: Do nothing, fail
-     o t: run build unit tests
-     o M: Use master branch code
-     o i: run interactive (-t flag to docker run)
-     o P: Populate a new local cache and push it to the (-c cache-URI) cache artifactory if -c option is present, currently file://, http:// and ftp:// are supported
-     o d: Detatch - NOT YET SUPPORTED
-
-  build-directory ($BUILD_DIR), specifies the directory for the output artifacts (.iso file).
-
+  -c cache destination - directory of cached files, defaults to ./cache
+  -r release name/version of the build result
+  --iso build the iso (implies RPMs too)
+  --rpms build the rpms
+  --debug enable debug
   -h help, prints this help text
 
-Description:
-build.sh builds opnfv .iso artifact.
-To reduce build time it uses build cache on a local or remote location. The cache is rebuilt and uploaded if either of the below conditions are met:
-1) The P(opulate) flag is set and the -c cache-base-URI is provided, if -c is not provided the cache will stay local.
-2) If the cache is invalidated by one of the following conditions:
-   - The config spec md5sum does not compare to the md5sum for the spec which the cache was built.
-   - The git Commit-Id on the remote repos/HEAD defined in the spec file does not correspont with the Commit-Id for what the cache was built with.
-3) A valid cache does not exist on the specified -c cache-base-URI.
-
-The cache URI object name is apex_cache-"md5sum(spec file)"
-
-Logging by default to console, but can be directed elsewhere with the -l option in which case both stdout and stderr is redirected to that destination.
-
-Built in unit testing of components is enabled by adding the t(est) flag.
-
-Return codes:
- - 0 Success!
- - 1-99 Unspecified build error
- - 100-199 Build system internal error (not build it self)
-   o 101 Build system instance busy
- - 200 Build failure
-
-Examples:
-build -c http://opnfv.org/artifactory/apex/cache -d ~/jenkins/genesis/apex/ci/output -f ti
-NOTE: At current the build scope is set to the git root of the repository, -d destination locations outside that scope will not work
+Example:
+build -c file:///tmp/cache -r dev123
 EOF
 }
-#
-# END of usage description
-############################################################################
 
-############################################################################
-# BEGIN of variables to customize
-#
 BUILD_BASE=$(readlink -e ../build/)
-RESULT_DIR="${BUILD_BASE}/release"
-BUILD_SPEC="${BUILD_BASE}/config.mk"
+CACHE_DEST=""
 CACHE_DIR="cache"
-LOCAL_CACHE_ARCH_NAME="apex-cache"
-REMOTE_CACHE_ARCH_NAME="apex_cache-$(md5sum ${BUILD_SPEC}| cut -f1 -d " ")"
-REMOTE_ACCESS_METHD=curl
-INCLUDE_DIR=../include
-#
-# END of variables to customize
-############################################################################
-
-############################################################################
-# BEGIN of script assigned variables
-#
-SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-LOCK_FILE="${SCRIPT_DIR}/.build.lck"
-CACHE_TMP="${SCRIPT_DIR}/tmp"
-TEST_SUCCEED=0
-TEST_FAIL=0
-UNIT_TEST=0
-USE_MASTER=0
-UPDATE_CACHE=0
-POPULATE_CACHE=0
-RECURSIV=0
-DETACH=0
-DEBUG=0
-INTEGRATION_TEST=0
-FULL_INTEGRATION_TEST=0
-INTERACTIVE=0
-BUILD_CACHE_URI=
-BUILD_SPEC=
-BUILD_DIR=
-BUILD_LOG=
-BUILD_VERSION=
-MAKE_ARGS=
-#
-# END of script assigned variables
-############################################################################
-
-############################################################################
-# BEGIN of include pragmas
-#
-source ${INCLUDE_DIR}/build.sh.debug
-#
-# END of include
-############################################################################
-
-############################################################################
-# BEGIN of main
-#
-while getopts "s:c:d:v:f:l:r:RtTh" OPTION
-do
-    case $OPTION in
-       h)
-           usage
-           rc=0
-           exit $rc
-           ;;
-
-       s)
-           BUILD_SPEC=${OPTARG}
-           ;;
-
-       c)
-           BUILD_CACHE_URI=${OPTARG}
-           ;;
-
-       d)
-           BUILD_DIR=${OPTARG}
-           ;;
-
-       l)
-           BUILD_LOG=${OPTARG}
-           ;;
-
-       v)
-           BUILD_VERSION=${OPTARG}
-           ;;
-
-       f)
-           BUILD_FLAGS=${OPTARG}
-           ;;
-
-       r)  REMOTE_ACCESS_METHD=${OPTARG}
-           ;;
-
-       R)
-           RECURSIVE=1
-           ;;
-
-       t)
-           INTEGRATION_TEST=1
-           ;;
-
-       T)
-           INTEGRATION_TEST=1
-           FULL_INTEGRATION_TEST=1
-           ;;
-
-       *)
-           echo "${OPTION} is not a valid argument"
-           rc=100
-           exit $rc
-           ;;
+CACHE_NAME="apex-cache"
+MAKE_TARGETS="images"
+REQUIRED_PKGS="rpm-build python-docutils"
+
+parse_cmdline() {
+  while [ "${1:0:1}" = "-" ]
+  do
+    case "$1" in
+        -h|--help)
+                display_usage
+                exit 0
+            ;;
+        -c|--cache-dir)
+                CACHE_DEST=${2}
+                shift 2
+            ;;
+        -r|--release)
+                RELEASE=${2}
+                shift 2
+            ;;
+        --iso )
+                MAKE_TARGETS="iso"
+                echo "Building opnfv-apex RPMs and ISO"
+                shift 1
+            ;;
+        --rpms )
+                MAKE_TARGETS="rpms"
+                echo "Buiding opnfv-apex RPMs"
+                shift 1
+            ;;
+        --debug )
+                debug="TRUE"
+                echo "Enable debug output"
+                shift 1
+            ;;
+        *)
+                display_usage
+                exit 1
+            ;;
     esac
-done
-
-if [ -z $BUILD_DIR ]; then
-    BUILD_DIR=$(echo $@ | cut -d ' ' -f ${OPTIND})
-fi
-
-for ((i=0; i<${#BUILD_FLAGS};i++)); do
-    case ${BUILD_FLAGS:$i:1} in
-       s)
-           rc=0
-           exit $rc
-           ;;
-
-       f)
-           rc=1
-           exit $rc
-           ;;
+  done
 
-       t)
-           UNIT_TEST=1
-           ;;
-
-       M)
-           USE_MASTER=1
-           ;;
-
-       i)
-           INTERACTIVE=1
-           ;;
-
-       P)
-           POPULATE_CACHE=1
-           ;;
-
-       d)
-           DETACH=1
-           echo "Detach is not yet supported - exiting ...."
-           rc=100
-           exit $rc
-           ;;
-
-       D)
-           DEBUG=1
-           ;;
-
-       *)
-           echo "${BUILD_FLAGS:$i:1} is not a valid build flag - exiting ...."
-           rc=100
-           exit $rc
-           ;;
-    esac
-done
-
-shift $((OPTIND-1))
-
-if [ ${INTEGRATION_TEST} -eq 1 ]; then
-    integration-test
-    rc=0
-    exit $rc
-fi
+}
 
-if [ ! -f ${BUILD_SPEC} ]; then
-    echo "spec file does not exist: $BUILD_SPEC - exiting ...."
-    rc=100
-    exit $rc
-fi
+run_make() {
+  make $MAKE_ARGS -C ${BUILD_BASE} $1
+}
 
-if [ -z ${BUILD_DIR} ]; then
-    echo "Missing build directory - exiting ...."
-    rc=100
-    exit $rc
-fi
+parse_cmdline "$@"
 
-if [ ! -z ${BUILD_LOG} ]; then
-    if [[ ${RECURSIVE} -ne 1 ]]; then
-       set +e
-       eval $0 -R $@ > ${BUILD_LOG} 2>&1
-       rc=$?
-       set -e
-       if [ $rc -ne 0]; then
-           exit $rc
-       fi
+# Install build dependencies
+for pkg in $REQUIRED_PKGS; do
+  if ! rpm -q $pkg > /dev/null; then
+    if ! sudo yum -y install $pkg > /dev/null; then
+      echo "Required package $pkg missing and installation failed."
+      exit 1
     fi
-fi
-
-if [ ${TEST_SUCCEED} -eq 1 ]; then
-    sleep 1
-    rc=0
-    exit $rc
-fi
-
-if [ ${TEST_FAIL} -eq 1 ]; then
-    sleep 1
-    rc=1
-    exit $rc
-fi
-
-if [ -e ${LOCK_FILE} ]; then
-    echo "A build job is already running, exiting....."
-    rc=101
-    exit $rc
-fi
-
-echo $$ > ${LOCK_FILE}
-
-if [ ! -z ${BUILD_CACHE_URI} ]; then
-    if [ ${POPULATE_CACHE} -ne 1 ]; then
-       rm -rf ${CACHE_TMP}/cache
-       mkdir -p ${CACHE_TMP}/cache
-       echo "Downloading cach file ${BUILD_CACHE_URI}/${REMOTE_CACHE_ARCH_NAME} ..."
-       set +e
-       ${REMOTE_ACCESS_METHD} -o ${CACHE_TMP}/cache/${LOCAL_CACHE_ARCH_NAME}.tgz ${BUILD_CACHE_URI}/${REMOTE_CACHE_ARCH_NAME}.tgz
-       rc=$?
-       set -e
-       if [ $rc -ne 0 ]; then
-               echo "Remote cache does not exist, or is not accessible - a new cache will be built ..."
-               POPULATE_CACHE=1
-       else
-           echo "Unpacking cache file ..."
-           tar -C ${CACHE_TMP}/cache -xvf ${CACHE_TMP}/cache/${LOCAL_CACHE_ARCH_NAME}.tgz
-           cp ${CACHE_TMP}/cache/cache/.versions ${BUILD_BASE}/.
-           set +e
-                   make -C ${BUILD_BASE} validate-cache;
-           rc=$?
-           set -e
+  fi
+done
 
-           if [ $rc -ne 0 ]; then
-               echo "Cache invalid - a new cache will be built "
-               POPULATE_CACHE=1
-           else
-               cp -rf ${CACHE_TMP}/cache/cache/. ${BUILD_BASE}
-           fi
-           rm -rf ${CACHE_TMP}/cache
-       fi
+if [ -n "$RELEASE" ]; then MAKE_ARGS+="RELEASE=$RELEASE "; fi
+
+# Get the Old Cache
+if [ -n "$CACHE_DEST" ]; then
+    echo "Retrieving Cache"
+    if [ -f $CACHE_DEST/${CACHE_NAME}.tgz ]; then
+        echo "Cache found at ${CACHE_DEST}/${CACHE_NAME}.tgz"
+        rm -rf $BUILD_BASE/$CACHE_DIR
+        echo "Unpacking Cache to $BUILD_BASE"
+        tar -xvzf $CACHE_DEST/${CACHE_NAME}.tgz -C ${BUILD_BASE}
+        echo "Cache contents after unpack:"
+        ls -l $BUILD_BASE/$CACHE_DIR
+    elif [ ! -d $BUILD_BASE/$CACHE_DIR ]; then
+        mkdir $BUILD_BASE/$CACHE_DIR
     fi
 fi
 
-if [ ${POPULATE_CACHE} -eq 1 ]; then
-    if [ ${DEBUG} -eq 0 ]; then
-       set +e
-       cd ${BUILD_BASE} && make clean
-       rc=$?
-       set -e
-       if [ $rc -ne 0 ]; then
-           echo "Build - make clean failed, exiting ..."
-           rc=100
-           exit $rc
-       fi
+# Conditionally execute RPM build checks if the specs change and target is not rpm or iso
+if [[ "$MAKE_TARGETS" == "images" ]]; then
+    commit_file_list=$(git show --pretty="format:" --name-status)
+    if git show -s | grep "force-build-rpms"; then
+        MAKE_TARGETS+=" rpms"
+    elif [[ $commit_file_list == *"A$(printf '\t')"* || $commit_file_list == *build/Makefile* ]]; then
+        # Makefile forces all rpms to be checked
+        MAKE_TARGETS+=" rpms-check"
+    else
+        # Spec files are selective
+        if [[ $commit_file_list == *build/opnfv-apex-undercloud.spec* ]]; then
+            MAKE_TARGETS+=" undercloud-rpm-check"
+        fi
+        if [[ $commit_file_list == *build/opnfv-apex-common.spec* ]]; then
+            MAKE_TARGETS+=" common-rpm-check"
+        fi
+        if [[ $commit_file_list == *build/opnfv-apex.spec* ]]; then
+            MAKE_TARGETS+=" opendaylight-rpm-check"
+        fi
+        if [[ $commit_file_list == *build/opnfv-apex-onos.spec* ]]; then
+            MAKE_TARGETS+=" onos-rpm-check"
+        fi
+        if [[ $commit_file_list == *build/opnfv-apex-opendaylight-sfc.spec* ]]; then
+            MAKE_TARGETS+=" opendaylight-sfc-rpm-check"
+        fi
     fi
 fi
 
-if [ ! -z ${BUILD_VERSION} ]; then
-    MAKE_ARGS+="REVSTATE=${BUILD_VERSION} "
-fi
-
-if [ ${UNIT_TEST} -eq 1 ]; then
-    MAKE_ARGS+="UNIT_TEST=TRUE "
-else
-    MAKE_ARGS+="UNIT_TEST=FALSE "
-fi
-
-if [ ${USE_MASTER} -eq 1 ]; then
-    MAKE_ARGS+="USE_MASTER=-master "
-fi
-
-if [ ${INTERACTIVE} -eq 1 ]; then
-    MAKE_ARGS+="INTERACTIVE=TRUE "
-else
-    MAKE_ARGS+="INTERACTIVE=FALSE "
-fi
-
-MAKE_ARGS+=all
-
-if [ ${DEBUG} -eq 0 ]; then
-    set +e
-    cd ${BUILD_BASE} && make ${MAKE_ARGS}
-    rc=$?
-    set -e
-    if [ $rc -gt 0 ]; then
-       echo "Build: make all failed, exiting ..."
-       rc=200
-       exit $rc
+# Make sure python is installed
+if ! rpm -q python34-devel > /dev/null; then
+    sudo yum install -y epel-release
+    if ! sudo yum install -y python34-devel; then
+        echo "Failed to install python34-devel package..."
+        exit 1
     fi
-else
-debug_make
 fi
-set +e
-make -C ${BUILD_BASE} prepare-cache
-rc=$?
-set -e
 
-if [ $rc -gt 0 ]; then
-    echo "Build: make prepare-cache failed - exiting ..."
-    rc=100
-    exit $rc
-fi
-echo "Copying built OPNFV .iso file to target directory ${BUILD_DIR} ..."
-rm -rf ${BUILD_DIR}
-mkdir -p ${BUILD_DIR}
-cp ${BUILD_BASE}/.versions ${BUILD_DIR}
-cp ${RESULT_DIR}/*.iso* ${BUILD_DIR}
-echo "Copying built OPNFV .rpm files to target directory ${BUILD_DIR} ..."
-cp ${BUILD_BASE}/*.rpm ${BUILD_DIR}
-cp ${BUILD_BASE}/noarch/*.rpm ${BUILD_DIR}
+# Execute make against targets
+for t in $MAKE_TARGETS; do
+    run_make $t
+done
 
-if [ $POPULATE_CACHE -eq 1 ]; then
-    if [ ! -z ${BUILD_CACHE_URI} ]; then
-       echo "Building cache ..."
-       tar --dereference -C ${BUILD_BASE} -caf ${BUILD_BASE}/${LOCAL_CACHE_ARCH_NAME}.tgz ${CACHE_DIR}
-       echo "Uploading cache ${BUILD_CACHE_URI}/${REMOTE_CACHE_ARCH_NAME}"
-       ${REMOTE_ACCESS_METHD} -T ${BUILD_BASE}/${LOCAL_CACHE_ARCH_NAME}.tgz ${BUILD_CACHE_URI}/${REMOTE_CACHE_ARCH_NAME}.tgz
-       rm ${BUILD_BASE}/${LOCAL_CACHE_ARCH_NAME}.tgz
+echo "Build Complete"
+
+# Build new Cache
+if [ -n "$CACHE_DEST" ]; then
+    echo "Building Cache"
+    if [ ! -d $CACHE_DEST ]; then mkdir -p $CACHE_DEST; fi
+    tar --atime-preserve --dereference -C $BUILD_BASE -caf $BUILD_BASE/${CACHE_NAME}.tgz $CACHE_DIR -C ${CACHE_DEST}/
+    if [ -f "${CACHE_DEST}/${CACHE_NAME}.tgz" ]; then
+      echo "Cache Build Complete"
+    else
+      echo "WARN: Cache file did not build correctly"
     fi
 fi
-echo "Success!!!"
-exit 0
-#
-# END of main
-############################################################################
+echo "Complete"