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.
15 """Plotly Dash HTML layout override.
20 import dash_bootstrap_components as dbc
22 from flask import Flask
25 from dash import callback_context, no_update, ALL
26 from dash import Input, Output, State
27 from dash.exceptions import PreventUpdate
28 from yaml import load, FullLoader, YAMLError
29 from ast import literal_eval
30 from copy import deepcopy
32 from ..utils.constants import Constants as C
33 from ..utils.control_panel import ControlPanel
34 from ..utils.trigger import Trigger
35 from ..utils.telemetry_data import TelemetryData
36 from ..utils.utils import show_tooltip, label, sync_checklists, gen_new_url, \
37 generate_options, get_list_group_items, graph_hdrh_latency
38 from ..utils.url_processing import url_decode
39 from .graphs import graph_trending, select_trending_data, graph_tm_trending
42 # Control panel partameters and their default values.
48 "dd-area-opt": list(),
51 "dd-test-opt": list(),
54 "cl-core-opt": list(),
55 "cl-core-val": list(),
56 "cl-core-all-val": list(),
57 "cl-core-all-opt": C.CL_ALL_DISABLED,
58 "cl-frmsize-opt": list(),
59 "cl-frmsize-val": list(),
60 "cl-frmsize-all-val": list(),
61 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
62 "cl-tsttype-opt": list(),
63 "cl-tsttype-val": list(),
64 "cl-tsttype-all-val": list(),
65 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
67 "cl-normalize-val": list()
72 """The layout of the dash app and the callbacks.
77 data_trending: pd.DataFrame,
78 html_layout_file: str,
79 graph_layout_file: str,
83 - save the input parameters,
84 - read and pre-process the data,
85 - prepare data for the control panel,
86 - read HTML layout file,
87 - read tooltips from the tooltip file.
89 :param app: Flask application running the dash application.
90 :param data_trending: Pandas dataframe with trending data.
91 :param html_layout_file: Path and name of the file specifying the HTML
92 layout of the dash application.
93 :param graph_layout_file: Path and name of the file with layout of
95 :param tooltip_file: Path and name of the yaml file specifying the
98 :type data_trending: pandas.DataFrame
99 :type html_layout_file: str
100 :type graph_layout_file: str
101 :type tooltip_file: str
106 self._data = data_trending
107 self._html_layout_file = html_layout_file
108 self._graph_layout_file = graph_layout_file
109 self._tooltip_file = tooltip_file
111 # Get structure of tests:
113 cols = ["job", "test_id", "test_type", "tg_type"]
114 for _, row in self._data[cols].drop_duplicates().iterrows():
115 lst_job = row["job"].split("-")
117 tbed = "-".join(lst_job[-2:])
118 lst_test = row["test_id"].split(".")
122 area = ".".join(lst_test[3:-2])
123 suite = lst_test[-2].replace("2n1l-", "").replace("1n1l-", "").\
126 nic = suite.split("-")[0]
127 for drv in C.DRIVERS:
133 test = test.replace(f"{drv}-", "")
137 infra = "-".join((tbed, nic, driver))
138 lst_test = test.split("-")
139 framesize = lst_test[0]
140 core = lst_test[1] if lst_test[1] else "8C"
141 test = "-".join(lst_test[2: -1])
143 if tbs.get(dut, None) is None:
145 if tbs[dut].get(infra, None) is None:
146 tbs[dut][infra] = dict()
147 if tbs[dut][infra].get(area, None) is None:
148 tbs[dut][infra][area] = dict()
149 if tbs[dut][infra][area].get(test, None) is None:
150 tbs[dut][infra][area][test] = dict()
151 tbs[dut][infra][area][test]["core"] = list()
152 tbs[dut][infra][area][test]["frame-size"] = list()
153 tbs[dut][infra][area][test]["test-type"] = list()
154 if core.upper() not in tbs[dut][infra][area][test]["core"]:
155 tbs[dut][infra][area][test]["core"].append(core.upper())
156 if framesize.upper() not in \
157 tbs[dut][infra][area][test]["frame-size"]:
158 tbs[dut][infra][area][test]["frame-size"].append(
161 if row["test_type"] == "mrr":
162 if "MRR" not in tbs[dut][infra][area][test]["test-type"]:
163 tbs[dut][infra][area][test]["test-type"].append("MRR")
164 elif row["test_type"] == "ndrpdr":
165 if "NDR" not in tbs[dut][infra][area][test]["test-type"]:
166 tbs[dut][infra][area][test]["test-type"].extend(
169 elif row["test_type"] == "hoststack":
170 if row["tg_type"] in ("iperf", "vpp"):
171 if "BPS" not in tbs[dut][infra][area][test]["test-type"]:
172 tbs[dut][infra][area][test]["test-type"].append("BPS")
173 elif row["tg_type"] == "ab":
174 if "CPS" not in tbs[dut][infra][area][test]["test-type"]:
175 tbs[dut][infra][area][test]["test-type"].extend(
181 self._html_layout = str()
182 self._graph_layout = None
183 self._tooltips = dict()
186 with open(self._html_layout_file, "r") as file_read:
187 self._html_layout = file_read.read()
188 except IOError as err:
190 f"Not possible to open the file {self._html_layout_file}\n{err}"
194 with open(self._graph_layout_file, "r") as file_read:
195 self._graph_layout = load(file_read, Loader=FullLoader)
196 except IOError as err:
198 f"Not possible to open the file {self._graph_layout_file}\n"
201 except YAMLError as err:
203 f"An error occurred while parsing the specification file "
204 f"{self._graph_layout_file}\n{err}"
208 with open(self._tooltip_file, "r") as file_read:
209 self._tooltips = load(file_read, Loader=FullLoader)
210 except IOError as err:
212 f"Not possible to open the file {self._tooltip_file}\n{err}"
214 except YAMLError as err:
216 f"An error occurred while parsing the specification file "
217 f"{self._tooltip_file}\n{err}"
221 if self._app is not None and hasattr(self, "callbacks"):
222 self.callbacks(self._app)
225 def html_layout(self):
226 return self._html_layout
228 def add_content(self):
229 """Top level method which generated the web page.
232 - Store for user input data,
234 - Main area with control panel and ploting area.
236 If no HTML layout is provided, an error message is displayed instead.
238 :returns: The HTML div with the whole page.
242 if self.html_layout and self._spec_tbs:
247 dcc.Store(id="store"),
248 dcc.Location(id="url", refresh=False),
260 self._add_ctrl_col(),
261 self._add_plotting_col()
267 id="offcanvas-metadata",
268 title="Throughput And Latency",
272 dbc.Row(id="metadata-tput-lat"),
273 dbc.Row(id="metadata-hdrh-graph")
276 delay_show=C.SPINNER_DELAY
293 def _add_navbar(self):
294 """Add nav element with navigation panel. It is placed on the top.
296 :returns: Navigation bar.
297 :rtype: dbc.NavbarSimple
299 return dbc.NavbarSimple(
300 id="navbarsimple-main",
313 brand_external_link=True,
318 def _add_ctrl_col(self) -> dbc.Col:
319 """Add column with controls. It is placed on the left side.
321 :returns: Column with the control panel.
326 children=self._add_ctrl_panel(),
327 className="sticky-top"
331 def _add_ctrl_panel(self) -> list:
332 """Add control panel.
334 :returns: Control panel.
339 class_name="g-0 p-1",
344 children=show_tooltip(
351 id={"type": "ctrl-dd", "index": "dut"},
352 placeholder="Select a Device under Test...",
355 {"label": k, "value": k} \
356 for k in self._spec_tbs.keys()
358 key=lambda d: d["label"]
367 class_name="g-0 p-1",
372 children=show_tooltip(
379 id={"type": "ctrl-dd", "index": "phy"},
381 "Select a Physical Test Bed Topology..."
389 class_name="g-0 p-1",
394 children=show_tooltip(
401 id={"type": "ctrl-dd", "index": "area"},
402 placeholder="Select an Area..."
410 class_name="g-0 p-1",
415 children=show_tooltip(
422 id={"type": "ctrl-dd", "index": "test"},
423 placeholder="Select a Test..."
431 class_name="g-0 p-1",
436 children=show_tooltip(
447 "index": "frmsize-all"
449 options=C.CL_ALL_DISABLED,
468 style={"align-items": "center"},
474 class_name="g-0 p-1",
479 children=show_tooltip(
492 options=C.CL_ALL_DISABLED,
511 style={"align-items": "center"},
517 class_name="g-0 p-1",
522 children=show_tooltip(
533 "index": "tsttype-all"
535 options=C.CL_ALL_DISABLED,
554 style={"align-items": "center"},
560 class_name="g-0 p-1",
565 children=show_tooltip(
576 "value": "normalize",
578 "Normalize to CPU frequency "
589 style={"align-items": "center"},
595 class_name="g-0 p-1",
598 id={"type": "ctrl-btn", "index": "add-test"},
599 children="Add Selected",
605 id="row-card-sel-tests",
606 class_name="g-0 p-1",
607 style=C.STYLE_DISABLED,
610 class_name="overflow-auto p-0",
613 style={"max-height": "20em"},
619 id="row-btns-sel-tests",
620 class_name="g-0 p-1",
621 style=C.STYLE_DISABLED,
626 id={"type": "ctrl-btn", "index": "rm-test"},
627 children="Remove Selected",
633 id={"type": "ctrl-btn", "index": "rm-test-all"},
634 children="Remove All",
644 id="row-btns-add-tm",
645 class_name="g-0 p-1",
646 style=C.STYLE_DISABLED,
650 id={"type": "telemetry-btn", "index": "open"},
651 children="Telemetry",
661 dbc.ModalHeader(dbc.ModalTitle("URL")),
662 dbc.ModalBody(id="mod-url")
673 def _add_plotting_col(self) -> dbc.Col:
674 """Add column with plots. It is placed on the right side.
676 :returns: Column with plots.
680 id="col-plotting-area",
684 id="plotting-area-trending",
685 class_name="g-0 p-0",
686 children=C.PLACEHOLDER
688 delay_show=C.SPINNER_DELAY
691 id="plotting-area-telemetry",
692 class_name="g-0 p-0",
693 children=C.PLACEHOLDER
697 style=C.STYLE_DISABLED,
700 def _plotting_area_trending(
705 """Generate the plotting area with all its content.
707 :param tests: A list of tests to be displayed in the trending graphs.
708 :param normalize: If True, the data in graphs is normalized.
710 :type normalize: bool
711 :returns: A collumn with trending graphs (tput and latency) in tabs.
717 figs = graph_trending(self._data, tests, self._graph_layout, normalize)
725 id={"type": "graph", "index": "tput"},
737 id={"type": "graph", "index": "lat"},
750 active_tab="tab-tput",
758 id="plot-btn-download",
759 children="Download Data",
762 style={"padding": "0rem 1rem"}
764 dcc.Download(id="download-trending-data")
767 "d-grid gap-0 d-md-flex justify-content-md-end"
784 class_name="g-0 p-1",
785 start_collapsed=False,
787 active_item=["item-0", ]
789 class_name="g-0 p-0",
794 dbc.ModalTitle("Select a Metric"),
798 dbc.ModalBody(self._get_telemetry_step_1()),
799 delay_show=2 * C.SPINNER_DELAY
804 id={"type": "telemetry-btn", "index": "select"},
809 id={"type": "telemetry-btn", "index": "cancel"},
814 id={"type": "telemetry-btn", "index": "remove"},
819 id={"type": "plot-mod-telemetry", "index": 0},
829 dbc.ModalTitle("Select Labels"),
833 dbc.ModalBody(self._get_telemetry_step_2()),
834 delay_show=2 * C.SPINNER_DELAY
839 id={"type": "telemetry-btn", "index": "back"},
844 id={"type": "telemetry-btn", "index": "add"},
849 id={"type": "telemetry-btn", "index": "cancel"},
854 id={"type": "plot-mod-telemetry", "index": 1},
864 def _plotting_area_telemetry(self, graphs: list) -> dbc.Col:
865 """Generate the plotting area with telemetry.
874 title=f"Telemetry: {graph[1]}" if graph[1] else "Telemetry",
876 id={"type": "graph-telemetry", "index": graph[1]},
887 class_name="g-0 p-1",
888 start_collapsed=False,
890 active_item=[f"item-{i}" for i in range(len(acc_items))]
892 class_name="g-0 p-0",
898 def _get_telemetry_step_1() -> list:
899 """Return the content of the modal window used in the step 1 of metrics
902 :returns: A list of dbc rows with 'input' and 'search output'.
907 class_name="g-0 p-1",
910 id={"type": "telemetry-search-in", "index": 0},
911 placeholder="Start typing a metric name...",
917 class_name="g-0 p-1",
920 class_name="overflow-auto p-0",
921 id={"type": "telemetry-search-out", "index": 0},
923 style={"max-height": "14em"},
931 def _get_telemetry_step_2() -> list:
932 """Return the content of the modal window used in the step 2 of metrics
935 :returns: A list of dbc rows with 'container with dynamic dropdowns' and
941 id={"type": "tm-container", "index": 0},
942 class_name="g-0 p-1",
943 children=["Add content here."]
946 class_name="g-0 p-2",
949 id={"type": "cb-all-in-one", "index": 0},
950 label="All Metrics in one Graph"
955 class_name="g-0 p-1",
958 id={"type": "tm-list-metrics", "index": 0},
968 def callbacks(self, app):
969 """Callbacks for the whole application.
971 :param app: The application.
976 Output("store", "data"),
977 Output("plotting-area-trending", "children"),
978 Output("plotting-area-telemetry", "children"),
979 Output("col-plotting-area", "style"),
980 Output("row-card-sel-tests", "style"),
981 Output("row-btns-sel-tests", "style"),
982 Output("row-btns-add-tm", "style"),
983 Output("lg-selected", "children"),
984 Output({"type": "telemetry-search-out", "index": ALL}, "children"),
985 Output({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
986 Output({"type": "telemetry-btn", "index": ALL}, "disabled"),
987 Output({"type": "tm-container", "index": ALL}, "children"),
988 Output({"type": "tm-list-metrics", "index": ALL}, "value"),
989 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
990 Output({"type": "ctrl-dd", "index": "phy"}, "options"),
991 Output({"type": "ctrl-dd", "index": "phy"}, "disabled"),
992 Output({"type": "ctrl-dd", "index": "phy"}, "value"),
993 Output({"type": "ctrl-dd", "index": "area"}, "options"),
994 Output({"type": "ctrl-dd", "index": "area"}, "disabled"),
995 Output({"type": "ctrl-dd", "index": "area"}, "value"),
996 Output({"type": "ctrl-dd", "index": "test"}, "options"),
997 Output({"type": "ctrl-dd", "index": "test"}, "disabled"),
998 Output({"type": "ctrl-dd", "index": "test"}, "value"),
999 Output({"type": "ctrl-cl", "index": "core"}, "options"),
1000 Output({"type": "ctrl-cl", "index": "core"}, "value"),
1001 Output({"type": "ctrl-cl", "index": "core-all"}, "value"),
1002 Output({"type": "ctrl-cl", "index": "core-all"}, "options"),
1003 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
1004 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
1005 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "value"),
1006 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "options"),
1007 Output({"type": "ctrl-cl", "index": "tsttype"}, "options"),
1008 Output({"type": "ctrl-cl", "index": "tsttype"}, "value"),
1009 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "value"),
1010 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "options"),
1011 Output({"type": "ctrl-btn", "index": "add-test"}, "disabled"),
1012 Output("normalize", "value"),
1014 State("store", "data"),
1015 State({"type": "sel-cl", "index": ALL}, "value"),
1016 State({"type": "cb-all-in-one", "index": ALL}, "value"),
1017 State({"type": "telemetry-search-out", "index": ALL}, "children"),
1018 State({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
1019 State({"type": "telemetry-btn", "index": ALL}, "disabled"),
1020 State({"type": "tm-container", "index": ALL}, "children"),
1021 State({"type": "tm-list-metrics", "index": ALL}, "value"),
1023 Input("url", "href"),
1024 Input({"type": "tele-cl", "index": ALL}, "value"),
1025 Input({"type": "tm-dd", "index": ALL}, "value"),
1027 Input("normalize", "value"),
1028 Input({"type": "telemetry-search-in", "index": ALL}, "value"),
1029 Input({"type": "telemetry-btn", "index": ALL}, "n_clicks"),
1030 Input({"type": "ctrl-dd", "index": ALL}, "value"),
1031 Input({"type": "ctrl-cl", "index": ALL}, "value"),
1032 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks"),
1034 prevent_initial_call=True
1036 def _update_application(
1042 tm_btns_disabled: list,
1050 """Update the application when the event is detected.
1055 "control-panel": dict(),
1056 "selected-tests": list(),
1057 "telemetry-data": dict(),
1058 "selected-metrics": dict(),
1062 ctrl_panel = ControlPanel(
1064 store.get("control-panel", dict())
1066 store_sel = store["selected-tests"]
1067 tm_data = store["telemetry-data"]
1068 tm_user = store["selected-metrics"]
1070 plotting_area_telemetry = no_update
1071 on_draw = [False, False] # 0 --> trending, 1 --> telemetry
1074 parsed_url = url_decode(href)
1076 url_params = parsed_url["params"]
1081 # Telemetry user data
1082 # The data provided by user or result of user action
1084 # List of unique metrics:
1085 "unique_metrics": list(),
1086 # List of metrics selected by user:
1087 "selected_metrics": list(),
1088 # Labels from metrics selected by user (key: label name,
1089 # value: list of all possible values):
1090 "unique_labels": dict(),
1091 # Labels selected by the user (subset of 'unique_labels'):
1092 "selected_labels": dict(),
1093 # All unique metrics with labels (output from the step 1)
1094 # converted from pandas dataframe to dictionary.
1095 "unique_metrics_with_labels": dict(),
1096 # Metrics with labels selected by the user using dropdowns.
1097 "selected_metrics_with_labels": dict()
1099 tm = TelemetryData(store_sel) if store_sel else TelemetryData()
1101 trigger = Trigger(callback_context.triggered)
1102 if trigger.type == "url" and url_params:
1105 store_sel = literal_eval(url_params["store_sel"][0])
1106 normalize = literal_eval(url_params["norm"][0])
1107 telemetry = literal_eval(url_params["telemetry"][0])
1108 all_in_one = literal_eval(url_params["all-in-one"][0])
1109 except (KeyError, IndexError, AttributeError):
1112 last_test = store_sel[-1]
1113 test = self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1114 [last_test["area"]][last_test["test"]]
1116 "dd-dut-val": last_test["dut"],
1117 "dd-phy-val": last_test["phy"],
1118 "dd-phy-opt": generate_options(
1119 self._spec_tbs[last_test["dut"]].keys()
1121 "dd-phy-dis": False,
1122 "dd-area-val": last_test["area"],
1124 {"label": label(v), "value": v} for v in sorted(
1125 self._spec_tbs[last_test["dut"]]\
1126 [last_test["phy"]].keys()
1129 "dd-area-dis": False,
1130 "dd-test-val": last_test["test"],
1131 "dd-test-opt": generate_options(
1132 self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1133 [last_test["area"]].keys()
1135 "dd-test-dis": False,
1136 "cl-core-opt": generate_options(test["core"]),
1137 "cl-core-val": [last_test["core"].upper(), ],
1138 "cl-core-all-val": list(),
1139 "cl-core-all-opt": C.CL_ALL_ENABLED,
1140 "cl-frmsize-opt": generate_options(test["frame-size"]),
1141 "cl-frmsize-val": [last_test["framesize"].upper(), ],
1142 "cl-frmsize-all-val": list(),
1143 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1144 "cl-tsttype-opt": generate_options(test["test-type"]),
1145 "cl-tsttype-val": [last_test["testtype"].upper(), ],
1146 "cl-tsttype-all-val": list(),
1147 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1148 "cl-normalize-val": normalize,
1149 "btn-add-dis": False
1153 tm = TelemetryData(store_sel)
1154 tm.from_dataframe(self._data)
1155 tm_data = tm.to_json()
1156 tm.from_json(tm_data)
1157 tm_user["selected_metrics_with_labels"] = telemetry
1159 elif trigger.type == "normalize":
1160 ctrl_panel.set({"cl-normalize-val": trigger.value})
1162 elif trigger.type == "ctrl-dd":
1163 if trigger.idx == "dut":
1165 options = generate_options(
1166 self._spec_tbs[trigger.value].keys()
1173 "dd-dut-val": trigger.value,
1174 "dd-phy-val": str(),
1175 "dd-phy-opt": options,
1176 "dd-phy-dis": disabled,
1177 "dd-area-val": str(),
1178 "dd-area-opt": list(),
1179 "dd-area-dis": True,
1180 "dd-test-val": str(),
1181 "dd-test-opt": list(),
1182 "dd-test-dis": True,
1183 "cl-core-opt": list(),
1184 "cl-core-val": list(),
1185 "cl-core-all-val": list(),
1186 "cl-core-all-opt": C.CL_ALL_DISABLED,
1187 "cl-frmsize-opt": list(),
1188 "cl-frmsize-val": list(),
1189 "cl-frmsize-all-val": list(),
1190 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1191 "cl-tsttype-opt": list(),
1192 "cl-tsttype-val": list(),
1193 "cl-tsttype-all-val": list(),
1194 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1197 elif trigger.idx == "phy":
1199 dut = ctrl_panel.get("dd-dut-val")
1200 phy = self._spec_tbs[dut][trigger.value]
1201 options = [{"label": label(v), "value": v} \
1202 for v in sorted(phy.keys())]
1208 "dd-phy-val": trigger.value,
1209 "dd-area-val": str(),
1210 "dd-area-opt": options,
1211 "dd-area-dis": disabled,
1212 "dd-test-val": str(),
1213 "dd-test-opt": list(),
1214 "dd-test-dis": True,
1215 "cl-core-opt": list(),
1216 "cl-core-val": list(),
1217 "cl-core-all-val": list(),
1218 "cl-core-all-opt": C.CL_ALL_DISABLED,
1219 "cl-frmsize-opt": list(),
1220 "cl-frmsize-val": list(),
1221 "cl-frmsize-all-val": list(),
1222 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1223 "cl-tsttype-opt": list(),
1224 "cl-tsttype-val": list(),
1225 "cl-tsttype-all-val": list(),
1226 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1229 elif trigger.idx == "area":
1231 dut = ctrl_panel.get("dd-dut-val")
1232 phy = ctrl_panel.get("dd-phy-val")
1233 area = self._spec_tbs[dut][phy][trigger.value]
1234 options = generate_options(area.keys())
1240 "dd-area-val": trigger.value,
1241 "dd-test-val": str(),
1242 "dd-test-opt": options,
1243 "dd-test-dis": disabled,
1244 "cl-core-opt": list(),
1245 "cl-core-val": list(),
1246 "cl-core-all-val": list(),
1247 "cl-core-all-opt": C.CL_ALL_DISABLED,
1248 "cl-frmsize-opt": list(),
1249 "cl-frmsize-val": list(),
1250 "cl-frmsize-all-val": list(),
1251 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1252 "cl-tsttype-opt": list(),
1253 "cl-tsttype-val": list(),
1254 "cl-tsttype-all-val": list(),
1255 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1258 elif trigger.idx == "test":
1259 dut = ctrl_panel.get("dd-dut-val")
1260 phy = ctrl_panel.get("dd-phy-val")
1261 area = ctrl_panel.get("dd-area-val")
1262 if all((dut, phy, area, trigger.value, )):
1263 test = self._spec_tbs[dut][phy][area][trigger.value]
1265 "dd-test-val": trigger.value,
1266 "cl-core-opt": generate_options(test["core"]),
1267 "cl-core-val": list(),
1268 "cl-core-all-val": list(),
1269 "cl-core-all-opt": C.CL_ALL_ENABLED,
1271 generate_options(test["frame-size"]),
1272 "cl-frmsize-val": list(),
1273 "cl-frmsize-all-val": list(),
1274 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1276 generate_options(test["test-type"]),
1277 "cl-tsttype-val": list(),
1278 "cl-tsttype-all-val": list(),
1279 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1282 elif trigger.type == "ctrl-cl":
1283 param = trigger.idx.split("-")[0]
1284 if "-all" in trigger.idx:
1285 c_sel, c_all, c_id = list(), trigger.value, "all"
1287 c_sel, c_all, c_id = trigger.value, list(), str()
1288 val_sel, val_all = sync_checklists(
1289 options=ctrl_panel.get(f"cl-{param}-opt"),
1295 f"cl-{param}-val": val_sel,
1296 f"cl-{param}-all-val": val_all,
1298 if all((ctrl_panel.get("cl-core-val"),
1299 ctrl_panel.get("cl-frmsize-val"),
1300 ctrl_panel.get("cl-tsttype-val"), )):
1301 ctrl_panel.set({"btn-add-dis": False})
1303 ctrl_panel.set({"btn-add-dis": True})
1304 elif trigger.type == "ctrl-btn":
1306 if trigger.idx == "add-test":
1307 dut = ctrl_panel.get("dd-dut-val")
1308 phy = ctrl_panel.get("dd-phy-val")
1309 area = ctrl_panel.get("dd-area-val")
1310 test = ctrl_panel.get("dd-test-val")
1311 # Add selected test(s) to the list of tests in store:
1312 if store_sel is None:
1314 for core in ctrl_panel.get("cl-core-val"):
1315 for framesize in ctrl_panel.get("cl-frmsize-val"):
1316 for ttype in ctrl_panel.get("cl-tsttype-val"):
1321 phy.replace('af_xdp', 'af-xdp'),
1328 if tid not in [i["id"] for i in store_sel]:
1335 "framesize": framesize.lower(),
1336 "core": core.lower(),
1337 "testtype": ttype.lower()
1339 store_sel = sorted(store_sel, key=lambda d: d["id"])
1340 if C.CLEAR_ALL_INPUTS:
1341 ctrl_panel.set(ctrl_panel.defaults)
1342 elif trigger.idx == "rm-test" and lst_sel:
1343 new_store_sel = list()
1344 for idx, item in enumerate(store_sel):
1345 if not lst_sel[idx]:
1346 new_store_sel.append(item)
1347 store_sel = new_store_sel
1348 elif trigger.idx == "rm-test-all":
1350 elif trigger.type == "telemetry-btn":
1351 if trigger.idx in ("open", "back"):
1352 tm.from_dataframe(self._data)
1353 tm_data = tm.to_json()
1354 tm_user["unique_metrics"] = tm.unique_metrics
1355 tm_user["selected_metrics"] = list()
1356 tm_user["unique_labels"] = dict()
1357 tm_user["selected_labels"] = dict()
1359 get_list_group_items(tm_user["unique_metrics"],
1362 is_open = (True, False)
1363 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1364 elif trigger.idx == "select":
1365 tm.from_json(tm_data)
1367 if not tm_user["selected_metrics"]:
1368 tm_user["selected_metrics"] = \
1369 tm_user["unique_metrics"]
1370 metrics = [a for a, b in \
1371 zip(tm_user["selected_metrics"], cl_metrics) if b]
1372 tm_user["selected_metrics"] = metrics
1373 tm_user["unique_labels"] = \
1374 tm.get_selected_labels(metrics)
1375 tm_user["unique_metrics_with_labels"] = \
1376 tm.unique_metrics_with_labels
1377 list_metrics[0] = tm.str_metrics
1378 tm_dd[0] = _get_dd_container(tm_user["unique_labels"])
1380 tm_btns_disabled[1] = True
1381 tm_btns_disabled[4] = False
1382 is_open = (False, True)
1385 is_open = (False, False)
1386 elif trigger.idx == "add":
1387 tm.from_json(tm_data)
1388 is_open = (False, False)
1389 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1390 on_draw = [True, True]
1391 elif trigger.idx == "cancel":
1392 is_open = (False, False)
1393 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1394 elif trigger.idx == "remove":
1396 is_open = (False, False)
1397 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1398 plotting_area_telemetry = C.PLACEHOLDER
1399 elif trigger.type == "telemetry-search-in":
1400 tm.from_metrics(tm_user["unique_metrics"])
1401 tm_user["selected_metrics"] = \
1402 tm.search_unique_metrics(trigger.value)
1403 search_out = (get_list_group_items(
1404 tm_user["selected_metrics"],
1408 is_open = (True, False)
1409 elif trigger.type == "tele-cl":
1411 tm_btns_disabled[1] = False
1413 tm_btns_disabled[1] = True
1414 is_open = (True, False)
1415 elif trigger.type == "tm-dd":
1416 tm.from_metrics_with_labels(
1417 tm_user["unique_metrics_with_labels"]
1421 for itm in tm_dd_in:
1424 elif isinstance(itm, str):
1426 selected[itm] = list()
1427 elif isinstance(itm, list):
1428 if previous_itm is not None:
1429 selected[previous_itm] = itm
1432 tm_dd[0] = _get_dd_container(
1433 tm_user["unique_labels"],
1437 sel_metrics = tm.filter_selected_metrics_by_labels(selected)
1438 tm_user["selected_metrics_with_labels"] = sel_metrics.to_dict()
1439 if not sel_metrics.empty:
1440 list_metrics[0] = tm.metrics_to_str(sel_metrics)
1441 tm_btns_disabled[5] = False
1443 list_metrics[0] = str()
1446 "store_sel": store_sel,
1447 "norm": ctrl_panel.get("cl-normalize-val")
1449 if tm_user and tm_user.get("selected_metrics_with_labels", None):
1450 new_url_params["telemetry"] = \
1451 tm_user["selected_metrics_with_labels"]
1452 new_url_params["all-in-one"] = all_in_one
1454 if on_draw[0]: # Trending
1456 lg_selected = get_list_group_items(store_sel, "sel-cl")
1457 plotting_area_trending = self._plotting_area_trending(
1459 bool(ctrl_panel.get("cl-normalize-val"))
1461 if on_draw[1]: # Telemetry
1462 plotting_area_telemetry = self._plotting_area_telemetry(
1464 tm.select_tm_trending_data(
1465 tm_user["selected_metrics_with_labels"]
1468 False if not all_in_one else all_in_one[0]
1471 col_plotting_area = C.STYLE_ENABLED
1472 row_card_sel_tests = C.STYLE_ENABLED
1473 row_btns_sel_tests = C.STYLE_ENABLED
1474 row_btns_add_tm = C.STYLE_ENABLED
1476 plotting_area_trending = no_update
1477 plotting_area_telemetry = C.PLACEHOLDER
1478 col_plotting_area = C.STYLE_DISABLED
1479 row_card_sel_tests = C.STYLE_DISABLED
1480 row_btns_sel_tests = C.STYLE_DISABLED
1481 row_btns_add_tm = C.STYLE_DISABLED
1482 lg_selected = no_update
1486 plotting_area_trending = no_update
1487 col_plotting_area = no_update
1488 row_card_sel_tests = no_update
1489 row_btns_sel_tests = no_update
1490 row_btns_add_tm = no_update
1491 lg_selected = no_update
1493 store["url"] = gen_new_url(parsed_url, new_url_params)
1494 store["control-panel"] = ctrl_panel.panel
1495 store["selected-tests"] = store_sel
1496 store["telemetry-data"] = tm_data
1497 store["selected-metrics"] = tm_user
1500 plotting_area_trending,
1501 plotting_area_telemetry,
1513 ret_val.extend(ctrl_panel.values)
1517 Output("plot-mod-url", "is_open"),
1518 Output("mod-url", "children"),
1519 State("store", "data"),
1520 State("plot-mod-url", "is_open"),
1521 Input("plot-btn-url", "n_clicks")
1523 def toggle_plot_mod_url(store, is_open, n_clicks):
1524 """Toggle the modal window with url.
1530 return not is_open, store.get("url", str())
1531 return is_open, store["url"]
1533 def _get_dd_container(
1535 selected_labels: dict=dict(),
1538 """Generate a container with dropdown selection boxes depenting on
1541 :param all_labels: A dictionary with unique labels and their
1543 :param selected_labels: A dictionalry with user selected lables and
1545 :param show_new: If True, a dropdown selection box to add a new
1547 :type all_labels: dict
1548 :type selected_labels: dict
1549 :type show_new: bool
1550 :returns: A list of dbc rows with dropdown selection boxes.
1561 """Generates a dbc row with dropdown boxes.
1563 :param id: A string added to the dropdown ID.
1564 :param lopts: A list of options for 'label' dropdown.
1565 :param lval: Value of 'label' dropdown.
1566 :param vopts: A list of options for 'value' dropdown.
1567 :param vvals: A list of values for 'value' dropdown.
1573 :returns: dbc row with dropdown boxes.
1585 "index": f"label-{id}"
1587 placeholder="Select a label...",
1591 value=lval if lval else None
1604 "index": f"value-{id}"
1606 placeholder="Select a value...",
1610 value=vvals if vvals else None
1616 return dbc.Row(class_name="g-0 p-1", children=children)
1620 # Display rows with items in 'selected_labels'; label on the left,
1621 # values on the right:
1622 keys_left = list(all_labels.keys())
1623 for idx, label in enumerate(selected_labels.keys()):
1624 container.append(_row(
1626 lopts=deepcopy(keys_left),
1628 vopts=all_labels[label],
1629 vvals=selected_labels[label]
1631 keys_left.remove(label)
1633 # Display row with dd with labels on the left, right side is empty:
1634 if show_new and keys_left:
1635 container.append(_row(id="new", lopts=keys_left))
1640 Output("metadata-tput-lat", "children"),
1641 Output("metadata-hdrh-graph", "children"),
1642 Output("offcanvas-metadata", "is_open"),
1643 Input({"type": "graph", "index": ALL}, "clickData"),
1644 prevent_initial_call=True
1646 def _show_metadata_from_graphs(graph_data: dict) -> tuple:
1647 """Generates the data for the offcanvas displayed when a particular
1648 point in a graph is clicked on.
1650 :param graph_data: The data from the clicked point in the graph.
1651 :type graph_data: dict
1652 :returns: The data to be displayed on the offcanvas and the
1653 information to show the offcanvas.
1654 :rtype: tuple(list, list, bool)
1657 trigger = Trigger(callback_context.triggered)
1660 idx = 0 if trigger.idx == "tput" else 1
1661 graph_data = graph_data[idx]["points"][0]
1662 except (IndexError, KeyError, ValueError, TypeError):
1665 metadata = no_update
1670 [dbc.Badge(x.split(":")[0]), x.split(": ")[1]]
1671 ) for x in graph_data.get("text", "").split("<br>")
1673 if trigger.idx == "tput":
1674 title = "Throughput"
1675 elif trigger.idx == "lat":
1677 hdrh_data = graph_data.get("customdata", None)
1680 class_name="gy-2 p-0",
1682 dbc.CardHeader(hdrh_data.pop("name")),
1683 dbc.CardBody(children=[
1685 id="hdrh-latency-graph",
1686 figure=graph_hdrh_latency(
1687 hdrh_data, self._graph_layout
1698 class_name="gy-2 p-0",
1700 dbc.CardHeader(children=[
1702 target_id="tput-lat-metadata",
1704 style={"display": "inline-block"}
1709 id="tput-lat-metadata",
1711 children=[dbc.ListGroup(children, flush=True), ]
1717 return metadata, graph, True
1720 Output("download-trending-data", "data"),
1721 State("store", "data"),
1722 Input("plot-btn-download", "n_clicks"),
1723 prevent_initial_call=True
1725 def _download_trending_data(store: list, _) -> dict:
1726 """Download the data
1728 :param store_sel: List of tests selected by user stored in the
1730 :type store_sel: list
1731 :returns: dict of data frame content (base64 encoded) and meta data
1732 used by the Download component.
1738 if not store["selected-tests"]:
1742 for itm in store["selected-tests"]:
1743 sel_data = select_trending_data(self._data, itm)
1744 if sel_data is None:
1746 df = pd.concat([df, sel_data], ignore_index=True, copy=False)
1748 return dcc.send_data_frame(df.to_csv, C.TREND_DOWNLOAD_FILE_NAME)