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.
18 import dash_bootstrap_components as dbc
20 from flask import Flask
21 from dash import dcc, html, dash_table, callback_context, no_update, ALL
22 from dash import Input, Output, State
23 from dash.exceptions import PreventUpdate
24 from dash.dash_table.Format import Format, Scheme
25 from ast import literal_eval
27 from ..utils.constants import Constants as C
28 from ..utils.control_panel import ControlPanel
29 from ..utils.trigger import Trigger
30 from ..utils.url_processing import url_decode
31 from ..utils.utils import generate_options, gen_new_url
32 from .tables import comparison_table
35 # Control panel partameters and their default values.
46 "frmsize-opt": list(),
47 "frmsize-val": list(),
50 "cmp-par-opt": list(),
53 "cmp-val-opt": list(),
56 "normalize-val": list()
59 # List of comparable parameters.
61 "dutver": "Release and Version",
62 "infra": "Infrastructure",
63 "frmsize": "Frame Size",
64 "core": "Number of Cores",
70 """The layout of the dash app and the callbacks.
76 data_iterative: pd.DataFrame,
80 - save the input parameters,
81 - prepare data for the control panel,
82 - read HTML layout file,
84 :param app: Flask application running the dash application.
85 :param data_iterative: Iterative data to be used in comparison tables.
86 :param html_layout_file: Path and name of the file specifying the HTML
87 layout of the dash application.
89 :type data_iterative: pandas.DataFrame
90 :type html_layout_file: str
95 self._html_layout_file = html_layout_file
96 self._data = data_iterative
98 # Get structure of tests:
101 "job", "test_id", "test_type", "dut_type", "dut_version", "tg_type",
104 for _, row in self._data[cols].drop_duplicates().iterrows():
105 lst_job = row["job"].split("-")
107 dver = f"{row['release']}-{row['dut_version']}"
108 tbed = "-".join(lst_job[-2:])
109 lst_test_id = row["test_id"].split(".")
111 suite = lst_test_id[-2].replace("2n1l-", "").replace("1n1l-", "").\
113 test = lst_test_id[-1]
114 nic = suite.split("-")[0]
115 for driver in C.DRIVERS:
117 drv = driver.replace("-", "_")
118 test = test.replace(f"{driver}-", "")
122 infra = "-".join((tbed, nic, drv))
123 lst_test = test.split("-")
125 core = lst_test[1] if lst_test[1] else "8C"
127 if tbs.get(dut, None) is None:
129 if tbs[dut].get(dver, None) is None:
130 tbs[dut][dver] = dict()
131 if tbs[dut][dver].get(infra, None) is None:
132 tbs[dut][dver][infra] = dict()
133 tbs[dut][dver][infra]["core"] = list()
134 tbs[dut][dver][infra]["fsize"] = list()
135 tbs[dut][dver][infra]["ttype"] = list()
136 if core.upper() not in tbs[dut][dver][infra]["core"]:
137 tbs[dut][dver][infra]["core"].append(core.upper())
138 if fsize.upper() not in tbs[dut][dver][infra]["fsize"]:
139 tbs[dut][dver][infra]["fsize"].append(fsize.upper())
140 if row["test_type"] == "mrr":
141 if "MRR" not in tbs[dut][dver][infra]["ttype"]:
142 tbs[dut][dver][infra]["ttype"].append("MRR")
143 elif row["test_type"] == "ndrpdr":
144 if "NDR" not in tbs[dut][dver][infra]["ttype"]:
145 tbs[dut][dver][infra]["ttype"].extend(("NDR", "PDR", ))
146 elif row["test_type"] == "hoststack" and \
147 row["tg_type"] in ("iperf", "vpp"):
148 if "BPS" not in tbs[dut][dver][infra]["ttype"]:
149 tbs[dut][dver][infra]["ttype"].append("BPS")
150 elif row["test_type"] == "hoststack" and row["tg_type"] == "ab":
151 if "CPS" not in tbs[dut][dver][infra]["ttype"]:
152 tbs[dut][dver][infra]["ttype"].extend(("CPS", "RPS", ))
156 self._html_layout = str()
158 with open(self._html_layout_file, "r") as file_read:
159 self._html_layout = file_read.read()
160 except IOError as err:
162 f"Not possible to open the file {self._html_layout_file}\n{err}"
166 if self._app is not None and hasattr(self, "callbacks"):
167 self.callbacks(self._app)
170 def html_layout(self):
171 return self._html_layout
173 def add_content(self):
174 """Top level method which generated the web page.
177 - Store for user input data,
179 - Main area with control panel and ploting area.
181 If no HTML layout is provided, an error message is displayed instead.
183 :returns: The HTML div with the whole page.
187 if self.html_layout and self._tbs:
203 dcc.Store(id="store-control-panel"),
204 dcc.Store(id="store-selected"),
205 dcc.Location(id="url", refresh=False),
206 self._add_ctrl_col(),
207 self._add_plotting_col()
225 def _add_navbar(self):
226 """Add nav element with navigation panel. It is placed on the top.
228 :returns: Navigation bar.
229 :rtype: dbc.NavbarSimple
231 return dbc.NavbarSimple(
232 id="navbarsimple-main",
245 brand_external_link=True,
250 def _add_ctrl_col(self) -> dbc.Col:
251 """Add column with controls. It is placed on the left side.
253 :returns: Column with the control panel.
258 children=self._add_ctrl_panel(),
259 className="sticky-top"
263 def _add_plotting_col(self) -> dbc.Col:
264 """Add column with plots. It is placed on the right side.
266 :returns: Column with plots.
270 id="col-plotting-area",
276 class_name="g-0 p-0",
287 def _add_ctrl_panel(self) -> list:
288 """Add control panel.
290 :returns: Control panel.
296 class_name="g-0 p-1",
300 dbc.InputGroupText("DUT"),
302 id={"type": "ctrl-dd", "index": "dut"},
303 placeholder="Select a Device under Test...",
306 {"label": k, "value": k} \
307 for k in self._tbs.keys()
309 key=lambda d: d["label"]
318 class_name="g-0 p-1",
322 dbc.InputGroupText("CSIT and DUT Version"),
324 id={"type": "ctrl-dd", "index": "dutver"},
325 placeholder="Select a CSIT and DUT Version...")
332 class_name="g-0 p-1",
336 dbc.InputGroupText("Infra"),
338 id={"type": "ctrl-dd", "index": "infra"},
340 "Select a Physical Test Bed Topology..."
348 class_name="g-0 p-1",
352 dbc.InputGroupText("Frame Size"),
354 id={"type": "ctrl-cl", "index": "frmsize"},
359 style={"align-items": "center"},
365 class_name="g-0 p-1",
369 dbc.InputGroupText("Number of Cores"),
371 id={"type": "ctrl-cl", "index": "core"},
376 style={"align-items": "center"},
382 class_name="g-0 p-1",
386 dbc.InputGroupText("Test Type"),
388 id={"type": "ctrl-cl", "index": "ttype"},
393 style={"align-items": "center"},
402 class_name="g-0 p-1",
406 dbc.InputGroupText("Parameter"),
408 id={"type": "ctrl-dd", "index": "cmpprm"},
409 placeholder="Select a Parameter..."
417 class_name="g-0 p-1",
421 dbc.InputGroupText("Value"),
423 id={"type": "ctrl-dd", "index": "cmpval"},
424 placeholder="Select a Value..."
435 class_name="g-0 p-1",
441 "value": "normalize",
442 "label": "Normalize to 2GHz CPU frequency"
448 style={"align-items": "center"},
460 html.H5("Reference Value")
476 html.H5("Compared Value")
492 html.H5("Normalization")
506 def _get_plotting_area(
512 """Generate the plotting area with all its content.
514 :param selected: Selected parameters of tests.
515 :param normalize: If true, the values in tables are normalized.
516 :param url: URL to be displayed in the modal window.
518 :type normalize: bool
520 :returns: List of rows with elements to be displayed in the plotting
525 title, df = comparison_table(self._data, selected, normalize)
531 "No data for comparison.",
534 class_name="g-0 p-1",
540 for idx, col in enumerate(df.columns):
550 l_col = col.rsplit(" ", 2)
552 "name": [l_col[0], " ".join(l_col[-2:])],
557 "format": Format(precision=2, scheme=Scheme.fixed)
562 children=html.H5(title),
568 children=dash_table.DataTable(
570 data=df.to_dict("records"),
571 merge_duplicate_headers=True,
573 filter_action="native",
574 sort_action="native",
579 style_cell={"textAlign": "right"},
580 style_cell_conditional=[{
581 "if": {"column_id": "Test Name"},
600 "text-transform": "none",
601 "padding": "0rem 1rem"
606 dbc.ModalHeader(dbc.ModalTitle("URL")),
615 id="plot-btn-download",
616 children="Download Data",
620 "text-transform": "none",
621 "padding": "0rem 1rem"
624 dcc.Download(id="download-iterative-data")
627 "d-grid gap-0 d-md-flex justify-content-md-end"
633 children=C.PLACEHOLDER,
638 def callbacks(self, app):
639 """Callbacks for the whole application.
641 :param app: The application.
647 Output("store-control-panel", "data"),
648 Output("store-selected", "data"),
649 Output("plotting-area", "children"),
650 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
651 Output({"type": "ctrl-dd", "index": "dutver"}, "options"),
652 Output({"type": "ctrl-dd", "index": "dutver"}, "disabled"),
653 Output({"type": "ctrl-dd", "index": "dutver"}, "value"),
654 Output({"type": "ctrl-dd", "index": "infra"}, "options"),
655 Output({"type": "ctrl-dd", "index": "infra"}, "disabled"),
656 Output({"type": "ctrl-dd", "index": "infra"}, "value"),
657 Output({"type": "ctrl-cl", "index": "core"}, "options"),
658 Output({"type": "ctrl-cl", "index": "core"}, "value"),
659 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
660 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
661 Output({"type": "ctrl-cl", "index": "ttype"}, "options"),
662 Output({"type": "ctrl-cl", "index": "ttype"}, "value"),
663 Output({"type": "ctrl-dd", "index": "cmpprm"}, "options"),
664 Output({"type": "ctrl-dd", "index": "cmpprm"}, "disabled"),
665 Output({"type": "ctrl-dd", "index": "cmpprm"}, "value"),
666 Output({"type": "ctrl-dd", "index": "cmpval"}, "options"),
667 Output({"type": "ctrl-dd", "index": "cmpval"}, "disabled"),
668 Output({"type": "ctrl-dd", "index": "cmpval"}, "value"),
669 Output("normalize", "value")
672 State("store-control-panel", "data"),
673 State("store-selected", "data")
676 Input("url", "href"),
677 Input("normalize", "value"),
678 Input({"type": "ctrl-dd", "index": ALL}, "value"),
679 Input({"type": "ctrl-cl", "index": ALL}, "value"),
680 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks")
683 def _update_application(
690 """Update the application when the event is detected.
693 ctrl_panel = ControlPanel(CP_PARAMS, control_panel)
706 parsed_url = url_decode(href)
708 url_params = parsed_url["params"]
713 plotting_area = no_update
715 trigger = Trigger(callback_context.triggered)
716 if trigger.type == "url" and url_params:
719 selected = literal_eval(url_params["selected"][0])
720 r_sel = selected["reference"]["selection"]
721 c_sel = selected["compare"]
722 normalize = literal_eval(url_params["norm"][0])
724 (selected["reference"]["set"] == True) and
725 (c_sel["set"] == True)
727 except (KeyError, IndexError):
731 "dut-val": r_sel["dut"],
732 "dutver-opt": generate_options(
733 self._tbs[r_sel["dut"]].keys()
736 "dutver-val": r_sel["dutver"],
737 "infra-opt": generate_options(
738 self._tbs[r_sel["dut"]][r_sel["dutver"]].keys()
741 "infra-val": r_sel["infra"],
742 "core-opt": generate_options(
743 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
744 [r_sel["infra"]]["core"]
746 "core-val": r_sel["core"],
747 "frmsize-opt": generate_options(
748 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
749 [r_sel["infra"]]["fsize"]
751 "frmsize-val": r_sel["frmsize"],
752 "ttype-opt": generate_options(
753 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
754 [r_sel["infra"]]["ttype"]
756 "ttype-val": r_sel["ttype"],
757 "normalize-val": normalize
760 for itm, label in CMP_PARAMS.items():
761 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
762 opts.append({"label": label, "value": itm})
765 "cmp-par-dis": False,
766 "cmp-par-val": c_sel["parameter"]
769 for itm in ctrl_panel.get(f"{c_sel['parameter']}-opt"):
770 set_val = ctrl_panel.get(f"{c_sel['parameter']}-val")
771 if isinstance(set_val, list):
772 if itm["value"] not in set_val:
775 if itm["value"] != set_val:
779 "cmp-val-dis": False,
780 "cmp-val-val": c_sel["value"]
783 elif trigger.type == "normalize":
784 ctrl_panel.set({"normalize-val": normalize})
786 elif trigger.type == "ctrl-dd":
787 if trigger.idx == "dut":
789 opts = generate_options(self._tbs[trigger.value].keys())
795 "dut-val": trigger.value,
797 "dutver-dis": disabled,
804 "frmsize-opt": list(),
805 "frmsize-val": list(),
808 "cmp-par-opt": list(),
810 "cmp-par-val": str(),
811 "cmp-val-opt": list(),
815 elif trigger.idx == "dutver":
817 dut = ctrl_panel.get("dut-val")
818 dver = self._tbs[dut][trigger.value]
819 opts = generate_options(dver.keys())
825 "dutver-val": trigger.value,
827 "infra-dis": disabled,
831 "frmsize-opt": list(),
832 "frmsize-val": list(),
835 "cmp-par-opt": list(),
837 "cmp-par-val": str(),
838 "cmp-val-opt": list(),
842 elif trigger.idx == "infra":
843 dut = ctrl_panel.get("dut-val")
844 dver = ctrl_panel.get("dutver-val")
845 if all((dut, dver, trigger.value, )):
846 driver = self._tbs[dut][dver][trigger.value]
848 "infra-val": trigger.value,
849 "core-opt": generate_options(driver["core"]),
851 "frmsize-opt": generate_options(driver["fsize"]),
852 "frmsize-val": list(),
853 "ttype-opt": generate_options(driver["ttype"]),
855 "cmp-par-opt": list(),
857 "cmp-par-val": str(),
858 "cmp-val-opt": list(),
862 elif trigger.idx == "cmpprm":
863 value = trigger.value
865 for itm in ctrl_panel.get(f"{value}-opt"):
866 set_val = ctrl_panel.get(f"{value}-val")
867 if isinstance(set_val, list):
868 if itm["value"] not in set_val:
871 if itm["value"] != set_val:
874 "cmp-par-val": value,
876 "cmp-val-dis": False,
879 elif trigger.idx == "cmpval":
880 ctrl_panel.set({"cmp-val-val": trigger.value})
881 selected["reference"] = {
884 "dut": ctrl_panel.get("dut-val"),
885 "dutver": ctrl_panel.get("dutver-val"),
886 "infra": ctrl_panel.get("infra-val"),
887 "core": ctrl_panel.get("core-val"),
888 "frmsize": ctrl_panel.get("frmsize-val"),
889 "ttype": ctrl_panel.get("ttype-val")
892 selected["compare"] = {
894 "parameter": ctrl_panel.get("cmp-par-val"),
895 "value": trigger.value
898 elif trigger.type == "ctrl-cl":
899 ctrl_panel.set({f"{trigger.idx}-val": trigger.value})
900 if all((ctrl_panel.get("core-val"),
901 ctrl_panel.get("frmsize-val"),
902 ctrl_panel.get("ttype-val"), )):
904 for itm, label in CMP_PARAMS.items():
905 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
906 if isinstance(ctrl_panel.get(f"{itm}-val"), list):
907 if len(ctrl_panel.get(f"{itm}-opt")) == \
908 len(ctrl_panel.get(f"{itm}-val")):
910 opts.append({"label": label, "value": itm})
913 "cmp-par-dis": False,
914 "cmp-par-val": str(),
915 "cmp-val-opt": list(),
921 "cmp-par-opt": list(),
923 "cmp-par-val": str(),
924 "cmp-val-opt": list(),
929 if all((on_draw, selected["reference"]["set"],
930 selected["compare"]["set"], )):
931 plotting_area = self._get_plotting_area(
933 normalize=bool(normalize),
936 params={"selected": selected, "norm": normalize}
940 ret_val = [ctrl_panel.panel, selected, plotting_area]
941 ret_val.extend(ctrl_panel.values)
945 Output("plot-mod-url", "is_open"),
946 Input("plot-btn-url", "n_clicks"),
947 State("plot-mod-url", "is_open")
949 def toggle_plot_mod_url(n, is_open):
950 """Toggle the modal window with url.
957 Output("download-iterative-data", "data"),
958 State("store-selected", "data"),
959 State("normalize", "value"),
960 Input("plot-btn-download", "n_clicks"),
961 prevent_initial_call=True
963 def _download_trending_data(selected: dict, normalize: list, _: int):
964 """Download the data.
966 :param selected: List of tests selected by user stored in the
968 :param normalize: If set, the data is normalized to 2GHz CPU
971 :type normalize: list
972 :returns: dict of data frame content (base64 encoded) and meta data
973 used by the Download component.
980 _, table = comparison_table(self._data, selected, normalize, "csv")
982 return dcc.send_data_frame(table.to_csv, C.COMP_DOWNLOAD_FILE_NAME)