1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
# Copyright (c) 2017 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Report generation.
"""
import subprocess
import logging
import datetime
from os import makedirs, environ
from os.path import isdir
from shutil import copy, Error, make_archive
from utils import get_files
from errors import PresentationError
# .css file for the html format of the report
THEME_OVERRIDES = """/* override table width restrictions */
@media screen and (min-width: 767px) {
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal !important;
}
.wy-table-responsive {
font-size: small;
margin-bottom: 24px;
max-width: 100%;
overflow: visible !important;
}
}
.rst-content blockquote {
margin-left: 0px;
line-height: 18px;
margin-bottom: 0px;
}
"""
# Command to build the html format of the report
HTML_BUILDER = 'sphinx-build -v -c . -a ' \
'-b html -E ' \
'-D release={release} ' \
'-D version="{release} report - {date}" ' \
'{working_dir} ' \
'{build_dir}/'
# Command to build the pdf format of the report
PDF_BUILDER = 'sphinx-build -v -c . -a ' \
'-b latex -E ' \
'-D release={release} ' \
'-D version="{release} report - {date}" ' \
'{working_dir} ' \
'{build_dir}'
def generate_report(release, spec):
"""Generate all formats and versions of the report.
:param release: Release string of the product.
:param spec: Specification read from the specification file.
:type release: str
:type spec: Specification
"""
logging.info("Generating the report ...")
report = {
"html": generate_html_report,
"pdf": generate_pdf_report
}
for report_format, versions in spec.output.items():
report[report_format](release, spec, versions)
archive_input_data(spec)
archive_report(spec)
logging.info("Done.")
def generate_html_report(release, spec, versions):
"""Generate html format of the report.
:param release: Release string of the product.
:param spec: Specification read from the specification file.
:param versions: List of versions to generate.
:type release: str
:type spec: Specification
:type versions: list
"""
logging.info(" Generating the html report, give me a few minutes, please "
"...")
cmd = HTML_BUILDER.format(
release=release,
date=datetime.date.today().strftime('%d-%b-%Y'),
working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
build_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
_execute_command(cmd)
with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE]"], "w") as \
css_file:
css_file.write(THEME_OVERRIDES)
with open(spec.environment["paths"]["DIR[CSS_PATCH_FILE2]"], "w") as \
css_file:
css_file.write(THEME_OVERRIDES)
logging.info(" Done.")
def generate_pdf_report(release, spec, versions):
"""Generate html format of the report.
:param release: Release string of the product.
:param spec: Specification read from the specification file.
:param versions: List of versions to generate. Not implemented yet.
:type release: str
:type spec: Specification
:type versions: list
"""
logging.info(" Generating the pdf report, give me a few minutes, please "
"...")
convert_plots = "xvfb-run -a wkhtmltopdf {html} {pdf}.pdf"
# Convert PyPLOT graphs in HTML format to PDF.
plots = get_files(spec.environment["paths"]["DIR[STATIC,VPP]"], "html")
for plot in plots:
file_name = "{0}".format(plot.rsplit(".", 1)[0])
cmd = convert_plots.format(html=plot, pdf=file_name)
_execute_command(cmd)
# Generate the LaTeX documentation
build_dir = spec.environment["paths"]["DIR[BUILD,LATEX]"]
cmd = PDF_BUILDER.format(
release=release,
date=datetime.date.today().strftime('%d-%b-%Y'),
working_dir=spec.environment["paths"]["DIR[WORKING,SRC]"],
build_dir=build_dir)
_execute_command(cmd)
# Build pdf documentation
archive_dir = spec.environment["paths"]["DIR[STATIC,ARCH]"]
cmds = [
'cd {build_dir} && '
'pdflatex -shell-escape -interaction nonstopmode csit.tex || true'.
format(build_dir=build_dir),
'cd {build_dir} && '
'pdflatex -interaction nonstopmode csit.tex || true'.
format(build_dir=build_dir),
'cd {build_dir} && '
'cp csit.pdf ../{archive_dir}/csit_{release}.pdf'.
format(build_dir=build_dir,
archive_dir=archive_dir,
release=release)
]
for cmd in cmds:
_execute_command(cmd)
logging.info(" Done.")
def archive_report(spec):
"""Archive the report.
:param spec: Specification read from the specification file.
:type spec: Specification
"""
logging.info(" Archiving the report ...")
make_archive("csit.report",
"gztar",
base_dir=spec.environment["paths"]["DIR[BUILD,HTML]"])
logging.info(" Done.")
def archive_input_data(spec):
"""Archive the report.
:param spec: Specification read from the specification file.
:type spec: Specification
:raises PresentationError: If it is not possible to archive the input data.
"""
logging.info(" Archiving the input data files ...")
if spec.is_debug:
extension = spec.debug["input-format"]
else:
extension = spec.input["file-format"]
data_files = get_files(spec.environment["paths"]["DIR[WORKING,DATA]"],
extension=extension)
dst = spec.environment["paths"]["DIR[STATIC,ARCH]"]
logging.info(" Destination: {0}".format(dst))
try:
if not isdir(dst):
makedirs(dst)
for data_file in data_files:
logging.info(" Copying the file: {0} ...".format(data_file))
copy(data_file, dst)
except (Error, OSError) as err:
raise PresentationError("Not possible to archive the input data.",
str(err))
logging.info(" Done.")
def _execute_command(cmd):
"""Execute the command in a subprocess and log the stdout and stderr.
:param cmd: Command to execute.
:type cmd: str
:returns: Return code of the executed command.
:rtype: int
"""
env = environ.copy()
proc = subprocess.Popen(
[cmd],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell=True,
env=env)
stdout, stderr = proc.communicate()
logging.info(stdout)
logging.info(stderr)
if proc.returncode != 0:
logging.error(" Command execution failed.")
return proc.returncode
|
