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 {
46 # Command to build the html format of the report
47 HTML_BUILDER = 'sphinx-build -v -c . -a ' \
50 '-D release={release} ' \
51 '-D version="{release} report - {date}" ' \
55 # Command to build the pdf format of the report
56 PDF_BUILDER = 'sphinx-build -v -c . -a ' \
59 '-D release={release} ' \
60 '-D version="{release} report - {date}" ' \
65 def generate_report(release, spec):
66 """Generate all formats and versions of the report.
68 :param release: Release string of the product.
69 :param spec: Specification read from the specification file.
71 :type spec: Specification
74 logging.info("Generating the report ...")
77 "html": generate_html_report,
78 "pdf": generate_pdf_report
81 for report_format, versions in spec.output["format"].items():
82 report[report_format](release, spec, versions)
84 archive_input_data(spec)
90 def generate_html_report(release, spec, versions):
91 """Generate html format of the report.
93 :param release: Release string of the product.
94 :param spec: Specification read from the specification file.
95 :param versions: List of versions to generate.
97 :type spec: Specification
101 logging.info(" Generating the html report, give me a few minutes, please "
104 cmd = HTML_BUILDER.format(
106 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
107 working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
108 build_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
111 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE]"], "w") as \
113 css_file.write(THEME_OVERRIDES)
115 with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE2]"], "w") as \
117 css_file.write(THEME_OVERRIDES)
119 logging.info(" Done.")
122 def generate_pdf_report(release, spec, versions):
123 """Generate html format of the report.
125 :param release: Release string of the product.
126 :param spec: Specification read from the specification file.
127 :param versions: List of versions to generate. Not implemented yet.
129 :type spec: Specification
133 logging.info(" Generating the pdf report, give me a few minutes, please "
136 convert_plots = "xvfb-run -a wkhtmltopdf {html} {pdf}.pdf"
138 # Convert PyPLOT graphs in HTML format to PDF.
139 plots = get_files(spec.environment["paths"]["DIR[STATIC,VPP]"], "html")
140 plots.extend(get_files(spec.environment["paths"]["DIR[STATIC,DPDK]"],
143 file_name = "{0}".format(plot.rsplit(".", 1)[0])
144 cmd = convert_plots.format(html=plot, pdf=file_name)
147 # Generate the LaTeX documentation
148 build_dir = spec.environment["paths"]["DIR[BUILD,LATEX]"]
149 cmd = PDF_BUILDER.format(
151 date=datetime.datetime.utcnow().strftime('%m/%d/%Y %H:%M UTC'),
152 working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
156 # Build pdf documentation
157 archive_dir = spec.environment["paths"]["DIR[STATIC,ARCH]"]
160 'pdflatex -shell-escape -interaction nonstopmode csit.tex || true'.
161 format(build_dir=build_dir),
163 'pdflatex -interaction nonstopmode csit.tex || true'.
164 format(build_dir=build_dir),
166 'cp csit.pdf ../{archive_dir}/csit_{release}.pdf'.
167 format(build_dir=build_dir,
168 archive_dir=archive_dir,
175 logging.info(" Done.")
178 def archive_report(spec):
179 """Archive the report.
181 :param spec: Specification read from the specification file.
182 :type spec: Specification
185 logging.info(" Archiving the report ...")
187 make_archive("csit.report",
189 base_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
191 logging.info(" Done.")