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
282 dbc.Alert("An Error Occured", color="danger"),
286 def _add_navbar(self):
287 """Add nav element with navigation panel. It is placed on the top.
289 :returns: Navigation bar.
290 :rtype: dbc.NavbarSimple
292 return dbc.NavbarSimple(
301 id="navbarsimple-main",
304 brand_external_link=True,
309 def _add_ctrl_col(self) -> dbc.Col:
310 """Add column with controls. It is placed on the left side.
312 :returns: Column with the control panel.
315 return dbc.Col(html.Div(self._add_ctrl_panel(), className="sticky-top"))
317 def _add_ctrl_panel(self) -> list:
318 """Add control panel.
320 :returns: Control panel.
328 show_tooltip(self._tooltips, "help-dut", "DUT")
331 id={"type": "ctrl-dd", "index": "dut"},
332 placeholder="Select a Device under Test...",
335 {"label": k, "value": k} \
336 for k in self._spec_tbs.keys()
338 key=lambda d: d["label"]
350 show_tooltip(self._tooltips, "help-infra", "Infra")
353 id={"type": "ctrl-dd", "index": "phy"},
354 placeholder="Select a Physical Test Bed Topology..."
365 show_tooltip(self._tooltips, "help-area", "Area")
368 id={"type": "ctrl-dd", "index": "area"},
369 placeholder="Select an Area..."
380 show_tooltip(self._tooltips, "help-test", "Test")
383 id={"type": "ctrl-dd", "index": "test"},
384 placeholder="Select a Test..."
394 dbc.InputGroupText(show_tooltip(
401 id={"type": "ctrl-cl", "index": "frmsize-all"},
402 options=C.CL_ALL_DISABLED,
410 id={"type": "ctrl-cl", "index": "frmsize"},
415 style={"align-items": "center"},
423 dbc.InputGroupText(show_tooltip(
430 id={"type": "ctrl-cl", "index": "core-all"},
431 options=C.CL_ALL_DISABLED,
439 id={"type": "ctrl-cl", "index": "core"},
444 style={"align-items": "center"},
452 dbc.InputGroupText(show_tooltip(
459 id={"type": "ctrl-cl", "index": "tsttype-all"},
460 options=C.CL_ALL_DISABLED,
468 id={"type": "ctrl-cl", "index": "tsttype"},
473 style={"align-items": "center"},
481 dbc.InputGroupText(show_tooltip(
486 dbc.Col(dbc.Checklist(
489 "value": "normalize",
490 "label": "Normalize to CPU frequency 2GHz"
497 style={"align-items": "center"},
504 id={"type": "ctrl-btn", "index": "add-test"},
505 children="Add Selected",
512 class_name="overflow-auto p-0",
515 style={"max-height": "20em"},
518 id="row-card-sel-tests",
519 class_name="g-0 p-1",
520 style=C.STYLE_DISABLED,
526 id={"type": "ctrl-btn", "index": "rm-test"},
533 id={"type": "ctrl-btn", "index": "rm-test-all"},
539 id="row-btns-sel-tests",
540 class_name="g-0 p-1",
541 style=C.STYLE_DISABLED,
546 "Add Telemetry Panel",
547 id={"type": "telemetry-btn", "index": "open"},
550 dbc.Button("Show URL", id="plot-btn-url", color="info"),
553 dbc.ModalHeader(dbc.ModalTitle("URL")),
554 dbc.ModalBody(id="mod-url")
562 id="row-btns-add-tm",
563 class_name="g-0 p-1",
564 style=C.STYLE_DISABLED,
569 def _add_plotting_col(self) -> dbc.Col:
570 """Add column with plots. It is placed on the right side.
572 :returns: Column with plots.
576 id="col-plotting-area",
580 id="plotting-area-trending",
581 class_name="g-0 p-0",
582 children=C.PLACEHOLDER
584 delay_show=C.SPINNER_DELAY
587 id="plotting-area-telemetry",
588 class_name="g-0 p-0",
589 children=C.PLACEHOLDER
593 style=C.STYLE_DISABLED,
597 def _plotting_area_trending(graphs: list) -> dbc.Col:
598 """Generate the plotting area with all its content.
600 :param graphs: A list of graphs to be displayed in the trending page.
602 :returns: A collumn with trending graphs (tput and latency) in tabs.
614 id={"type": "graph", "index": "tput"},
626 id={"type": "graph", "index": "lat"},
639 active_tab="tab-tput",
648 id="plot-btn-download",
651 style={"padding": "0rem 1rem"}
653 dcc.Download(id="download-trending-data")
655 className="d-grid gap-0 d-md-flex justify-content-md-end"
664 dbc.AccordionItem(trending, title="Trending"),
665 class_name="g-0 p-1",
666 start_collapsed=False,
668 active_item=["item-0", ]
673 dbc.ModalTitle("Select a Metric"),
677 dbc.ModalBody(Layout._get_telemetry_step_1()),
678 delay_show=2 * C.SPINNER_DELAY
683 id={"type": "telemetry-btn", "index": "select"},
689 id={"type": "telemetry-btn", "index": "cancel"},
695 id={"type": "telemetry-btn", "index": "rm-all"},
701 id={"type": "plot-mod-telemetry", "index": 0},
711 dbc.ModalTitle("Select Labels"),
715 dbc.ModalBody(Layout._get_telemetry_step_2()),
716 delay_show=2 * C.SPINNER_DELAY
721 id={"type": "telemetry-btn", "index": "back"},
726 "Add Telemetry Panel",
727 id={"type": "telemetry-btn", "index": "add"},
733 id={"type": "telemetry-btn", "index": "cancel"},
739 id={"type": "plot-mod-telemetry", "index": 1},
750 def _plotting_area_telemetry(graphs: list) -> dbc.Col:
751 """Generate the plotting area with telemetry.
753 :param graphs: A list of graphs to be displayed in the telemetry page.
755 :returns: A collumn with telemetry trending graphs.
761 def _plural(iterative):
762 return "s" if len(iterative) > 1 else str()
765 for idx, graph_set in enumerate(graphs):
767 for graph in graph_set[0]:
768 graph_name = ", ".join(graph[1])
772 id={"type": "graph-telemetry", "index": graph_name},
775 title=(f"Test{_plural(graph[1])}: {graph_name}"),
785 class_name="g-0 p-0",
786 start_collapsed=True,
798 "type": "tm-btn-remove",
803 style={"padding": "0rem 1rem"}
808 "type": "tm-btn-download",
813 style={"padding": "0rem 1rem"}
817 "d-grid gap-0 d-md-flex justify-content-md-end"
822 class_name="g-0 p-0",
824 f"Metric{_plural(graph_set[1])}: ",
825 ", ".join(graph_set[1])
833 class_name="g-0 p-1",
834 start_collapsed=True,
840 def _get_telemetry_step_1() -> list:
841 """Return the content of the modal window used in the step 1 of metrics
844 :returns: A list of dbc rows with 'input' and 'search output'.
849 class_name="g-0 p-1",
852 id={"type": "telemetry-search-in", "index": 0},
853 placeholder="Start typing a metric name...",
859 class_name="g-0 p-1",
862 class_name="overflow-auto p-0",
863 id={"type": "telemetry-search-out", "index": 0},
865 style={"max-height": "14em"},
873 def _get_telemetry_step_2() -> list:
874 """Return the content of the modal window used in the step 2 of metrics
877 :returns: A list of dbc rows with 'container with dynamic dropdowns' and
884 id={"type": "tm-container", "index": 0},
891 id={"type": "cb-all-in-one", "index": 0},
892 label="All Metrics in one Graph"
898 id={"type": "cb-ignore-host", "index": 0},
908 id={"type": "tm-list-metrics", "index": 0},
918 def callbacks(self, app):
919 """Callbacks for the whole application.
921 :param app: The application.
926 Output("store", "data"),
927 Output("plotting-area-trending", "children"),
928 Output("plotting-area-telemetry", "children"),
929 Output("col-plotting-area", "style"),
930 Output("row-card-sel-tests", "style"),
931 Output("row-btns-sel-tests", "style"),
932 Output("row-btns-add-tm", "style"),
933 Output("lg-selected", "children"),
934 Output({"type": "telemetry-search-out", "index": ALL}, "children"),
935 Output({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
936 Output({"type": "telemetry-btn", "index": ALL}, "disabled"),
937 Output({"type": "tm-container", "index": ALL}, "children"),
938 Output({"type": "tm-list-metrics", "index": ALL}, "value"),
939 Output({"type": "ctrl-dd", "index": "dut"}, "value"),
940 Output({"type": "ctrl-dd", "index": "phy"}, "options"),
941 Output({"type": "ctrl-dd", "index": "phy"}, "disabled"),
942 Output({"type": "ctrl-dd", "index": "phy"}, "value"),
943 Output({"type": "ctrl-dd", "index": "area"}, "options"),
944 Output({"type": "ctrl-dd", "index": "area"}, "disabled"),
945 Output({"type": "ctrl-dd", "index": "area"}, "value"),
946 Output({"type": "ctrl-dd", "index": "test"}, "options"),
947 Output({"type": "ctrl-dd", "index": "test"}, "disabled"),
948 Output({"type": "ctrl-dd", "index": "test"}, "value"),
949 Output({"type": "ctrl-cl", "index": "core"}, "options"),
950 Output({"type": "ctrl-cl", "index": "core"}, "value"),
951 Output({"type": "ctrl-cl", "index": "core-all"}, "value"),
952 Output({"type": "ctrl-cl", "index": "core-all"}, "options"),
953 Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
954 Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
955 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "value"),
956 Output({"type": "ctrl-cl", "index": "frmsize-all"}, "options"),
957 Output({"type": "ctrl-cl", "index": "tsttype"}, "options"),
958 Output({"type": "ctrl-cl", "index": "tsttype"}, "value"),
959 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "value"),
960 Output({"type": "ctrl-cl", "index": "tsttype-all"}, "options"),
961 Output({"type": "ctrl-btn", "index": "add-test"}, "disabled"),
962 Output("normalize", "value"),
964 State("store", "data"),
965 State({"type": "sel-cl", "index": ALL}, "value"),
966 State({"type": "cb-all-in-one", "index": ALL}, "value"),
967 State({"type": "cb-ignore-host", "index": ALL}, "value"),
968 State({"type": "telemetry-search-out", "index": ALL}, "children"),
969 State({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
970 State({"type": "telemetry-btn", "index": ALL}, "disabled"),
971 State({"type": "tm-container", "index": ALL}, "children"),
972 State({"type": "tm-list-metrics", "index": ALL}, "value"),
973 State({"type": "tele-cl", "index": ALL}, "value"),
975 Input("url", "href"),
976 Input({"type": "tm-dd", "index": ALL}, "value"),
978 Input("normalize", "value"),
979 Input({"type": "telemetry-search-in", "index": ALL}, "value"),
980 Input({"type": "telemetry-btn", "index": ALL}, "n_clicks"),
981 Input({"type": "tm-btn-remove", "index": ALL}, "n_clicks"),
982 Input({"type": "ctrl-dd", "index": ALL}, "value"),
983 Input({"type": "ctrl-cl", "index": ALL}, "value"),
984 Input({"type": "ctrl-btn", "index": ALL}, "n_clicks"),
986 prevent_initial_call=True
988 def _update_application(
995 tm_btns_disabled: list,
1003 """Update the application when the event is detected.
1008 "control-panel": dict(),
1009 "selected-tests": list(),
1010 "trending-graphs": None,
1011 "telemetry-data": dict(),
1012 "selected-metrics": dict(),
1013 "telemetry-panels": list(),
1014 "telemetry-all-in-one": list(),
1015 "telemetry-ignore-host": list(),
1016 "telemetry-graphs": list(),
1020 ctrl_panel = ControlPanel(
1022 store.get("control-panel", dict())
1024 store_sel = store["selected-tests"]
1025 tm_data = store["telemetry-data"]
1026 tm_user = store["selected-metrics"]
1027 tm_panels = store["telemetry-panels"]
1028 tm_all_in_one = store["telemetry-all-in-one"]
1029 tm_ignore_host = store["telemetry-ignore-host"]
1031 plotting_area_telemetry = no_update
1032 on_draw = [False, False] # 0 --> trending, 1 --> telemetry
1035 parsed_url = url_decode(href)
1037 url_params = parsed_url["params"]
1042 # Telemetry user data
1043 # The data provided by user or result of user action
1045 # List of unique metrics:
1046 "unique_metrics": list(),
1047 # List of metrics selected by user:
1048 "selected_metrics": list(),
1049 # Labels from metrics selected by user (key: label name,
1050 # value: list of all possible values):
1051 "unique_labels": dict(),
1052 # Labels selected by the user (subset of 'unique_labels'):
1053 "selected_labels": dict(),
1054 # All unique metrics with labels (output from the step 1)
1055 # converted from pandas dataframe to dictionary.
1056 "unique_metrics_with_labels": dict(),
1057 # Metrics with labels selected by the user using dropdowns.
1058 "selected_metrics_with_labels": dict()
1060 tm = TelemetryData(store_sel) if store_sel else TelemetryData()
1062 trigger = Trigger(callback_context.triggered)
1063 if trigger.type == "url" and url_params:
1066 store_sel = literal_eval(url_params["store_sel"][0])
1067 normalize = literal_eval(url_params["norm"][0])
1068 telemetry = literal_eval(url_params["telemetry"][0])
1069 url_p = url_params.get("all-in-one", ["[[None]]"])
1070 tm_all_in_one = literal_eval(url_p[0])
1071 url_p = url_params.get("ignore-host", ["[[None]]"])
1072 tm_ignore_host = literal_eval(url_p[0])
1073 if not isinstance(telemetry, list):
1074 telemetry = [telemetry, ]
1075 except (KeyError, IndexError, AttributeError, ValueError):
1078 last_test = store_sel[-1]
1079 test = self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1080 [last_test["area"]][last_test["test"]]
1082 "dd-dut-val": last_test["dut"],
1083 "dd-phy-val": last_test["phy"],
1084 "dd-phy-opt": generate_options(
1085 self._spec_tbs[last_test["dut"]].keys()
1087 "dd-phy-dis": False,
1088 "dd-area-val": last_test["area"],
1090 {"label": label(v), "value": v} for v in sorted(
1091 self._spec_tbs[last_test["dut"]]\
1092 [last_test["phy"]].keys()
1095 "dd-area-dis": False,
1096 "dd-test-val": last_test["test"],
1097 "dd-test-opt": generate_options(
1098 self._spec_tbs[last_test["dut"]][last_test["phy"]]\
1099 [last_test["area"]].keys()
1101 "dd-test-dis": False,
1102 "cl-core-opt": generate_options(test["core"]),
1103 "cl-core-val": [last_test["core"].upper(), ],
1104 "cl-core-all-val": list(),
1105 "cl-core-all-opt": C.CL_ALL_ENABLED,
1106 "cl-frmsize-opt": generate_options(test["frame-size"]),
1107 "cl-frmsize-val": [last_test["framesize"].upper(), ],
1108 "cl-frmsize-all-val": list(),
1109 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1110 "cl-tsttype-opt": generate_options(test["test-type"]),
1111 "cl-tsttype-val": [last_test["testtype"].upper(), ],
1112 "cl-tsttype-all-val": list(),
1113 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1114 "cl-normalize-val": normalize,
1115 "btn-add-dis": False
1117 store["trending-graphs"] = None
1118 store["telemetry-graphs"] = list()
1121 tm = TelemetryData(store_sel)
1122 tm.from_dataframe(self._data)
1123 tm_data = tm.to_json()
1124 tm.from_json(tm_data)
1125 tm_panels = telemetry
1127 elif trigger.type == "normalize":
1128 ctrl_panel.set({"cl-normalize-val": trigger.value})
1129 store["trending-graphs"] = None
1131 elif trigger.type == "ctrl-dd":
1132 if trigger.idx == "dut":
1134 options = generate_options(
1135 self._spec_tbs[trigger.value].keys()
1142 "dd-dut-val": trigger.value,
1143 "dd-phy-val": str(),
1144 "dd-phy-opt": options,
1145 "dd-phy-dis": disabled,
1146 "dd-area-val": str(),
1147 "dd-area-opt": list(),
1148 "dd-area-dis": True,
1149 "dd-test-val": str(),
1150 "dd-test-opt": list(),
1151 "dd-test-dis": True,
1152 "cl-core-opt": list(),
1153 "cl-core-val": list(),
1154 "cl-core-all-val": list(),
1155 "cl-core-all-opt": C.CL_ALL_DISABLED,
1156 "cl-frmsize-opt": list(),
1157 "cl-frmsize-val": list(),
1158 "cl-frmsize-all-val": list(),
1159 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1160 "cl-tsttype-opt": list(),
1161 "cl-tsttype-val": list(),
1162 "cl-tsttype-all-val": list(),
1163 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1166 elif trigger.idx == "phy":
1168 dut = ctrl_panel.get("dd-dut-val")
1169 phy = self._spec_tbs[dut][trigger.value]
1170 options = [{"label": label(v), "value": v} \
1171 for v in sorted(phy.keys())]
1177 "dd-phy-val": trigger.value,
1178 "dd-area-val": str(),
1179 "dd-area-opt": options,
1180 "dd-area-dis": disabled,
1181 "dd-test-val": str(),
1182 "dd-test-opt": list(),
1183 "dd-test-dis": True,
1184 "cl-core-opt": list(),
1185 "cl-core-val": list(),
1186 "cl-core-all-val": list(),
1187 "cl-core-all-opt": C.CL_ALL_DISABLED,
1188 "cl-frmsize-opt": list(),
1189 "cl-frmsize-val": list(),
1190 "cl-frmsize-all-val": list(),
1191 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1192 "cl-tsttype-opt": list(),
1193 "cl-tsttype-val": list(),
1194 "cl-tsttype-all-val": list(),
1195 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1198 elif trigger.idx == "area":
1200 dut = ctrl_panel.get("dd-dut-val")
1201 phy = ctrl_panel.get("dd-phy-val")
1202 area = self._spec_tbs[dut][phy][trigger.value]
1203 options = generate_options(area.keys())
1209 "dd-area-val": trigger.value,
1210 "dd-test-val": str(),
1211 "dd-test-opt": options,
1212 "dd-test-dis": disabled,
1213 "cl-core-opt": list(),
1214 "cl-core-val": list(),
1215 "cl-core-all-val": list(),
1216 "cl-core-all-opt": C.CL_ALL_DISABLED,
1217 "cl-frmsize-opt": list(),
1218 "cl-frmsize-val": list(),
1219 "cl-frmsize-all-val": list(),
1220 "cl-frmsize-all-opt": C.CL_ALL_DISABLED,
1221 "cl-tsttype-opt": list(),
1222 "cl-tsttype-val": list(),
1223 "cl-tsttype-all-val": list(),
1224 "cl-tsttype-all-opt": C.CL_ALL_DISABLED,
1227 elif trigger.idx == "test":
1228 dut = ctrl_panel.get("dd-dut-val")
1229 phy = ctrl_panel.get("dd-phy-val")
1230 area = ctrl_panel.get("dd-area-val")
1231 if all((dut, phy, area, trigger.value, )):
1232 test = self._spec_tbs[dut][phy][area][trigger.value]
1234 "dd-test-val": trigger.value,
1235 "cl-core-opt": generate_options(test["core"]),
1236 "cl-core-val": list(),
1237 "cl-core-all-val": list(),
1238 "cl-core-all-opt": C.CL_ALL_ENABLED,
1240 generate_options(test["frame-size"]),
1241 "cl-frmsize-val": list(),
1242 "cl-frmsize-all-val": list(),
1243 "cl-frmsize-all-opt": C.CL_ALL_ENABLED,
1245 generate_options(test["test-type"]),
1246 "cl-tsttype-val": list(),
1247 "cl-tsttype-all-val": list(),
1248 "cl-tsttype-all-opt": C.CL_ALL_ENABLED,
1251 elif trigger.type == "ctrl-cl":
1252 param = trigger.idx.split("-")[0]
1253 if "-all" in trigger.idx:
1254 c_sel, c_all, c_id = list(), trigger.value, "all"
1256 c_sel, c_all, c_id = trigger.value, list(), str()
1257 val_sel, val_all = sync_checklists(
1258 options=ctrl_panel.get(f"cl-{param}-opt"),
1264 f"cl-{param}-val": val_sel,
1265 f"cl-{param}-all-val": val_all,
1267 if all((ctrl_panel.get("cl-core-val"),
1268 ctrl_panel.get("cl-frmsize-val"),
1269 ctrl_panel.get("cl-tsttype-val"), )):
1270 ctrl_panel.set({"btn-add-dis": False})
1272 ctrl_panel.set({"btn-add-dis": True})
1273 elif trigger.type == "ctrl-btn":
1275 tm_all_in_one = list()
1276 tm_ignore_host = list()
1277 store["trending-graphs"] = None
1278 store["telemetry-graphs"] = list()
1280 on_draw = [True, True]
1281 if trigger.idx == "add-test":
1282 dut = ctrl_panel.get("dd-dut-val")
1283 phy = ctrl_panel.get("dd-phy-val")
1284 area = ctrl_panel.get("dd-area-val")
1285 test = ctrl_panel.get("dd-test-val")
1286 # Add selected test(s) to the list of tests in store:
1287 if store_sel is None:
1289 for core in ctrl_panel.get("cl-core-val"):
1290 for framesize in ctrl_panel.get("cl-frmsize-val"):
1291 for ttype in ctrl_panel.get("cl-tsttype-val"):
1296 phy.replace('af_xdp', 'af-xdp'),
1303 if tid not in [i["id"] for i in store_sel]:
1310 "framesize": framesize.lower(),
1311 "core": core.lower(),
1312 "testtype": ttype.lower()
1314 store_sel = sorted(store_sel, key=lambda d: d["id"])
1315 if C.CLEAR_ALL_INPUTS:
1316 ctrl_panel.set(ctrl_panel.defaults)
1317 elif trigger.idx == "rm-test" and lst_sel:
1318 new_store_sel = list()
1319 for idx, item in enumerate(store_sel):
1320 if not lst_sel[idx]:
1321 new_store_sel.append(item)
1322 store_sel = new_store_sel
1323 elif trigger.idx == "rm-test-all":
1325 elif trigger.type == "telemetry-btn":
1326 if trigger.idx in ("open", "back"):
1327 tm.from_dataframe(self._data)
1328 tm_data = tm.to_json()
1329 tm_user["unique_metrics"] = tm.unique_metrics
1330 tm_user["selected_metrics"] = list()
1331 tm_user["unique_labels"] = dict()
1332 tm_user["selected_labels"] = dict()
1334 get_list_group_items(tm_user["unique_metrics"],
1337 is_open = (True, False)
1338 tm_btns_disabled[1], tm_btns_disabled[5] = False, True
1339 elif trigger.idx == "select":
1341 tm.from_json(tm_data)
1342 if not tm_user["selected_metrics"]:
1343 tm_user["selected_metrics"] = \
1344 tm_user["unique_metrics"]
1345 metrics = [a for a, b in \
1346 zip(tm_user["selected_metrics"], cl_metrics) if b]
1347 tm_user["selected_metrics"] = metrics
1348 tm_user["unique_labels"] = \
1349 tm.get_selected_labels(metrics)
1350 tm_user["unique_metrics_with_labels"] = \
1351 tm.unique_metrics_with_labels
1352 list_metrics[0] = tm.str_metrics
1353 tm_dd[0] = _get_dd_container(tm_user["unique_labels"])
1355 tm_btns_disabled[1] = True
1356 tm_btns_disabled[4] = False
1357 is_open = (False, True)
1359 is_open = (True, False)
1360 elif trigger.idx == "add":
1361 tm.from_json(tm_data)
1362 tm_panels.append(tm_user["selected_metrics_with_labels"])
1363 tm_all_in_one.append(all_in_one)
1364 tm_ignore_host.append(ignore_host)
1365 is_open = (False, False)
1366 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1367 on_draw = [True, True]
1368 elif trigger.idx == "cancel":
1369 is_open = (False, False)
1370 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1371 elif trigger.idx == "rm-all":
1373 tm_all_in_one = list()
1374 tm_ignore_host = list()
1376 is_open = (False, False)
1377 tm_btns_disabled[1], tm_btns_disabled[5] = True, True
1378 plotting_area_telemetry = C.PLACEHOLDER
1379 elif trigger.type == "telemetry-search-in":
1380 tm.from_metrics(tm_user["unique_metrics"])
1381 tm_user["selected_metrics"] = \
1382 tm.search_unique_metrics(trigger.value)
1383 search_out = (get_list_group_items(
1384 tm_user["selected_metrics"],
1388 is_open = (True, False)
1389 elif trigger.type == "tm-dd":
1390 tm.from_metrics_with_labels(
1391 tm_user["unique_metrics_with_labels"]
1395 for itm in tm_dd_in:
1398 elif isinstance(itm, str):
1400 selected[itm] = list()
1401 elif isinstance(itm, list):
1402 if previous_itm is not None:
1403 selected[previous_itm] = itm
1406 tm_dd[0] = _get_dd_container(
1407 tm_user["unique_labels"],
1411 sel_metrics = tm.filter_selected_metrics_by_labels(selected)
1412 tm_user["selected_metrics_with_labels"] = sel_metrics.to_dict()
1413 if not sel_metrics.empty:
1414 list_metrics[0] = tm.metrics_to_str(sel_metrics)
1415 tm_btns_disabled[5] = False
1417 list_metrics[0] = str()
1418 elif trigger.type == "tm-btn-remove":
1419 del tm_panels[trigger.idx]
1420 del tm_all_in_one[trigger.idx]
1421 del tm_ignore_host[trigger.idx]
1422 del store["telemetry-graphs"][trigger.idx]
1423 tm.from_json(tm_data)
1424 on_draw = [True, True]
1427 "store_sel": store_sel,
1428 "norm": ctrl_panel.get("cl-normalize-val")
1431 new_url_params["telemetry"] = tm_panels
1432 new_url_params["all-in-one"] = tm_all_in_one
1433 new_url_params["ignore-host"] = tm_ignore_host
1435 if on_draw[0]: # Trending
1437 lg_selected = get_list_group_items(store_sel, "sel-cl")
1438 if store["trending-graphs"]:
1439 graphs = store["trending-graphs"]
1441 graphs = graph_trending(
1445 bool(ctrl_panel.get("cl-normalize-val"))
1447 if graphs and graphs[0]:
1448 store["trending-graphs"] = graphs
1449 plotting_area_trending = \
1450 Layout._plotting_area_trending(graphs)
1453 start_idx = len(store["telemetry-graphs"])
1454 end_idx = len(tm_panels)
1456 plotting_area_telemetry = C.PLACEHOLDER
1457 elif on_draw[1] and (end_idx >= start_idx):
1458 for idx in range(start_idx, end_idx):
1459 store["telemetry-graphs"].append(graph_tm_trending(
1460 tm.select_tm_trending_data(
1462 ignore_host=bool(tm_ignore_host[idx][0])
1465 bool(tm_all_in_one[idx][0])
1467 plotting_area_telemetry = \
1468 Layout._plotting_area_telemetry(
1469 store["telemetry-graphs"]
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
1485 tm_all_in_one = list()
1486 tm_ignore_host = list()
1489 plotting_area_trending = no_update
1490 col_plotting_area = no_update
1491 row_card_sel_tests = no_update
1492 row_btns_sel_tests = no_update
1493 row_btns_add_tm = no_update
1494 lg_selected = no_update
1496 store["url"] = gen_new_url(parsed_url, new_url_params)
1497 store["control-panel"] = ctrl_panel.panel
1498 store["selected-tests"] = store_sel
1499 store["telemetry-data"] = tm_data
1500 store["selected-metrics"] = tm_user
1501 store["telemetry-panels"] = tm_panels
1502 store["telemetry-all-in-one"] = tm_all_in_one
1503 store["telemetry-ignore-host"] = tm_ignore_host
1506 plotting_area_trending,
1507 plotting_area_telemetry,
1519 ret_val.extend(ctrl_panel.values)
1523 Output("plot-mod-url", "is_open"),
1524 Output("mod-url", "children"),
1525 State("store", "data"),
1526 State("plot-mod-url", "is_open"),
1527 Input("plot-btn-url", "n_clicks")
1529 def toggle_plot_mod_url(store, is_open, n_clicks):
1530 """Toggle the modal window with url.
1536 return not is_open, store.get("url", str())
1537 return is_open, store["url"]
1539 def _get_dd_container(
1541 selected_labels: dict=dict(),
1544 """Generate a container with dropdown selection boxes depenting on
1547 :param all_labels: A dictionary with unique labels and their
1549 :param selected_labels: A dictionalry with user selected lables and
1551 :param show_new: If True, a dropdown selection box to add a new
1553 :type all_labels: dict
1554 :type selected_labels: dict
1555 :type show_new: bool
1556 :returns: A list of dbc rows with dropdown selection boxes.
1567 """Generates a dbc row with dropdown boxes.
1569 :param id: A string added to the dropdown ID.
1570 :param lopts: A list of options for 'label' dropdown.
1571 :param lval: Value of 'label' dropdown.
1572 :param vopts: A list of options for 'value' dropdown.
1573 :param vvals: A list of values for 'value' dropdown.
1579 :returns: dbc row with dropdown boxes.
1591 "index": f"label-{id}"
1593 placeholder="Select a label...",
1597 value=lval if lval else None
1610 "index": f"value-{id}"
1612 placeholder="Select a value...",
1616 value=vvals if vvals else None
1622 return dbc.Row(class_name="g-0 p-1", children=children)
1626 # Display rows with items in 'selected_labels'; label on the left,
1627 # values on the right:
1628 keys_left = list(all_labels.keys())
1629 for idx, label in enumerate(selected_labels.keys()):
1630 container.append(_row(
1632 lopts=deepcopy(keys_left),
1634 vopts=all_labels[label],
1635 vvals=selected_labels[label]
1637 keys_left.remove(label)
1639 # Display row with dd with labels on the left, right side is empty:
1640 if show_new and keys_left:
1641 container.append(_row(id="new", lopts=keys_left))
1646 Output("metadata-tput-lat", "children"),
1647 Output("metadata-hdrh-graph", "children"),
1648 Output("offcanvas-metadata", "is_open"),
1649 Input({"type": "graph", "index": ALL}, "clickData"),
1650 prevent_initial_call=True
1652 def _show_metadata_from_graphs(graph_data: dict) -> tuple:
1653 """Generates the data for the offcanvas displayed when a particular
1654 point in a graph is clicked on.
1656 :param graph_data: The data from the clicked point in the graph.
1657 :type graph_data: dict
1658 :returns: The data to be displayed on the offcanvas and the
1659 information to show the offcanvas.
1660 :rtype: tuple(list, list, bool)
1663 trigger = Trigger(callback_context.triggered)
1666 idx = 0 if trigger.idx == "tput" else 1
1667 graph_data = graph_data[idx]["points"][0]
1668 except (IndexError, KeyError, ValueError, TypeError):
1671 metadata = no_update
1676 [dbc.Badge(x.split(":")[0]), x.split(": ")[1]]
1677 ) for x in graph_data.get("text", "").split("<br>")
1679 if trigger.idx == "tput":
1680 title = "Throughput"
1681 elif trigger.idx == "lat":
1683 hdrh_data = graph_data.get("customdata", None)
1686 class_name="gy-2 p-0",
1688 dbc.CardHeader(hdrh_data.pop("name")),
1689 dbc.CardBody(children=[
1691 id="hdrh-latency-graph",
1692 figure=graph_hdrh_latency(
1693 hdrh_data, self._graph_layout
1704 class_name="gy-2 p-0",
1706 dbc.CardHeader(children=[
1708 target_id="tput-lat-metadata",
1710 style={"display": "inline-block"}
1715 id="tput-lat-metadata",
1717 children=[dbc.ListGroup(children, flush=True), ]
1723 return metadata, graph, True
1726 Output("download-trending-data", "data"),
1727 State("store", "data"),
1728 Input("plot-btn-download", "n_clicks"),
1729 Input({"type": "tm-btn-download", "index": ALL}, "n_clicks"),
1730 prevent_initial_call=True
1732 def _download_data(store: list, *_) -> dict:
1733 """Download the data
1735 :param store_sel: List of tests selected by user stored in the
1737 :type store_sel: list
1738 :returns: dict of data frame content (base64 encoded) and meta data
1739 used by the Download component.
1745 if not store["selected-tests"]:
1750 trigger = Trigger(callback_context.triggered)
1751 if not trigger.value:
1754 if trigger.type == "plot-btn-download":
1756 for itm in store["selected-tests"]:
1757 sel_data = select_trending_data(self._data, itm)
1758 if sel_data is None:
1760 data.append(sel_data)
1761 df = pd.concat(data, ignore_index=True, copy=False)
1762 file_name = C.TREND_DOWNLOAD_FILE_NAME
1763 elif trigger.type == "tm-btn-download":
1764 tm = TelemetryData(store["selected-tests"])
1765 tm.from_json(store["telemetry-data"])
1766 df = tm.select_tm_trending_data(
1767 store["telemetry-panels"][trigger.idx]
1769 file_name = C.TELEMETRY_DOWNLOAD_FILE_NAME
1773 return dcc.send_data_frame(df.to_csv, file_name)