X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Fgenerator_files.py;h=e1ddef013d8507af8acad08fe8971cc0163348a6;hb=refs%2Fchanges%2F59%2F25459%2F5;hp=dd70c70ce707492a339add20dc91f4a16dd34dac;hpb=9a89069be33f11879f8307e5b774c6e1e7afa398;p=csit.git
diff --git a/resources/tools/presentation/generator_files.py b/resources/tools/presentation/generator_files.py
index dd70c70ce7..e1ddef013d 100644
--- a/resources/tools/presentation/generator_files.py
+++ b/resources/tools/presentation/generator_files.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
@@ -17,7 +17,18 @@
import logging
-from utils import get_files, get_rst_title_char
+from pal_utils import get_files, get_rst_title_char
+
+
+RST_INCLUDE_TABLE = (u"\n.. only:: html\n\n"
+ u" .. csv-table::\n"
+ u" :header-rows: 1\n"
+ u" :widths: auto\n"
+ u" :align: center\n"
+ u" :file: {file_html}\n"
+ u"\n.. only:: latex\n\n"
+ u"\n .. raw:: latex\n\n"
+ u" \\csvautolongtable{{{file_latex}}}\n\n")
def generate_files(spec, data):
@@ -29,88 +40,156 @@ def generate_files(spec, data):
:type data: InputData
"""
- logging.info("Generating the files ...")
+ generator = {
+ u"file_test_results": file_test_results,
+ u"file_test_results_html": file_test_results_html
+ }
+
+ logging.info(u"Generating the files ...")
for file_spec in spec.files:
try:
- eval(file_spec["algorithm"])(file_spec, data)
- except NameError:
- logging.error("The algorithm '{0}' is not defined.".
- format(file_spec["algorithm"]))
- logging.info("Done.")
+ generator[file_spec[u"algorithm"]](file_spec, data)
+ except (NameError, KeyError) as err:
+ logging.error(
+ f"Probably algorithm {file_spec[u'algorithm']} is not defined: "
+ f"{repr(err)}"
+ )
+ logging.info(u"Done.")
+
+
+def _tests_in_suite(suite_name, tests):
+ """Check if the suite includes tests.
+
+ :param suite_name: Name of the suite to be checked.
+ :param tests: Set of tests
+ :type suite_name: str
+ :type tests: pandas.Series
+ :returns: True if the suite includes tests.
+ :rtype: bool
+ """
+
+ for key in tests.keys():
+ if suite_name == tests[key][u"parent"]:
+ return True
+ return False
-def file_test_results(file_spec, input_data):
- """Generate the file(s) with algorithm: file_test_results specified in the
- specification file.
+def file_test_results(file_spec, input_data, frmt=u"rst"):
+ """Generate the file(s) with algorithms
+ - file_test_results
+ specified in the specification file.
:param file_spec: File to generate.
:param input_data: Data to process.
+ :param frmt: Format can be: rst or html
:type file_spec: pandas.Series
:type input_data: InputData
+ :type frmt: str
"""
- def tests_in_suite(suite_name, tests):
- """Check if the suite includes tests.
-
- :param suite_name: Name of the suite to be checked.
- :param tests: Set of tests
- :type suite_name: str
- :type tests: pandas.Series
- :returns: True if the suite includes tests.
- :rtype: bool
- """
-
- for key in tests.keys():
- if suite_name == tests[key]["parent"]:
- return True
- return False
-
- file_name = "{0}{1}".format(file_spec["output-file"],
- file_spec["output-file-ext"])
- rst_header = file_spec["file-header"]
-
- rst_include_table = ("\n.. only:: html\n\n"
- " .. csv-table::\n"
- " :header-rows: 1\n"
- " :widths: auto\n"
- " :align: center\n"
- " :file: {file_html}\n"
- "\n.. only:: latex\n\n"
- "\n .. raw:: latex\n\n"
- " \csvautolongtable{{{file_latex}}}\n\n")
-
- logging.info(" Generating the file {0} ...".format(file_name))
-
- table_lst = get_files(file_spec["dir-tables"], ".csv", full_path=True)
- if len(table_lst) == 0:
- logging.error(" No tables to include in '{0}'. Skipping.".
- format(file_spec["dir-tables"]))
- return None
-
- job = file_spec["data"].keys()[0]
- build = str(file_spec["data"][job][0])
-
- logging.info(" Writing file '{0}'".format(file_name))
-
- suites = input_data.suites(job, build)[file_spec["data-start-level"]:]
+ base_file_name = f"{file_spec[u'output-file']}"
+ rst_header = (
+ u"\n"
+ u".. |br| raw:: html\n\n
\n\n\n"
+ u".. |prein| raw:: html\n\n
\n\n\n" + u".. |preout| raw:: html\n\n\n\n" + ) + start_lvl = file_spec.get(u"data-start-level", 4) + + logging.info(f" Generating the file {base_file_name} ...") + + if frmt == u"html": + table_lst = get_files(file_spec[u"dir-tables"], u".rst", full_path=True) + elif frmt == u"rst": + table_lst = get_files(file_spec[u"dir-tables"], u".csv", full_path=True) + else: + return + if not table_lst: + logging.error( + f" No tables to include in {file_spec[u'dir-tables']}. Skipping." + ) + return + + logging.info( + f" Creating the tests data set for the " + f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}." + ) + + tests = input_data.filter_data( + file_spec, + params=[u"name", u"parent", u"doc", u"type", u"level"], + continue_on_error=True + ) + if tests.empty: + return + tests = input_data.merge_data(tests) + tests.sort_index(inplace=True) + + suites = input_data.filter_data( + file_spec, + continue_on_error=True, + data_set=u"suites" + ) + if suites.empty: + return + suites = input_data.merge_data(suites) suites.sort_index(inplace=True) - with open(file_name, "w") as file_handler: - file_handler.write(rst_header) - for suite_longname, suite in suites.iteritems(): - suite_name = suite["name"] - file_handler.write("\n{0}\n{1}\n".format( - suite_name, get_rst_title_char( - suite["level"] - file_spec["data-start-level"] - 1) * - len(suite_name))) - file_handler.write("\n{0}\n".format( - suite["doc"].replace('|br|', '\n\n -'))) - if tests_in_suite(suite_name, input_data.tests(job, build)): + file_name = u"" + for suite_longname, suite in suites.items(): + + suite_lvl = len(suite_longname.split(u".")) + if suite_lvl < start_lvl: + # Not interested in this suite + continue + + if suite_lvl == start_lvl: + # Our top-level suite + chapter = suite_longname.split(u'.')[-1] + file_name = f"{base_file_name}/{chapter}.rst" + logging.info(f" Writing file {file_name}") + with open(f"{base_file_name}/index.rst", u"a") as file_handler: + file_handler.write(f" {chapter}\n") + with open(file_name, u"a") as file_handler: + file_handler.write(rst_header) + + title_line = get_rst_title_char(suite[u"level"] - start_lvl + 2) * \ + len(suite[u"name"]) + with open(file_name, u"a") as file_handler: + if not (u"-ndrpdr" in suite[u"name"] or + u"-mrr" in suite[u"name"] or + u"-dev" in suite[u"name"]): + file_handler.write(f"\n{suite[u'name']}\n{title_line}\n") + + if _tests_in_suite(suite[u"name"], tests): + file_handler.write(f"\n{suite[u'name']}\n{title_line}\n") + file_handler.write( + f"\n{suite[u'doc']}\n".replace(u'|br|', u'\n\n -') + ) for tbl_file in table_lst: - if suite_name in tbl_file: - file_handler.write( - rst_include_table.format( - file_latex=tbl_file, - file_html=tbl_file.split("/")[-1])) + if suite[u"name"] in tbl_file: + if frmt == u"html": + file_handler.write( + f"\n.. include:: {tbl_file.split(u'/')[-1]}\n" + ) + elif frmt == u"rst": + file_handler.write( + RST_INCLUDE_TABLE.format( + file_latex=tbl_file, + file_html=tbl_file.split(u"/")[-1]) + ) + + logging.info(u" Done.") + + +def file_test_results_html(file_spec, input_data): + """Generate the file(s) with algorithms + - file_test_results_html + specified in the specification file. - logging.info(" Done.") + :param file_spec: File to generate. + :param input_data: Data to process. + :type file_spec: pandas.Series + :type input_data: InputData + """ + file_test_results(file_spec, input_data, frmt=u"html")