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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
import collections
import os
import subprocess
import yaml
from argparse import ArgumentParser
from csv import DictWriter
from jinja2 import Environment, FileSystemLoader
class PrependOrderedDict(collections.OrderedDict):
def prepend(self, key, value, dict_setitem=dict.__setitem__):
root = self._OrderedDict__root
first = root[1]
if key in self:
link = self._OrderedDict__map[key]
link_prev, link_next, _ = link
link_prev[1] = link_next
link_next[0] = link_prev
link[0] = root
link[1] = first
root[1] = first[0] = link
else:
root[1] = first[0] = self._OrderedDict__map[key] = [root, first, key]
dict_setitem(self, key, value)
def render(obj, template="testplan.html", name=None):
if name is None:
name = template
templates_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "templates")
_env = Environment(loader=FileSystemLoader(templates_dir))
_template = _env.get_template(template)
_obj = _template.render(obj=obj)
with open("{}".format(name), "wb") as _file:
_file.write(_obj.encode('utf-8'))
# get list of repositories and cache them
def repository_list(testplan):
repositories = set()
tp_version = testplan['metadata']['format']
if tp_version == "Linaro Test Plan v2":
if 'manual' in testplan['tests'].keys() and testplan['tests']['manual'] is not None:
for test in testplan['tests']['manual']:
repositories.add(test['repository'])
if 'automated' in testplan['tests'].keys() and testplan['tests']['automated'] is not None:
for test in testplan['tests']['automated']:
repositories.add(test['repository'])
if tp_version == "Linaro Test Plan v1":
for req in testplan['requirements']:
if 'tests' in req.keys() and req['tests'] is not None:
if 'manual' in req['tests'].keys() and req['tests']['manual'] is not None:
for test in req['tests']['manual']:
repositories.add(test['repository'])
if 'automated' in req['tests'].keys() and req['tests']['automated'] is not None:
for test in req['tests']['automated']:
repositories.add(test['repository'])
return repositories
def clone_repository(repository_url, base_path, ignore=False):
path_suffix = repository_url.rsplit("/", 1)[1]
if path_suffix.endswith(".git"):
path_suffix = path_suffix[:-4]
path = os.path.abspath(os.path.join(base_path, path_suffix))
if os.path.exists(path) and ignore:
return(repository_url, path)
# git clone repository_url
subprocess.call(['git', 'clone', repository_url, path])
# return tuple (repository_url, system_path)
return (repository_url, path)
def test_exists(test, repositories, args):
test_file_path = os.path.join(
repositories[test['repository']],
test['path']
)
current_dir = os.getcwd()
print current_dir
os.chdir(repositories[test['repository']])
if 'revision' in test.keys():
subprocess.call(['git', 'checkout', test['revision']])
else:
# if no revision is specified, use current HEAD
output = subprocess.check_output(['git', 'rev-parse', 'HEAD'])
test['revision'] = output
if not os.path.exists(test_file_path) or not os.path.isfile(test_file_path):
test['missing'] = True
os.chdir(current_dir)
return not test['missing']
test['missing'] = False
# open the file and render the test
subprocess.call(['git', 'checkout', 'master'])
print current_dir
os.chdir(current_dir)
print os.getcwd()
test_file = open(test_file_path, "r")
test_yaml = yaml.load(test_file.read())
params_string = ""
if 'parameters' in test.keys():
params_string = "_".join(["{0}-{1}".format(param_name, param_value).replace("/", "").replace(" ", "") for param_name, param_value in test['parameters'].iteritems()])
test_yaml['params'].update(test['parameters'])
if args.single_output:
# update parameters in test
if 'params' in test_yaml.keys():
for param_name, param_value in test_yaml['params'].iteritems():
if param_name not in test['parameters'].keys():
test['parameters'].update({param_name: param_value})
print params_string
test_name = "{0}_{1}.html".format(test_yaml['metadata']['name'], params_string)
if not args.single_output:
test['filename'] = test_name
test_path = os.path.join(os.path.abspath(args.output), test_name)
if args.single_output:
# update test plan object
test.update(test_yaml['run'])
# prepend in reversed order so 'name' is on top
test.prepend("os", test_yaml['metadata']['os'])
test.prepend("scope", test_yaml['metadata']['scope'])
test.prepend("description", test_yaml['metadata']['description'])
test.prepend("name", test_yaml['metadata']['name'])
else:
render(test_yaml, template="test.html", name=test_path)
return not test['missing']
def add_csv_row(requirement, test, args, manual=False):
fieldnames = [
"req_name",
"req_owner",
"req_category",
"path",
"repository",
"revision",
"parameters",
"mandatory",
"kind",
]
csv_file_path = os.path.join(os.path.abspath(args.output), args.csv_name)
has_header = False
if os.path.isfile(csv_file_path):
has_header = True
with open(csv_file_path, "ab+") as csv_file:
csvdict = DictWriter(csv_file, fieldnames=fieldnames)
if not has_header:
csvdict.writeheader()
csvdict.writerow(
{
"req_name": requirement.get('name'),
"req_owner": requirement.get('owner'),
"req_category": requirement.get('category'),
"path": test.get('path'),
"repository": test.get('repository'),
"revision": test.get('revision'),
"parameters": test.get('parameters'),
"mandatory": test.get('mandatory'),
"kind": "manual" if manual else "automated",
}
)
def check_coverage(requirement, repositories, args):
requirement['covered'] = False
if 'tests' not in requirement.keys() or requirement['tests'] is None:
return
if 'manual' in requirement['tests'].keys() and requirement['tests']['manual'] is not None:
for test in requirement['tests']['manual']:
if test_exists(test, repositories, args):
requirement['covered'] = True
if args.csv_name:
add_csv_row(requirement, test, args, True)
if 'automated' in requirement['tests'].keys() and requirement['tests']['automated'] is not None:
for test in requirement['tests']['automated']:
if test_exists(test, repositories, args):
requirement['covered'] = True
if args.csv_name:
add_csv_row(requirement, test, args)
def dict_representer(dumper, data):
return dumper.represent_dict(data.iteritems())
def dict_constructor(loader, node):
return PrependOrderedDict(loader.construct_pairs(node))
def main():
parser = ArgumentParser()
parser.add_argument("-f",
"--file",
dest="testplan_list",
required=True,
nargs="+",
help="Test plan file to be used")
parser.add_argument("-r",
"--repositories",
dest="repository_path",
default="repositories",
help="Test plan file to be used")
parser.add_argument("-o",
"--output",
dest="output",
default="output",
help="Destination directory for generated files")
parser.add_argument("-i",
"--ignore-clone",
dest="ignore_clone",
action="store_true",
default=False,
help="Ignore cloning repositories and use previously cloned")
parser.add_argument("-s",
"--single-file-output",
dest="single_output",
action="store_true",
default=False,
help="""Render test plan into single HTML file. This option ignores
any metadata that is available in test cases""")
parser.add_argument("-c",
"--csv",
dest="csv_name",
required=False,
help="Name of CSV to store overall list of requirements and test. If name is absent, the file will not be generated")
_mapping_tag = yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG
yaml.add_representer(PrependOrderedDict, dict_representer)
yaml.add_constructor(_mapping_tag, dict_constructor)
args = parser.parse_args()
if not os.path.exists(os.path.abspath(args.output)):
os.makedirs(os.path.abspath(args.output), 0755)
for testplan in args.testplan_list:
if os.path.exists(testplan) and os.path.isfile(testplan):
testplan_file = open(testplan, "r")
tp_obj = yaml.load(testplan_file.read())
repo_list = repository_list(tp_obj)
repositories = {}
for repo in repo_list:
repo_url, repo_path = clone_repository(repo, args.repository_path, args.ignore_clone)
repositories.update({repo_url: repo_path})
# ToDo: check test plan structure
tp_version = tp_obj['metadata']['format']
if tp_version == "Linaro Test Plan v1":
for requirement in tp_obj['requirements']:
check_coverage(requirement, repositories, args)
if tp_version == "Linaro Test Plan v2":
if 'manual' in tp_obj['tests'].keys() and tp_obj['tests']['manual'] is not None:
for test in tp_obj['tests']['manual']:
test_exists(test, repositories, args)
if 'automated' in tp_obj['tests'].keys() and tp_obj['tests']['automated'] is not None:
for test in tp_obj['tests']['automated']:
test_exists(test, repositories, args)
tp_name = tp_obj['metadata']['name'] + ".html"
tp_file_name = os.path.join(os.path.abspath(args.output), tp_name)
if tp_version == "Linaro Test Plan v1":
render(tp_obj, name=tp_file_name)
if tp_version == "Linaro Test Plan v2":
render(tp_obj, name=tp_file_name, template="testplan_v2.html")
testplan_file.close()
# go through requiremets and for each test:
# - if file exists render test as separate html file
# - if file is missing, indicate missing test (red)
# render test plan with links to test files
# add option to render as single file (for pdf generation)
if __name__ == "__main__":
main()
|
