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()
216 id="offcanvas-documentation",
217 title="Documentation",
220 children=html.Iframe(
221 src=C.URL_DOC_REL_NOTES,
241 def _add_navbar(self):
242 """Add nav element with navigation panel. It is placed on the top.
244 :returns: Navigation bar.
245 :rtype: dbc.NavbarSimple
247 return dbc.NavbarSimple(
248 id="navbarsimple-main",
250 dbc.NavItem(dbc.NavLink(
255 dbc.NavItem(dbc.NavLink(
261 dbc.NavItem(dbc.NavLink(
266 dbc.NavItem(dbc.NavLink(
268 id="btn-documentation",
273 brand_external_link=True,
278 def _add_ctrl_col(self) -> dbc.Col:
279 """Add column with controls. It is placed on the left side.
281 :returns: Column with the control panel.
286 children=self._add_ctrl_panel(),
287 className="sticky-top"
291 def _add_plotting_col(self) -> dbc.Col:
292 """Add column with plots. It is placed on the right side.
294 :returns: Column with plots.
298 id="col-plotting-area",
304 class_name="g-0 p-0",
315 def _add_ctrl_panel(self) -> list:
316 """Add control panel.
318 :returns: Control panel.
324 class_name="g-0 p-1",
328 dbc.InputGroupText("DUT"),
330 id={"type": "ctrl-dd", "index": "dut"},
331 placeholder="Select a Device under Test...",
334 {"label": k, "value": k} \
335 for k in self._tbs.keys()
337 key=lambda d: d["label"]
346 class_name="g-0 p-1",
350 dbc.InputGroupText("CSIT and DUT Version"),
352 id={"type": "ctrl-dd", "index": "dutver"},
353 placeholder="Select a CSIT and DUT Version...")
360 class_name="g-0 p-1",
364 dbc.InputGroupText("Infra"),
366 id={"type": "ctrl-dd", "index": "infra"},
368 "Select a Physical Test Bed Topology..."
376 class_name="g-0 p-1",
380 dbc.InputGroupText("Frame Size"),
382 id={"type": "ctrl-cl", "index": "frmsize"},
387 style={"align-items": "center"},
393 class_name="g-0 p-1",
397 dbc.InputGroupText("Number of Cores"),
399 id={"type": "ctrl-cl", "index": "core"},
404 style={"align-items": "center"},
410 class_name="g-0 p-1",
414 dbc.InputGroupText("Measurement"),
416 id={"type": "ctrl-cl", "index": "ttype"},
421 style={"align-items": "center"},
430 class_name="g-0 p-1",
434 dbc.InputGroupText("Parameter"),
436 id={"type": "ctrl-dd", "index": "cmpprm"},
437 placeholder="Select a Parameter..."
445 class_name="g-0 p-1",
449 dbc.InputGroupText("Value"),
451 id={"type": "ctrl-dd", "index": "cmpval"},
452 placeholder="Select a Value..."
463 class_name="g-0 p-1",
469 "value": "normalize",
470 "label": "Normalize to 2GHz CPU frequency"
476 style={"align-items": "center"},
488 html.H5("Reference Value")
504 html.H5("Compared Value")
520 html.H5("Normalization")
535 def _get_plotting_area(
540 """Generate the plotting area with all its content.
542 :param title: The title of the comparison table..
543 :param table: Comparison table to be displayed.
544 :param url: URL to be displayed in the modal window.
546 :type table: pandas.DataFrame
548 :returns: List of rows with elements to be displayed in the plotting
557 "No data for comparison.",
560 class_name="g-0 p-1",
566 for idx, col in enumerate(table.columns):
576 l_col = col.rsplit(" ", 2)
578 "name": [l_col[0], " ".join(l_col[-2:])],
583 "format": Format(precision=2, scheme=Scheme.fixed)
588 children=html.H5(title),
594 children=dash_table.DataTable(
595 id={"type": "table", "index": "comparison"},
597 data=table.to_dict("records"),
598 merge_duplicate_headers=True,
600 filter_action="custom",
602 sort_action="native",
607 style_cell={"textAlign": "right"},
608 style_cell_conditional=[{
609 "if": {"column_id": "Test Name"},
628 "text-transform": "none",
629 "padding": "0rem 1rem"
634 dbc.ModalHeader(dbc.ModalTitle("URL")),
643 id="plot-btn-download",
644 children="Download Data",
648 "text-transform": "none",
649 "padding": "0rem 1rem"
652 dcc.Download(id="download-iterative-data")
655 "d-grid gap-0 d-md-flex justify-content-md-end"
661 children=C.PLACEHOLDER,
666 def callbacks(self, app):
667 """Callbacks for the whole application.
669 :param app: The application.
675 Output("store-control-panel", "data"),
676 Output("store-selected", "data"),
677 Output("store-table-data", "data"),
678 Output("store-filtered-table-data", "data"),
679 Output("plotting-area", "children"),
680 Output({"type": "table", "index": ALL}, "data"),
681 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
682 Output({"type": "ctrl-dd", "index": "dutver"}, "options"),
683 Output({"type": "ctrl-dd", "index": "dutver"}, "disabled"),
684 Output({"type": "ctrl-dd", "index": "dutver"}, "value"),
685 Output({"type": "ctrl-dd", "index": "infra"}, "options"),
686 Output({"type": "ctrl-dd", "index": "infra"}, "disabled"),
687 Output({"type": "ctrl-dd", "index": "infra"}, "value"),
688 Output({"type": "ctrl-cl", "index": "core"}, "options"),
689 Output({"type": "ctrl-cl", "index": "core"}, "value"),
690 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
691 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
692 Output({"type": "ctrl-cl", "index": "ttype"}, "options"),
693 Output({"type": "ctrl-cl", "index": "ttype"}, "value"),
694 Output({"type": "ctrl-dd", "index": "cmpprm"}, "options"),
695 Output({"type": "ctrl-dd", "index": "cmpprm"}, "disabled"),
696 Output({"type": "ctrl-dd", "index": "cmpprm"}, "value"),
697 Output({"type": "ctrl-dd", "index": "cmpval"}, "options"),
698 Output({"type": "ctrl-dd", "index": "cmpval"}, "disabled"),
699 Output({"type": "ctrl-dd", "index": "cmpval"}, "value"),
700 Output("normalize", "value")
703 State("store-control-panel", "data"),
704 State("store-selected", "data"),
705 State("store-table-data", "data"),
706 State("store-filtered-table-data", "data"),
707 State({"type": "table", "index": ALL}, "data")
710 Input("url", "href"),
711 Input("normalize", "value"),
712 Input({"type": "table", "index": ALL}, "filter_query"),
713 Input({"type": "ctrl-dd", "index": ALL}, "value"),
714 Input({"type": "ctrl-cl", "index": ALL}, "value"),
715 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks")
718 def _update_application(
721 store_table_data: list,
729 """Update the application when the event is detected.
732 ctrl_panel = ControlPanel(CP_PARAMS, control_panel)
745 parsed_url = url_decode(href)
747 url_params = parsed_url["params"]
752 plotting_area = no_update
754 trigger = Trigger(callback_context.triggered)
755 if trigger.type == "url" and url_params:
758 selected = literal_eval(url_params["selected"][0])
759 r_sel = selected["reference"]["selection"]
760 c_sel = selected["compare"]
761 normalize = literal_eval(url_params["norm"][0])
763 (selected["reference"]["set"] == True) and
764 (c_sel["set"] == True)
766 except (KeyError, IndexError, AttributeError):
770 "dut-val": r_sel["dut"],
771 "dutver-opt": generate_options(
772 self._tbs[r_sel["dut"]].keys()
775 "dutver-val": r_sel["dutver"],
776 "infra-opt": generate_options(
777 self._tbs[r_sel["dut"]][r_sel["dutver"]].keys()
780 "infra-val": r_sel["infra"],
781 "core-opt": generate_options(
782 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
783 [r_sel["infra"]]["core"]
785 "core-val": r_sel["core"],
786 "frmsize-opt": generate_options(
787 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
788 [r_sel["infra"]]["fsize"]
790 "frmsize-val": r_sel["frmsize"],
791 "ttype-opt": generate_options(
792 self._tbs[r_sel["dut"]][r_sel["dutver"]]\
793 [r_sel["infra"]]["ttype"]
795 "ttype-val": r_sel["ttype"],
796 "normalize-val": normalize
799 for itm, label in CMP_PARAMS.items():
800 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
801 opts.append({"label": label, "value": itm})
804 "cmp-par-dis": False,
805 "cmp-par-val": c_sel["parameter"]
808 for itm in ctrl_panel.get(f"{c_sel['parameter']}-opt"):
809 set_val = ctrl_panel.get(f"{c_sel['parameter']}-val")
810 if isinstance(set_val, list):
811 if itm["value"] not in set_val:
814 if itm["value"] != set_val:
818 "cmp-val-dis": False,
819 "cmp-val-val": c_sel["value"]
822 elif trigger.type == "normalize":
823 ctrl_panel.set({"normalize-val": normalize})
825 elif trigger.type == "ctrl-dd":
826 if trigger.idx == "dut":
828 opts = generate_options(self._tbs[trigger.value].keys())
834 "dut-val": trigger.value,
836 "dutver-dis": disabled,
843 "frmsize-opt": list(),
844 "frmsize-val": list(),
847 "cmp-par-opt": list(),
849 "cmp-par-val": str(),
850 "cmp-val-opt": list(),
854 elif trigger.idx == "dutver":
856 dut = ctrl_panel.get("dut-val")
857 dver = self._tbs[dut][trigger.value]
858 opts = generate_options(dver.keys())
864 "dutver-val": trigger.value,
866 "infra-dis": disabled,
870 "frmsize-opt": list(),
871 "frmsize-val": list(),
874 "cmp-par-opt": list(),
876 "cmp-par-val": str(),
877 "cmp-val-opt": list(),
881 elif trigger.idx == "infra":
882 dut = ctrl_panel.get("dut-val")
883 dver = ctrl_panel.get("dutver-val")
884 if all((dut, dver, trigger.value, )):
885 driver = self._tbs[dut][dver][trigger.value]
887 "infra-val": trigger.value,
888 "core-opt": generate_options(driver["core"]),
890 "frmsize-opt": generate_options(driver["fsize"]),
891 "frmsize-val": list(),
892 "ttype-opt": generate_options(driver["ttype"]),
894 "cmp-par-opt": list(),
896 "cmp-par-val": str(),
897 "cmp-val-opt": list(),
901 elif trigger.idx == "cmpprm":
902 value = trigger.value
904 for itm in ctrl_panel.get(f"{value}-opt"):
905 set_val = ctrl_panel.get(f"{value}-val")
906 if isinstance(set_val, list):
907 if itm["value"] == "Latency":
909 if itm["value"] not in set_val:
912 if itm["value"] != set_val:
915 "cmp-par-val": value,
917 "cmp-val-dis": False,
920 elif trigger.idx == "cmpval":
921 ctrl_panel.set({"cmp-val-val": trigger.value})
922 selected["reference"] = {
925 "dut": ctrl_panel.get("dut-val"),
926 "dutver": ctrl_panel.get("dutver-val"),
927 "infra": ctrl_panel.get("infra-val"),
928 "core": ctrl_panel.get("core-val"),
929 "frmsize": ctrl_panel.get("frmsize-val"),
930 "ttype": ctrl_panel.get("ttype-val")
933 selected["compare"] = {
935 "parameter": ctrl_panel.get("cmp-par-val"),
936 "value": trigger.value
939 elif trigger.type == "ctrl-cl":
940 ctrl_panel.set({f"{trigger.idx}-val": trigger.value})
941 if all((ctrl_panel.get("core-val"),
942 ctrl_panel.get("frmsize-val"),
943 ctrl_panel.get("ttype-val"), )):
944 if "Latency" in ctrl_panel.get("ttype-val"):
945 ctrl_panel.set({"ttype-val": ["Latency", ]})
947 for itm, label in CMP_PARAMS.items():
948 if "Latency" in ctrl_panel.get("ttype-val") and \
951 if len(ctrl_panel.get(f"{itm}-opt")) > 1:
952 if isinstance(ctrl_panel.get(f"{itm}-val"), list):
953 if len(ctrl_panel.get(f"{itm}-opt")) == \
954 len(ctrl_panel.get(f"{itm}-val")):
956 opts.append({"label": label, "value": itm})
959 "cmp-par-dis": False,
960 "cmp-par-val": str(),
961 "cmp-val-opt": list(),
967 "cmp-par-opt": list(),
969 "cmp-par-val": str(),
970 "cmp-val-opt": list(),
974 elif trigger.type == "table" and trigger.idx == "comparison":
975 filtered_data = filter_table_data(
979 table_data = [filtered_data, ]
981 if all((on_draw, selected["reference"]["set"],
982 selected["compare"]["set"], )):
983 title, table = comparison_table(self._data, selected, normalize)
984 plotting_area = self._get_plotting_area(
989 params={"selected": selected, "norm": normalize}
992 store_table_data = table.to_dict("records")
993 filtered_data = store_table_data
995 table_data = [store_table_data, ]
1005 ret_val.extend(ctrl_panel.values)
1009 Output("plot-mod-url", "is_open"),
1010 Input("plot-btn-url", "n_clicks"),
1011 State("plot-mod-url", "is_open")
1013 def toggle_plot_mod_url(n, is_open):
1014 """Toggle the modal window with url.
1021 Output("download-iterative-data", "data"),
1022 State("store-table-data", "data"),
1023 State("store-filtered-table-data", "data"),
1024 Input("plot-btn-download", "n_clicks"),
1025 prevent_initial_call=True
1027 def _download_comparison_data(
1029 filtered_table_data: list,
1032 """Download the data.
1034 :param table_data: Original unfiltered table data.
1035 :param filtered_table_data: Filtered table data.
1036 :type table_data: list
1037 :type filtered_table_data: list
1038 :returns: dict of data frame content (base64 encoded) and meta data
1039 used by the Download component.
1046 if filtered_table_data:
1047 table = pd.DataFrame.from_records(filtered_table_data)
1049 table = pd.DataFrame.from_records(table_data)
1051 return dcc.send_data_frame(table.to_csv, C.COMP_DOWNLOAD_FILE_NAME)
1054 Output("offcanvas-documentation", "is_open"),
1055 Input("btn-documentation", "n_clicks"),
1056 State("offcanvas-documentation", "is_open")
1058 def toggle_offcanvas_documentation(n_clicks, is_open):