# lib_vpp.sh - Docker build script VPP library.
#              For import only.

# Copyright (c) 2021 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Don't import more than once.
if [ -n "$(alias lib_vpp_imported 2> /dev/null)" ] ; then
    return 0
fi
alias lib_vpp_imported=true

export CIMAN_DOCKER_SCRIPTS=${CIMAN_DOCKER_SCRIPTS:-"$(dirname $BASH_SOURCE)"}
. $CIMAN_DOCKER_SCRIPTS/lib_common.sh


VPP_SUPPORTED_EXECUTOR_CLASSES="builder"
vpp_supported_executor_class() {
    if ! grep -q "${1:-}" <<< $VPP_SUPPORTED_EXECUTOR_CLASSES ; then
        return 1
    fi
    return 0
}

make_vpp() {
    local target=$1
    local branch=${2:-"master"}
    local branchname="$(echo $branch | sed -e 's,/,_,')"
    local bld_log="$DOCKER_BUILD_LOG_DIR"
    bld_log="${bld_log}/$FDIOTOOLS_IMAGENAME-$branchname"
    bld_log="${bld_log}-make_vpp_${target}-bld.log"

    makefile_target="^${target}:"
    if [ -z "$(grep $makefile_target Makefile)" ] ; then
        echo "Make target '$target' does not exist in VPP branch '$branch'!"
        return
    fi
    git clean -qfdx
    description="'make UNATTENDED=y $target' in $(pwd) ($branch)"
    echo_log -e "    Starting  $description..."
    local force_opts="--allow-downgrades --allow-remove-essential"
    force_opts="$force_opts --allow-change-held-packages"
    make UNATTENDED=y CONFIRM="-y" FORCE="$force_opts" \
         $target 2>&1 | tee -a "$bld_log"
    git checkout -q -- .
    echo_log "    Completed $description!"
}

make_vpp_test() {
    local target=$1
    local branch=${2:-"master"}
    local branchname="$(echo $branch | sed -e 's,/,_,')"
    local bld_log="$DOCKER_BUILD_LOG_DIR"
    bld_log="${bld_log}/$FDIOTOOLS_IMAGENAME-$branchname"
    bld_log="${bld_log}-make_vpp_test_${target}-bld.log"

    makefile_target="^${target}:"
    if [ -z "$(grep -e $makefile_target test/Makefile)" ] ; then
        echo "Make test target '$target' does not exist in VPP branch '$branch'!"
        return
    fi
    git clean -qfdx
    description="'make -C test $target' in $(pwd) ($branch)"
    echo_log "    Starting  $description..."
    make WS_ROOT="$DOCKER_VPP_DIR" BR="$DOCKER_VPP_DIR/build-root" \
         TEST_DIR="$DOCKER_VPP_DIR/test" -C test $target 2>&1 | tee -a $bld_log
    remove_pyc_files_and_pycache_dirs
    git checkout -q -- .
    echo_log "    Completed $description!"
}

docker_build_setup_vpp() {
    if vpp_supported_executor_class "$EXECUTOR_CLASS" ; then
        if [ ! -d "$DOCKER_VPP_DIR" ] ; then
            echo_log "Cloning VPP into $DOCKER_VPP_DIR..."
            git clone -q https://gerrit.fd.io/r/vpp $DOCKER_VPP_DIR
        fi
        clean_git_repo $DOCKER_VPP_DIR
    fi
}

# Branches must be listed in chronological order -- oldest stable branch
# first and master last.
#
# Note: CI Jobs for each architecture are maintained in
#       .../ci-management/jjb/vpp/vpp.yaml
#       All OS's and branches are included in the 'os' and 'stream'
#       definitions respectively, then the exclude list maintained
#       to create an enumerated set of jobs jobs that match the
#       definitions here.
declare -A VPP_BRANCHES
VPP_BRANCHES["centos-7"]="stable/2009"
VPP_BRANCHES["centos-8"]="stable/2009 stable/2101 master"
VPP_BRANCHES["debian-9"]="stable/2009"
VPP_BRANCHES["debian-10"]="stable/2009 stable/2101 master"
VPP_BRANCHES["ubuntu-18.04"]="stable/2009 stable/2101 master"
VPP_BRANCHES["ubuntu-20.04"]="stable/2009 stable/2101 master"
export VPP_BRANCHES