xtesting/core/feature.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 ZTE Corp 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 classes of all Xtesting Features.
  11
  12 Feature is considered as TestCase offered by Third-party. It offers
  13 helpers to run any python method or any bash command.
  14 """
  15
  16 import abc
  17 import logging
  18 import os
  19 import subprocess
  20 import sys
  21 import time
  22
  23 from xtesting.core import testcase
  24
  25 __author__ = ("Serena Feng <feng.xiaowei@zte.com.cn>, "
  26               "Cedric Ollivier <cedric.ollivier@orange.com>")
  27
  28
  29 class Feature(testcase.TestCase, metaclass=abc.ABCMeta):
  30     """Base model for single feature."""
  31
  32     __logger = logging.getLogger(__name__)
  33
  34     @abc.abstractmethod
  35     def execute(self, **kwargs):
  36         """Execute the Python method.
  37
  38         The subclasses must override the default implementation which
  39         is false on purpose.
  40
  41         The new implementation must return 0 if success or anything
  42         else if failure.
  43
  44         Args:
  45             kwargs: Arbitrary keyword arguments.
  46         """
  47
  48     def run(self, **kwargs):
  49         """Run the feature.
  50
  51         It allows executing any Python method by calling execute().
  52
  53         It sets the following attributes required to push the results
  54         to DB:
  55
  56             * result,
  57             * start_time,
  58             * stop_time.
  59
  60         It doesn't fulfill details when pushing the results to the DB.
  61
  62         Args:
  63             kwargs: Arbitrary keyword arguments.
  64
  65         Returns:
  66             TestCase.EX_OK if execute() returns 0,
  67             TestCase.EX_RUN_ERROR otherwise.
  68         """
  69         self.start_time = time.time()
  70         exit_code = testcase.TestCase.EX_RUN_ERROR
  71         self.result = 0
  72         try:
  73             if self.execute(**kwargs) == 0:
  74                 exit_code = testcase.TestCase.EX_OK
  75                 self.result = 100
  76         except Exception:  # pylint: disable=broad-except
  77             self.__logger.exception("%s FAILED", self.project_name)
  78         self.stop_time = time.time()
  79         return exit_code
  80
  81
  82 class BashFeature(Feature):
  83     """Class designed to run any bash command."""
  84
  85     __logger = logging.getLogger(__name__)
  86
  87     def __init__(self, **kwargs):
  88         super().__init__(**kwargs)
  89         self.result_file = f"{self.res_dir}/{self.case_name}.log"
  90
  91     def execute(self, **kwargs):
  92         """Execute the cmd passed as arg
  93
  94         Args:
  95             kwargs: Arbitrary keyword arguments.
  96
  97         Returns:
  98             process return code if no exception,
  99             -1 otherwise.
 100         """
 101         try:
 102             cmd = kwargs["cmd"]
 103             console = kwargs["console"] if "console" in kwargs else False
 104             # For some tests, we may need to force stop after N sec
 105             max_duration = kwargs.get("max_duration")
 106             if not os.path.isdir(self.res_dir):
 107                 os.makedirs(self.res_dir)
 108             with open(self.result_file, 'w', encoding='utf-8') as f_stdout:
 109                 self.__logger.info("Calling %s", cmd)
 110                 with subprocess.Popen(
 111                         cmd, shell=True, stdout=subprocess.PIPE,
 112                         stderr=subprocess.STDOUT) as process:
 113                     for line in iter(process.stdout.readline, b''):
 114                         if console:
 115                             sys.stdout.write(line.decode("utf-8"))
 116                         f_stdout.write(line.decode("utf-8"))
 117                     try:
 118                         process.wait(timeout=max_duration)
 119                     except subprocess.TimeoutExpired:
 120                         process.kill()
 121                         self.__logger.info(
 122                             "Killing process after %d second(s).",
 123                             max_duration)
 124                         return -2
 125             with open(self.result_file, 'r', encoding='utf-8') as f_stdin:
 126                 self.__logger.debug("$ %s\n%s", cmd, f_stdin.read().rstrip())
 127             return process.returncode
 128         except KeyError:
 129             self.__logger.error("Please give cmd as arg. kwargs: %s", kwargs)
 130         return -1