blob: 4fe9cf84136f96f2c6c4bd4ef34b10f1787dc97b [file] [log] [blame]
Craig Tiller6169d5f2016-03-31 07:46:18 -07001# Copyright 2015, Google Inc.
Adele Zhou2271ab52015-10-28 13:59:14 -07002# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met:
7#
8# * Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10# * Redistributions in binary form must reproduce the above
11# copyright notice, this list of conditions and the following disclaimer
12# in the documentation and/or other materials provided with the
13# distribution.
14# * Neither the name of Google Inc. nor the names of its
15# contributors may be used to endorse or promote products derived from
16# this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30"""Generate XML and HTML test reports."""
31
Adele Zhou3bc7ba42015-11-05 10:21:58 -080032try:
33 from mako.runtime import Context
34 from mako.template import Template
Carl Mastrangeloe7f8e8e2015-12-08 17:22:44 -080035 from mako import exceptions
Adele Zhou3bc7ba42015-11-05 10:21:58 -080036except (ImportError):
37 pass # Mako not installed but it is ok.
Adele Zhou2271ab52015-10-28 13:59:14 -070038import os
Adele Zhoud01cbe32015-11-02 14:20:43 -080039import string
Adele Zhou2271ab52015-10-28 13:59:14 -070040import xml.etree.cElementTree as ET
41
42
Adele Zhoud01cbe32015-11-02 14:20:43 -080043def _filter_msg(msg, output_format):
44 """Filters out nonprintable and illegal characters from the message."""
45 if output_format in ['XML', 'HTML']:
46 # keep whitespaces but remove formfeed and vertical tab characters
47 # that make XML report unparseable.
48 filtered_msg = filter(
49 lambda x: x in string.printable and x != '\f' and x != '\v',
Jan Tattermusch60ab05a2016-02-25 17:42:44 -080050 msg.decode('UTF-8', 'ignore'))
Adele Zhoud01cbe32015-11-02 14:20:43 -080051 if output_format == 'HTML':
52 filtered_msg = filtered_msg.replace('"', '"')
53 return filtered_msg
54 else:
55 return msg
56
57
Jan Tattermusch19a41212016-10-09 17:02:34 +020058def render_junit_xml_report(resultset, xml_report, suite_package='grpc',
59 suite_name='tests'):
Adele Zhou2271ab52015-10-28 13:59:14 -070060 """Generate JUnit-like XML report."""
61 root = ET.Element('testsuites')
Jan Tattermusch19a41212016-10-09 17:02:34 +020062 testsuite = ET.SubElement(root, 'testsuite', id='1', package=suite_package,
63 name=suite_name)
Adele Zhou2271ab52015-10-28 13:59:14 -070064 for shortname, results in resultset.iteritems():
65 for result in results:
66 xml_test = ET.SubElement(testsuite, 'testcase', name=shortname)
67 if result.elapsed_time:
68 xml_test.set('time', str(result.elapsed_time))
Adele Zhoud01cbe32015-11-02 14:20:43 -080069 ET.SubElement(xml_test, 'system-out').text = _filter_msg(result.message,
70 'XML')
Adele Zhou2271ab52015-10-28 13:59:14 -070071 if result.state == 'FAILED':
72 ET.SubElement(xml_test, 'failure', message='Failure')
73 elif result.state == 'TIMEOUT':
74 ET.SubElement(xml_test, 'error', message='Timeout')
75 tree = ET.ElementTree(root)
76 tree.write(xml_report, encoding='UTF-8')
77
78
Adele Zhou3bc7ba42015-11-05 10:21:58 -080079def render_interop_html_report(
80 client_langs, server_langs, test_cases, auth_test_cases, http2_cases,
Adele Zhoub9e66cc2016-02-03 13:12:23 -080081 resultset, num_failures, cloud_to_prod, prod_servers, http2_interop):
Adele Zhou3bc7ba42015-11-05 10:21:58 -080082 """Generate HTML report for interop tests."""
Adele Zhou12877c92015-12-09 11:22:25 -080083 template_file = 'tools/run_tests/interop_html_report.template'
Adele Zhou3bc7ba42015-11-05 10:21:58 -080084 try:
85 mytemplate = Template(filename=template_file, format_exceptions=True)
86 except NameError:
87 print 'Mako template is not installed. Skipping HTML report generation.'
88 return
89 except IOError as e:
90 print 'Failed to find the template %s: %s' % (template_file, e)
91 return
Adele Zhou2271ab52015-10-28 13:59:14 -070092
Adele Zhou3bc7ba42015-11-05 10:21:58 -080093 sorted_test_cases = sorted(test_cases)
94 sorted_auth_test_cases = sorted(auth_test_cases)
95 sorted_http2_cases = sorted(http2_cases)
96 sorted_client_langs = sorted(client_langs)
97 sorted_server_langs = sorted(server_langs)
Adele Zhoub9e66cc2016-02-03 13:12:23 -080098 sorted_prod_servers = sorted(prod_servers)
Adele Zhou3bc7ba42015-11-05 10:21:58 -080099
100 args = {'client_langs': sorted_client_langs,
101 'server_langs': sorted_server_langs,
102 'test_cases': sorted_test_cases,
103 'auth_test_cases': sorted_auth_test_cases,
104 'http2_cases': sorted_http2_cases,
105 'resultset': resultset,
106 'num_failures': num_failures,
107 'cloud_to_prod': cloud_to_prod,
Adele Zhoub9e66cc2016-02-03 13:12:23 -0800108 'prod_servers': sorted_prod_servers,
Adele Zhou3bc7ba42015-11-05 10:21:58 -0800109 'http2_interop': http2_interop}
Carl Mastrangeloe7f8e8e2015-12-08 17:22:44 -0800110
Adele Zhou12877c92015-12-09 11:22:25 -0800111 html_report_out_dir = 'reports'
112 if not os.path.exists(html_report_out_dir):
113 os.mkdir(html_report_out_dir)
114 html_file_path = os.path.join(html_report_out_dir, 'index.html')
Carl Mastrangeloe7f8e8e2015-12-08 17:22:44 -0800115 try:
116 with open(html_file_path, 'w') as output_file:
117 mytemplate.render_context(Context(output_file, **args))
118 except:
119 print(exceptions.text_error_template().render())
120 raise
121