"""
loadQuickTest.py:

   Tested with two back-2-back Ixia ports

   RestPy has a limitation on running Quick Test.  It could not modify Quick Test parameters on a 
   Windows API server.
   If you want to be able to modify the traffic configuration, create your Quick Test using
   NGPF and create a traffic item.  So instead of modifying Quick Test parameters, you modify
   the traffic items.

   - Connect to the API server
   - Configure license server IP
   - Loads a saved Quick Test config file.
     This script will run all the created Quick Tests in the saved config file one after another and
     retrieve all of the csv result files with a timestamp on them so they don't overwrite your existing
     result files.

   - Optional: Assign ports or use the ports that are in the saved config file.
   - Start all protocols
   - Verify all protocols
   - Start traffic 
   - Monitor Quick Test 
   - Copy Quick Test CSV result files
   - Copy PDF test result. This only for Windows. 
 

Supports IxNetwork API servers:
   - Windows, Windows Connection Mgr and Linux

Supports Web Quick Test also. Set applicationType = 'quicktest'

Requirements
   - IxNetwork 8.50
   - Python 2.7 and 3+
   - pip install requests
   - pip install ixnetwork_restpy (minimum version 1.0.51)

RestPy Doc:
    https://www.openixia.com/userGuides/restPyDoc

Usage:
   # Defaults to Windows
   - Enter: python <script>
"""

import json, sys, os, re, time, datetime, traceback

# Import the RestPy module
from ixnetwork_restpy import SessionAssistant, Files

# IxNetwork API server platform options: windows|linux
osPlatform = 'windows'

apiServerIp = '192.168.70.3'

# A list of chassis to use
ixChassisIpList = ['192.168.70.128']
portList = [[ixChassisIpList[0], 1, 1], [ixChassisIpList[0], 2, 1]]

# For Linux API server only
username = 'admin'
password = 'admin'

# The IP address for your Ixia license server(s) in a list.
licenseServerIp = ['192.168.70.6']

# subscription, perpetual or mixed
licenseMode = 'subscription'

# tier1, tier2, tier3, tier3-10g
licenseTier = 'tier3'

# Defaults to ixnrest for windows and linux api server.  
# Web Quick Test is a new web edition in the Linux API server.
# The type for the web QT is 'quicktest'.  
applicationType = 'ixnrest'

# Set to True to leave the session opened for debugging. For linux and connection_manager only. 
debugMode = False

# Forcefully take port ownership if the portList are owned by other users.
forceTakePortOwnership = True

# The full path to the Quick Test config file
configFile = 'ngpfQuickTest2ports_8.50.ixncfg'

# Where to copy the csv and pdf result files in Windows.
# If using Windows API server and if you want to copy result files into same windows filesystem
windowsDestinationFolder = 'c:\\Results' 

# If running this script on a Linux, where do you want to put the csv and pdf result files
linuxDestinationFolder = os.getcwd()

# For novusTenGigLan card type only. Options: copper|fiber
portMedia = 'copper'

class Timestamp:
    """
    Get timestamp for the result files.
    """
    def now(self):
        self._get = datetime.datetime.now().strftime('%H%M%S')

    @property
    def get(self):
        return self._get


def addTimestampToFile(rfcTest, filename):
    """
    Add a timestamp to a file to avoid overwriting existing files.
    Replace default PDF file name Test_Report to the Quick Test RFC test name.

    If a path is included, it will yank out the file from the path.
    """
    currentTimestamp = timestamp.get
    if '\\' in filename:
        filename = filename.split('\\')[-1]

    if '/' in filename:
        filename = filename.split('/')[-1]

    newFilename = filename.split('.')[0]
    newFileExtension = filename.split('.')[1]
    newFileWithTimestamp = '{}_{}.{}'.format(rfcTest, currentTimestamp,  newFileExtension)
    return newFileWithTimestamp

    ixNetworkVersion = ixNetwork.Globals.BuildNumber
    match = re.match('([0-9]+)\.[^ ]+ *', ixNetworkVersion)
    ixNetworkVersion = int(match.group(1))

    if ixNetworkVersion >= 8:
        timer = 10
        for counter in range(1,timer+1):
            currentActions = quickTestHandle.Results.CurrentActions

            ixNetwork.info('\n\ngetQuickTestCurrentAction:\n')
            for eachCurrentAction in quickTestHandle.Results.CurrentActions:
                ixNetwork.info('\t{}'.format(eachCurrentAction['arg2']))

            ixNetwork.info('\n')

            if counter < timer and currentActions == []:
                ixNetwork.info('\n\ngetQuickTestCurrentAction is empty. Waiting %s/%s\n\n' % (counter, timer))
                time.sleep(1)
                continue

            if counter < timer and currentActions != []:
                break

            if counter == timer and currentActions == []:
                raise Exception('\n\ngetQuickTestCurrentActions: Has no action')

        return currentActions[-1]['arg2']
    else:
        return quickTestHandle.Results.Progress

