1 # Copyright (c) 2017 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 cmd = HTML_BUILDER.format(
153 report_version=report_version,
154 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
155 working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
156 build_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
159 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE]"], "w") as \
161 css_file.write(THEME_OVERRIDES)
163 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE2]"], "w") as \
165 css_file.write(THEME_OVERRIDES)
167 logging.info(" Done.")
170 def generate_pdf_report(release, spec, versions, report_version):
171 """Generate html format of the report.
173 :param release: Release string of the product.
174 :param spec: Specification read from the specification file.
175 :param versions: List of versions to generate. Not implemented yet.
176 :param report_version: Version of the report.
178 :type spec: Specification
180 :type report_version: str
183 logging.info(" Generating the pdf report, give me a few minutes, please "
186 convert_plots = "xvfb-run -a wkhtmltopdf {html} {pdf}.pdf"
188 # Convert PyPLOT graphs in HTML format to PDF.
189 plots = get_files(spec.environment["paths"]["DIR[STATIC,VPP]"], "html")
190 plots.extend(get_files(spec.environment["paths"]["DIR[STATIC,DPDK]"],
193 file_name = "{0}".format(plot.rsplit(".", 1)[0])
194 cmd = convert_plots.format(html=plot, pdf=file_name)
197 # Generate the LaTeX documentation
198 build_dir = spec.environment["paths"]["DIR[BUILD,LATEX]"]
199 cmd = PDF_BUILDER.format(
201 report_version=report_version,
202 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
203 working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
207 # Build pdf documentation
208 archive_dir = spec.environment["paths"]["DIR[STATIC,ARCH]"]
211 'pdflatex -shell-escape -interaction nonstopmode csit.tex || true'.
212 format(build_dir=build_dir),
214 'pdflatex -interaction nonstopmode csit.tex || true'.
215 format(build_dir=build_dir),
217 'cp csit.pdf ../{archive_dir}/csit_{release}_{report_version}.pdf'.
218 format(build_dir=build_dir,
219 archive_dir=archive_dir,
221 report_version=report_version)
227 logging.info(" Done.")
230 def archive_report(spec):
231 """Archive the report.
233 :param spec: Specification read from the specification file.
234 :type spec: Specification
237 logging.info(" Archiving the report ...")
239 make_archive("csit.report",
241 base_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
243 logging.info(" Done.")