1 # Copyright (c) 2017 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Algorithms to generate tables.
19 from string import replace
21 from errors import PresentationError
22 from utils import mean, stdev, relative_change
25 def generate_tables(spec, data):
26 """Generate all tables specified in the specification file.
28 :param spec: Specification read from the specification file.
29 :param data: Data to process.
30 :type spec: Specification
34 logging.info("Generating the tables ...")
35 for table in spec.tables:
37 eval(table["algorithm"])(table, data)
39 logging.error("The algorithm '{0}' is not defined.".
40 format(table["algorithm"]))
44 def table_details(table, input_data):
45 """Generate the table(s) with algorithm: table_detailed_test_results
46 specified in the specification file.
48 :param table: Table to generate.
49 :param input_data: Data to process.
50 :type table: pandas.Series
51 :type input_data: InputData
54 logging.info(" Generating the table {0} ...".
55 format(table.get("title", "")))
58 data = input_data.filter_data(table)
60 # Prepare the header of the tables
62 for column in table["columns"]:
63 header.append('"{0}"'.format(str(column["title"]).replace('"', '""')))
65 # Generate the data for the table according to the model in the table
68 job = table["data"].keys()[0]
69 build = str(table["data"][job][0])
71 suites = input_data.suites(job, build)
73 logging.error(" No data available. The table will not be generated.")
76 for suite_longname, suite in suites.iteritems():
78 suite_name = suite["name"]
80 for test in data[job][build].keys():
81 if data[job][build][test]["parent"] in suite_name:
83 for column in table["columns"]:
85 col_data = str(data[job][build][test][column["data"].
86 split(" ")[1]]).replace('"', '""')
87 if column["data"].split(" ")[1] in ("vat-history",
89 col_data = replace(col_data, " |br| ", "",
91 col_data = " |prein| {0} |preout| ".\
93 row_lst.append('"{0}"'.format(col_data))
95 row_lst.append("No data")
96 table_lst.append(row_lst)
98 # Write the data to file
100 file_name = "{0}_{1}{2}".format(table["output-file"], suite_name,
101 table["output-file-ext"])
102 logging.info(" Writing file: '{}'".format(file_name))
103 with open(file_name, "w") as file_handler:
104 file_handler.write(",".join(header) + "\n")
105 for item in table_lst:
106 file_handler.write(",".join(item) + "\n")
108 logging.info(" Done.")
111 def table_performance_improvements(table, input_data):
112 """Generate the table(s) with algorithm: table_performance_improvements
113 specified in the specification file.
115 :param table: Table to generate.
116 :param input_data: Data to process.
117 :type table: pandas.Series
118 :type input_data: InputData
121 def _write_line_to_file(file_handler, data):
122 """Write a line to the .csv file.
124 :param file_handler: File handler for the csv file. It must be open for
126 :param data: Item to be written to the file.
127 :type file_handler: BinaryIO
133 if isinstance(item["data"], str):
134 line_lst.append(item["data"])
135 elif isinstance(item["data"], float):
136 line_lst.append("{:.1f}".format(item["data"]))
137 elif item["data"] is None:
139 file_handler.write(",".join(line_lst) + "\n")
141 logging.info(" Generating the table {0} ...".
142 format(table.get("title", "")))
145 file_name = table.get("template", None)
148 tmpl = _read_csv_template(file_name)
149 except PresentationError:
150 logging.error(" The template '{0}' does not exist. Skipping the "
151 "table.".format(file_name))
154 logging.error("The template is not defined. Skipping the table.")
158 data = input_data.filter_data(table)
160 # Prepare the header of the tables
162 for column in table["columns"]:
163 header.append(column["title"])
165 # Generate the data for the table according to the model in the table
168 for tmpl_item in tmpl:
170 for column in table["columns"]:
171 cmd = column["data"].split(" ")[0]
172 args = column["data"].split(" ")[1:]
173 if cmd == "template":
175 val = float(tmpl_item[int(args[0])])
177 val = tmpl_item[int(args[0])]
178 tbl_item.append({"data": val})
183 for build in data[job]:
185 data_lst.append(float(build[tmpl_item[0]]["throughput"]
187 except (KeyError, TypeError):
191 tbl_item.append({"data": (eval(operation)(data_lst)) /
194 tbl_item.append({"data": None})
195 elif cmd == "operation":
198 nr1 = float(tbl_item[int(args[1])]["data"])
199 nr2 = float(tbl_item[int(args[2])]["data"])
201 tbl_item.append({"data": eval(operation)(nr1, nr2)})
203 tbl_item.append({"data": None})
204 except (IndexError, ValueError, TypeError):
205 logging.error("No data for {0}".format(tbl_item[1]["data"]))
206 tbl_item.append({"data": None})
209 logging.error("Not supported command {0}. Skipping the table.".
212 tbl_lst.append(tbl_item)
214 # Sort the table according to the relative change
215 tbl_lst.sort(key=lambda rel: rel[-1]["data"], reverse=True)
217 # Create the tables and write them to the files
219 "{0}_ndr_top{1}".format(table["output-file"], table["output-file-ext"]),
220 "{0}_pdr_top{1}".format(table["output-file"], table["output-file-ext"]),
221 "{0}_ndr_low{1}".format(table["output-file"], table["output-file-ext"]),
222 "{0}_pdr_low{1}".format(table["output-file"], table["output-file-ext"])
225 for file_name in file_names:
226 logging.info(" Writing the file '{0}'".format(file_name))
227 with open(file_name, "w") as file_handler:
228 file_handler.write(",".join(header) + "\n")
230 if "ndr_top" in file_name \
231 and "ndr" in item[1]["data"] \
232 and item[-1]["data"] >= 10.0:
233 _write_line_to_file(file_handler, item)
234 elif "pdr_top" in file_name \
235 and "pdr" in item[1]["data"] \
236 and item[-1]["data"] >= 10.0:
237 _write_line_to_file(file_handler, item)
238 elif "ndr_low" in file_name \
239 and "ndr" in item[1]["data"] \
240 and item[-1]["data"] < 10.0:
241 _write_line_to_file(file_handler, item)
242 elif "pdr_low" in file_name \
243 and "pdr" in item[1]["data"] \
244 and item[-1]["data"] < 10.0:
245 _write_line_to_file(file_handler, item)
247 logging.info(" Done.")
250 def _read_csv_template(file_name):
251 """Read the template from a .csv file.
253 :param file_name: Name / full path / relative path of the file to read.
255 :returns: Data from the template as list (lines) of lists (items on line).
257 :raises: PresentationError if it is not possible to read the file.
261 with open(file_name, 'r') as csv_file:
263 for line in csv_file:
264 tmpl_data.append(line[:-1].split(","))
266 except IOError as err:
267 raise PresentationError(str(err), level="ERROR")