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, filter_table_data
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",
65 "ttype": "Measurement"
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(
146 ("NDR", "PDR", "Latency")
148 elif row["test_type"] == "hoststack" and \
149 row["tg_type"] in ("iperf", "vpp"):
150 if "BPS" not in tbs[dut][dver][infra]["ttype"]:
151 tbs[dut][dver][infra]["ttype"].append("BPS")
152 elif row["test_type"] == "hoststack" and row["tg_type"] == "ab":
153 if "CPS" not in tbs[dut][dver][infra]["ttype"]:
154 tbs[dut][dver][infra]["ttype"].extend(("CPS", "RPS", ))
158 self._html_layout = str()
160 with open(self._html_layout_file, "r") as file_read:
161 self._html_layout = file_read.read()
162 except IOError as err:
164 f"Not possible to open the file {self._html_layout_file}\n{err}"
168 if self._app is not None and hasattr(self, "callbacks"):
169 self.callbacks(self._app)
172 def html_layout(self):
173 return self._html_layout
175 def add_content(self):
176 """Top level method which generated the web page.
179 - Store for user input data,
181 - Main area with control panel and ploting area.
183 If no HTML layout is provided, an error message is displayed instead.
185 :returns: The HTML div with the whole page.
189 if self.html_layout and self._tbs:
205 dcc.Store(id="store-control-panel"),
206 dcc.Store(id="store-selected"),
207 dcc.Store(id="store-table-data"),
208 dcc.Store(id="store-filtered-table-data"),
209 dcc.Location(id="url", refresh=False),
210 self._add_ctrl_col(),
211 self._add_plotting_col()
229 def _add_navbar(self):
230 """Add nav element with navigation panel. It is placed on the top.
232 :returns: Navigation bar.
233 :rtype: dbc.NavbarSimple
235 return dbc.NavbarSimple(
236 id="navbarsimple-main",
249 brand_external_link=True,
254 def _add_ctrl_col(self) -> dbc.Col:
255 """Add column with controls. It is placed on the left side.
257 :returns: Column with the control panel.
262 children=self._add_ctrl_panel(),
263 className="sticky-top"
267 def _add_plotting_col(self) -> dbc.Col:
268 """Add column with plots. It is placed on the right side.
270 :returns: Column with plots.
274 id="col-plotting-area",
280 class_name="g-0 p-0",
291 def _add_ctrl_panel(self) -> list:
292 """Add control panel.
294 :returns: Control panel.
300 class_name="g-0 p-1",
304 dbc.InputGroupText("DUT"),
306 id={"type": "ctrl-dd", "index": "dut"},
307 placeholder="Select a Device under Test...",
310 {"label": k, "value": k} \
311 for k in self._tbs.keys()
313 key=lambda d: d["label"]
322 class_name="g-0 p-1",
326 dbc.InputGroupText("CSIT and DUT Version"),
328 id={"type": "ctrl-dd", "index": "dutver"},
329 placeholder="Select a CSIT and DUT Version...")
336 class_name="g-0 p-1",
340 dbc.InputGroupText("Infra"),
342 id={"type": "ctrl-dd", "index": "infra"},
344 "Select a Physical Test Bed Topology..."
352 class_name="g-0 p-1",
356 dbc.InputGroupText("Frame Size"),
358 id={"type": "ctrl-cl", "index": "frmsize"},
363 style={"align-items": "center"},
369 class_name="g-0 p-1",
373 dbc.InputGroupText("Number of Cores"),
375 id={"type": "ctrl-cl", "index": "core"},
380 style={"align-items": "center"},
386 class_name="g-0 p-1",
390 dbc.InputGroupText("Measurement"),
392 id={"type": "ctrl-cl", "index": "ttype"},
397 style={"align-items": "center"},
406 class_name="g-0 p-1",
410 dbc.InputGroupText("Parameter"),
412 id={"type": "ctrl-dd", "index": "cmpprm"},
413 placeholder="Select a Parameter..."
421 class_name="g-0 p-1",
425 dbc.InputGroupText("Value"),
427 id={"type": "ctrl-dd", "index": "cmpval"},
428 placeholder="Select a Value..."
439 class_name="g-0 p-1",
445 "value": "normalize",
446 "label": "Normalize to 2GHz CPU frequency"
452 style={"align-items": "center"},
464 html.H5("Reference Value")
480 html.H5("Compared Value")
496 html.H5("Normalization")
511 def _get_plotting_area(
516 """Generate the plotting area with all its content.
518 :param title: The title of the comparison table..
519 :param table: Comparison table to be displayed.
520 :param url: URL to be displayed in the modal window.
522 :type table: pandas.DataFrame
524 :returns: List of rows with elements to be displayed in the plotting
533 "No data for comparison.",
536 class_name="g-0 p-1",
542 for idx, col in enumerate(table.columns):
552 l_col = col.rsplit(" ", 2)
554 "name": [l_col[0], " ".join(l_col[-2:])],
559 "format": Format(precision=2, scheme=Scheme.fixed)
564 children=html.H5(title),
570 children=dash_table.DataTable(
571 id={"type": "table", "index": "comparison"},
573 data=table.to_dict("records"),
574 merge_duplicate_headers=True,
576 filter_action="custom",
578 sort_action="native",
583 style_cell={"textAlign": "right"},
584 style_cell_conditional=[{
585 "if": {"column_id": "Test Name"},
604 "text-transform": "none",
605 "padding": "0rem 1rem"
610 dbc.ModalHeader(dbc.ModalTitle("URL")),
619 id="plot-btn-download",
620 children="Download Data",
624 "text-transform": "none",
625 "padding": "0rem 1rem"
628 dcc.Download(id="download-iterative-data")
631 "d-grid gap-0 d-md-flex justify-content-md-end"
637 children=C.PLACEHOLDER,
642 def callbacks(self, app):
643 """Callbacks for the whole application.
645 :param app: The application.
651 Output("store-control-panel", "data"),
652 Output("store-selected", "data"),
653 Output("store-table-data", "data"),
654 Output("store-filtered-table-data", "data"),
655 Output("plotting-area", "children"),
656 Output({"type": "table", "index": ALL}, "data"),
657 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
658 Output({"type": "ctrl-dd", "index": "dutver"}, "options"),
659 Output({"type": "ctrl-dd", "index": "dutver"}, "disabled"),
660 Output({"type": "ctrl-dd", "index": "dutver"}, "value"),
661 Output({"type": "ctrl-dd", "index": "infra"}, "options"),
662 Output({"type": "ctrl-dd", "index": "infra"}, "disabled"),
663 Output({"type": "ctrl-dd", "index": "infra"}, "value"),
664 Output({"type": "ctrl-cl", "index": "core"}, "options"),
665 Output({"type": "ctrl-cl", "index": "core"}, "value"),
666 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
667 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
668 Output({"type": "ctrl-cl", "index": "ttype"}, "options"),
669 Output({"type": "ctrl-cl", "index": "ttype"}, "value"),
670 Output({"type": "ctrl-dd", "index": "cmpprm"}, "options"),
671 Output({"type": "ctrl-dd", "index": "cmpprm"}, "disabled"),
672 Output({"type": "ctrl-dd", "index": "cmpprm"}, "value"),
673 Output({"type": "ctrl-dd", "index": "cmpval"}, "options"),
674 Output({"type": "ctrl-dd", "index": "cmpval"}, "disabled"),
675 Output({"type": "ctrl-dd", "index": "cmpval"}, "value"),
676 Output("normalize", "value")
679 State("store-control-panel", "data"),
680 State("store-selected", "data"),
681 State("store-table-data", "data"),
682 State("store-filtered-table-data", "data"),
683 State({"type": "table", "index": ALL}, "data")
686 Input("url", "href"),
687 Input("normalize", "value"),
688 Input({"type": "table", "index": ALL}, "filter_query"),
689 Input({"type": "ctrl-dd", "index": ALL}, "value"),
690 Input({"type": "ctrl-cl", "index": ALL}, "value"),
691 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks")
694 def _update_application(
697 store_table_data: list,
705 """Update the application when the event is detected.
708 ctrl_panel = ControlPanel(CP_PARAMS, control_panel)
721 parsed_url = url_decode(href)
723 url_params = parsed_url["params"]
728 plotting_area = no_update
730 trigger = Trigger(callback_context.triggered)
731 if trigger.type == "url" and url_params:
734 selected = literal_eval(url_params["selected"][0])
735 r_sel = selected["reference"]["selection"]
736 c_sel = selected["compare"]
737 normalize = literal_eval(url_params["norm"][0])
739 (selected["reference"]["set"] == True) and
740 (c_sel["set"] == True)
742 except (KeyError, IndexError, AttributeError):
746 "dut-val": r_sel["dut"],
747 "dutver-opt": generate_options(
748 self._tbs[r_sel["dut"]].keys()
751 "dutver-val": r_sel["dutver"],
752 "infra-opt": generate_options(
753 self._tbs[r_sel["dut"]][r_sel["dutver"]].keys()
756 "infra-val": r_sel["infra"],
757 "core-opt": generate_options(
758 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
759 [r_sel["infra"]]["core"]
761 "core-val": r_sel["core"],
762 "frmsize-opt": generate_options(
763 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
764 [r_sel["infra"]]["fsize"]
766 "frmsize-val": r_sel["frmsize"],
767 "ttype-opt": generate_options(
768 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
769 [r_sel["infra"]]["ttype"]
771 "ttype-val": r_sel["ttype"],
772 "normalize-val": normalize
775 for itm, label in CMP_PARAMS.items():
776 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
777 opts.append({"label": label, "value": itm})
780 "cmp-par-dis": False,
781 "cmp-par-val": c_sel["parameter"]
784 for itm in ctrl_panel.get(f"{c_sel['parameter']}-opt"):
785 set_val = ctrl_panel.get(f"{c_sel['parameter']}-val")
786 if isinstance(set_val, list):
787 if itm["value"] not in set_val:
790 if itm["value"] != set_val:
794 "cmp-val-dis": False,
795 "cmp-val-val": c_sel["value"]
798 elif trigger.type == "normalize":
799 ctrl_panel.set({"normalize-val": normalize})
801 elif trigger.type == "ctrl-dd":
802 if trigger.idx == "dut":
804 opts = generate_options(self._tbs[trigger.value].keys())
810 "dut-val": trigger.value,
812 "dutver-dis": disabled,
819 "frmsize-opt": list(),
820 "frmsize-val": list(),
823 "cmp-par-opt": list(),
825 "cmp-par-val": str(),
826 "cmp-val-opt": list(),
830 elif trigger.idx == "dutver":
832 dut = ctrl_panel.get("dut-val")
833 dver = self._tbs[dut][trigger.value]
834 opts = generate_options(dver.keys())
840 "dutver-val": trigger.value,
842 "infra-dis": disabled,
846 "frmsize-opt": list(),
847 "frmsize-val": list(),
850 "cmp-par-opt": list(),
852 "cmp-par-val": str(),
853 "cmp-val-opt": list(),
857 elif trigger.idx == "infra":
858 dut = ctrl_panel.get("dut-val")
859 dver = ctrl_panel.get("dutver-val")
860 if all((dut, dver, trigger.value, )):
861 driver = self._tbs[dut][dver][trigger.value]
863 "infra-val": trigger.value,
864 "core-opt": generate_options(driver["core"]),
866 "frmsize-opt": generate_options(driver["fsize"]),
867 "frmsize-val": list(),
868 "ttype-opt": generate_options(driver["ttype"]),
870 "cmp-par-opt": list(),
872 "cmp-par-val": str(),
873 "cmp-val-opt": list(),
877 elif trigger.idx == "cmpprm":
878 value = trigger.value
880 for itm in ctrl_panel.get(f"{value}-opt"):
881 set_val = ctrl_panel.get(f"{value}-val")
882 if isinstance(set_val, list):
883 if itm["value"] == "Latency":
885 if itm["value"] not in set_val:
888 if itm["value"] != set_val:
891 "cmp-par-val": value,
893 "cmp-val-dis": False,
896 elif trigger.idx == "cmpval":
897 ctrl_panel.set({"cmp-val-val": trigger.value})
898 selected["reference"] = {
901 "dut": ctrl_panel.get("dut-val"),
902 "dutver": ctrl_panel.get("dutver-val"),
903 "infra": ctrl_panel.get("infra-val"),
904 "core": ctrl_panel.get("core-val"),
905 "frmsize": ctrl_panel.get("frmsize-val"),
906 "ttype": ctrl_panel.get("ttype-val")
909 selected["compare"] = {
911 "parameter": ctrl_panel.get("cmp-par-val"),
912 "value": trigger.value
915 elif trigger.type == "ctrl-cl":
916 ctrl_panel.set({f"{trigger.idx}-val": trigger.value})
917 if all((ctrl_panel.get("core-val"),
918 ctrl_panel.get("frmsize-val"),
919 ctrl_panel.get("ttype-val"), )):
920 if "Latency" in ctrl_panel.get("ttype-val"):
921 ctrl_panel.set({"ttype-val": ["Latency", ]})
923 for itm, label in CMP_PARAMS.items():
924 if "Latency" in ctrl_panel.get("ttype-val") and \
927 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
928 if isinstance(ctrl_panel.get(f"{itm}-val"), list):
929 if len(ctrl_panel.get(f"{itm}-opt")) == \
930 len(ctrl_panel.get(f"{itm}-val")):
932 opts.append({"label": label, "value": itm})
935 "cmp-par-dis": False,
936 "cmp-par-val": str(),
937 "cmp-val-opt": list(),
943 "cmp-par-opt": list(),
945 "cmp-par-val": str(),
946 "cmp-val-opt": list(),
950 elif trigger.type == "table" and trigger.idx == "comparison":
951 filtered_data = filter_table_data(
955 table_data = [filtered_data, ]
957 if all((on_draw, selected["reference"]["set"],
958 selected["compare"]["set"], )):
959 title, table = comparison_table(self._data, selected, normalize)
960 plotting_area = self._get_plotting_area(
965 params={"selected": selected, "norm": normalize}
968 store_table_data = table.to_dict("records")
969 filtered_data = store_table_data
971 table_data = [store_table_data, ]
981 ret_val.extend(ctrl_panel.values)
985 Output("plot-mod-url", "is_open"),
986 Input("plot-btn-url", "n_clicks"),
987 State("plot-mod-url", "is_open")
989 def toggle_plot_mod_url(n, is_open):
990 """Toggle the modal window with url.
997 Output("download-iterative-data", "data"),
998 State("store-table-data", "data"),
999 State("store-filtered-table-data", "data"),
1000 Input("plot-btn-download", "n_clicks"),
1001 prevent_initial_call=True
1003 def _download_comparison_data(
1005 filtered_table_data: list,
1008 """Download the data.
1010 :param table_data: Original unfiltered table data.
1011 :param filtered_table_data: Filtered table data.
1012 :type table_data: list
1013 :type filtered_table_data: list
1014 :returns: dict of data frame content (base64 encoded) and meta data
1015 used by the Download component.
1022 if filtered_table_data:
1023 table = pd.DataFrame.from_records(filtered_table_data)
1025 table = pd.DataFrame.from_records(table_data)
1027 return dcc.send_data_frame(table.to_csv, C.COMP_DOWNLOAD_FILE_NAME)