X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Fgenerator_files.py;h=3c2939e15aea432990b2edb3fadcdbd055190274;hp=dd70c70ce707492a339add20dc91f4a16dd34dac;hb=fbd4f04d204c7052a6016fa4b694ffb2bc536955;hpb=9a89069be33f11879f8307e5b774c6e1e7afa398 diff --git a/resources/tools/presentation/generator_files.py b/resources/tools/presentation/generator_files.py index dd70c70ce7..3c2939e15a 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: @@ -19,6 +19,16 @@ import logging from 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") + def generate_files(spec, data): """Generate all files specified in the specification file. @@ -33,15 +43,33 @@ def generate_files(spec, data): 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"])) + except NameError as err: + logging.error("Probably algorithm '{alg}' is not defined: {err}". + format(alg=file_spec["algorithm"], err=repr(err))) logging.info("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]["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. + """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. @@ -49,36 +77,10 @@ def file_test_results(file_spec, input_data): :type input_data: InputData """ - 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) @@ -87,29 +89,51 @@ def file_test_results(file_spec, input_data): 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"]:] + 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) + 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") + 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"] + if len(suite_longname.split(".")) <= file_spec["data-start-level"]: + continue + file_handler.write("\n{0}\n{1}\n".format( - suite_name, get_rst_title_char( + 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)): + len(suite["name"]))) + + 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 -'))) for tbl_file in table_lst: - if suite_name in tbl_file: + if suite["name"] in tbl_file: file_handler.write( - rst_include_table.format( + RST_INCLUDE_TABLE.format( file_latex=tbl_file, file_html=tbl_file.split("/")[-1]))