def getQuickTestCurrentAction(quickTestHandle):
    """
    Get the Quick Test current progress.
    """
    ixNetworkVersion = ixNetwork.Globals.BuildNumber
    match = re.match('([0-9]+)\.[^ ]+ *', ixNetworkVersion)
    ixNetworkVersion = int(match.group(1))

    if ixNetworkVersion >= 8:
        timer = 10
        for counter in range(1,timer+1):
            currentActions = quickTestHandle.Results.CurrentActions

            ixNetwork.info('\n\ngetQuickTestCurrentAction:\n')
            for eachCurrentAction in quickTestHandle.Results.CurrentActions:
                ixNetwork.info('\t{}'.format(eachCurrentAction['arg2']))

            ixNetwork.info('\n')

            if counter < timer and currentActions == []:
                ixNetwork.info('\n\ngetQuickTestCurrentAction is empty. Waiting %s/%s\n\n' % (counter, timer))
                time.sleep(1)
                continue

            if counter < timer and currentActions != []:
                break

            if counter == timer and currentActions == []:
                raise Exception('\n\ngetQuickTestCurrentActions: Has no action')

        return currentActions[-1]['arg2']
    else:
        return quickTestHandle.Results.Progress

def verifyQuickTestInitialization(quickTestHandle):
    """
    Verify quick test initialization stages.
    """
    for timer in range(1,30+1):
        currentAction = getQuickTestCurrentAction(quickTestHandle)
        ixNetwork.info('\n\nverifyQuickTestInitialization currentAction: {}\n'.format(currentAction))
        if currentAction == 'TestEnded':
            raise Exception('VerifyQuickTestInitialization: QuickTest failed during initialization: {}'.format(quickTestHandle.Results.Status))

        if timer < 30 and currentAction == 'None':
            ixNetwork.info('\n\nverifyQuickTestInitialization CurrentState = %s\n\tWaiting %s/30 seconds to change state\n' % (currentAction, timer))
            time.sleep(1)
            continue
        else:
            break

        if timer == 20 and currentAction == 'None':
            raise Exception('\n\nQuick Test is stuck.')

    successStatusList = ['TransmittingComplete', 'TransmittingFrames', 'WaitingForStats', 'CollectingStats', 'TestEnded']
    quickTestApplyStates = ['InitializingTest', 'ApplyFlowGroups', 'SetupStatisticsCollection']
    ixNetworkVersion = ixNetwork.Globals.BuildNumber
    match = re.match('([0-9]+)\.[^ ]+ *', ixNetworkVersion)
    ixNetworkVersion = int(match.group(1))

    applyQuickTestCounter = 120
    for counter in range(1,applyQuickTestCounter+1):
        currentAction = getQuickTestCurrentAction(quickTestHandle)
        ixNetwork.info('\n\nverifyQuickTestInitialization: CurrentState: %s  Expecting: TransmittingFrames\n\tWaiting %s/%s seconds\n' % (currentAction, counter, applyQuickTestCounter))
     
        if currentAction == 'TestEnded':
            raise Exception('\n\nVerifyQuickTestInitialization: QuickTest failed!!: {}'.format(quickTestHandle.Results.Status))

        if currentAction == None:
            currentAction = 'ApplyingAndInitializing'

        if ixNetworkVersion >= 8:
            if counter < applyQuickTestCounter and currentAction not in successStatusList:
                time.sleep(1)
                continue

            if counter < applyQuickTestCounter and currentAction in successStatusList:
                ixNetwork.info('\n\nVerifyQuickTestInitialization is done applying configuration and has started transmitting frames\n')
                break

        if ixNetworkVersion < 8:
            if counter < applyQuickTestCounter and currentAction != 'ApplyingAndInitializing':
                time.sleep(1)
                continue

            if counter < applyQuickTestCounter and currentAction == 'ApplyingAndInitializing':
                ixNetwork.info('\n\nVerifyQuickTestInitialization is done applying configuration and has started transmitting frames\n')
                break

        if counter == applyQuickTestCounter:
            if ixNetworkVersion >= 8 and currentAction not in successStatusList:
                if currentAction == 'ApplyFlowGroups':
                    ixNetwork.info('\n\nVerifyQuickTestInitialization: IxNetwork is stuck on Applying Flow Groups. You need to go to the session to FORCE QUIT it.\n')

                raise Exception('\n\nVerifyQuickTestInitialization is stuck on %s. Waited %s/%s seconds' % (
                        currentAction, counter, applyQuickTestCounter))

            if ixNetworkVersion < 8 and currentAction != 'Trial':
                raise Exception('\n\nVerifyQuickTestInitialization is stuck on %s. Waited %s/%s seconds' % (
                        currentAction, counter, applyQuickTestCounter))

