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
|
#!/usr/bin/python
# Copyright (c) 2016 Cisco and/or its affiliates.
# 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.
"""Script extracts intersted data (name, documentation, message, status) from
robot framework output file (output.xml) and print in specified format (wiki,
html) to stdout or, if specified by parameter, redirect to file."""
import argparse
import re
import sys
from robot.api import ExecutionResult, ResultVisitor
class ExecutionChecker(ResultVisitor):
"""Abstract class to traverse through the test suite structure."""
def __init__(self, args):
self.formatting = args.formatting
def visit_suite(self, suite):
"""Implements traversing through the suite and its direct children.
:param suite: Suite to process.
:type suite: Suite
:return: Nothing.
"""
if self.start_suite(suite) is not False:
if suite.tests:
if self.formatting == 'html':
sys.stdout.write('<table width=100% border=1><tr>'+'\n')
sys.stdout.write('<th width=32%>Name</th>'+'\n')
sys.stdout.write('<th width=40%>Documentation</th>'+'\n')
if "ndrdisc" in suite.longname:
sys.stdout.write('<th width=24%>Message</th>'+'\n')
sys.stdout.write('<th width=4%>Status</th><tr/>'+'\n')
sys.stdout.write('</tr>')
elif self.formatting == 'wiki':
sys.stdout.write('{| class="wikitable"'+'\n')
if "ndrdisc" in suite.longname:
header = '!Name!!Documentation!!Message!!Status'
else:
header = '!Name!!Documentation!!Status'
sys.stdout.write(header+'\n')
else:
pass
suite.suites.visit(self)
suite.tests.visit(self)
if suite.tests:
if self.formatting == 'html':
sys.stdout.write('</table>'+'\n')
elif self.formatting == 'wiki':
sys.stdout.write('|}'+'\n')
else:
pass
self.end_suite(suite)
def start_suite(self, suite):
"""Called when suite starts.
:param suite: Suite to process.
:type suite: Suite
:return: Nothing.
"""
level = len(suite.longname.split("."))
if self.formatting == 'html':
mark_l = '<h'+str(level)+'>'
mark_r = '</h'+str(level)+'>'
sys.stdout.write(mark_l+suite.name+mark_r+'\n')
sys.stdout.write('<p>'+re.sub(r"(\*)(.*?)(\*)", r"<b>\2</b>",\
suite.doc, 0, flags=re.MULTILINE).replace(\
'[', '<br>[')+'</p>\n')
elif self.formatting == 'wiki':
mark = "=" * (level+2)
sys.stdout.write(mark+suite.name+mark+'\n')
sys.stdout.write(re.sub(r"(\*)(.*?)(\*)", r"\n*'''\2'''",\
suite.doc.replace('\n', ' '), 0, flags=re.MULTILINE)+'\n')
else:
pass
def end_suite(self, suite):
"""Called when suite ends.
:param suite: Suite to process.
:type suite: Suite
:return: Nothing.
"""
pass
def visit_test(self, test):
"""Implements traversing through the test.
:param test: Test to process.
:type test: Test
:return: Nothing.
"""
if self.start_test(test) is not False:
self.end_test(test)
def start_test(self, test):
"""Called when test starts.
:param test: Test to process.
:type test: Test
:return: Nothing.
"""
if self.formatting == 'html':
sys.stdout.write('<tr>'+'\n')
sys.stdout.write('<td>'+test.name+'</td>'+'\n')
sys.stdout.write('<td>'+test.doc+'</td>'+'\n')
if any("NDRPDRDISC" in tag for tag in test.tags):
sys.stdout.write('<td>'+test.message+'</td>'+'\n')
sys.stdout.write('<td>'+test.status+'</td>'+'\n')
elif self.formatting == 'wiki':
sys.stdout.write('|-'+'\n')
sys.stdout.write('|'+test.name+'\n')
sys.stdout.write('|'+test.doc.replace('\n', ' ').replace('\r',\
'')+'\n')
if any("NDRPDRDISC" in tag for tag in test.tags):
sys.stdout.write('|'+test.message+'\n')
sys.stdout.write('|'+test.status+'\n')
else:
pass
def end_test(self, test):
"""Called when test ends.
:param test: Test to process.
:type test: Test
:return: Nothing.
"""
if self.formatting == 'html':
sys.stdout.write('</tr>'+'\n')
elif self.formatting == 'wiki':
pass
else:
pass
def process_robot_file(args):
"""Process data from robot output.xml file and return raw data.
:param args: Parsed arguments.
:type args: ArgumentParser
:return: Nothing.
"""
result = ExecutionResult(args.input)
checker = ExecutionChecker(args)
result.visit(checker)
def print_error(msg):
"""Print error message on stderr.
:param msg: Error message to print.
:type msg: str
:return: nothing
"""
sys.stderr.write(msg+'\n')
def parse_args():
"""Parse arguments from cmd line.
:return: Parsed arguments.
:rtype ArgumentParser
"""
parser = argparse.ArgumentParser()
parser.add_argument("-i", "--input", required=True,
type=argparse.FileType('r'),
help="Robot XML log file")
parser.add_argument("-o", "--output",
type=argparse.FileType('w'),
help="Output file")
parser.add_argument("-f", "--formatting", required=True,
choices=['html', 'wiki'],
help="Output file format")
return parser.parse_args()
def main():
"""Main function."""
args = parse_args()
if args.output:
sys.stdout = args.output
process_robot_file(args)
if __name__ == "__main__":
sys.exit(main())
|
