tests/atests/common/preprovisioning.py

#
# Copyright 2018 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

"""
vOLT-HA Pre-provisioning Test module
"""

import time
import os
import commands
import testCaseUtils

class Preprovisioning(object):

    """
    This class implements voltha pre-provisioning test
    """
    
    def __init__(self):
        self.dirs = {}
        self.dirs ['log'] = None
        self.dirs ['root'] = None
        self.dirs ['voltha'] = None
        
        self.__oltIpAddress = None
        self.__oltPort = None
        self.__oltType = None
        self.__onuType = None
        self.__statusLines = ""
        self.__fields = []
        self.__oltDeviceId = None
        
    def pSetLogDirs(self, logDir):
        testCaseUtils.configDirs(self, logDir)

    def configure(self, oltIpAddress, oltPort, oltType, onuType):
        self.__oltIpAddress = oltIpAddress       
        self.__oltPort = oltPort
        self.__oltType = oltType
        self.__onuType = onuType

    def get_fields_from_grep_command(self, searchWord, logFile):
        grepCommand =\
            "grep %s %s/%s" % (searchWord, testCaseUtils.getDir(self, 'log'), logFile)  
        self.__statusLines = commands.getstatusoutput(grepCommand)[1]
        
    def preprovisionOlt(self):
        print('Do PROVISIONING')
        testCaseUtils.send_command_to_voltha_cli(testCaseUtils.getDir(self, 'log'),
            'preprovision_olt -t ponsim_olt -H %s:%s' %
            (self.__oltIpAddress, self.__oltPort),
            'voltha_preprovision_olt.log')
        time.sleep(5)
        
    def status_should_be_success_after_preprovision_command(self):
        self.get_fields_from_grep_command('success', 'voltha_preprovision_olt.log')
        assert self.__statusLines, 'Preprovision Olt command should have returned success but did not'
        
    def query_devices_before_enabling(self):
        testCaseUtils.send_command_to_voltha_cli(testCaseUtils.getDir(self, 'log'), 'devices',
                                        'voltha_devices_before_enable.log')
        time.sleep(5)
        
    def check_olt_fields_before_enabling(self):
        result = True
        self.get_fields_from_grep_command(self.__oltType, 'voltha_devices_before_enable.log')
        assert self.__statusLines, 'No Olt listed under devices'
        self.__fields = testCaseUtils.parseFields(self.__statusLines)
        self.__oltDeviceId = self.__fields[1].strip()
        print ("OLT device id = %s" % self.__oltDeviceId)
        adminState = self.__fields[3].strip()
        assert adminState == 'PREPROVISIONED', 'Admin State not PREPROVISIONED'
        hostPort = self.__fields[4].strip()
        assert hostPort, 'hostPort field is empty'
        hostPortFields = hostPort.split(":")
        assert hostPortFields[0].strip() == self.__oltIpAddress or hostPortFields[1] == str(self.__oltPort), \
            'Olt IP or Port does not match'
           
    def check_states(self, devType):
        result = True
        adminState = self.__fields[7].strip()
        assert adminState == 'ENABLED', 'Admin State of %s not ENABLED' % devType
        operStatus = self.__fields[8].strip()
        assert operStatus == 'ACTIVE', 'Oper Status of %s not ACTIVE' % devType
        connectStatus = self.__fields[9].strip()
        assert connectStatus == 'REACHABLE', 'Connect Status of %s not REACHABLE' % devType
        return result

    def check_olt_fields_after_enabling(self):
        self.get_fields_from_grep_command(self.__oltType, 'voltha_devices_after_enable.log')
        assert self.__statusLines, 'No Olt listed under devices'
        self.__fields = testCaseUtils.parseFields(self.__statusLines)
        assert self.check_states(self.__oltType), 'States of %s does match expected' % self.__oltType
        hostPort = self.__fields[11].strip()
        assert hostPort, 'hostPort field is empty'
        hostPortFields = hostPort.split(":")
        assert hostPortFields[0] == self.__oltIpAddress or hostPortFields[1] == str(self.__oltPort), \
            'Olt IP or Port does not match'
                      
    def check_onu_fields_after_enabling(self):        
        self.get_fields_from_grep_command(self.__onuType, 'voltha_devices_after_enable.log')
        assert self.__statusLines, 'No Onu listed under devices'
        lines = self.__statusLines.splitlines()
        lenLines = len(lines)
        assert lenLines == 1, 'Fixed single onu does not match, ONU Count was %d' % lenLines
        for line in lines:
            self.__fields = testCaseUtils.parseFields(line)
            assert self.check_states(self.__onuType) == True, 'States of %s does match expected' % self.__onuType
        
    def enable(self):
        print('Enable %s OLT device' % self.__oltDeviceId)
        testCaseUtils.send_command_to_voltha_cli(testCaseUtils.getDir(self, 'log'), 'enable ' + self.__oltDeviceId,
                                        'voltha_enable.log')

    def status_should_be_success_after_enable_command(self):
        self.get_fields_from_grep_command('success', 'voltha_enable.log')
        assert self.__statusLines, 'Enable command should have returned success but did not'
              
    def query_devices_after_enabling(self):
        testCaseUtils.send_command_to_voltha_cli(testCaseUtils.getDir(self, 'log'), 'devices',
                                        'voltha_devices_after_enable.log')

def runTest(oltIpAddress, oltPort, oltType, onuType, logDir):
    preprovisioning = Preprovisioning()
    preprovisioning.pSetLogDirs(logDir)
    preprovisioning.configure(oltIpAddress, oltPort, oltType, onuType)
    preprovisioning.preprovisionOlt()
    preprovisioning.status_should_be_success_after_preprovision_command()
    preprovisioning.query_devices_before_enabling()
    preprovisioning.check_olt_fields_before_enabling()
    preprovisioning.enable()
    preprovisioning.status_should_be_success_after_enable_command()
    preprovisioning.query_devices_after_enabling()
    preprovisioning.check_olt_fields_after_enabling()
    preprovisioning.check_onu_fields_after_enabling()