def monitorQuickTestRunningProgress(quickTestHandle, getProgressInterval=10):
    """
    Description
        monitor the Quick Test running progress.

    Parameters
        quickTestHandle: /api/v1/sessions/{id}/ixnetwork/quickTest/rfc2544throughput/{id}
    """
    isRunningBreakFlag = 0
    trafficStartedFlag = 0
    waitForRunningProgressCounter = 0
    counter = 1
    connectionFailureCounter = 0
    maxRetries = 10

    while True:
        # This while loop was implemented because sometimes there could be failure to connect to the 
        # API server.  It could be caused by many various issues not related to IxNetwork.
        # Going to retry doing GETs up to 10 times.
        connectedToApiServerFlag = False

        while True:
            try:
                isRunning = quickTestHandle.Results.IsRunning
                currentRunningProgress = quickTestHandle.Results.Progress
                print('\nmonitorQuickTestRunningProgress: isRuning:', isRunning)
                break
            except:
                ixNetwork.debug('\n\nmonitorQuickTestRunningProgress: Failed to connect to API server {}/{} times\n'.format(connectionFailureCounter, maxRetries))
                if connectionFailureCounter == maxRetries:
                    raise Exception('\n\nmonitorQuickTestRunningProgress: Giving up trying to connecto the the API server after {} attempts\n'.format(maxRetries))

                if connectionFailureCounter <= maxRetries:
                    connectionFailureCounter += 1
                    time.sleep(3)
                    continue

        ixNetwork.info('\n\nmonitorQuickTestRunningProgress: isRunning: {}  CurrentRunningProgress: {}\n'.format(isRunning, currentRunningProgress))

        if isRunning == True:
            if bool(re.match('^Trial.*', currentRunningProgress)) == False:
                if waitForRunningProgressCounter < 40:
                    ixNetwork.info('\n\nmonitorQuickTestRunningProgress: Waiting for trial runs {0}/30 seconds\n'.format(waitForRunningProgressCounter))
                    waitForRunningProgressCounter += 1
                    time.sleep(1)

                if waitForRunningProgressCounter == 40:
                    raise Exception('\n\nmonitorQuickTestRunningProgress: isRunning=True. QT is running, but no quick test iteration stats showing after 40 seconds.')
            else:
                # The test is running fine.  Keep running until isRunning == False.
                trafficStartedFlag = 1
                time.sleep(getProgressInterval)
                continue
        else:
            if trafficStartedFlag == 1:
                # We only care about traffic not running in the beginning.
                # If traffic ran and stopped, then break out.
                ixNetwork.info('\n\nmonitorQuickTestRunningProgress: isRunning=False. Quick Test ran and is complete\n\n')
                return True

            if trafficStartedFlag == 0 and isRunningBreakFlag < 40:
                ixNetwork.info('\n\nmonitorQuickTestRunningProgress: isRunning=False. QT did not run yet. Wait {0}/40 seconds\n\n'.format(isRunningBreakFlag))
                isRunningBreakFlag += 1
                time.sleep(1)
                continue

            if trafficStartedFlag == 0 and isRunningBreakFlag == 40:
                raise Exception('\n\nmonitorQuickTestRunningProgress: Quick Test failed to start:: {}'.format(quickTestHandle.Results.Status))


