"""atfutils module contains  general purpose wrappers

*) assert_success
*) assert_failure
*) print-stdout
*) print_stderr
*) set_active_volume
"""

import re
import ssh
from atfglobals import GlobalObj

def assert_success(**arguments):
    """
    """     
    if not arguments["exitstatus"]:
        return 0
    else:
        return 1

def assert_failure(**arguments):
    """
    """        
    if arguments["exitstatus"]:
        return 0
    else:
        return 1

def print_stdout(stdoutdata):
    """
    """
    logger = GlobalObj.getLoggerObj()
    if not stdoutdata == None:
        for data in stdoutdata:
            logger.debug(data)

def print_stderr(stderrdata):
    logger = GlobalObj.getLoggerObj()
    if not stderrdata == None:
        for data in stderrdata:
            logger.debug(data)

def set_active_volume(volumekey):
    """
    """
    logger = GlobalObj.getLoggerObj()
    env = GlobalObj.getTestenvObj()
    return_status = env.setActiveVolume(volumekey)
    if return_status:
        logger.error("Unable to set Active Volume. \
                    '%s' Not defined in TestEnvironment" % volumekey )
    return return_status



__all__ = ['assert_success',
           'assert_failure',
           'print-stdout',
           'print_stderr',
           'set_active_volume']