X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Fgenerator_files.py;h=d6c7546ae7468fe3233aa56979168d105390c7d1;hb=a8a9827ea12122026190f9c7a590a8af7f92d772;hp=1247924cdf3fbde4c73572e427166d83245e4c38;hpb=803610d9ca0c1afd345db4d2858d4aa93a5233ed;p=csit.git diff --git a/resources/tools/presentation/generator_files.py b/resources/tools/presentation/generator_files.py index 1247924cdf..d6c7546ae7 100644 --- a/resources/tools/presentation/generator_files.py +++ b/resources/tools/presentation/generator_files.py @@ -17,17 +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 = ("\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") + +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): @@ -39,14 +40,21 @@ 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 as err: - logging.error("Probably algorithm '{alg}' is not defined: {err}". - format(alg=file_spec["algorithm"], err=repr(err))) - 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): @@ -61,74 +69,121 @@ def _tests_in_suite(suite_name, tests): """ for key in tests.keys(): - if suite_name == tests[key]["parent"]: + if suite_name == tests[key][u"parent"]: return True return False -def file_test_results(file_spec, input_data): +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 """ - file_name = "{0}{1}".format(file_spec["output-file"], - file_spec["output-file-ext"]) - rst_header = file_spec["file-header"] - - 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 - - logging.info(" Writing file '{0}'".format(file_name)) - - logging.info(" Creating the 'tests' data set for the {0} '{1}'.". - format(file_spec.get("type", ""), file_spec.get("title", ""))) - tests = input_data.filter_data(file_spec) + base_file_name = f"{file_spec[u'output-file']}" + rst_header = file_spec.get(u"file-header", u"") + 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) - - logging.info(" Creating the 'suites' data set for the {0} '{1}'.". - format(file_spec.get("type", ""), file_spec.get("title", ""))) - file_spec["filter"] = "all" - suites = input_data.filter_data(file_spec, data_set="suites") + 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(): - if len(suite_longname.split(".")) <= file_spec["data-start-level"]: - continue - - if not ("-ndrpdr" in suite["name"] or - "-mrr" in suite["name"] or - "-func" in suite["name"] or - "-device" in 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"]))) - - if _tests_in_suite(suite["name"], tests): - 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 -'))) + + 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])) - logging.info(" Done.") + 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. + + :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")