#!/bin/bash

#

#  Copyright (C) 2014 - 2020 Intel Corporation.

#  All rights reserved.

#

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions are met:

#  1. Redistributions of source code must retain the above copyright notice(s),

#     this list of conditions and the following disclaimer.

#  2. Redistributions in binary form must reproduce the above copyright notice(s),

#     this list of conditions and the following disclaimer in the documentation

#     and/or other materials provided with the distribution.

#

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY EXPRESS

#  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

#  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO

#  EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY DIRECT, INDIRECT,

#  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

#  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

#  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#

basedir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

PROGNAME=`basename $0`

# Default path (to installation dir of memkind-tests RPM)

TEST_PATH="$basedir/"

# Gtest binaries executed by Berta

GTEST_BINARIES=(all_tests decorator_test allocator_perf_tool_tests gb_page_tests_bind_policy memkind_stat_test defrag_allocate)

# Pytest files executed by Berta

PYTEST_FILES=(hbw_detection_test.py autohbw_test.py trace_mechanism_test.py)

red=`tput setaf 1`

green=`tput setaf 2`

yellow=`tput setaf 3`

default=`tput sgr0`

err=0

function usage () {

   cat <

Usage: $PROGNAME [-c csv_file] [-l log_file] [-f test_filter] [-T tests_dir] [-d] [-m] [-p] [-e] [-x] [-s] [-h]

OPTIONS

    -c,

        path to CSV file

    -l,

        path to LOG file

    -f,

        test filter

    -T,

        path to tests directory

    -d,

        skip high bandwidth memory nodes detection tests

    -m,

        skip tests that require 2MB pages configured on the machine

    -p,

        skip python tests

    -e,

        run only HBW performance operation tests

    -x,

        skip tests that are passed as value

    -s,

        run disabled test (e.g. pmem long time stress test)

    -h,

        parameter added to display script usage

EOF

}

function emit() {

    if [ "$LOG_FILE" != "" ]; then

        echo "$@" 2>&1 | tee -a $LOG_FILE;

    else

        echo "$@"

    fi

}

