Source code for testcases.OpalErrorLog

#!/usr/bin/env python3
# IBM_PROLOG_BEGIN_TAG
# This is an automatically generated prolog.
#
# $Source: op-test-framework/testcases/OpalErrorLog.py $
#
# OpenPOWER Automated Test Project
#
# Contributors Listed Below - COPYRIGHT 2015
# [+] International Business Machines Corp.
#
#
# 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.
#
# IBM_PROLOG_END_TAG

'''
OpalErrorLog
------------

Tests the OPAL error log functionality (as in PELs, not OPAL's log).

Currently runs only in FSP platforms
'''

import time
import subprocess
import re

from common.OpTestIPMI import OpTestIPMI
from common.OpTestConstants import OpTestConstants as BMC_CONST
from common.OpTestError import OpTestError

import unittest
import OpTestConfiguration
from common.OpTestSystem import OpSystemState
from common.Exceptions import CommandFailed

import logging
import OpTestLogger
log = OpTestLogger.optest_logger_glob.get_logger(__name__)


class OpalErrorLog(unittest.TestCase):
    def setUp(self):
        conf = OpTestConfiguration.conf
        self.cv_SYSTEM = conf.system()
        self.cv_FSP = self.cv_SYSTEM.bmc
        self.cv_HOST = conf.host()
        self.bmc_type = conf.args.bmc_type
        self.cv_SYSTEM.goto_state(OpSystemState.OS)

    def opal_elog_init(self):
        rc = 0
        try:
            self.cv_HOST.host_check_sysfs_path_availability(
                "/sys/firmware/opal/elog/")
        except CommandFailed as cf:
            rc = cf.exitcode

        if "FSP" in self.bmc_type:
            self.assertEqual(rc, 0,
                             "opal elog sysfs path is not available in host")
        else:
            self.skipTest("elog test not implemented for non-FSP systems")

        self.cv_FSP.fsp_get_console()
        if not self.cv_FSP.mount_exists():
            raise OpTestError("Please mount NFS and retry the test")

        # Check status of opal_errd daemon before running the test
        if not self.cv_HOST.host_get_status_of_opal_errd_daemon():
            self.cv_HOST.host_stop_opal_errd_daemon()
            self.cv_HOST.host_start_opal_errd_daemon()
        self.assertTrue(self.cv_HOST.host_get_status_of_opal_errd_daemon(),
                        "opal_errd daemon is failed to start")


class BasicTest(OpalErrorLog):

    def count(self):
        self.count = 8
        return self.count

    def runTest(self):
        self.opal_elog_init()
        # Clear previous existing logs in Host and FSP before start of the test
        self.cv_FSP.clear_errorlogs_in_fsp()
        self.cv_HOST.host_clear_error_logs()
        count = self.count()
        # Start Generating the error logs from FSP.
        log.debug("FSP: Start generating the error logs from FSP.")
        for i in range(count+1):
            log.debug("Iteration: {}".format(i))
            self.cv_FSP.generate_error_log_from_fsp()
        self.cv_HOST.host_list_all_errorlogs()
        self.cv_HOST.host_list_all_service_action_logs()
        self.cv_FSP.list_all_errorlogs_in_fsp()
        res = self.cv_HOST.host_get_number_of_errorlogs()
        transfer_complete = False
        tries = 60
        for j in range(tries+1):
            res = self.cv_HOST.host_get_number_of_errorlogs()
            if res >= count:
                transfer_complete = True
                break
            time.sleep(1)
            log.debug("Waiting for transfer of error logs to Host: (%d\%d)"
                      % (j, tries))
        if not transfer_complete:
            self.cv_HOST.host_gather_opal_msg_log()
            self.cv_HOST.host_gather_kernel_log()
        self.assertTrue(transfer_complete,
                        "Failed to transfer all error logs to Host in 60s")
        self.cv_FSP.clear_errorlogs_in_fsp()


class FullTest(BasicTest):

    def count(self):
        self.count = 255
        return self.count


class TortureTest(BasicTest):

    def count(self):
        self.count = 100000
        return self.count