def copyFileWindowsToLocalWindows(windowsPathAndFileName, localPath, prependFilename=None, includeTimestamp=False):
    """
    Description
        Copy files from the Windows IxNetwork API Server to a local c: drive destination.
        You could include a timestamp for the destination file.

    Parameters
        windowsPathAndFileName: (str): The full path and filename to retrieve from Windows client.
        localPath: (str): The Windows local path without the filename. Ex: C:\\Results.
        prependFilename: (str): The rfc test name.  Ex: rfc2544throughput
        includeTimestamp: (bool):  If False, each time you copy the same file will be overwritten.

    Example:
       WindowsPathAndFileName =  'C:\\Users\\hgee\\AppData\\Local\\Ixia\\IxNetwork\\data\\result\\DP.Rfc2544Tput\\9e1a1f04-fca5-42a8-b3f3-74e5d165e68c\\Run0001\\TestReport.pdf'
       localPath = 'C:\\Results'
    """
    ixNetwork.info('\n\ncopyFileWindowsToLocalWindows: From: %s to %s\n\n' % (windowsPathAndFileName, localPath))
    fileName = windowsPathAndFileName.split('\\')[-1]
    fileName = fileName.replace(' ', '_')
    if includeTimestamp:
        fileName = addTimestampToFile(prependFilename, fileName)

    destinationPath = '{}\\{}'.format(localPath, fileName)
    ixNetwork.info('\nCopying from {} -> {}'.format(windowsPathAndFileName, destinationPath))
    ixNetwork.CopyFile(windowsPathAndFileName, destinationPath)


def copyApiServerFileToLocalLinux(apiServerPathAndFileName, localPath, prependFilename=None, localPathOs='linux', includeTimestamp=False):
    """
    Description
        Copy files from either a Windows or Linux API Server to a local Linux filesystem.
        The source path could be any path in the API server.
        The filename to be copied will remain the same filename unless you set renameDestinationFile to something else.
        You could also append a timestamp for the destination file so the result files won't be overwritten.

    Parameters
        apiServerPathAndFileName: (str): The full path and filename to retrieve from either a Windows API server or a Linux API server.
        localPath: (str): The Linux local filesystem path without the filename. Ex: /home/hgee/Results.
        prependFilename: (str): The rfc test name.  Ex: rfc2544throughput
        localPathOs: (str): The destination's OS.  linux or windows.
        includeTimestamp: (bool):  If False, each time you copy the same file will be overwritten.

    Example:
       apiServerPathAndFileName =  '/root/.local/share/Ixia/IxNetwork/data/result/DP.Rfc2544Tput/10694b39-6a8a-4e70-b1cd-52ec756910c3/Run0005/portMap.csv'
       localPath = '/home/hgee/portMap.csv'
    """
    if '/' in apiServerPathAndFileName:
        fileName = apiServerPathAndFileName.split('/')[-1]

    if '\\' in apiServerPathAndFileName:
        fileName = apiServerPathAndFileName.split('\\')[-1]

    fileName = fileName.replace(' ', '_')

    if includeTimestamp:
        fileName = addTimestampToFile(prependFilename, fileName)

    if localPathOs == 'linux':
        destinationPath = '{}/{}'.format(localPath, fileName)

    if localPathOs == 'windows':
        destinationPath = '{}\\{}'.format(localPath, fileName)

    ixNetwork.info('\nCopying file from API server:{} -> {}'.format(apiServerPathAndFileName, destinationPath))
    session.Session.DownloadFile(apiServerPathAndFileName, destinationPath)


