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