def report(verbose, user, password, base_url, report_file, output_file, format,
serialization_roundtrip, orca_server_url):
"""
Make a report. See API documentation's POST reports section for
REPORT_FILE requirements.
"""
set_log_level(verbose)
token = cli_access_token(user, password)
with open(report_file) as f:
metadata = json.load(f)
session = APISession(token, base_url=base_url)
report = session.process_report_dict(metadata)
if orca_server_url is not None:
import plotly.io as pio
pio.orca.config.server_url = orca_server_url
if serialization_roundtrip:
with mock_raw_report_endpoints(base_url):
session.create_report(report)
reports.compute_report(token, 'no_id', base_url)
full_report = session.get_report('no_id')
else:
data = reports.get_data_for_report(session, report)
raw_report = reports.create_raw_report_from_data(report, data)
full_report = report.replace(raw_report=raw_report, status='complete')
# assumed dashboard url based on api url
dash_url = base_url.replace('api', 'dashboard')
if ((format == 'detect' and output_file.endswith('.html'))
or format == 'html'):
html_report = template.render_html(full_report,
dash_url,
with_timeseries=True,
body_only=False)
with open(output_file, 'w') as f:
f.write(html_report)
elif ((format == 'detect' and output_file.endswith('.pdf'))
or format == 'pdf'):
pdf_report = template.render_pdf(full_report, dash_url)
with open(output_file, 'wb') as f:
f.write(pdf_report)
else:
raise ValueError("Unable to detect format")
def get(self, uuid):
try:
self.set_metadata(uuid)
except DataRequestException as e:
errors = {'errors': e.errors}
return ReportView().get(uuid, errors=errors)
exclude_timeseries = 'exclude_timeseries' in request.args
# don't do the work of making a report if the format is incorrect
if self.format_ not in ('html', 'pdf'):
raise ValueError(
'Only html and pdf report downloads are currently supported')
fname = self.metadata['report_parameters']['name'].replace(
' ', '_')
report_object = build_report(self.metadata)
# render to right format
if self.format_ == 'html':
bytes_out = render_html(
report_object,
request.url_root.rstrip('/'),
with_timeseries=not exclude_timeseries, body_only=False
).encode('utf-8')
elif self.format_ == 'pdf':
bytes_out = render_pdf(
report_object,
request.url_root.rstrip('/'),
)
out = check_sign_zip(bytes_out, fname + f'.{self.format_}',
current_app.config['GPG_KEY_ID'],
current_app.config['GPG_PASSPHRASE_FILE'])
return send_file(
out,
'application/zip',
as_attachment=True,
attachment_filename=fname + '.zip',
add_etags=False)
def test_render_html_body_only(report_with_raw, dash_url, with_series,
mocked_timeseries_plots):
rendered = template.render_html(
report_with_raw, dash_url, with_series, True)
assert rendered[:30] == '<style type="text/css" scoped>'
def test_render_html_full_html(report_with_raw, dash_url, with_series,
mocked_timeseries_plots):
rendered = template.render_html(
report_with_raw, dash_url, with_series, False)
assert rendered[:46] == '<!doctype html>\n<html lang="en" class="h-100">'
def test_render_html_body_only(report_with_raw, dash_url, with_series,
mocked_timeseries_plots):
rendered = template.render_html(report_with_raw, dash_url, with_series,
True)
assert rendered[:22] == '<h1 id="report-title">'