functest/core/testcase.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Orange and others.
   4 #
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9
  10 """Define the parent class of all Functest TestCases."""
  11
  12 import os
  13
  14 import functest.utils.functest_logger as ft_logger
  15 import functest.utils.functest_utils as ft_utils
  16
  17 __author__ = "Cedric Ollivier <cedric.ollivier@orange.com>"
  18
  19
  20 class TestCase(object):
  21     """Base model for single test case."""
  22
  23     EX_OK = os.EX_OK
  24     """everything is OK"""
  25
  26     EX_RUN_ERROR = os.EX_SOFTWARE
  27     """run() failed"""
  28
  29     EX_PUSH_TO_DB_ERROR = os.EX_SOFTWARE - 1
  30     """push_to_db() failed"""
  31
  32     EX_TESTCASE_FAILED = os.EX_SOFTWARE - 2
  33     """results are false"""
  34
  35     logger = ft_logger.Logger(__name__).getLogger()
  36
  37     def __init__(self, **kwargs):
  38         self.details = {}
  39         self.project_name = kwargs.get('project_name', 'functest')
  40         self.case_name = kwargs.get('case_name', '')
  41         self.criteria = ""
  42         self.start_time = ""
  43         self.stop_time = ""
  44
  45     def check_criteria(self):
  46         """Interpret the results of the test case.
  47
  48         It allows getting the results of TestCase. It completes run()
  49         which only returns the execution status.
  50
  51         It can be overriden if checking criteria is not suitable.
  52
  53         Returns:
  54             TestCase.EX_OK if criteria is 'PASS'.
  55             TestCase.EX_TESTCASE_FAILED otherwise.
  56         """
  57         try:
  58             assert self.criteria
  59             if self.criteria == 'PASS':
  60                 return TestCase.EX_OK
  61         except AssertionError:
  62             self.logger.error("Please run test before checking the results")
  63         return TestCase.EX_TESTCASE_FAILED
  64
  65     def run(self, **kwargs):
  66         """Run the test case.
  67
  68         It allows running TestCase and getting its execution
  69         status.
  70
  71         The subclasses must override the default implementation which
  72         is false on purpose.
  73
  74         The new implementation must set the following attributes to
  75         push the results to DB:
  76
  77             * criteria,
  78             * start_time,
  79             * stop_time.
  80
  81         Args:
  82             kwargs: Arbitrary keyword arguments.
  83
  84         Returns:
  85             TestCase.EX_RUN_ERROR.
  86         """
  87         # pylint: disable=unused-argument
  88         self.logger.error("Run must be implemented")
  89         return TestCase.EX_RUN_ERROR
  90
  91     def push_to_db(self):
  92         """Push the results of the test case to the DB.
  93
  94         It allows publishing the results and to check the status.
  95
  96         It could be overriden if the common implementation is not
  97         suitable. The following attributes must be set before pushing
  98         the results to DB:
  99
 100             * project_name,
 101             * case_name,
 102             * criteria,
 103             * start_time,
 104             * stop_time.
 105
 106         Returns:
 107             TestCase.EX_OK if results were pushed to DB.
 108             TestCase.EX_PUSH_TO_DB_ERROR otherwise.
 109         """
 110         try:
 111             assert self.project_name
 112             assert self.case_name
 113             assert self.criteria
 114             assert self.start_time
 115             assert self.stop_time
 116             if ft_utils.push_results_to_db(
 117                     self.project_name, self.case_name, self.start_time,
 118                     self.stop_time, self.criteria, self.details):
 119                 self.logger.info("The results were successfully pushed to DB")
 120                 return TestCase.EX_OK
 121             else:
 122                 self.logger.error("The results cannot be pushed to DB")
 123                 return TestCase.EX_PUSH_TO_DB_ERROR
 124         except Exception:  # pylint: disable=broad-except
 125             self.logger.exception("The results cannot be pushed to DB")
 126             return TestCase.EX_PUSH_TO_DB_ERROR