function normalize_path {

    local PATH=$1

    if [ ! -d $PATH ];

    then

        echo "Not a directory: '$PATH'"

        usage

        exit 1

    fi

    if [[ $PATH != /* ]]; then

        PATH=`pwd`/$PATH

    fi

    echo $PATH

}

function show_skipped_tests()

{

    SKIP_PATTERN=$1

    DEFAULT_IFS=$IFS

    # Search for gtests that match given pattern

    for i in ${!GTEST_BINARIES[*]}; do

        GTEST_BINARY_PATH=$TEST_PATH${GTEST_BINARIES[$i]}

        for LINE in $($GTEST_BINARY_PATH --gtest_list_tests); do

            if [[ $LINE == *. ]]; then

                TEST_SUITE=$LINE;

            else

                if [[ "$TEST_SUITE$LINE" == *"$SKIP_PATTERN"* ]]; then

                    emit "$TEST_SUITE$LINE,${yellow}SKIPPED${default}"

                fi

            fi

        done

    done

    # Search for pytests that match given pattern

    for i in ${!PYTEST_FILES[*]}; do

        PTEST_BINARY_PATH=$TEST_PATH${PYTEST_FILES[$i]}

        IFS=$'\n'

        for LINE in $(py.test $PTEST_BINARY_PATH --collect-only); do

            if [[ $LINE == *"

                TEST_SUITE=$(sed "s/^.*'\(.*\)'.*$/\1/" <<< $LINE)

            elif [[ $LINE == *"

                LINE=$(sed "s/^.*'\(.*\)'.*$/\1/" <<< $LINE)

                if [[ "$TEST_SUITE.$LINE" == *"$SKIP_PATTERN"* ]]; then

                    emit "$TEST_SUITE.$LINE,${yellow}SKIPPED${default}"

                fi

            fi

        done

    done

    IFS=$DEFAULT_IFS

    emit ""

}

function execute_gtest()

{

    ret_val=1

    TESTCMD=$1

    TEST=$2

    # Apply filter (if provided)

    if [ "$TEST_FILTER" != "" ]; then

        if [[ $TEST != $TEST_FILTER ]]; then

            return

        fi

    fi

    # Concatenate test command

    TESTCMD=$(printf "$TESTCMD" "$TEST""$SKIPPED_GTESTS""$RUN_DISABLED_GTEST")

    # And test prefix if applicable

    if [ "$TEST_PREFIX" != "" ]; then

        TESTCMD=$(printf "$TEST_PREFIX" "$TESTCMD")

    fi

    OUTPUT=`eval $TESTCMD`

    PATOK='.*OK ].*'

    PATFAILED='.*FAILED  ].*'

        PATSKIPPED='.*PASSED  ] 0.*'

    if [[ $OUTPUT =~ $PATOK ]]; then

        RESULT="$TEST,${green}PASSED${default}"

        ret_val=0

    elif [[ $OUTPUT =~ $PATFAILED ]]; then

        RESULT="$TEST,${red}FAILED${default}"

    elif [[ $OUTPUT =~ $PATSKIPPED ]]; then

        RESULT="$TEST,${yellow}SKIPPED${default}"

        ret_val=0

    else

        RESULT="$TEST,${red}CRASH${default}"

    fi

    if [ "$CSV" != "" ]; then

        emit "$OUTPUT"

        echo $RESULT >> $CSV

    else

        echo $RESULT

    fi

    return $ret_val

}

function execute_pytest()

{

    ret=1

    TESTCMD=$1

    TEST_SUITE=$2

    TEST=$3

    # Apply filter (if provided)

    if [ "$TEST_FILTER" != "" ]; then

        if [[ $TEST_SUITE.$TEST != $TEST_FILTER ]]; then

            return

        fi

    fi

    # Concatenate test command

    TESTCMD=$(printf "$TESTCMD" "$TEST$SKIPPED_PYTESTS")

    # And test prefix if applicable

    if [ "$TEST_PREFIX" != "" ]; then

        TESTCMD=$(printf "$TEST_PREFIX" "$TESTCMD")

    fi

    OUTPUT=`eval $TESTCMD`

    PATOK='.*1 passed.*'

    PATFAILED='.*1 failed.*'

    PATSKIPPED='.*deselected.*'

    if [[ $OUTPUT =~ $PATOK ]]; then

        RESULT="$TEST_SUITE.$TEST,${green}PASSED${default}"

        ret=0

    elif [[ $OUTPUT =~ $PATFAILED ]]; then

        RESULT="$TEST_SUITE.$TEST,${red}FAILED${default}"

    elif [[ $OUTPUT =~ $PATSKIPPED ]]; then

        return 0

    else

        RESULT="$TEST_SUITE.$TEST,${red}CRASH${default}"

    fi

    if [ "$CSV" != "" ]; then

        emit "$OUTPUT"

        echo $RESULT >> $CSV

    else

        echo $RESULT

    fi

    return $ret

}

#Check support for numa nodes (at least two)

function check_numa()

{

    numactl --hardware | grep "^node 1" > /dev/null

    if [ $? -ne 0 ]; then

        echo "ERROR: $0 requires a NUMA enabled system with more than one node."

        exit 1

    fi

}

#Check support for High Bandwidth Memory - simulate one if no one was found

function check_hbw_nodes()

{

    if [ ! -f /usr/bin/memkind-hbw-nodes ]; then

        if [ -x ./memkind-hbw-nodes ]; then

            export PATH=$PATH:$PWD

        else

            echo "Cannot find 'memkind-hbw-nodes' in $PWD. Did you run 'make'?"

            exit 1

        fi

    fi

    ret=$(memkind-hbw-nodes)

    if [[ $ret == "" ]]; then

        export MEMKIND_HBW_NODES=1

        TEST_PREFIX="numactl --membind=0 --cpunodebind=$MEMKIND_HBW_NODES %s"

    fi

}

#Check automatic support for persistent memory NUMA node - simulate one if no one was found

function check_auto_dax_kmem_nodes()

{

    if [ ! -f /usr/bin/memkind-auto-dax-kmem-nodes ]; then

        if [ -x ./memkind-auto-dax-kmem-nodes ]; then

            export PATH=$PATH:$PWD

        else

            echo "Cannot find 'memkind-auto-dax-kmem-nodes' in $PWD. Did you run 'make'?"

            exit 1

        fi

    fi

    ret=$(memkind-auto-dax-kmem-nodes)

    if [[ $ret == "" ]]; then

        export MEMKIND_DAX_KMEM_NODES=1

    fi

}

#begin of main script

check_numa

check_hbw_nodes

check_auto_dax_kmem_nodes

OPTIND=1

while getopts "T:c:f:l:hdemsx:p:" opt; do

    case "$opt" in

        T)

            TEST_PATH=$OPTARG;

            ;;

        c)

            CSV=$OPTARG;

            ;;

        f)

            TEST_FILTER=$OPTARG;

            ;;

        l)

            LOG_FILE=$OPTARG;

            ;;

        m)

            echo "Skipping tests that require 2MB pages due to unsatisfactory system conditions"

            if [[ "$SKIPPED_GTESTS" == "" ]]; then

                SKIPPED_GTESTS=":-*test_TC_MEMKIND_2MBPages_*"

            else

                SKIPPED_GTESTS=$SKIPPED_GTESTS":*test_TC_MEMKIND_2MBPages_*"

            fi

            if [[ "$SKIPPED_PYTESTS" == "" ]]; then

                SKIPPED_PYTESTS=" and not test_TC_MEMKIND_2MBPages_"

            else

                SKIPPED_PYTESTS=$SKIPPED_PYTESTS" and not test_TC_MEMKIND_2MBPages_"

            fi

            show_skipped_tests "test_TC_MEMKIND_2MBPages_"

            ;;

        d)

            echo "Skipping tests that detect high bandwidth memory nodes due to unsatisfactory system conditions"

            if [[ $SKIPPED_PYTESTS == "" ]]; then

                SKIPPED_PYTESTS=" and not hbw_detection"

            else

                SKIPPED_PYTESTS=$SKIPPED_PYTESTS" and not hbw_detection"

            fi

            show_skipped_tests "test_TC_MEMKIND_hbw_detection"

            ;;

        e)

            GTEST_BINARIES=(performance_test)

            SKIPPED_PYTESTS=$SKIPPED_PYTESTS$PYTEST_FILES

            break;

            ;;

        p)

            SKIPPED_PYTESTS=$SKIPPED_PYTESTS$OPTARG

            show_skipped_tests "$OPTARG"

            break;

            ;;

        x)

            echo "Skipping some tests on demand '$OPTARG'"

            if [[ $SKIPPED_GTESTS == "" ]]; then

                SKIPPED_GTESTS=":-"$OPTARG

            else

                SKIPPED_GTESTS=$SKIPPED_GTESTS":"$OPTARG

            fi

            show_skipped_tests "$OPTARG"

            ;;

        s)

            echo "Run also disabled tests"

            RUN_DISABLED_GTEST=" --gtest_also_run_disabled_tests"

            ;;

        h)

            usage;

            exit 0;

            ;;

    esac

done

TEST_PATH=`normalize_path "$TEST_PATH"`

# Clear any remnants of previous execution(s)

rm -rf $CSV

rm -rf $LOG_FILE

# Run tests written in gtest

for i in ${!GTEST_BINARIES[*]}; do

    GTEST_BINARY_PATH=$TEST_PATH${GTEST_BINARIES[$i]}

    emit

    emit "### Processing gtest binary '$GTEST_BINARY_PATH' ###"

    for LINE in $($GTEST_BINARY_PATH --gtest_list_tests); do

        if [[ $LINE == *. ]]; then

            TEST_SUITE=$LINE;

        else

            TEST_CMD="$GTEST_BINARY_PATH --gtest_filter=%s 2>&1"

            execute_gtest "$TEST_CMD" "$TEST_SUITE$LINE"

            ret=$?

            if [ $err -eq 0 ]; then err=$ret; fi

        fi

    done

done

# Run tests written in pytest

for i in ${!PYTEST_FILES[*]}; do

    PTEST_BINARY_PATH=$TEST_PATH${PYTEST_FILES[$i]}

    emit

    emit "### Processing pytest file '$PTEST_BINARY_PATH' ###"

    IFS=$'\n'

    for LINE in $(py.test $PTEST_BINARY_PATH --collect-only); do

        if [[ $LINE == *"

            TEST_SUITE=$(sed "s/^.*'\(.*\)'.*$/\1/" <<< $LINE)

        elif [[ $LINE == *"

            LINE=$(sed "s/^.*'\(.*\)'.*$/\1/" <<< $LINE)

            TEST_CMD="py.test $PTEST_BINARY_PATH -k='%s' 2>&1"

            execute_pytest "$TEST_CMD" "$TEST_SUITE" "$LINE"

            ret=$?

            if [ $err -eq 0 ]; then err=$ret; fi

        fi

    done

done

exit $err