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.
20 from shutil import make_archive
22 from utils import get_files, execute_command, archive_input_data
25 # .css file for the html format of the report
26 THEME_OVERRIDES = """/* override table width restrictions */
27 @media screen and (min-width: 767px) {
28 .wy-table-responsive table td, .wy-table-responsive table th {
29 white-space: normal !important;
32 .wy-table-responsive {
36 overflow: visible !important;
39 .rst-content blockquote {
45 display: inline-block;
53 .wy-menu-vertical li.current a {
55 border-right: solid 1px #c9c9c9;
58 .wy-menu-vertical li.toctree-l2.current > a {
62 .wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a {
67 .wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a {
72 .wy-menu-vertical li.on a, .wy-menu-vertical li.current > a {
79 border-top-width: medium;
80 border-bottom-width: medium;
81 border-top-style: none;
82 border-bottom-style: none;
83 border-top-color: currentcolor;
84 border-bottom-color: currentcolor;
85 padding-left: 2em -4px;
89 # Command to build the html format of the report
90 HTML_BUILDER = 'sphinx-build -v -c . -a ' \
93 '-D release={release} ' \
94 '-D version="Report v{report_version} - {date}" ' \
98 # Command to build the pdf format of the report
99 PDF_BUILDER = 'sphinx-build -v -c . -a ' \
102 '-D release={release} ' \
103 '-D version="Report v{report_version} - {date}" ' \
108 def generate_report(release, spec, report_version):
109 """Generate all formats and versions of the report.
111 :param release: Release string of the product.
112 :param spec: Specification read from the specification file.
113 :param report_version: Version of the report.
115 :type spec: Specification
116 :type report_version: str
119 logging.info("Generating the report ...")
122 "html": generate_html_report,
123 "pdf": generate_pdf_report
126 for report_format, versions in spec.output["format"].items():
127 report[report_format](release, spec, versions, report_version)
129 archive_input_data(spec)
132 logging.info("Done.")
135 def generate_html_report(release, spec, versions, report_version):
136 """Generate html format of the report.
138 :param release: Release string of the product.
139 :param spec: Specification read from the specification file.
140 :param versions: List of versions to generate.
141 :param report_version: Version of the report.
143 :type spec: Specification
145 :type report_version: str
148 logging.info(" Generating the html report, give me a few minutes, please "
151 working_dir = spec.environment["paths"]["DIR[WORKING,SRC]"]
153 cmd = 'cd {working_dir} && mv -f index.html.template index.rst'.\
154 format(working_dir=working_dir)
157 cmd = HTML_BUILDER.format(
159 report_version=report_version,
160 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
161 working_dir=working_dir,
162 build_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
165 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE]"], "w") as \
167 css_file.write(THEME_OVERRIDES)
169 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE2]"], "w") as \
171 css_file.write(THEME_OVERRIDES)
173 logging.info(" Done.")
176 def generate_pdf_report(release, spec, versions, report_version):
177 """Generate html format of the report.
179 :param release: Release string of the product.
180 :param spec: Specification read from the specification file.
181 :param versions: List of versions to generate. Not implemented yet.
182 :param report_version: Version of the report.
184 :type spec: Specification
186 :type report_version: str
189 logging.info(" Generating the pdf report, give me a few minutes, please "
192 working_dir = spec.environment["paths"]["DIR[WORKING,SRC]"]
194 cmd = 'cd {working_dir} && mv -f index.pdf.template index.rst'.\
195 format(working_dir=working_dir)
198 _convert_all_svg_to_pdf(spec.environment["paths"]["DIR[WORKING,SRC]"])
200 # Convert PyPLOT graphs in HTML format to PDF.
201 convert_plots = "xvfb-run -a wkhtmltopdf {html} {pdf}"
202 plots = get_files(spec.environment["paths"]["DIR[STATIC,VPP]"], "html")
203 plots.extend(get_files(spec.environment["paths"]["DIR[STATIC,DPDK]"],
206 file_name = "{0}.pdf".format(plot.rsplit(".", 1)[0])
207 logging.info("Converting '{0}' to '{1}'".format(plot, file_name))
208 execute_command(convert_plots.format(html=plot, pdf=file_name))
210 # Generate the LaTeX documentation
211 build_dir = spec.environment["paths"]["DIR[BUILD,LATEX]"]
212 cmd = PDF_BUILDER.format(
214 report_version=report_version,
215 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
216 working_dir=working_dir,
220 # Build pdf documentation
221 archive_dir = spec.environment["paths"]["DIR[STATIC,ARCH]"]
224 'pdflatex -shell-escape -interaction nonstopmode csit.tex || true'.
225 format(build_dir=build_dir),
227 'pdflatex -interaction nonstopmode csit.tex || true'.
228 format(build_dir=build_dir),
230 'cp csit.pdf ../{archive_dir}/csit_{release}_v{report_version}.pdf &&'
231 'cp csit.pdf ../{archive_dir}/csit_{release}.pdf'.
232 format(build_dir=build_dir,
233 archive_dir=archive_dir,
235 report_version=report_version)
241 logging.info(" Done.")
244 def archive_report(spec):
245 """Archive the report.
247 :param spec: Specification read from the specification file.
248 :type spec: Specification
251 logging.info(" Archiving the report ...")
253 make_archive("csit.report",
255 base_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
257 logging.info(" Done.")
260 def _convert_all_svg_to_pdf(path):
261 """Convert all svg files on path "path" to pdf.
263 :param path: Path to the root directory with svg files to convert.
267 cmd = "inkscape -D -z --file={svg} --export-pdf={pdf}"
269 svg_files = get_files(path, "svg", full_path=True)
270 for svg_file in svg_files:
271 pdf_file = "{0}.pdf".format(svg_file.rsplit('.', 1)[0])
272 logging.info("Converting '{0}' to '{1}'".format(svg_file, pdf_file))
273 execute_command(cmd.format(svg=svg_file, pdf=pdf_file))