def getQuickTestCsvFiles(quickTestHandle, copyToPath, csvFile='all', rfcTest=None, includeTimestamp=False):
    """
    Description
        Copy Quick Test CSV result files to a specified path on either Windows or Linux.
        Note: Currently only supports copying from Windows.
              Copy from Linux is coming in November.

    quickTestHandle: The Quick Test handle.
    copyToPath: The destination path to copy to.
                If copy to Windows: Ex:  c:\\Results\\Path
                If copy to Linux:   Ex:  /home/user1/results/path

    csvFile: A list of CSV files to get: 'all', one or more CSV files to get:
             AggregateResults.csv, iteration.csv, results.csv, logFile.txt, portMap.csv
    rfcTest: Ex: rfc2544throughput
    includeTimestamp: To append a timestamp on the result file.
    """
    resultsPath = quickTestHandle.Results.ResultPath
    ixNetwork.info('\n\ngetQuickTestCsvFiles: %s\n' % resultsPath)

    if csvFile == 'all':
        getCsvFiles = ['AggregateResults.csv', 'iteration.csv', 'results.csv', 'logFile.txt', 'portMap.csv']
    else:
        if type(csvFile) is not list:
            getCsvFiles = [csvFile]
        else:
            getCsvFiles = csvFile

    for eachCsvFile in getCsvFiles:
        # Backslash indicates the results resides on a Windows OS.
        if '\\' in resultsPath:
            windowsSource = resultsPath+'\\{0}'.format(eachCsvFile)

            if bool(re.match('[a-z]:.*', copyToPath, re.I)):
                copyFileWindowsToLocalWindows(windowsSource, copyToPath, prependFilename=rfcTest, includeTimestamp=includeTimestamp)
            else:
                # Copy From Windows API server to local Linux client filesystem
                copyApiServerFileToLocalLinux(windowsSource, copyToPath, prependFilename=rfcTest, localPathOs='linux', includeTimestamp=includeTimestamp)

        else:
            linuxSource = resultsPath+'/{0}'.format(eachCsvFile)

            # Copy from Linux api server to Local Linux client filesystem.
            try:
                ixNetwork.info('\n\nCopying file from Linux API server:{} to local Linux: {}\n'.format(linuxSource, eachCsvFile))
                copyApiServerFileToLocalLinux(linuxSource, copyToPath, prependFilename=rfcTest, localPathOs='linux', includeTimestamp=includeTimestamp)
            except Exception as errMsg:
                ixNetwork.warn('\n\ncopyApiServerFileToLocalLinux ERROR: {}\n'.format(errMsg))

def verifyNgpfIsLayer3(topologyName):
    """
    Verify if the configuration has NGPF and if it is, verify if it is layer 3
    in order to know whether to start all protocols or not.
    """
    result = ixNetwork.Topology.find(topologyName).DeviceGroup.find().Ethernet.find().Ipv4.find()
    try:
        print('\n\nTopology isLayer3: {}\n'.format(result.href))
        isLayer3 = True
    except: 
        result = ixNetwork.Topology.find(topologyName).DeviceGroup.find().Ethernet.find().Ipv6.find()
        try:
            print('\n\nTopology isLayer3: {}\n'.format(result.href))
            isLayer3 = True
        except:
            isLayer3 = False
            print('\n\nTopology isLayer3: False\n')

    return isLayer3


