# -*- Mode: Shell-script; tab-width: 2; indent-tabs-mode: nil; -*-
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (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.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is mozilla.org code.
#
# The Initial Developer of the Original Code is
# Mozilla Corporation.
# Portions created by the Initial Developer are Copyright (C) 2006.
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#  Bob Clary <bob@bclary.com>
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****

# This script contains a number of variables, functions, etc which 
# are reused across a number of scripts. It should be included in each
# script prior to any other commands as follows:
#
# source $TEST_DIR/bin/library.sh

if [[ -n "$DEBUG" ]]; then
    echo "calling $0 $@" 1>&2
fi

# export variables
set -a 

# in the event of an untrapped script error tail the test log, 
# if it exists, to stderr then echo a FATAL ERROR message to the 
# test log and stderr.

function _err()
{
    local rc=$?
    debug "_err: $0"

    if [[ "$rc" -gt 0 ]]; then
        if [[ -n "$TEST_LOG" ]]; then
            echo -e "\nFATAL ERROR in $0 exit code $rc\n" >> $TEST_LOG
        else
            echo -e "\nFATAL ERROR in $0 exit code $rc\n" 1>&2
        fi
    fi
    exit $rc
}

trap "_err" ERR

function _exit()
{
    local rc=$?
    local currscript=`get_scriptname $0`

    debug "_exit: $0"

    if [[ "$rc" -gt 0 && -n "$TEST_LOG" && "$SCRIPT" == "$currscript" ]]; then
        # only tail the log once at the top level script
        tail $TEST_LOG 1>&2
    fi
}

trap "_exit" EXIT

# error message
# output error message end exit 2

error()
{
    local message=$1
    local lineno=$2

    debug "error: $0:$LINENO"
    
    echo -e "FATAL ERROR in script $0:$lineno $message\n" 1>&2
    if [[ "$0" == "-bash" || "$0" == "bash" ]]; then
        return 0
    fi
    exit 2
} 


if [[ -z "$LIBRARYSH" ]]; then
    # skip remainder of script if it has already included

    checkProductBranch()
    {
        local product=$1
        local branch=$2

        case $product in
            js|firefox|thunderbird|fennec)
                ;;
            *)
                error "product \"$product\" must be one of firefox, thunderbird, or fennec" $LINENO
        esac

        case $branch in
            1.8.0|1.8.1|1.9.0|1.9.1|1.9.2)
                ;;
            *)
                error "branch \"$branch\" must be one of 1.8.0, 1.8.1, 1.9.0 1.9.1 1.9.2" $LINENO
        esac

        # special case thunderbird and fennec due to their different
        # repository and build tree structures.
        case "$product" in
            "thunderbird")
                if [[ $branch == "1.9.2" ]]; then
                    error "thunderbird on branch 1.9.2 is not supported"
                fi
                ;;
            "fennec")
                if [[ $branch != "1.9.1" && "$branch" != "1.9.2" ]]; then
                    error "fennec on branch $branch is not supported"
                fi
                ;;
        esac
     } 

    # Darwin 8.11.1's |which| does not return a non-zero exit code if the 
    # program can not be found. Therefore, kludge around it.
    findprogram()
    {
        local program=$1
        local location=`which $program 2>&1`
        if [[ ! -x $location ]]; then
            return 1
        fi
        return 0
    }

    debug()
    {
        if [[ -n "$DEBUG" ]]; then
            echo "DEBUG: $@"
        fi
    }

    # console msg
    #
    # output message to console, ie. stderr

    console()
    {
        echo -e "$@" 1>&2
    }

    # loaddata
    # 
    # load data files into environment
    loaddata()
    {
        local datafiles="$@"
        local datafile
        if [[ -n "$datafiles" ]]; then
            for datafile in $datafiles; do 
                if [[ ! -e "$datafile" ]]; then
                    error "datafile $datafile does not exist"
                fi
                cat $datafile | sed 's|^|data: |'
                if ! source $datafile; then
                    error "Unable to load data file $datafile"
                fi
            done
        fi
    }

    # dumpenvironment
    #
    # output environment to stdout

    dumpenvironment()
    {
        set | grep '^[A-Z]' | sed 's|^|environment: |'
    }

    dumphardware()
    {
        echo "uname -a:`uname -a`"
        echo "uname -s:`uname -s`"
        echo "uname -n:`uname -n`"
        echo "uname -r:`uname -r`"
        echo "uname -v:`uname -v`"
        echo "uname -m:`uname -m`"
        echo "uname -p:`uname -p`"
        if [[ "$OSID" != "darwin" ]]; then
            echo "uname -i:`uname -i`"
            echo "uname -o:`uname -o`"
        fi

        ulimit -a | sed 's|^|ulimit:|'

        if [[ -e /proc/cpuinfo ]]; then
            cat /proc/cpuinfo | sed 's|^|cpuinfo:|'
        fi
        if [[ -e /proc/meminfo ]]; then
            cat /proc/meminfo | sed 's|^|meminfo:|'
        fi
        if findprogram system_profiler; then
            system_profiler | sed 's|^|system_profiler:|'
        fi
    }

    # dumpvars varname1, ...
    #
    # dumps name=value pairs to stdout for each variable named 
    # in argument list

    dumpvars()
    {
        local argc=$#
        local argn=1

        while [ $argn -le $argc ]; do
            local var=${!argn}
            echo ${var}=${!var}
            let argn=argn+1
        done
    }

    # get_executable product branch directory
    #
    # writes path to product executable to stdout

    get_executable()
    {
        local get_executable_product="$1"
        local get_executable_branch="$2"
        local get_executable_directory="$3"

        if [[ -z "$get_executable_product" || \
            -z "$get_executable_branch" || \
            -z "$get_executable_directory" ]]; then
            error "usage: get_executable product branch directory"
        elif [[ ! -d "$get_executable_directory" ]]; then
            error "get_executable: executable directory \"$get_executable_directory\" does not exist"
        else
            # should use /u+x,g+x,a+x but mac os x uses an obsolete find
            # filter the output to remove extraneous file in dist/bin for
            # cvs builds on mac os x.
            local executable=`(
                get_executable_name="$get_executable_product${EXE_EXT}"
                case "$OSID" in
                    darwin)
                        get_executable_filter="Contents/MacOS/$get_executable_product"
                        if [[ "$get_executable_product" == "thunderbird" ]]; then
                            get_executable_name="$get_executable_product-bin"
                        fi
                        ;;
                    *)
                        get_executable_filter="$get_executable_product"
                        ;;
                esac
                if find "$get_executable_directory" -perm +111 -type f \
                    -name "$get_executable_name" | \
                    grep "$get_executable_filter"; then
                    true
                fi
                )`

            if [[ -z "$executable" ]]; then
                error "get_executable $product $branch $executablepath returned empty path" $LINENO
            fi

            if [[ ! -x "$executable" ]]; then 
                error "executable \"$executable\" is not executable" $LINENO
            fi

            echo $executable
        fi
    }

    function get_scriptname()
    {
        debug "\$0: $0"

        local script
        if [[ "$0" == "-bash" || "$0" == "bash" ]]; then
            script="library.sh"
        else
            script=`basename $0`
        fi
        echo $script
    }

    LIBRARYSH=1

    MALLOC_CHECK_=${MALLOC_CHECK_:-2}

    ulimit -c 0

    # set path to make life easier
    if ! echo ${PATH} | grep -q $TEST_DIR/bin; then
        PATH=$TEST_DIR/bin:$PATH
    fi

    # force en_US locale
    if ! echo "$LANG" | grep -q en_US; then
        LANG=en_US
        LC_TIME=en_US
    fi

    # handle sorting non-ascii logs on mac os x 10.5.3
    LC_ALL=C

    TEST_TIMEZONE=`date +%z`

    # save starting directory
    STARTDIR=`pwd`

    # location of the script.
    SCRIPTDIR=`dirname $0`

    # don't attach to running instance
    MOZ_NO_REMOTE=1

    # don't restart
    NO_EM_RESTART=1

    # bypass profile manager
    MOZ_BYPASS_PROFILE_AT_STARTUP=1

    # ah crap handler timeout
    MOZ_GDB_SLEEP=${MOZ_GDB_SLEEP:-10}

    # no airbag
    unset MOZ_AIRBAG
    #MOZ_CRASHREPORTER_DISABLE=${MOZ_CRASHREPORTER_DISABLE:-1}
    MOZ_CRASHREPORTER_NO_REPORT=${MOZ_CRASHREPORTER_NO_REPORT:-1}

    #leak gauge
    #NSPR_LOG_MODULES=DOMLeak:5,DocumentLeak:5,nsDocShellLeak:5

    TEST_MEMORY="`memory.pl`"

    # debug msg
    #
    # output debugging message to stdout if $DEBUG is set

    DEBUG=${DEBUG:-""}

    SCRIPT=`get_scriptname $0`

    if [[ -z "$TEST_DIR" ]]; then
        # get the "bin" directory
        TEST_DIR=`dirname $0`
        # get the "bin" directory parent
        TEST_DIR=`dirname $TEST_DIR`
        if [[ ! -e "${TEST_DIR}/bin/library.sh" ]]; then
            error "BAD TEST_DIR $TEST_DIR"
        fi
    fi

    TEST_HTTP=${TEST_HTTP:-test.mozilla.com}
    TEST_STARTUP_TIMEOUT=${TEST_STARTUP_TIMEOUT:-30}
    TEST_MACHINE=`uname -n`

    kernel_name=`uname -s`

    if [[ $kernel_name == 'Linux' ]]; then
        OSID=linux
        EXE_EXT=
        TEST_KERNEL=`uname -r | sed 's|\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\)[-.0-9]*\.\([a-zA-Z0-9]*\)|\1.\2.\3|'`
        TEST_PROCESSORTYPE=`cat /proc/cpuinfo | grep vendor | uniq | sed 's|vendor.* : \(.*\)|\1|'`
        TIMECOMMAND='/usr/bin/time -f "Elapsed time %e seconds, User %U seconds, System %S seconds, CPU %P, Memory: %M"'

        if echo $TEST_PROCESSORTYPE | grep -q 'Intel'; then
            TEST_PROCESSORTYPE=intel
        elif echo $TEST_PROCESSORTYPE | grep -q 'AMD'; then
            TEST_PROCESSORTYPE=amd
        fi

        if uname -p | grep -q '64$'; then
            TEST_PROCESSORTYPE=${TEST_PROCESSORTYPE}64
        else
            TEST_PROCESSORTYPE=${TEST_PROCESSORTYPE}32
        fi

    elif [[ $kernel_name == 'Darwin' ]]; then
        OSID=darwin
        EXE_EXT=
        TEST_KERNEL=`uname -r`
        TEST_PROCESSORTYPE=`uname -p`
        TIMEFORMAT="Elapsed time %E seconds, User %U seconds, System %S seconds, CPU %P%"
        TIMECOMMAND=time

        if [[ $TEST_PROCESSORTYPE == "i386" ]]; then
            TEST_PROCESSORTYPE=intel
        fi

        # assume 32bit for now...
        TEST_PROCESSORTYPE=${TEST_PROCESSORTYPE}32

    elif echo $kernel_name | grep -q CYGWIN; then
        OSID=nt
        EXE_EXT=".exe"
        TEST_KERNEL=`echo $kernel_name | sed 's|[^.0-9]*\([.0-9]*\).*|\1|'`
        TEST_PROCESSORTYPE=`cat /proc/cpuinfo | grep vendor | uniq | sed 's|vendor.* : \(.*\)|\1|'`
        TIMECOMMAND='/usr/bin/time -f "Elapsed time %e seconds, User %U seconds, System %S seconds, CPU %P, Memory: %M"'

        if echo $TEST_PROCESSORTYPE | grep -q 'Intel'; then
            TEST_PROCESSORTYPE=intel
        elif echo $TEST_PROCESSORTYPE | grep -q 'AMD'; then
            TEST_PROCESSORTYPE=amd
        fi

        if uname -p | grep -q '64$'; then
            TEST_PROCESSORTYPE=${TEST_PROCESSORTYPE}64
        else
            TEST_PROCESSORTYPE=${TEST_PROCESSORTYPE}32
        fi

    else
        error "Unknown OS $kernel_name" $LINENO
    fi

    case $TEST_PROCESSORTYPE in
        *32)
            if [[ $TEST_MEMORY -gt 4 ]]; then
                TEST_MEMORY=4
            fi
            ;;
    esac

    # no dialogs on asserts
    XPCOM_DEBUG_BREAK=${XPCOM_DEBUG_BREAK:-warn}

    if [[ -z "$BUILDDIR" ]]; then
        case `uname -s` in
            MINGW*)
                export BUILDDIR=/c/work/mozilla/builds
                ;;
            *)
                export BUILDDIR=/work/mozilla/builds
                ;;
        esac
    fi
fi