1 # Copyright (c) 2023 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.
14 """Plotly Dash HTML layout override.
19 import dash_bootstrap_components as dbc
21 from flask import Flask
24 from dash import callback_context, no_update
25 from dash import Input, Output, State
26 from dash.exceptions import PreventUpdate
27 from yaml import load, FullLoader, YAMLError
29 from ..utils.constants import Constants as C
30 from ..utils.control_panel import ControlPanel
31 from ..utils.utils import show_tooltip, gen_new_url, get_ttypes, get_cadences, \
32 get_test_beds, get_job, generate_options, set_job_params
33 from ..utils.url_processing import url_decode
34 from .graphs import graph_statistics, select_data
38 """The layout of the dash app and the callbacks.
44 data_stats: pd.DataFrame,
45 data_trending: pd.DataFrame,
46 html_layout_file: str,
47 graph_layout_file: str,
51 - save the input parameters,
52 - read and pre-process the data,
53 - prepare data for the control panel,
54 - read HTML layout file,
55 - read tooltips from the tooltip file.
57 :param app: Flask application running the dash application.
58 :param data_stats: Pandas dataframe with staistical data.
59 :param data_trending: Pandas dataframe with trending data.
60 :param html_layout_file: Path and name of the file specifying the HTML
61 layout of the dash application.
62 :param graph_layout_file: Path and name of the file with layout of
64 :param tooltip_file: Path and name of the yaml file specifying the
67 :type data_stats: pandas.DataFrame
68 :type data_trending: pandas.DataFrame
69 :type html_layout_file: str
70 :type graph_layout_file: str
71 :type tooltip_file: str
76 self._html_layout_file = html_layout_file
77 self._graph_layout_file = graph_layout_file
78 self._tooltip_file = tooltip_file
80 # Pre-process the data:
81 data_stats = data_stats[~data_stats.job.str.contains("-verify-")]
82 data_stats = data_stats[~data_stats.job.str.contains("-coverage-")]
83 data_stats = data_stats[~data_stats.job.str.contains("-iterative-")]
84 data_stats = data_stats[["job", "build", "start_time", "duration"]]
86 jobs = sorted(list(data_stats["job"].unique()))
95 lst_job = job.split("-")
96 d_job_info["job"].append(job)
97 d_job_info["dut"].append(lst_job[1])
98 d_job_info["ttype"].append(lst_job[3])
99 d_job_info["cadence"].append(lst_job[4])
100 d_job_info["tbed"].append("-".join(lst_job[-2:]))
101 self._job_info = pd.DataFrame.from_dict(d_job_info)
103 self._default = set_job_params(self._job_info, C.STATS_DEFAULT_JOB)
109 "dut_version": list(),
116 df_job = data_trending.loc[(data_trending["job"] == job)]
117 builds = df_job["build"].unique()
119 df_build = df_job.loc[(df_job["build"] == build)]
120 tst_info["job"].append(job)
121 tst_info["build"].append(build)
122 tst_info["dut_type"].append(df_build["dut_type"].iloc[-1])
123 tst_info["dut_version"].append(df_build["dut_version"].iloc[-1])
124 tst_info["hosts"].append(df_build["hosts"].iloc[-1])
126 passed = df_build.value_counts(subset="passed")[True]
130 failed = df_build.value_counts(subset="passed")[False]
131 failed_tests = df_build.loc[(df_build["passed"] == False)]\
132 ["test_id"].to_list()
134 for tst in failed_tests:
135 lst_tst = tst.split(".")
136 suite = lst_tst[-2].replace("2n1l-", "").\
137 replace("1n1l-", "").replace("2n-", "")
138 l_failed.append(f"{suite.split('-')[0]}-{lst_tst[-1]}")
142 tst_info["passed"].append(passed)
143 tst_info["failed"].append(failed)
144 tst_info["lst_failed"].append(sorted(l_failed))
146 self._data = data_stats.merge(pd.DataFrame.from_dict(tst_info))
149 self._html_layout = str()
150 self._graph_layout = None
151 self._tooltips = dict()
154 with open(self._html_layout_file, "r") as file_read:
155 self._html_layout = file_read.read()
156 except IOError as err:
158 f"Not possible to open the file {self._html_layout_file}\n{err}"
162 with open(self._graph_layout_file, "r") as file_read:
163 self._graph_layout = load(file_read, Loader=FullLoader)
164 except IOError as err:
166 f"Not possible to open the file {self._graph_layout_file}\n"
169 except YAMLError as err:
171 f"An error occurred while parsing the specification file "
172 f"{self._graph_layout_file}\n{err}"
176 with open(self._tooltip_file, "r") as file_read:
177 self._tooltips = load(file_read, Loader=FullLoader)
178 except IOError as err:
180 f"Not possible to open the file {self._tooltip_file}\n{err}"
182 except YAMLError as err:
184 f"An error occurred while parsing the specification file "
185 f"{self._tooltip_file}\n{err}"
188 # Control panel partameters and their default values.
190 "ri-ttypes-options": self._default["ttypes"],
191 "ri-cadences-options": self._default["cadences"],
192 "dd-tbeds-options": self._default["tbeds"],
193 "ri-duts-value": self._default["dut"],
194 "ri-ttypes-value": self._default["ttype"],
195 "ri-cadences-value": self._default["cadence"],
196 "dd-tbeds-value": self._default["tbed"],
197 "al-job-children": self._default["job"]
201 if self._app is not None and hasattr(self, "callbacks"):
202 self.callbacks(self._app)
205 def html_layout(self) -> dict:
206 return self._html_layout
208 def add_content(self):
209 """Top level method which generated the web page.
212 - Store for user input data,
214 - Main area with control panel and ploting area.
216 If no HTML layout is provided, an error message is displayed instead.
218 :returns: The HTML div with the whole page.
227 dcc.Store(id="control-panel"),
228 dcc.Location(id="url", refresh=False),
239 id="offcanvas-metadata",
240 title="Detailed Information",
244 dbc.Row(id="row-metadata")
252 self._add_ctrl_col(),
253 self._add_plotting_col()
258 id="offcanvas-documentation",
259 title="Documentation",
262 children=html.Iframe(
263 src=C.URL_DOC_TRENDING,
283 def _add_navbar(self):
284 """Add nav element with navigation panel. It is placed on the top.
286 :returns: Navigation bar.
287 :rtype: dbc.NavbarSimple
289 return dbc.NavbarSimple(
290 id="navbarsimple-main",
292 dbc.NavItem(dbc.NavLink(
297 dbc.NavItem(dbc.NavLink(
302 dbc.NavItem(dbc.NavLink(
308 dbc.NavItem(dbc.NavLink(
310 id="btn-documentation",
315 brand_external_link=True,
320 def _add_ctrl_col(self) -> dbc.Col:
321 """Add column with controls. It is placed on the left side.
323 :returns: Column with the control panel.
328 children=self._add_ctrl_panel(),
329 className="sticky-top"
333 def _add_plotting_col(self) -> dbc.Col:
334 """Add column with plots and tables. It is placed on the right side.
336 :returns: Column with tables.
340 id="col-plotting-area",
346 class_name="g-0 p-0",
357 def _add_ctrl_panel(self) -> dbc.Row:
358 """Add control panel.
360 :returns: Control panel.
365 class_name="g-0 p-1",
370 children=show_tooltip(
379 value=self._default["dut"],
380 options=self._default["duts"],
381 class_name="form-control"
389 class_name="g-0 p-1",
394 children=show_tooltip(
403 value=self._default["ttype"],
404 options=self._default["ttypes"],
405 class_name="form-control"
413 class_name="g-0 p-1",
418 children=show_tooltip(
427 value=self._default["cadence"],
428 options=self._default["cadences"],
429 class_name="form-control"
437 class_name="g-0 p-1",
442 children=show_tooltip(
450 placeholder="Select a test bed...",
451 value=self._default["tbed"],
452 options=self._default["tbeds"]
460 class_name="g-0 p-1",
465 children=self._default["job"]
471 def _get_plotting_area(
476 """Generate the plotting area with all its content.
478 :param job: The job which data will be displayed.
479 :param url: URL to be displayed in the modal window.
482 :returns: List of rows with elements to be displayed in the plotting
487 figs = graph_statistics(self._data, job, self._graph_layout)
494 id="row-graph-passed",
495 class_name="g-0 p-1",
504 id="row-graph-duration",
505 class_name="g-0 p-1",
523 "text-transform": "none",
524 "padding": "0rem 1rem"
529 dbc.ModalHeader(dbc.ModalTitle("URL")),
538 id="plot-btn-download",
539 children="Download Data",
543 "text-transform": "none",
544 "padding": "0rem 1rem"
547 dcc.Download(id="download-stats-data")
550 "d-grid gap-0 d-md-flex justify-content-md-end"
557 def callbacks(self, app):
558 """Callbacks for the whole application.
560 :param app: The application.
565 Output("control-panel", "data"), # Store
566 Output("plotting-area", "children"),
567 Output("ri-ttypes", "options"),
568 Output("ri-cadences", "options"),
569 Output("dd-tbeds", "options"),
570 Output("ri-duts", "value"),
571 Output("ri-ttypes", "value"),
572 Output("ri-cadences", "value"),
573 Output("dd-tbeds", "value"),
574 Output("al-job", "children"),
575 State("control-panel", "data"), # Store
576 Input("ri-duts", "value"),
577 Input("ri-ttypes", "value"),
578 Input("ri-cadences", "value"),
579 Input("dd-tbeds", "value"),
582 def _update_ctrl_panel(cp_data: dict, dut: str, ttype: str, cadence:str,
583 tbed: str, href: str) -> tuple:
584 """Update the application when the event is detected.
586 :param cp_data: Current status of the control panel stored in
588 :param dut: Input - DUT name.
589 :param ttype: Input - Test type.
590 :param cadence: Input - The cadence of the job.
591 :param tbed: Input - The test bed.
592 :param href: Input - The URL provided by the browser.
599 :returns: New values for web page elements.
603 ctrl_panel = ControlPanel(self._cp_default, cp_data)
606 parsed_url = url_decode(href)
608 url_params = parsed_url["params"]
612 trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0]
613 if trigger_id == "ri-duts":
614 ttype_opts = generate_options(get_ttypes(self._job_info, dut))
615 ttype_val = ttype_opts[0]["value"]
616 cad_opts = generate_options(get_cadences(
617 self._job_info, dut, ttype_val))
618 cad_val = cad_opts[0]["value"]
619 tbed_opts = generate_options(get_test_beds(
620 self._job_info, dut, ttype_val, cad_val))
621 tbed_val = tbed_opts[0]["value"]
623 "ri-duts-value": dut,
624 "ri-ttypes-options": ttype_opts,
625 "ri-ttypes-value": ttype_val,
626 "ri-cadences-options": cad_opts,
627 "ri-cadences-value": cad_val,
628 "dd-tbeds-options": tbed_opts,
629 "dd-tbeds-value": tbed_val
631 elif trigger_id == "ri-ttypes":
632 cad_opts = generate_options(get_cadences(
633 self._job_info, ctrl_panel.get("ri-duts-value"), ttype))
634 cad_val = cad_opts[0]["value"]
635 tbed_opts = generate_options(get_test_beds(
636 self._job_info, ctrl_panel.get("ri-duts-value"), ttype,
638 tbed_val = tbed_opts[0]["value"]
640 "ri-ttypes-value": ttype,
641 "ri-cadences-options": cad_opts,
642 "ri-cadences-value": cad_val,
643 "dd-tbeds-options": tbed_opts,
644 "dd-tbeds-value": tbed_val
646 elif trigger_id == "ri-cadences":
647 tbed_opts = generate_options(get_test_beds(
648 self._job_info, ctrl_panel.get("ri-duts-value"),
649 ctrl_panel.get("ri-ttypes-value"), cadence))
650 tbed_val = tbed_opts[0]["value"]
652 "ri-cadences-value": cadence,
653 "dd-tbeds-options": tbed_opts,
654 "dd-tbeds-value": tbed_val
656 elif trigger_id == "dd-tbeds":
658 "dd-tbeds-value": tbed
660 elif trigger_id == "url":
662 new_job = url_params.get("job", list())[0]
664 job_params = set_job_params(self._job_info, new_job)
665 ctrl_panel = ControlPanel(
667 "ri-ttypes-options": job_params["ttypes"],
668 "ri-cadences-options": job_params["cadences"],
669 "dd-tbeds-options": job_params["tbeds"],
670 "ri-duts-value": job_params["dut"],
671 "ri-ttypes-value": job_params["ttype"],
672 "ri-cadences-value": job_params["cadence"],
673 "dd-tbeds-value": job_params["tbed"],
674 "al-job-children": job_params["job"]
679 ctrl_panel = ControlPanel(self._cp_default, cp_data)
683 ctrl_panel.get("ri-duts-value"),
684 ctrl_panel.get("ri-ttypes-value"),
685 ctrl_panel.get("ri-cadences-value"),
686 ctrl_panel.get("dd-tbeds-value")
689 ctrl_panel.set({"al-job-children": job})
690 plotting_area = self._get_plotting_area(
692 gen_new_url(parsed_url, {"job": job})
699 ret_val.extend(ctrl_panel.values)
703 Output("plot-mod-url", "is_open"),
704 [Input("plot-btn-url", "n_clicks")],
705 [State("plot-mod-url", "is_open")],
707 def toggle_plot_mod_url(n, is_open):
708 """Toggle the modal window with url.
715 Output("download-stats-data", "data"),
716 State("control-panel", "data"), # Store
717 Input("plot-btn-download", "n_clicks"),
718 prevent_initial_call=True
720 def _download_data(cp_data: dict, n_clicks: int):
723 :param cp_data: Current status of the control panel stored in
725 :param n_clicks: Number of clicks on the button "Download".
728 :returns: dict of data frame content (base64 encoded) and meta data
729 used by the Download component.
735 ctrl_panel = ControlPanel(self._cp_default, cp_data)
739 ctrl_panel.get("ri-duts-value"),
740 ctrl_panel.get("ri-ttypes-value"),
741 ctrl_panel.get("ri-cadences-value"),
742 ctrl_panel.get("dd-tbeds-value")
745 data = select_data(self._data, job)
746 data = data.drop(columns=["job", ])
748 return dcc.send_data_frame(
749 data.T.to_csv, f"{job}-{C.STATS_DOWNLOAD_FILE_NAME}")
752 Output("row-metadata", "children"),
753 Output("offcanvas-metadata", "is_open"),
754 Input("graph-passed", "clickData"),
755 Input("graph-duration", "clickData"),
756 prevent_initial_call=True
758 def _show_metadata_from_graphs(
759 passed_data: dict, duration_data: dict) -> tuple:
760 """Generates the data for the offcanvas displayed when a particular
761 point in a graph is clicked on.
763 :param passed_data: The data from the clicked point in the graph
764 displaying the pass/fail data.
765 :param duration_data: The data from the clicked point in the graph
766 displaying the duration data.
767 :type passed_data: dict
768 :type duration data: dict
769 :returns: The data to be displayed on the offcanvas (job statistics
770 and the list of failed tests) and the information to show the
772 :rtype: tuple(list, bool)
775 if not (passed_data or duration_data):
780 title = "Job Statistics"
781 trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0]
782 if trigger_id == "graph-passed":
783 graph_data = passed_data["points"][0].get("hovertext", "")
784 elif trigger_id == "graph-duration":
785 graph_data = duration_data["points"][0].get("text", "")
787 lst_graph_data = graph_data.split("<br>")
789 # Prepare list of failed tests:
792 for itm in lst_graph_data:
793 if "csit-ref:" in itm:
794 job, build = itm.split(" ")[-1].split("/")
797 fail_tests = self._data.loc[
798 (self._data["job"] == job) &
799 (self._data["build"] == build)
800 ]["lst_failed"].values[0]
806 # Create the content of the offcanvas:
809 class_name="gy-2 p-0",
811 dbc.CardHeader(children=[
813 target_id="metadata",
815 style={"display": "inline-block"}
822 children=[dbc.ListGroup(
831 ) for x in lst_graph_data
840 if fail_tests is not None:
843 class_name="gy-2 p-0",
846 f"List of Failed Tests ({len(fail_tests)})"
851 children=[dbc.ListGroup(
853 dbc.ListGroupItem(x) \
865 return metadata, open_canvas
868 Output("offcanvas-documentation", "is_open"),
869 Input("btn-documentation", "n_clicks"),
870 State("offcanvas-documentation", "is_open")
872 def toggle_offcanvas_documentation(n_clicks, is_open):