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-selected-tests"),
248 dcc.Store(id="store-control-panel"),
249 dcc.Store(id="store-telemetry-data"),
250 dcc.Store(id="store-telemetry-user"),
251 dcc.Location(id="url", refresh=False),
263 self._add_ctrl_col(),
264 self._add_plotting_col()
270 id="offcanvas-metadata",
271 title="Throughput And Latency",
275 dbc.Row(id="metadata-tput-lat"),
276 dbc.Row(id="metadata-hdrh-graph")
279 delay_show=C.SPINNER_DELAY
296 def _add_navbar(self):
297 """Add nav element with navigation panel. It is placed on the top.
299 :returns: Navigation bar.
300 :rtype: dbc.NavbarSimple
302 return dbc.NavbarSimple(
303 id="navbarsimple-main",
316 brand_external_link=True,
321 def _add_ctrl_col(self) -> dbc.Col:
322 """Add column with controls. It is placed on the left side.
324 :returns: Column with the control panel.
329 children=self._add_ctrl_panel(),
330 className="sticky-top"
334 def _add_ctrl_panel(self) -> list:
335 """Add control panel.
337 :returns: Control panel.
342 class_name="g-0 p-1",
347 children=show_tooltip(
354 id={"type": "ctrl-dd", "index": "dut"},
355 placeholder="Select a Device under Test...",
358 {"label": k, "value": k} \
359 for k in self._spec_tbs.keys()
361 key=lambda d: d["label"]
370 class_name="g-0 p-1",
375 children=show_tooltip(
382 id={"type": "ctrl-dd", "index": "phy"},
384 "Select a Physical Test Bed Topology..."
392 class_name="g-0 p-1",
397 children=show_tooltip(
404 id={"type": "ctrl-dd", "index": "area"},
405 placeholder="Select an Area..."
413 class_name="g-0 p-1",
418 children=show_tooltip(
425 id={"type": "ctrl-dd", "index": "test"},
426 placeholder="Select a Test..."
434 class_name="g-0 p-1",
439 children=show_tooltip(
450 "index": "frmsize-all"
452 options=C.CL_ALL_DISABLED,
471 style={"align-items": "center"},
477 class_name="g-0 p-1",
482 children=show_tooltip(
495 options=C.CL_ALL_DISABLED,
514 style={"align-items": "center"},
520 class_name="g-0 p-1",
525 children=show_tooltip(
536 "index": "tsttype-all"
538 options=C.CL_ALL_DISABLED,
557 style={"align-items": "center"},
563 class_name="g-0 p-1",
568 children=show_tooltip(
579 "value": "normalize",
581 "Normalize to CPU frequency "
592 style={"align-items": "center"},
598 class_name="g-0 p-1",
601 id={"type": "ctrl-btn", "index": "add-test"},
602 children="Add Selected",
608 id="row-card-sel-tests",
609 class_name="g-0 p-1",
610 style=C.STYLE_DISABLED,
613 class_name="overflow-auto p-0",
616 style={"max-height": "20em"},
622 id="row-btns-sel-tests",
623 class_name="g-0 p-1",
624 style=C.STYLE_DISABLED,
629 id={"type": "ctrl-btn", "index": "rm-test"},
630 children="Remove Selected",
636 id={"type": "ctrl-btn", "index": "rm-test-all"},
637 children="Remove All",
648 def _add_plotting_col(self) -> dbc.Col:
649 """Add column with plots. It is placed on the right side.
651 :returns: Column with plots.
655 id="col-plotting-area",
659 id="plotting-area-trending",
660 class_name="g-0 p-0",
661 children=C.PLACEHOLDER
663 delay_show=C.SPINNER_DELAY
666 id="plotting-area-telemetry",
667 class_name="g-0 p-0",
668 children=C.PLACEHOLDER
671 id="plotting-area-buttons",
672 class_name="g-0 p-0",
673 children=C.PLACEHOLDER
679 def _get_plotting_area_buttons(self) -> dbc.Col:
680 """Add buttons and modals to the plotting area.
682 :returns: A column with buttons and modals for telemetry.
689 id={"type": "telemetry-btn", "index": "open"},
690 children="Add Panel with Telemetry",
694 "text-transform": "none",
695 "padding": "0rem 1rem"
708 id="plot-mod-telemetry-body-1",
709 children=self._get_telemetry_step_1()
711 delay_show=2*C.SPINNER_DELAY
717 "type": "telemetry-btn",
725 "type": "telemetry-btn",
732 id="plot-mod-telemetry-1",
749 id="plot-mod-telemetry-body-2",
750 children=self._get_telemetry_step_2()
752 delay_show=2*C.SPINNER_DELAY
758 "type": "telemetry-btn",
766 "type": "telemetry-btn",
774 "type": "telemetry-btn",
781 id="plot-mod-telemetry-2",
789 className="d-grid gap-0 d-md-flex justify-content-md-end"
793 def _get_plotting_area_trending(
799 """Generate the plotting area with all its content.
801 :param tests: A list of tests to be displayed in the trending graphs.
802 :param normalize: If True, the data in graphs is normalized.
803 :param url: An URL to be displayed in the modal window.
805 :type normalize: bool
807 :returns: A collumn with trending graphs (tput and latency) in tabs.
813 figs = graph_trending(self._data, tests, self._graph_layout, normalize)
821 id={"type": "graph", "index": "tput"},
833 id={"type": "graph", "index": "lat"},
846 active_tab="tab-tput",
859 "text-transform": "none",
860 "padding": "0rem 1rem"
865 dbc.ModalHeader(dbc.ModalTitle("URL")),
874 id="plot-btn-download",
875 children="Download Data",
879 "text-transform": "none",
880 "padding": "0rem 1rem"
883 dcc.Download(id="download-trending-data")
886 "d-grid gap-0 d-md-flex justify-content-md-end"
903 class_name="g-0 p-1",
904 start_collapsed=False,
906 active_item=["item-0", ]
908 class_name="g-0 p-0",
913 def _get_plotting_area_telemetry(self, graphs: list) -> dbc.Col:
914 """Generate the plotting area with telemetry.
923 title=f"Telemetry: {graph[1]}" if graph[1] else "Telemetry",
925 id={"type": "graph-telemetry", "index": graph[1]},
936 class_name="g-0 p-1",
937 start_collapsed=False,
939 active_item=[f"item-{i}" for i in range(len(acc_items))]
941 class_name="g-0 p-0",
947 def _get_telemetry_step_1() -> list:
948 """Return the content of the modal window used in the step 1 of metrics
951 :returns: A list of dbc rows with 'input' and 'search output'.
956 class_name="g-0 p-1",
959 id="telemetry-search-in",
960 placeholder="Start typing a metric name...",
966 class_name="g-0 p-1",
969 class_name="overflow-auto p-0",
970 id="telemetry-search-out",
972 style={"max-height": "14em"},
980 def _get_telemetry_step_2() -> list:
981 """Return the content of the modal window used in the step 2 of metrics
984 :returns: A list of dbc rows with 'container with dynamic dropdowns' and
991 class_name="g-0 p-1",
992 children=["Add content here."]
995 id="telemetry-all-in-one",
996 class_name="g-0 p-2",
1000 label="All Metrics in one Graph"
1005 class_name="g-0 p-1",
1008 id="telemetry-list-metrics",
1018 def callbacks(self, app):
1019 """Callbacks for the whole application.
1021 :param app: The application.
1027 Output("store-control-panel", "data"),
1028 Output("store-selected-tests", "data"),
1029 Output("plotting-area-trending", "children"),
1030 Output("plotting-area-buttons", "children"),
1031 Output("row-card-sel-tests", "style"),
1032 Output("row-btns-sel-tests", "style"),
1033 Output("lg-selected", "children"),
1034 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
1035 Output({"type": "ctrl-dd", "index": "phy"}, "options"),
1036 Output({"type": "ctrl-dd", "index": "phy"}, "disabled"),
1037 Output({"type": "ctrl-dd", "index": "phy"}, "value"),
1038 Output({"type": "ctrl-dd", "index": "area"}, "options"),
1039 Output({"type": "ctrl-dd", "index": "area"}, "disabled"),
1040 Output({"type": "ctrl-dd", "index": "area"}, "value"),
1041 Output({"type": "ctrl-dd", "index": "test"}, "options"),
1042 Output({"type": "ctrl-dd", "index": "test"}, "disabled"),
1043 Output({"type": "ctrl-dd", "index": "test"}, "value"),
1044 Output({"type": "ctrl-cl", "index": "core"}, "options"),
1045 Output({"type": "ctrl-cl", "index": "core"}, "value"),
1046 Output({"type": "ctrl-cl", "index": "core-all"}, "value"),
1047 Output({"type": "ctrl-cl", "index": "core-all"}, "options"),
1048 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
1049 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
1050 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "value"),
1051 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "options"),
1052 Output({"type": "ctrl-cl", "index": "tsttype"}, "options"),
1053 Output({"type": "ctrl-cl", "index": "tsttype"}, "value"),
1054 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "value"),
1055 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "options"),
1056 Output({"type": "ctrl-btn", "index": "add-test"}, "disabled"),
1057 Output("normalize", "value")
1060 State("store-control-panel", "data"),
1061 State("store-selected-tests", "data"),
1062 State({"type": "sel-cl", "index": ALL}, "value")
1065 Input("url", "href"),
1066 Input("normalize", "value"),
1067 Input({"type": "ctrl-dd", "index": ALL}, "value"),
1068 Input({"type": "ctrl-cl", "index": ALL}, "value"),
1069 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks")
1071 prevent_initial_call=True
1073 def _update_application(
1074 control_panel: dict,
1081 """Update the application when the event is detected.
1084 ctrl_panel = ControlPanel(CP_PARAMS, control_panel)
1088 parsed_url = url_decode(href)
1090 url_params = parsed_url["params"]
1094 trigger = Trigger(callback_context.triggered)
1096 if trigger.type == "url" and url_params:
1098 store_sel = literal_eval(url_params["store_sel"][0])
1099 normalize = literal_eval(url_params["norm"][0])
1100 except (KeyError, IndexError, AttributeError):
1103 last_test = store_sel[-1]
1104 test = self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1105 [last_test["area"]][last_test["test"]]
1107 "dd-dut-val": last_test["dut"],
1108 "dd-phy-val": last_test["phy"],
1109 "dd-phy-opt": generate_options(
1110 self._spec_tbs[last_test["dut"]].keys()
1112 "dd-phy-dis": False,
1113 "dd-area-val": last_test["area"],
1115 {"label": label(v), "value": v} for v in sorted(
1116 self._spec_tbs[last_test["dut"]]\
1117 [last_test["phy"]].keys()
1120 "dd-area-dis": False,
1121 "dd-test-val": last_test["test"],
1122 "dd-test-opt": generate_options(
1123 self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1124 [last_test["area"]].keys()
1126 "dd-test-dis": False,
1127 "cl-core-opt": generate_options(test["core"]),
1128 "cl-core-val": [last_test["core"].upper(), ],
1129 "cl-core-all-val": list(),
1130 "cl-core-all-opt": C.CL_ALL_ENABLED,
1131 "cl-frmsize-opt": generate_options(test["frame-size"]),
1132 "cl-frmsize-val": [last_test["framesize"].upper(), ],
1133 "cl-frmsize-all-val": list(),
1134 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1135 "cl-tsttype-opt": generate_options(test["test-type"]),
1136 "cl-tsttype-val": [last_test["testtype"].upper(), ],
1137 "cl-tsttype-all-val": list(),
1138 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1139 "cl-normalize-val": normalize,
1140 "btn-add-dis": False
1143 elif trigger.type == "normalize":
1144 ctrl_panel.set({"cl-normalize-val": normalize})
1146 elif trigger.type == "ctrl-dd":
1147 if trigger.idx == "dut":
1149 options = generate_options(
1150 self._spec_tbs[trigger.value].keys()
1157 "dd-dut-val": trigger.value,
1158 "dd-phy-val": str(),
1159 "dd-phy-opt": options,
1160 "dd-phy-dis": disabled,
1161 "dd-area-val": str(),
1162 "dd-area-opt": list(),
1163 "dd-area-dis": True,
1164 "dd-test-val": str(),
1165 "dd-test-opt": list(),
1166 "dd-test-dis": True,
1167 "cl-core-opt": list(),
1168 "cl-core-val": list(),
1169 "cl-core-all-val": list(),
1170 "cl-core-all-opt": C.CL_ALL_DISABLED,
1171 "cl-frmsize-opt": list(),
1172 "cl-frmsize-val": list(),
1173 "cl-frmsize-all-val": list(),
1174 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1175 "cl-tsttype-opt": list(),
1176 "cl-tsttype-val": list(),
1177 "cl-tsttype-all-val": list(),
1178 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1181 elif trigger.idx == "phy":
1183 dut = ctrl_panel.get("dd-dut-val")
1184 phy = self._spec_tbs[dut][trigger.value]
1185 options = [{"label": label(v), "value": v} \
1186 for v in sorted(phy.keys())]
1192 "dd-phy-val": trigger.value,
1193 "dd-area-val": str(),
1194 "dd-area-opt": options,
1195 "dd-area-dis": disabled,
1196 "dd-test-val": str(),
1197 "dd-test-opt": list(),
1198 "dd-test-dis": True,
1199 "cl-core-opt": list(),
1200 "cl-core-val": list(),
1201 "cl-core-all-val": list(),
1202 "cl-core-all-opt": C.CL_ALL_DISABLED,
1203 "cl-frmsize-opt": list(),
1204 "cl-frmsize-val": list(),
1205 "cl-frmsize-all-val": list(),
1206 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1207 "cl-tsttype-opt": list(),
1208 "cl-tsttype-val": list(),
1209 "cl-tsttype-all-val": list(),
1210 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1213 elif trigger.idx == "area":
1215 dut = ctrl_panel.get("dd-dut-val")
1216 phy = ctrl_panel.get("dd-phy-val")
1217 area = self._spec_tbs[dut][phy][trigger.value]
1218 options = generate_options(area.keys())
1224 "dd-area-val": trigger.value,
1225 "dd-test-val": str(),
1226 "dd-test-opt": options,
1227 "dd-test-dis": disabled,
1228 "cl-core-opt": list(),
1229 "cl-core-val": list(),
1230 "cl-core-all-val": list(),
1231 "cl-core-all-opt": C.CL_ALL_DISABLED,
1232 "cl-frmsize-opt": list(),
1233 "cl-frmsize-val": list(),
1234 "cl-frmsize-all-val": list(),
1235 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1236 "cl-tsttype-opt": list(),
1237 "cl-tsttype-val": list(),
1238 "cl-tsttype-all-val": list(),
1239 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1242 elif trigger.idx == "test":
1243 dut = ctrl_panel.get("dd-dut-val")
1244 phy = ctrl_panel.get("dd-phy-val")
1245 area = ctrl_panel.get("dd-area-val")
1246 if all((dut, phy, area, trigger.value, )):
1247 test = self._spec_tbs[dut][phy][area][trigger.value]
1249 "dd-test-val": trigger.value,
1250 "cl-core-opt": generate_options(test["core"]),
1251 "cl-core-val": list(),
1252 "cl-core-all-val": list(),
1253 "cl-core-all-opt": C.CL_ALL_ENABLED,
1255 generate_options(test["frame-size"]),
1256 "cl-frmsize-val": list(),
1257 "cl-frmsize-all-val": list(),
1258 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1260 generate_options(test["test-type"]),
1261 "cl-tsttype-val": list(),
1262 "cl-tsttype-all-val": list(),
1263 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1266 elif trigger.type == "ctrl-cl":
1267 param = trigger.idx.split("-")[0]
1268 if "-all" in trigger.idx:
1269 c_sel, c_all, c_id = list(), trigger.value, "all"
1271 c_sel, c_all, c_id = trigger.value, list(), str()
1272 val_sel, val_all = sync_checklists(
1273 options=ctrl_panel.get(f"cl-{param}-opt"),
1279 f"cl-{param}-val": val_sel,
1280 f"cl-{param}-all-val": val_all,
1282 if all((ctrl_panel.get("cl-core-val"),
1283 ctrl_panel.get("cl-frmsize-val"),
1284 ctrl_panel.get("cl-tsttype-val"), )):
1285 ctrl_panel.set({"btn-add-dis": False})
1287 ctrl_panel.set({"btn-add-dis": True})
1288 elif trigger.type == "ctrl-btn":
1290 if trigger.idx == "add-test":
1291 dut = ctrl_panel.get("dd-dut-val")
1292 phy = ctrl_panel.get("dd-phy-val")
1293 area = ctrl_panel.get("dd-area-val")
1294 test = ctrl_panel.get("dd-test-val")
1295 # Add selected test(s) to the list of tests in store:
1296 if store_sel is None:
1298 for core in ctrl_panel.get("cl-core-val"):
1299 for framesize in ctrl_panel.get("cl-frmsize-val"):
1300 for ttype in ctrl_panel.get("cl-tsttype-val"):
1305 phy.replace('af_xdp', 'af-xdp'),
1312 if tid not in [i["id"] for i in store_sel]:
1319 "framesize": framesize.lower(),
1320 "core": core.lower(),
1321 "testtype": ttype.lower()
1323 store_sel = sorted(store_sel, key=lambda d: d["id"])
1324 if C.CLEAR_ALL_INPUTS:
1325 ctrl_panel.set(ctrl_panel.defaults)
1326 elif trigger.idx == "rm-test" and lst_sel:
1327 new_store_sel = list()
1328 for idx, item in enumerate(store_sel):
1329 if not lst_sel[idx]:
1330 new_store_sel.append(item)
1331 store_sel = new_store_sel
1332 elif trigger.idx == "rm-test-all":
1337 lg_selected = get_list_group_items(store_sel, "sel-cl")
1338 plotting_area_trending = self._get_plotting_area_trending(
1343 {"store_sel": store_sel, "norm": normalize}
1346 plotting_area_buttons = self._get_plotting_area_buttons()
1347 row_card_sel_tests = C.STYLE_ENABLED
1348 row_btns_sel_tests = C.STYLE_ENABLED
1350 plotting_area_trending = C.PLACEHOLDER
1351 plotting_area_buttons = C.PLACEHOLDER
1352 row_card_sel_tests = C.STYLE_DISABLED
1353 row_btns_sel_tests = C.STYLE_DISABLED
1354 lg_selected = no_update
1357 plotting_area_trending = no_update
1358 plotting_area_buttons = no_update
1359 row_card_sel_tests = no_update
1360 row_btns_sel_tests = no_update
1361 lg_selected = no_update
1366 plotting_area_trending,
1367 plotting_area_buttons,
1372 ret_val.extend(ctrl_panel.values)
1376 Output("plot-mod-url", "is_open"),
1377 Input("plot-btn-url", "n_clicks"),
1378 State("plot-mod-url", "is_open")
1380 def toggle_plot_mod_url(n, is_open):
1381 """Toggle the modal window with url.
1388 Output("store-telemetry-data", "data"),
1389 Output("store-telemetry-user", "data"),
1390 Output("telemetry-search-in", "value"),
1391 Output("telemetry-search-out", "children"),
1392 Output("telemetry-list-metrics", "value"),
1393 Output("telemetry-dd", "children"),
1394 Output("plotting-area-telemetry", "children"),
1395 Output("plot-mod-telemetry-1", "is_open"),
1396 Output("plot-mod-telemetry-2", "is_open"),
1397 Output({"type": "telemetry-btn", "index": "select"}, "disabled"),
1398 Output({"type": "telemetry-btn", "index": "add"}, "disabled"),
1399 State("store-telemetry-data", "data"),
1400 State("store-telemetry-user", "data"),
1401 State("store-selected-tests", "data"),
1402 State("cb-all-in-one", "value"),
1403 Input({"type": "tele-cl", "index": ALL}, "value"),
1404 Input("telemetry-search-in", "value"),
1405 Input({"type": "telemetry-btn", "index": ALL}, "n_clicks"),
1406 Input({"type": "tm-dd", "index": ALL}, "value"),
1407 prevent_initial_call=True
1409 def _update_plot_mod_telemetry(
1419 """Toggle the modal window with telemetry.
1422 if not any(n_clicks):
1426 # Telemetry user data
1427 # The data provided by user or result of user action
1429 # List of unique metrics:
1430 "unique_metrics": list(),
1431 # List of metrics selected by user:
1432 "selected_metrics": list(),
1433 # Labels from metrics selected by user (key: label name,
1434 # value: list of all possible values):
1435 "unique_labels": dict(),
1436 # Labels selected by the user (subset of 'unique_labels'):
1437 "selected_labels": dict(),
1438 # All unique metrics with labels (output from the step 1)
1439 # converted from pandas dataframe to dictionary.
1440 "unique_metrics_with_labels": dict(),
1441 # Metrics with labels selected by the user using dropdowns.
1442 "selected_metrics_with_labels": dict()
1445 tm = TelemetryData(tests=store_sel)
1447 search_out = no_update
1448 list_metrics = no_update
1450 plotting_area_telemetry = no_update
1451 is_open = (False, False)
1452 is_btn_disabled = (True, True)
1454 trigger = Trigger(callback_context.triggered)
1455 if trigger.type == "telemetry-btn":
1456 if trigger.idx in ("open", "back"):
1457 tm.from_dataframe(self._data)
1458 tm_json = tm.to_json()
1459 tm_user["unique_metrics"] = tm.unique_metrics
1460 tm_user["selected_metrics"] = list()
1461 tm_user["unique_labels"] = dict()
1462 tm_user["selected_labels"] = dict()
1464 search_out = get_list_group_items(
1465 tm_user["unique_metrics"],
1469 is_open = (True, False)
1470 elif trigger.idx == "select":
1471 tm.from_json(tm_data)
1473 if not tm_user["selected_metrics"]:
1474 tm_user["selected_metrics"] = \
1475 tm_user["unique_metrics"]
1476 metrics = [a for a, b in \
1477 zip(tm_user["selected_metrics"], cl_metrics) if b]
1478 tm_user["selected_metrics"] = metrics
1479 tm_user["unique_labels"] = \
1480 tm.get_selected_labels(metrics)
1481 tm_user["unique_metrics_with_labels"] = \
1482 tm.unique_metrics_with_labels
1483 list_metrics = tm.str_metrics
1484 tm_dd = _get_dd_container(tm_user["unique_labels"])
1486 is_btn_disabled = (True, False)
1487 is_open = (False, True)
1490 is_open = (False, False)
1491 elif trigger.idx == "add":
1492 tm.from_json(tm_data)
1493 plotting_area_telemetry = self._get_plotting_area_telemetry(
1495 tm.select_tm_trending_data(
1496 tm_user["selected_metrics_with_labels"]
1503 is_open = (False, False)
1504 elif trigger.idx == "cancel":
1506 is_open = (False, False)
1507 elif trigger.type == "telemetry-search-in":
1508 tm.from_metrics(tm_user["unique_metrics"])
1509 tm_user["selected_metrics"] = \
1510 tm.search_unique_metrics(search_in)
1511 search_out = get_list_group_items(
1512 tm_user["selected_metrics"],
1516 is_open = (True, False)
1517 elif trigger.type == "tele-cl":
1519 is_btn_disabled = (False, True)
1520 is_open = (True, False)
1521 elif trigger.type == "tm-dd":
1522 tm.from_metrics_with_labels(
1523 tm_user["unique_metrics_with_labels"]
1527 for itm in tm_dd_in:
1530 elif isinstance(itm, str):
1532 selected[itm] = list()
1533 elif isinstance(itm, list):
1534 if previous_itm is not None:
1535 selected[previous_itm] = itm
1539 tm_dd = _get_dd_container(
1540 tm_user["unique_labels"],
1544 sel_metrics = tm.filter_selected_metrics_by_labels(selected)
1545 tm_user["selected_metrics_with_labels"] = sel_metrics.to_dict()
1546 if not sel_metrics.empty:
1547 list_metrics = tm.metrics_to_str(sel_metrics)
1549 list_metrics = str()
1551 is_btn_disabled = (True, False)
1552 is_open = (False, True)
1562 plotting_area_telemetry
1564 ret_val.extend(is_open)
1565 ret_val.extend(is_btn_disabled)
1568 def _get_dd_container(
1570 selected_labels: dict=dict(),
1573 """Generate a container with dropdown selection boxes depenting on
1576 :param all_labels: A dictionary with unique labels and their
1578 :param selected_labels: A dictionalry with user selected lables and
1580 :param show_new: If True, a dropdown selection box to add a new
1582 :type all_labels: dict
1583 :type selected_labels: dict
1584 :type show_new: bool
1585 :returns: A list of dbc rows with dropdown selection boxes.
1596 """Generates a dbc row with dropdown boxes.
1598 :param id: A string added to the dropdown ID.
1599 :param lopts: A list of options for 'label' dropdown.
1600 :param lval: Value of 'label' dropdown.
1601 :param vopts: A list of options for 'value' dropdown.
1602 :param vvals: A list of values for 'value' dropdown.
1608 :returns: dbc row with dropdown boxes.
1620 "index": f"label-{id}"
1622 placeholder="Select a label...",
1626 value=lval if lval else None
1639 "index": f"value-{id}"
1641 placeholder="Select a value...",
1645 value=vvals if vvals else None
1651 return dbc.Row(class_name="g-0 p-1", children=children)
1655 # Display rows with items in 'selected_labels'; label on the left,
1656 # values on the right:
1657 keys_left = list(all_labels.keys())
1658 for idx, label in enumerate(selected_labels.keys()):
1659 container.append(_row(
1661 lopts=deepcopy(keys_left),
1663 vopts=all_labels[label],
1664 vvals=selected_labels[label]
1666 keys_left.remove(label)
1668 # Display row with dd with labels on the left, right side is empty:
1669 if show_new and keys_left:
1670 container.append(_row(id="new", lopts=keys_left))
1675 Output("metadata-tput-lat", "children"),
1676 Output("metadata-hdrh-graph", "children"),
1677 Output("offcanvas-metadata", "is_open"),
1678 Input({"type": "graph", "index": ALL}, "clickData"),
1679 prevent_initial_call=True
1681 def _show_metadata_from_graphs(graph_data: dict) -> tuple:
1682 """Generates the data for the offcanvas displayed when a particular
1683 point in a graph is clicked on.
1685 :param graph_data: The data from the clicked point in the graph.
1686 :type graph_data: dict
1687 :returns: The data to be displayed on the offcanvas and the
1688 information to show the offcanvas.
1689 :rtype: tuple(list, list, bool)
1692 trigger = Trigger(callback_context.triggered)
1695 idx = 0 if trigger.idx == "tput" else 1
1696 graph_data = graph_data[idx]["points"][0]
1697 except (IndexError, KeyError, ValueError, TypeError):
1700 metadata = no_update
1705 [dbc.Badge(x.split(":")[0]), x.split(": ")[1]]
1706 ) for x in graph_data.get("text", "").split("<br>")
1708 if trigger.idx == "tput":
1709 title = "Throughput"
1710 elif trigger.idx == "lat":
1712 hdrh_data = graph_data.get("customdata", None)
1715 class_name="gy-2 p-0",
1717 dbc.CardHeader(hdrh_data.pop("name")),
1718 dbc.CardBody(children=[
1720 id="hdrh-latency-graph",
1721 figure=graph_hdrh_latency(
1722 hdrh_data, self._graph_layout
1733 class_name="gy-2 p-0",
1735 dbc.CardHeader(children=[
1737 target_id="tput-lat-metadata",
1739 style={"display": "inline-block"}
1744 id="tput-lat-metadata",
1746 children=[dbc.ListGroup(children, flush=True), ]
1752 return metadata, graph, True
1755 Output("download-trending-data", "data"),
1756 State("store-selected-tests", "data"),
1757 Input("plot-btn-download", "n_clicks"),
1758 prevent_initial_call=True
1760 def _download_trending_data(store_sel: list, _) -> dict:
1761 """Download the data
1763 :param store_sel: List of tests selected by user stored in the
1765 :type store_sel: list
1766 :returns: dict of data frame content (base64 encoded) and meta data
1767 used by the Download component.
1775 for itm in store_sel:
1776 sel_data = select_trending_data(self._data, itm)
1777 if sel_data is None:
1779 df = pd.concat([df, sel_data], ignore_index=True, copy=False)
1781 return dcc.send_data_frame(df.to_csv, C.TREND_DOWNLOAD_FILE_NAME)