resources/tools/presentation/generator_files.py

   1 # Copyright (c) 2018 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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Algorithms to generate files.
  15 """
  16
  17
  18 import logging
  19
  20 from pal_utils import get_files, get_rst_title_char
  21
  22
  23 RST_INCLUDE_TABLE = (u"\n.. only:: html\n\n"
  24                      u"    .. csv-table::\n"
  25                      u"        :header-rows: 1\n"
  26                      u"        :widths: auto\n"
  27                      u"        :align: center\n"
  28                      u"        :file: {file_html}\n"
  29                      u"\n.. only:: latex\n\n"
  30                      u"\n  .. raw:: latex\n\n"
  31                      u"      \\csvautolongtable{{{file_latex}}}\n\n")
  32
  33
  34 def generate_files(spec, data):
  35     """Generate all files specified in the specification file.
  36
  37     :param spec: Specification read from the specification file.
  38     :param data: Data to process.
  39     :type spec: Specification
  40     :type data: InputData
  41     """
  42
  43     generator = {
  44         u"file_test_results": file_test_results,
  45         u"file_test_results_html": file_test_results_html
  46     }
  47
  48     logging.info(u"Generating the files ...")
  49     for file_spec in spec.files:
  50         try:
  51             generator[file_spec[u"algorithm"]](file_spec, data)
  52         except (NameError, KeyError) as err:
  53             logging.error(
  54                 f"Probably algorithm {file_spec[u'algorithm']} is not defined: "
  55                 f"{repr(err)}"
  56             )
  57     logging.info(u"Done.")
  58
  59
  60 def _tests_in_suite(suite_name, tests):
  61     """Check if the suite includes tests.
  62
  63     :param suite_name: Name of the suite to be checked.
  64     :param tests: Set of tests
  65     :type suite_name: str
  66     :type tests: pandas.Series
  67     :returns: True if the suite includes tests.
  68     :rtype: bool
  69     """
  70
  71     for key in tests.keys():
  72         if suite_name == tests[key][u"parent"]:
  73             return True
  74     return False
  75
  76
  77 def file_test_results(file_spec, input_data):
  78     """Generate the file(s) with algorithms
  79     - file_test_results
  80     specified in the specification file.
  81
  82     :param file_spec: File to generate.
  83     :param input_data: Data to process.
  84     :type file_spec: pandas.Series
  85     :type input_data: InputData
  86     """
  87
  88     file_name = f"{file_spec[u'output-file']}{file_spec[u'output-file-ext']}"
  89     rst_header = file_spec[u"file-header"]
  90
  91     logging.info(f"  Generating the file {file_name} ...")
  92
  93     table_lst = get_files(file_spec[u"dir-tables"], u".csv", full_path=True)
  94     if not table_lst:
  95         logging.error(
  96             f"  No tables to include in {file_spec[u'dir-tables']}. Skipping."
  97         )
  98         return
  99
 100     logging.info(f"    Writing file {file_name}")
 101
 102     logging.info(
 103         f"    Creating the tests data set for the "
 104         f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}."
 105     )
 106     tests = input_data.filter_data(file_spec)
 107     tests = input_data.merge_data(tests)
 108
 109     logging.info(
 110         f"    Creating the suites data set for the "
 111         f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}."
 112     )
 113     file_spec[u"filter"] = u"all"
 114     suites = input_data.filter_data(file_spec, data_set=u"suites")
 115     suites = input_data.merge_data(suites)
 116     suites.sort_index(inplace=True)
 117
 118     with open(file_name, u"wt") as file_handler:
 119         file_handler.write(rst_header)
 120         for suite_longname, suite in suites.items():
 121             if len(suite_longname.split(u".")) <= \
 122                     file_spec[u"data-start-level"]:
 123                 continue
 124
 125             title_line = \
 126                 get_rst_title_char(
 127                     suite[u"level"] - file_spec[u"data-start-level"] - 1
 128                 ) * len(suite[u"name"])
 129             if not (u"-ndrpdr" in suite[u"name"] or
 130                     u"-mrr" in suite[u"name"] or
 131                     u"-func" in suite[u"name"] or
 132                     u"-device" in suite[u"name"] or
 133                     u"-dev" in suite[u"name"]):
 134                 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
 135
 136             if _tests_in_suite(suite[u"name"], tests):
 137                 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
 138                 file_handler.write(
 139                     f"\n{suite[u'doc']}\n".replace(u'|br|', u'\n\n -')
 140                 )
 141                 for tbl_file in table_lst:
 142                     if suite[u"name"] in tbl_file:
 143                         file_handler.write(
 144                             RST_INCLUDE_TABLE.format(
 145                                 file_latex=tbl_file,
 146                                 file_html=tbl_file.split(u"/")[-1]))
 147
 148     logging.info(u"  Done.")
 149
 150
 151 def file_test_results_html(file_spec, input_data):
 152     """Generate the file(s) with algorithms
 153     - file_test_results_html
 154     specified in the specification file.
 155
 156     :param file_spec: File to generate.
 157     :param input_data: Data to process.
 158     :type file_spec: pandas.Series
 159     :type input_data: InputData
 160     """
 161
 162     file_name = f"{file_spec[u'output-file']}.rst"
 163     rst_header = file_spec[u"file-header"]
 164
 165     logging.info(f"  Generating the file {file_name} ...")
 166
 167     table_lst = get_files(file_spec[u"dir-tables"], u".rst", full_path=True)
 168     if not table_lst:
 169         logging.error(
 170             f"  No tables to include in {file_spec[u'dir-tables']}. Skipping."
 171         )
 172         return
 173
 174     logging.info(f"    Writing file {file_name}")
 175
 176     logging.info(
 177         f"    Creating the tests data set for the "
 178         f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}."
 179     )
 180
 181     tests = input_data.filter_data(
 182         file_spec,
 183         params=[u"name", u"parent", u"doc", u"type", u"level"],
 184         continue_on_error=True
 185     )
 186     if tests.empty:
 187         return
 188     tests = input_data.merge_data(tests)
 189     tests.sort_index(inplace=True)
 190
 191     suites = input_data.filter_data(
 192         file_spec,
 193         continue_on_error=True,
 194         data_set=u"suites"
 195     )
 196     if suites.empty:
 197         return
 198     suites = input_data.merge_data(suites)
 199
 200     with open(file_name, u"wt") as file_handler:
 201         file_handler.write(rst_header)
 202         for suite_longname, suite in suites.items():
 203             if len(suite_longname.split(u".")) <= \
 204                     file_spec[u"data-start-level"]:
 205                 continue
 206
 207             title_line = \
 208                 get_rst_title_char(
 209                     suite[u"level"] - file_spec[u"data-start-level"] - 1
 210                 ) * len(suite[u"name"])
 211             if not (u"-ndrpdr" in suite[u"name"] or
 212                     u"-mrr" in suite[u"name"] or
 213                     u"-func" in suite[u"name"] or
 214                     u"-device" in suite[u"name"]):
 215                 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
 216
 217             if _tests_in_suite(suite[u"name"], tests):
 218                 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
 219                 file_handler.write(
 220                     f"\n{suite[u'doc']}\n".replace(u'|br|', u'\n\n -')
 221                 )
 222                 for tbl_file in table_lst:
 223                     if suite[u"name"] in tbl_file:
 224                         file_handler.write(
 225                             f"\n.. include:: {tbl_file.split(u'/')[-1]}\n"
 226                         )
 227
 228     logging.info(u"  Done.")