prplMesh/tests/test_gw_repeater.sh

#!/bin/bash
###############################################################
# SPDX-License-Identifier: BSD-2-Clause-Patent
# SPDX-FileCopyrightText: 2019-2020 the prplMesh contributors (see AUTHORS.md)
# This code is subject to the terms of the BSD+Patent license.
# See LICENSE file for more details.
###############################################################

scriptdir=$(cd "${0%/*}" || exit 1; pwd)
rootdir="${scriptdir%/*}"

# shellcheck source=functions.sh
. "${rootdir}/tools/functions.sh"

usage() {
    echo "usage: $(basename "${0}") [-hv] [-d delay]"
    echo "  options:"
    echo "      -h|--help - show this help menu"
    echo "      -v|--verbose - verbosity on"
    echo "      -d|--delay - delay between starting the containers
    and testing their status (default %DELAY seconds"
    echo "      -f|--force - kill any running containers before starting"
    echo "      -u|--unique-id - unique id to add as suffix to container and network names"
    echo "      -t|--tag - use image with this tag (-t option passed to run.sh)"
    echo "      -g|--gateway - gateway container name"
    echo "      -r|--repeater - repeater container name"
    echo "      --rm - remove containers after test completes"
    echo "      --gateway-only - start gateway only"
    echo "      --repeater-only - start repeater only"
}

# This function checks if this script is executed in Microsoft's WSL
# Docker for Windows currently is unable to forward traffic from the
# host to the containers. Since we communicate with the UCC listeners
# on the gateway and the repeaters, expose the UCC listening ports
# from the containers to the host
check_wsl() {
    # Do nothing for non-WSL environments
    if ! grep -q Microsoft /proc/version; then return; fi

    status "Running in WSL"

    # Read GW & Repeater UCC ports
    local GW_UCC_PORT
    GW_UCC_PORT=$(grep ucc_listener_port \
    "${rootdir}"/build/install/config/beerocks_controller.conf | \
    awk -F'[= ]' '{ print $2 }')

    local RP_UCC_PORT
    RP_UCC_PORT=$(grep ucc_listener_port \
    "${rootdir}"/build/install/config/beerocks_agent.conf | \
    awk -F'[= ]' '{ print $2 }')

    GW_EXTRA_OPT=(--expose "${GW_UCC_PORT}" --publish "127.0.0.1::${GW_UCC_PORT}")
    RP_EXTRA_OPT=(--expose "${RP_UCC_PORT}" --publish "127.0.0.1::${RP_UCC_PORT}")
}

get_repater_bridge_mac() {
    if [ "$#" -eq 1 ]; then
        REPEATER_BRIDGE_MAC=$(run docker container exec "$1" ifconfig br-lan | grep ether | tr -s ' ' | cut --delimiter=' ' -f 3)
        echo "$REPEATER_BRIDGE_MAC"
    fi
}

main() {
    if ! OPTS=$(getopt -o 'hvd:fg:r:t:u:' --long help,verbose,rm,gateway-only,repeater-only,delay:,force,gateway:,repeater:,tag:,unique-id: -n 'parse-options' -- "$@"); then
        err "Failed parsing options." >&2 ; usage; exit 1 ;
    fi

    eval set -- "$OPTS"

    while true; do
        case "$1" in
            -v | --verbose)       VERBOSE_OPT="-v"; shift ;;
            -h | --help)          usage; exit 0; shift ;;
            -d | --delay)         DELAY="$2"; shift; shift ;;
            -f | --force)         docker_opts+=("-f"); shift ;;
            -u | --unique-id)     UNIQUE_ID="$2"; shift; shift ;;
            -t | --tag)           docker_opts+=("--tag" "$2"); shift; shift ;;
            -g | --gateway)       GW_NAME="$2"; shift; shift ;;
            -r | --repeater)      REPEATER_NAMES="$REPEATER_NAMES $2"; shift; shift ;;
            --rm)                 REMOVE=true; shift ;;
            --gateway-only)       START_REPEATER=false; shift ;;
            --repeater-only)      START_GATEWAY=false; shift ;;
            -- ) shift; break ;;
            * ) err "unsupported argument $1"; usage; exit 1 ;;
        esac
    done

    check_wsl

    status "Starting GW+Repeater test"

    # default values for gateway and repeater[s] names
    REPEATER_NAMES=${REPEATER_NAMES-repeater-${UNIQUE_ID}}
    GW_NAME=${GW_NAME-gateway-${UNIQUE_ID}}

    dbg REMOVE="${REMOVE}"
    dbg GW_NAME="${GW_NAME}"
    dbg REPEATER_NAMES="${REPEATER_NAMES}"
    dbg START_GATEWAY="${START_GATEWAY}"
    dbg START_REPEATER="${START_REPEATER}"
    dbg DELAY="${DELAY}"
    dbg UNIQUE_ID="${UNIQUE_ID}"

    docker_opts+=("-u" "${UNIQUE_ID}")

    [ "$START_GATEWAY" = "true" ] && {
        status "Start GW (Controller + local Agent)"
        "${rootdir}"/tools/docker/run.sh ${VERBOSE_OPT} "${docker_opts[@]}" "${GW_EXTRA_OPT[@]}" \
            start-controller-agent -d -n "${GW_NAME}" -- "$@"
    }

    [ "$START_GATEWAY" = "true" ] && [ "$START_REPEATER" = "true" ] && {
        status "Delay ${DELAY} seconds..."
        sleep "${DELAY}"
    }

    [ "$START_REPEATER" = "true" ] && {
        for repeater in $REPEATER_NAMES; do
            status "Start Repeater (Remote Agent): $repeater"
            "${rootdir}"/tools/docker/run.sh ${VERBOSE_OPT} "${docker_opts[@]}" "${RP_EXTRA_OPT[@]}" \
                start-agent -d -n "${repeater}" -- "$@"
        done
    }

    status "Delay ${DELAY} seconds..."
    sleep "${DELAY}"

    error=0
    [ "$START_GATEWAY" = "true" ] && report "GW operational" \
        "${rootdir}"/tools/docker/test.sh ${VERBOSE_OPT} -n "${GW_NAME}"


    [ "$START_REPEATER" = "true" ] && {
        for repeater in $REPEATER_NAMES
        do
            REPEATER_BRIDGE_MAC=$(get_repater_bridge_mac "${repeater}")
            report "Repeater $repeater operational" \
            "${rootdir}"/tools/docker/test.sh ${VERBOSE_OPT} -n "${GW_NAME}" -b "${REPEATER_BRIDGE_MAC}"
        done
    }

    [ "$REMOVE" = "true" ] && {
        status "Deleting containers ${GW_NAME} ${REPEATER_NAMES}"
        docker rm -f "${GW_NAME}" "${REPEATER_NAMES}" >/dev/null 2>&1
    }

    return $error
}

REMOVE=false
START_GATEWAY=true
START_REPEATER=true
UNIQUE_ID=${SUDO_USER:-${USER}}
DELAY=20
docker_opts=()

main "$@"