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:
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 files.
20 from pal_utils import get_files, get_rst_title_char
23 RST_INCLUDE_TABLE = (u"\n.. only:: html\n\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")
34 def generate_files(spec, data):
35 """Generate all files specified in the specification file.
37 :param spec: Specification read from the specification file.
38 :param data: Data to process.
39 :type spec: Specification
44 u"file_test_results": file_test_results
47 logging.info(u"Generating the files ...")
48 for file_spec in spec.files:
50 generator[file_spec[u"algorithm"]](file_spec, data)
51 except (NameError, KeyError) as err:
53 f"Probably algorithm {file_spec[u'algorithm']} is not defined: "
56 logging.info(u"Done.")
59 def _tests_in_suite(suite_name, tests):
60 """Check if the suite includes tests.
62 :param suite_name: Name of the suite to be checked.
63 :param tests: Set of tests
65 :type tests: pandas.Series
66 :returns: True if the suite includes tests.
70 for key in tests.keys():
71 if suite_name == tests[key][u"parent"]:
76 def file_test_results(file_spec, input_data):
77 """Generate the file(s) with algorithms
79 specified in the specification file.
81 :param file_spec: File to generate.
82 :param input_data: Data to process.
83 :type file_spec: pandas.Series
84 :type input_data: InputData
87 file_name = f"{file_spec[u'output-file']}{file_spec[u'output-file-ext']}"
88 rst_header = file_spec[u"file-header"]
90 logging.info(f" Generating the file {file_name} ...")
92 table_lst = get_files(file_spec[u"dir-tables"], u".csv", full_path=True)
95 f" No tables to include in {file_spec[u'dir-tables']}. Skipping."
99 logging.info(f" Writing file {file_name}")
102 f" Creating the tests data set for the "
103 f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}."
105 tests = input_data.filter_data(file_spec)
106 tests = input_data.merge_data(tests)
109 f" Creating the suites data set for the "
110 f"{file_spec.get(u'type', u'')} {file_spec.get(u'title', u'')}."
112 file_spec[u"filter"] = u"all"
113 suites = input_data.filter_data(file_spec, data_set=u"suites")
114 suites = input_data.merge_data(suites)
115 suites.sort_index(inplace=True)
117 with open(file_name, u"w") as file_handler:
118 file_handler.write(rst_header)
119 for suite_longname, suite in suites.items():
120 if len(suite_longname.split(u".")) <= \
121 file_spec[u"data-start-level"]:
126 suite[u"level"] - file_spec[u"data-start-level"] - 1
127 ) * len(suite[u"name"])
128 if not (u"-ndrpdr" in suite[u"name"] or
129 u"-mrr" in suite[u"name"] or
130 u"-func" in suite[u"name"] or
131 u"-device" in suite[u"name"]):
132 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
134 if _tests_in_suite(suite[u"name"], tests):
135 file_handler.write(f"\n{suite[u'name']}\n{title_line}\n")
137 f"\n{suite[u'doc']}\n".replace(u'|br|', u'\n\n -')
139 for tbl_file in table_lst:
140 if suite[u"name"] in tbl_file:
142 RST_INCLUDE_TABLE.format(
144 file_html=tbl_file.split(u"/")[-1]))
146 logging.info(u" Done.")