try:
    # LogLevel: none, info, warning, request, request_response, all
    session = SessionAssistant(IpAddress=apiServerIp, RestPort=None, UserName='admin', Password='admin', 
                               SessionName=None, SessionId=None, ApiKey=None, ApplicationType=applicationType,
                               ClearConfig=True, LogLevel='all', LogFilename='restpy.log')

    ixNetwork = session.Ixnetwork

    ixNetwork.LoadConfig(Files(configFile, local_file=True))

    # Assign ports
    portMap = session.PortMapAssistant()
    vport = dict()
    for index,port in enumerate(portList):
        # For the port name, get the loaded configuration's port name
        portName = ixNetwork.Vport.find()[index].Name
        portMap.Map(IpAddress=port[0], CardId=port[1], PortId=port[2], Name=portName)
        
    portMap.Connect(forceTakePortOwnership)

    for vport in ixNetwork.Vport.find():
        if vport.Type == 'novusTenGigLan':
            vport.L1Config.NovusTenGigLan.Media = portMedia

    if verifyNgpfIsLayer3:
        ixNetwork.StartAllProtocols(Arg1='sync')

        ixNetwork.info('Verify protocol sessions\n')
        protocolSummary = session.StatViewAssistant('Protocols Summary')
        protocolSummary.CheckCondition('Sessions Not Started', protocolSummary.EQUAL, 0)
        protocolSummary.CheckCondition('Sessions Down', protocolSummary.EQUAL, 0)
        ixNetwork.info(protocolSummary)

    # Create a timestamp for test result files.
    # To append a timestamp in the CSV result files so existing result files won't get overwritten.
    timestamp = Timestamp()

    # These are all the RFC tests to search for in the saved config file.
    for rfcTest in [ixNetwork.QuickTest.Rfc2544frameLoss.find(),
                    ixNetwork.QuickTest.Rfc2544throughput.find(),
                    ixNetwork.QuickTest.Rfc2544back2back.find(),
                    ixNetwork.QuickTest.Rfc2889addressCache.find(),
                    ixNetwork.QuickTest.Rfc2889addressRate.find(),
                    ixNetwork.QuickTest.Rfc2889broadcastRate.find(),
                    ixNetwork.QuickTest.Rfc2889congestionControl.find(),
                    ixNetwork.QuickTest.Rfc2889frameErrorFiltering.find(),
                    ixNetwork.QuickTest.Rfc2889fullyMeshed.find(),
                    ixNetwork.QuickTest.Rfc2889manyToOne.find(),
                    ixNetwork.QuickTest.Rfc2889oneToMany.find(),
                    ixNetwork.QuickTest.Rfc2889partiallyMeshed.find(),
                    ]:

        if not rfcTest:
            # If the loaded QT config file doesn't have rfcTest created, then skip it.
            continue
       
        for quickTestHandle in rfcTest:
            quickTestName = quickTestHandle.Name
            ixNetwork.info('\n\nQuickTestHandle: {}\n'.format(quickTestHandle))
            match = re.search('/api/.*/quickTest/(.*)/[0-9]+', quickTestHandle.href)
            rfc = match.group(1)
            rfcTest = '{}_{}'.format(rfc, quickTestName)
            ixNetwork.info('\n\nExecuting Quick Test: {}\n'.format(rfcTest))

            quickTestHandle.Apply()
            quickTestHandle.Start()
            verifyQuickTestInitialization(quickTestHandle)
            monitorQuickTestRunningProgress(quickTestHandle)

            timestamp.now()

            if osPlatform == 'linux':
                # Copy CSV from either a Windows or Linux API server to local linux filesystem
                getQuickTestCsvFiles(quickTestHandle, copyToPath=linuxDestinationFolder, rfcTest=rfcTest, includeTimestamp=True)

                try:
                    pdfFile = quickTestHandle.GenerateReport()
                    destPdfTestResult = addTimestampToFile(rfcTest=rfcTest, filename=pdfFile)
                    ixNetwork.info('Copying PDF results to: {}'.format(linuxDestinationFolder+destPdfTestResult))
                    session.Session.DownloadFile(pdfFile, linuxDestinationFolder+'/'+destPdfTestResult)
                except:
                    # If using Linux API server, a PDF result file is not supported for all rfc tests.
                    ixNetwork.warn('\n\nPDF for {} is not supported\n'.format(rfc))

            if osPlatform == 'windows':
                # Uncomment to copy CSV files from Windows to local windows filesystem
                #getQuickTestCsvFiles(quickTestHandle, copyToPath=windowsDestinationFolder, rfcTest=quickTestName, includeTimestamp=True)

                # Uncomment to copy the PDF from Windows to local Windows.
                #copyFileWindowsToLocalWindows(pdfFile, windowsDestinationFolder+'\\'+destPdfTestResult)

                # Copy CSV results from either a Windows or Linux API server to local linux filesystem
                getQuickTestCsvFiles(quickTestHandle, copyToPath=linuxDestinationFolder, rfcTest=rfcTest, includeTimestamp=True)

                pdfFile = quickTestHandle.GenerateReport()
                destPdfTestResult = addTimestampToFile(rfcTest=rfcTest, filename=pdfFile)
                ixNetwork.info('Copying PDF results to: {}'.format(linuxDestinationFolder+destPdfTestResult))
                session.Session.DownloadFile(pdfFile, linuxDestinationFolder+'/'+destPdfTestResult)

            # Examples to show how to stop and remove a quick test.
            # Uncomment one or both if you want to use them.
            #quickTestHandle.Stop()
            #quickTestHandle.remove()

    if debugMode == False:
        # For Linux and Windows Connection Manager only
        session.Session.remove()

except Exception as errMsg:
    print('\n%s' % traceback.format_exc())
    if debugMode == False and 'session' in locals():
        session.Session.remove()