1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
|
# Copyright (c) 2023 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Plotly Dash HTML layout override.
"""
import logging
import pandas as pd
import dash_bootstrap_components as dbc
from flask import Flask
from dash import dcc
from dash import html
from dash import callback_context, no_update, ALL
from dash import Input, Output, State
from dash.exceptions import PreventUpdate
from yaml import load, FullLoader, YAMLError
from ast import literal_eval
from copy import deepcopy
from ..utils.constants import Constants as C
from ..utils.control_panel import ControlPanel
from ..utils.trigger import Trigger
from ..utils.telemetry_data import TelemetryData
from ..utils.utils import show_tooltip, label, sync_checklists, gen_new_url, \
generate_options, get_list_group_items, graph_hdrh_latency
from ..utils.url_processing import url_decode
from .graphs import graph_trending, select_trending_data, graph_tm_trending
# Control panel partameters and their default values.
CP_PARAMS = {
"dd-dut-val": str(),
"dd-phy-opt": list(),
"dd-phy-dis": True,
"dd-phy-val": str(),
"dd-area-opt": list(),
"dd-area-dis": True,
"dd-area-val": str(),
"dd-test-opt": list(),
"dd-test-dis": True,
"dd-test-val": str(),
"cl-core-opt": list(),
"cl-core-val": list(),
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_DISABLED,
"cl-frmsize-opt": list(),
"cl-frmsize-val": list(),
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_DISABLED,
"cl-tsttype-opt": list(),
"cl-tsttype-val": list(),
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_DISABLED,
"btn-add-dis": True,
"cl-normalize-val": list()
}
class Layout:
"""The layout of the dash app and the callbacks.
"""
def __init__(self,
app: Flask,
data_trending: pd.DataFrame,
html_layout_file: str,
graph_layout_file: str,
tooltip_file: str
) -> None:
"""Initialization:
- save the input parameters,
- read and pre-process the data,
- prepare data for the control panel,
- read HTML layout file,
- read tooltips from the tooltip file.
:param app: Flask application running the dash application.
:param data_trending: Pandas dataframe with trending data.
:param html_layout_file: Path and name of the file specifying the HTML
layout of the dash application.
:param graph_layout_file: Path and name of the file with layout of
plot.ly graphs.
:param tooltip_file: Path and name of the yaml file specifying the
tooltips.
:type app: Flask
:type data_trending: pandas.DataFrame
:type html_layout_file: str
:type graph_layout_file: str
:type tooltip_file: str
"""
# Inputs
self._app = app
self._data = data_trending
self._html_layout_file = html_layout_file
self._graph_layout_file = graph_layout_file
self._tooltip_file = tooltip_file
# Get structure of tests:
tbs = dict()
cols = ["job", "test_id", "test_type", "tg_type"]
for _, row in self._data[cols].drop_duplicates().iterrows():
lst_job = row["job"].split("-")
dut = lst_job[1]
tbed = "-".join(lst_job[-2:])
lst_test = row["test_id"].split(".")
if dut == "dpdk":
area = "dpdk"
else:
area = ".".join(lst_test[3:-2])
suite = lst_test[-2].replace("2n1l-", "").replace("1n1l-", "").\
replace("2n-", "")
test = lst_test[-1]
nic = suite.split("-")[0]
for drv in C.DRIVERS:
if drv in test:
if drv == "af-xdp":
driver = "af_xdp"
else:
driver = drv
test = test.replace(f"{drv}-", "")
break
else:
driver = "dpdk"
infra = "-".join((tbed, nic, driver))
lst_test = test.split("-")
framesize = lst_test[0]
core = lst_test[1] if lst_test[1] else "8C"
test = "-".join(lst_test[2: -1])
if tbs.get(dut, None) is None:
tbs[dut] = dict()
if tbs[dut].get(infra, None) is None:
tbs[dut][infra] = dict()
if tbs[dut][infra].get(area, None) is None:
tbs[dut][infra][area] = dict()
if tbs[dut][infra][area].get(test, None) is None:
tbs[dut][infra][area][test] = dict()
tbs[dut][infra][area][test]["core"] = list()
tbs[dut][infra][area][test]["frame-size"] = list()
tbs[dut][infra][area][test]["test-type"] = list()
if core.upper() not in tbs[dut][infra][area][test]["core"]:
tbs[dut][infra][area][test]["core"].append(core.upper())
if framesize.upper() not in \
tbs[dut][infra][area][test]["frame-size"]:
tbs[dut][infra][area][test]["frame-size"].append(
framesize.upper()
)
if row["test_type"] == "mrr":
if "MRR" not in tbs[dut][infra][area][test]["test-type"]:
tbs[dut][infra][area][test]["test-type"].append("MRR")
elif row["test_type"] == "ndrpdr":
if "NDR" not in tbs[dut][infra][area][test]["test-type"]:
tbs[dut][infra][area][test]["test-type"].extend(
("NDR", "PDR")
)
elif row["test_type"] == "hoststack":
if row["tg_type"] in ("iperf", "vpp"):
if "BPS" not in tbs[dut][infra][area][test]["test-type"]:
tbs[dut][infra][area][test]["test-type"].append("BPS")
elif row["tg_type"] == "ab":
if "CPS" not in tbs[dut][infra][area][test]["test-type"]:
tbs[dut][infra][area][test]["test-type"].extend(
("CPS", "RPS")
)
self._spec_tbs = tbs
# Read from files:
self._html_layout = str()
self._graph_layout = None
self._tooltips = dict()
try:
with open(self._html_layout_file, "r") as file_read:
self._html_layout = file_read.read()
except IOError as err:
raise RuntimeError(
f"Not possible to open the file {self._html_layout_file}\n{err}"
)
try:
with open(self._graph_layout_file, "r") as file_read:
self._graph_layout = load(file_read, Loader=FullLoader)
except IOError as err:
raise RuntimeError(
f"Not possible to open the file {self._graph_layout_file}\n"
f"{err}"
)
except YAMLError as err:
raise RuntimeError(
f"An error occurred while parsing the specification file "
f"{self._graph_layout_file}\n{err}"
)
try:
with open(self._tooltip_file, "r") as file_read:
self._tooltips = load(file_read, Loader=FullLoader)
except IOError as err:
logging.warning(
f"Not possible to open the file {self._tooltip_file}\n{err}"
)
except YAMLError as err:
logging.warning(
f"An error occurred while parsing the specification file "
f"{self._tooltip_file}\n{err}"
)
# Callbacks:
if self._app is not None and hasattr(self, "callbacks"):
self.callbacks(self._app)
@property
def html_layout(self):
return self._html_layout
def add_content(self):
"""Top level method which generated the web page.
It generates:
- Store for user input data,
- Navigation bar,
- Main area with control panel and ploting area.
If no HTML layout is provided, an error message is displayed instead.
:returns: The HTML div with the whole page.
:rtype: html.Div
"""
if self.html_layout and self._spec_tbs:
return html.Div(
id="div-main",
className="small",
children=[
dcc.Store(id="store"),
dcc.Location(id="url", refresh=False),
dbc.Row(
id="row-navbar",
class_name="g-0",
children=[
self._add_navbar()
]
),
dbc.Row(
id="row-main",
class_name="g-0",
children=[
self._add_ctrl_col(),
self._add_plotting_col()
]
),
dbc.Spinner(
dbc.Offcanvas(
class_name="w-50",
id="offcanvas-metadata",
title="Detailed Information",
placement="end",
is_open=False,
children=[
dbc.Row(id="metadata-tput-lat"),
dbc.Row(id="metadata-hdrh-graph")
]
),
delay_show=C.SPINNER_DELAY
),
dbc.Offcanvas(
class_name="w-75",
id="offcanvas-documentation",
title="Documentation",
placement="end",
is_open=False,
children=html.Iframe(
src=C.URL_DOC_TRENDING,
width="100%",
height="100%"
)
)
]
)
else:
return html.Div(
dbc.Alert("An Error Occured", color="danger"),
id="div-main-error"
)
def _add_navbar(self):
"""Add nav element with navigation panel. It is placed on the top.
:returns: Navigation bar.
:rtype: dbc.NavbarSimple
"""
return dbc.NavbarSimple(
children=[
dbc.NavItem(dbc.NavLink(
C.TREND_TITLE,
active=True,
external_link=True,
href="/trending"
)),
dbc.NavItem(dbc.NavLink(
C.NEWS_TITLE,
external_link=True,
href="/news"
)),
dbc.NavItem(dbc.NavLink(
C.STATS_TITLE,
external_link=True,
href="/stats"
)),
dbc.NavItem(dbc.NavLink(
"Documentation",
id="btn-documentation",
))
],
id="navbarsimple-main",
brand=C.BRAND,
brand_href="/",
brand_external_link=True,
class_name="p-2",
fluid=True
)
def _add_ctrl_col(self) -> dbc.Col:
"""Add column with controls. It is placed on the left side.
:returns: Column with the control panel.
:rtype: dbc.Col
"""
return dbc.Col(html.Div(self._add_ctrl_panel(), className="sticky-top"))
def _add_ctrl_panel(self) -> list:
"""Add control panel.
:returns: Control panel.
:rtype: list
"""
return [
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(
show_tooltip(self._tooltips, "help-dut", "DUT")
),
dbc.Select(
id={"type": "ctrl-dd", "index": "dut"},
placeholder="Select a Device under Test...",
options=sorted(
[
{"label": k, "value": k} \
for k in self._spec_tbs.keys()
],
key=lambda d: d["label"]
)
)
],
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(
show_tooltip(self._tooltips, "help-infra", "Infra")
),
dbc.Select(
id={"type": "ctrl-dd", "index": "phy"},
placeholder="Select a Physical Test Bed Topology..."
)
],
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(
show_tooltip(self._tooltips, "help-area", "Area")
),
dbc.Select(
id={"type": "ctrl-dd", "index": "area"},
placeholder="Select an Area..."
)
],
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(
show_tooltip(self._tooltips, "help-test", "Test")
),
dbc.Select(
id={"type": "ctrl-dd", "index": "test"},
placeholder="Select a Test..."
)
],
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(show_tooltip(
self._tooltips,
"help-framesize",
"Frame Size"
)),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "frmsize-all"},
options=C.CL_ALL_DISABLED,
inline=True,
class_name="ms-2"
),
width=2
),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "frmsize"},
inline=True
)
)
],
style={"align-items": "center"},
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(show_tooltip(
self._tooltips,
"help-cores",
"Number of Cores"
)),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "core-all"},
options=C.CL_ALL_DISABLED,
inline=True,
class_name="ms-2"
),
width=2
),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "core"},
inline=True
)
)
],
style={"align-items": "center"},
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(show_tooltip(
self._tooltips,
"help-ttype",
"Test Type"
)),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "tsttype-all"},
options=C.CL_ALL_DISABLED,
inline=True,
class_name="ms-2"
),
width=2
),
dbc.Col(
dbc.Checklist(
id={"type": "ctrl-cl", "index": "tsttype"},
inline=True
)
)
],
style={"align-items": "center"},
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.InputGroup(
[
dbc.InputGroupText(show_tooltip(
self._tooltips,
"help-normalize",
"Normalization"
)),
dbc.Col(dbc.Checklist(
id="normalize",
options=[{
"value": "normalize",
"label": "Normalize to CPU frequency 2GHz"
}],
value=[],
inline=True,
class_name="ms-2"
))
],
style={"align-items": "center"},
size="sm"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.Button(
id={"type": "ctrl-btn", "index": "add-test"},
children="Add Selected",
color="info"
),
class_name="g-0 p-1"
),
dbc.Row(
dbc.ListGroup(
class_name="overflow-auto p-0",
id="lg-selected",
children=[],
style={"max-height": "20em"},
flush=True
),
id="row-card-sel-tests",
class_name="g-0 p-1",
style=C.STYLE_DISABLED,
),
dbc.Row(
dbc.ButtonGroup([
dbc.Button(
"Remove Selected",
id={"type": "ctrl-btn", "index": "rm-test"},
class_name="w-100",
color="info",
disabled=False
),
dbc.Button(
"Remove All",
id={"type": "ctrl-btn", "index": "rm-test-all"},
class_name="w-100",
color="info",
disabled=False
)
]),
id="row-btns-sel-tests",
class_name="g-0 p-1",
style=C.STYLE_DISABLED,
),
dbc.Stack(
[
dbc.Button(
"Add Telemetry Panel",
id={"type": "telemetry-btn", "index": "open"},
color="info"
),
dbc.Button("Show URL", id="plot-btn-url", color="info"),
dbc.Modal(
[
dbc.ModalHeader(dbc.ModalTitle("URL")),
dbc.ModalBody(id="mod-url")
],
id="plot-mod-url",
size="xl",
is_open=False,
scrollable=True
)
],
id="row-btns-add-tm",
class_name="g-0 p-1",
style=C.STYLE_DISABLED,
gap=2
)
]
def _add_plotting_col(self) -> dbc.Col:
"""Add column with plots. It is placed on the right side.
:returns: Column with plots.
:rtype: dbc.Col
"""
return dbc.Col(
id="col-plotting-area",
children=[
dbc.Row(
id="plotting-area-trending",
class_name="g-0 p-0",
children=C.PLACEHOLDER
),
dbc.Row(
id="plotting-area-telemetry",
class_name="g-0 p-0",
children=C.PLACEHOLDER
)
],
width=9,
style=C.STYLE_DISABLED,
)
@staticmethod
def _plotting_area_trending(graphs: list) -> dbc.Col:
"""Generate the plotting area with all its content.
:param graphs: A list of graphs to be displayed in the trending page.
:type graphs: list
:returns: A collumn with trending graphs (tput and latency) in tabs.
:rtype: dbc.Col
"""
if not graphs:
return C.PLACEHOLDER
if not graphs[0]:
return C.PLACEHOLDER
tab_items = [
dbc.Tab(
children=dcc.Graph(
id={"type": "graph", "index": "tput"},
figure=graphs[0]
),
label="Throughput",
tab_id="tab-tput"
)
]
if graphs[1]:
tab_items.append(
dbc.Tab(
children=dcc.Graph(
id={"type": "graph", "index": "bandwidth"},
figure=graphs[1]
),
label="Bandwidth",
tab_id="tab-bandwidth"
)
)
if graphs[2]:
tab_items.append(
dbc.Tab(
children=dcc.Graph(
id={"type": "graph", "index": "lat"},
figure=graphs[2]
),
label="Latency",
tab_id="tab-lat"
)
)
trending = [
dbc.Row(
dbc.Tabs(
children=tab_items,
id="tabs",
active_tab="tab-tput",
),
class_name="g-0 p-0"
),
dbc.Row(
html.Div(
[
dbc.Button(
"Download Data",
id="plot-btn-download",
class_name="me-1",
color="info",
style={"padding": "0rem 1rem"}
),
dcc.Download(id="download-trending-data")
],
className="d-grid gap-0 d-md-flex justify-content-md-end"
),
class_name="g-0 p-0"
)
]
return dbc.Col(
children=[
dbc.Accordion(
dbc.AccordionItem(trending, title="Trending"),
class_name="g-0 p-1",
start_collapsed=False,
always_open=True,
active_item=["item-0", ]
),
dbc.Modal(
[
dbc.ModalHeader(
dbc.ModalTitle("Select a Metric"),
close_button=False
),
dbc.Spinner(
dbc.ModalBody(Layout._get_telemetry_step_1()),
delay_show=2 * C.SPINNER_DELAY
),
dbc.ModalFooter([
dbc.Button(
"Select",
id={"type": "telemetry-btn", "index": "select"},
color="success",
disabled=True
),
dbc.Button(
"Cancel",
id={"type": "telemetry-btn", "index": "cancel"},
color="info",
disabled=False
),
dbc.Button(
"Remove All",
id={"type": "telemetry-btn", "index": "rm-all"},
color="danger",
disabled=False
)
])
],
id={"type": "plot-mod-telemetry", "index": 0},
size="lg",
is_open=False,
scrollable=False,
backdrop="static",
keyboard=False
),
dbc.Modal(
[
dbc.ModalHeader(
dbc.ModalTitle("Select Labels"),
close_button=False
),
dbc.Spinner(
dbc.ModalBody(Layout._get_telemetry_step_2()),
delay_show=2 * C.SPINNER_DELAY
),
dbc.ModalFooter([
dbc.Button(
"Back",
id={"type": "telemetry-btn", "index": "back"},
color="info",
disabled=False
),
dbc.Button(
"Add Telemetry Panel",
id={"type": "telemetry-btn", "index": "add"},
color="success",
disabled=True
),
dbc.Button(
"Cancel",
id={"type": "telemetry-btn", "index": "cancel"},
color="info",
disabled=False
)
])
],
id={"type": "plot-mod-telemetry", "index": 1},
size="xl",
is_open=False,
scrollable=False,
backdrop="static",
keyboard=False
)
]
)
@staticmethod
def _plotting_area_telemetry(graphs: list) -> dbc.Col:
"""Generate the plotting area with telemetry.
:param graphs: A list of graphs to be displayed in the telemetry page.
:type graphs: list
:returns: A collumn with telemetry trending graphs.
:rtype: dbc.Col
"""
if not graphs:
return C.PLACEHOLDER
def _plural(iterative):
return "s" if len(iterative) > 1 else str()
panels = list()
for idx, graph_set in enumerate(graphs):
acc_items = list()
for graph in graph_set[0]:
graph_name = ", ".join(graph[1])
acc_items.append(
dbc.AccordionItem(
dcc.Graph(
id={"type": "graph-telemetry", "index": graph_name},
figure=graph[0]
),
title=(f"Test{_plural(graph[1])}: {graph_name}"),
class_name="g-0 p-0"
)
)
panels.append(
dbc.AccordionItem(
[
dbc.Row(
dbc.Accordion(
children=acc_items,
class_name="g-0 p-0",
start_collapsed=True,
always_open=True,
flush=True
),
class_name="g-0 p-0"
),
dbc.Row(
html.Div(
[
dbc.Button(
"Remove",
id={
"type": "tm-btn-remove",
"index": idx
},
class_name="me-1",
color="danger",
style={"padding": "0rem 1rem"}
),
dbc.Button(
"Download Data",
id={
"type": "tm-btn-download",
"index": idx
},
class_name="me-1",
color="info",
style={"padding": "0rem 1rem"}
)
],
className=\
"d-grid gap-0 d-md-flex justify-content-md-end"
),
class_name="g-0 p-0"
)
],
class_name="g-0 p-0",
title=(
f"Metric{_plural(graph_set[1])}: ",
", ".join(graph_set[1])
)
)
)
return dbc.Col(
dbc.Accordion(
panels,
class_name="g-0 p-1",
start_collapsed=True,
always_open=True
)
)
@staticmethod
def _get_telemetry_step_1() -> list:
"""Return the content of the modal window used in the step 1 of metrics
selection.
:returns: A list of dbc rows with 'input' and 'search output'.
:rtype: list
"""
return [
dbc.Row(
class_name="g-0 p-1",
children=[
dbc.Input(
id={"type": "telemetry-search-in", "index": 0},
placeholder="Start typing a metric name...",
type="text"
)
]
),
dbc.Row(
class_name="g-0 p-1",
children=[
dbc.ListGroup(
class_name="overflow-auto p-0",
id={"type": "telemetry-search-out", "index": 0},
children=[],
style={"max-height": "14em"},
flush=True
)
]
)
]
@staticmethod
def _get_telemetry_step_2() -> list:
"""Return the content of the modal window used in the step 2 of metrics
selection.
:returns: A list of dbc rows with 'container with dynamic dropdowns' and
'search output'.
:rtype: list
"""
return [
dbc.Row(
"Add content here.",
id={"type": "tm-container", "index": 0},
class_name="g-0 p-1"
),
dbc.Row(
[
dbc.Col(
dbc.Checkbox(
id={"type": "cb-all-in-one", "index": 0},
label="All Metrics in one Graph"
),
width=6
),
dbc.Col(
dbc.Checkbox(
id={"type": "cb-ignore-host", "index": 0},
label="Ignore Host"
),
width=6
)
],
class_name="g-0 p-2"
),
dbc.Row(
dbc.Textarea(
id={"type": "tm-list-metrics", "index": 0},
rows=20,
size="sm",
wrap="off",
readonly=True
),
class_name="g-0 p-1"
)
]
def callbacks(self, app):
"""Callbacks for the whole application.
:param app: The application.
:type app: Flask
"""
@app.callback(
Output("store", "data"),
Output("plotting-area-trending", "children"),
Output("plotting-area-telemetry", "children"),
Output("col-plotting-area", "style"),
Output("row-card-sel-tests", "style"),
Output("row-btns-sel-tests", "style"),
Output("row-btns-add-tm", "style"),
Output("lg-selected", "children"),
Output({"type": "telemetry-search-out", "index": ALL}, "children"),
Output({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
Output({"type": "telemetry-btn", "index": ALL}, "disabled"),
Output({"type": "tm-container", "index": ALL}, "children"),
Output({"type": "tm-list-metrics", "index": ALL}, "value"),
Output({"type": "ctrl-dd", "index": "dut"}, "value"),
Output({"type": "ctrl-dd", "index": "phy"}, "options"),
Output({"type": "ctrl-dd", "index": "phy"}, "disabled"),
Output({"type": "ctrl-dd", "index": "phy"}, "value"),
Output({"type": "ctrl-dd", "index": "area"}, "options"),
Output({"type": "ctrl-dd", "index": "area"}, "disabled"),
Output({"type": "ctrl-dd", "index": "area"}, "value"),
Output({"type": "ctrl-dd", "index": "test"}, "options"),
Output({"type": "ctrl-dd", "index": "test"}, "disabled"),
Output({"type": "ctrl-dd", "index": "test"}, "value"),
Output({"type": "ctrl-cl", "index": "core"}, "options"),
Output({"type": "ctrl-cl", "index": "core"}, "value"),
Output({"type": "ctrl-cl", "index": "core-all"}, "value"),
Output({"type": "ctrl-cl", "index": "core-all"}, "options"),
Output({"type": "ctrl-cl", "index": "frmsize"}, "options"),
Output({"type": "ctrl-cl", "index": "frmsize"}, "value"),
Output({"type": "ctrl-cl", "index": "frmsize-all"}, "value"),
Output({"type": "ctrl-cl", "index": "frmsize-all"}, "options"),
Output({"type": "ctrl-cl", "index": "tsttype"}, "options"),
Output({"type": "ctrl-cl", "index": "tsttype"}, "value"),
Output({"type": "ctrl-cl", "index": "tsttype-all"}, "value"),
Output({"type": "ctrl-cl", "index": "tsttype-all"}, "options"),
Output({"type": "ctrl-btn", "index": "add-test"}, "disabled"),
Output("normalize", "value"),
State("store", "data"),
State({"type": "sel-cl", "index": ALL}, "value"),
State({"type": "cb-all-in-one", "index": ALL}, "value"),
State({"type": "cb-ignore-host", "index": ALL}, "value"),
State({"type": "telemetry-search-out", "index": ALL}, "children"),
State({"type": "plot-mod-telemetry", "index": ALL}, "is_open"),
State({"type": "telemetry-btn", "index": ALL}, "disabled"),
State({"type": "tm-container", "index": ALL}, "children"),
State({"type": "tm-list-metrics", "index": ALL}, "value"),
State({"type": "tele-cl", "index": ALL}, "value"),
Input("url", "href"),
Input({"type": "tm-dd", "index": ALL}, "value"),
Input("normalize", "value"),
Input({"type": "telemetry-search-in", "index": ALL}, "value"),
Input({"type": "telemetry-btn", "index": ALL}, "n_clicks"),
Input({"type": "tm-btn-remove", "index": ALL}, "n_clicks"),
Input({"type": "ctrl-dd", "index": ALL}, "value"),
Input({"type": "ctrl-cl", "index": ALL}, "value"),
Input({"type": "ctrl-btn", "index": ALL}, "n_clicks"),
prevent_initial_call=True
)
def _update_application(
store: dict,
lst_sel: list,
all_in_one: list,
ignore_host: list,
search_out: list,
is_open: list,
tm_btns_disabled: list,
tm_dd: list,
list_metrics: list,
cl_metrics: list,
href: str,
tm_dd_in: list,
*_
) -> tuple:
"""Update the application when the event is detected.
"""
if store is None:
store = {
"control-panel": dict(),
"selected-tests": list(),
"trending-graphs": None,
"telemetry-data": dict(),
"selected-metrics": dict(),
"telemetry-panels": list(),
"telemetry-all-in-one": list(),
"telemetry-ignore-host": list(),
"telemetry-graphs": list(),
"url": str()
}
ctrl_panel = ControlPanel(
CP_PARAMS,
store.get("control-panel", dict())
)
store_sel = store["selected-tests"]
tm_data = store["telemetry-data"]
tm_user = store["selected-metrics"]
tm_panels = store["telemetry-panels"]
tm_all_in_one = store["telemetry-all-in-one"]
tm_ignore_host = store["telemetry-ignore-host"]
plotting_area_telemetry = no_update
on_draw = [False, False] # 0 --> trending, 1 --> telemetry
# Parse the url:
parsed_url = url_decode(href)
if parsed_url:
url_params = parsed_url["params"]
else:
url_params = None
if tm_user is None:
# Telemetry user data
# The data provided by user or result of user action
tm_user = {
# List of unique metrics:
"unique_metrics": list(),
# List of metrics selected by user:
"selected_metrics": list(),
# Labels from metrics selected by user (key: label name,
# value: list of all possible values):
"unique_labels": dict(),
# Labels selected by the user (subset of 'unique_labels'):
"selected_labels": dict(),
# All unique metrics with labels (output from the step 1)
# converted from pandas dataframe to dictionary.
"unique_metrics_with_labels": dict(),
# Metrics with labels selected by the user using dropdowns.
"selected_metrics_with_labels": dict()
}
tm = TelemetryData(store_sel) if store_sel else TelemetryData()
trigger = Trigger(callback_context.triggered)
if trigger.type == "url" and url_params:
telemetry = None
try:
store_sel = literal_eval(url_params["store_sel"][0])
normalize = literal_eval(url_params["norm"][0])
telemetry = literal_eval(url_params["telemetry"][0])
url_p = url_params.get("all-in-one", ["[[None]]"])
tm_all_in_one = literal_eval(url_p[0])
url_p = url_params.get("ignore-host", ["[[None]]"])
tm_ignore_host = literal_eval(url_p[0])
if not isinstance(telemetry, list):
telemetry = [telemetry, ]
except (KeyError, IndexError, AttributeError, ValueError):
pass
if store_sel:
last_test = store_sel[-1]
test = self._spec_tbs[last_test["dut"]][last_test["phy"]]\
[last_test["area"]][last_test["test"]]
ctrl_panel.set({
"dd-dut-val": last_test["dut"],
"dd-phy-val": last_test["phy"],
"dd-phy-opt": generate_options(
self._spec_tbs[last_test["dut"]].keys()
),
"dd-phy-dis": False,
"dd-area-val": last_test["area"],
"dd-area-opt": [
{"label": label(v), "value": v} for v in sorted(
self._spec_tbs[last_test["dut"]]\
[last_test["phy"]].keys()
)
],
"dd-area-dis": False,
"dd-test-val": last_test["test"],
"dd-test-opt": generate_options(
self._spec_tbs[last_test["dut"]][last_test["phy"]]\
[last_test["area"]].keys()
),
"dd-test-dis": False,
"cl-core-opt": generate_options(test["core"]),
"cl-core-val": [last_test["core"].upper(), ],
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_ENABLED,
"cl-frmsize-opt": generate_options(test["frame-size"]),
"cl-frmsize-val": [last_test["framesize"].upper(), ],
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_ENABLED,
"cl-tsttype-opt": generate_options(test["test-type"]),
"cl-tsttype-val": [last_test["testtype"].upper(), ],
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_ENABLED,
"cl-normalize-val": normalize,
"btn-add-dis": False
})
store["trending-graphs"] = None
store["telemetry-graphs"] = list()
on_draw[0] = True
if telemetry:
tm = TelemetryData(store_sel)
tm.from_dataframe(self._data)
tm_data = tm.to_json()
tm.from_json(tm_data)
tm_panels = telemetry
on_draw[1] = True
elif trigger.type == "normalize":
ctrl_panel.set({"cl-normalize-val": trigger.value})
store["trending-graphs"] = None
on_draw[0] = True
elif trigger.type == "ctrl-dd":
if trigger.idx == "dut":
try:
options = generate_options(
self._spec_tbs[trigger.value].keys()
)
disabled = False
except KeyError:
options = list()
disabled = True
ctrl_panel.set({
"dd-dut-val": trigger.value,
"dd-phy-val": str(),
"dd-phy-opt": options,
"dd-phy-dis": disabled,
"dd-area-val": str(),
"dd-area-opt": list(),
"dd-area-dis": True,
"dd-test-val": str(),
"dd-test-opt": list(),
"dd-test-dis": True,
"cl-core-opt": list(),
"cl-core-val": list(),
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_DISABLED,
"cl-frmsize-opt": list(),
"cl-frmsize-val": list(),
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_DISABLED,
"cl-tsttype-opt": list(),
"cl-tsttype-val": list(),
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_DISABLED,
"btn-add-dis": True
})
elif trigger.idx == "phy":
try:
dut = ctrl_panel.get("dd-dut-val")
phy = self._spec_tbs[dut][trigger.value]
options = [{"label": label(v), "value": v} \
for v in sorted(phy.keys())]
disabled = False
except KeyError:
options = list()
disabled = True
ctrl_panel.set({
"dd-phy-val": trigger.value,
"dd-area-val": str(),
"dd-area-opt": options,
"dd-area-dis": disabled,
"dd-test-val": str(),
"dd-test-opt": list(),
"dd-test-dis": True,
"cl-core-opt": list(),
"cl-core-val": list(),
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_DISABLED,
"cl-frmsize-opt": list(),
"cl-frmsize-val": list(),
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_DISABLED,
"cl-tsttype-opt": list(),
"cl-tsttype-val": list(),
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_DISABLED,
"btn-add-dis": True
})
elif trigger.idx == "area":
try:
dut = ctrl_panel.get("dd-dut-val")
phy = ctrl_panel.get("dd-phy-val")
area = self._spec_tbs[dut][phy][trigger.value]
options = generate_options(area.keys())
disabled = False
except KeyError:
options = list()
disabled = True
ctrl_panel.set({
"dd-area-val": trigger.value,
"dd-test-val": str(),
"dd-test-opt": options,
"dd-test-dis": disabled,
"cl-core-opt": list(),
"cl-core-val": list(),
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_DISABLED,
"cl-frmsize-opt": list(),
"cl-frmsize-val": list(),
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_DISABLED,
"cl-tsttype-opt": list(),
"cl-tsttype-val": list(),
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_DISABLED,
"btn-add-dis": True
})
elif trigger.idx == "test":
dut = ctrl_panel.get("dd-dut-val")
phy = ctrl_panel.get("dd-phy-val")
area = ctrl_panel.get("dd-area-val")
if all((dut, phy, area, trigger.value, )):
test = self._spec_tbs[dut][phy][area][trigger.value]
ctrl_panel.set({
"dd-test-val": trigger.value,
"cl-core-opt": generate_options(test["core"]),
"cl-core-val": list(),
"cl-core-all-val": list(),
"cl-core-all-opt": C.CL_ALL_ENABLED,
"cl-frmsize-opt": \
generate_options(test["frame-size"]),
"cl-frmsize-val": list(),
"cl-frmsize-all-val": list(),
"cl-frmsize-all-opt": C.CL_ALL_ENABLED,
"cl-tsttype-opt": \
generate_options(test["test-type"]),
"cl-tsttype-val": list(),
"cl-tsttype-all-val": list(),
"cl-tsttype-all-opt": C.CL_ALL_ENABLED,
"btn-add-dis": True
})
elif trigger.type == "ctrl-cl":
param = trigger.idx.split("-")[0]
if "-all" in trigger.idx:
c_sel, c_all, c_id = list(), trigger.value, "all"
else:
c_sel, c_all, c_id = trigger.value, list(), str()
val_sel, val_all = sync_checklists(
options=ctrl_panel.get(f"cl-{param}-opt"),
sel=c_sel,
all=c_all,
id=c_id
)
ctrl_panel.set({
f"cl-{param}-val": val_sel,
f"cl-{param}-all-val": val_all,
})
if all((ctrl_panel.get("cl-core-val"),
ctrl_panel.get("cl-frmsize-val"),
ctrl_panel.get("cl-tsttype-val"), )):
ctrl_panel.set({"btn-add-dis": False})
else:
ctrl_panel.set({"btn-add-dis": True})
elif trigger.type == "ctrl-btn":
tm_panels = list()
tm_all_in_one = list()
tm_ignore_host = list()
store["trending-graphs"] = None
store["telemetry-graphs"] = list()
# on_draw[0] = True
on_draw = [True, True]
if trigger.idx == "add-test":
dut = ctrl_panel.get("dd-dut-val")
phy = ctrl_panel.get("dd-phy-val")
area = ctrl_panel.get("dd-area-val")
test = ctrl_panel.get("dd-test-val")
# Add selected test(s) to the list of tests in store:
if store_sel is None:
store_sel = list()
for core in ctrl_panel.get("cl-core-val"):
for framesize in ctrl_panel.get("cl-frmsize-val"):
for ttype in ctrl_panel.get("cl-tsttype-val"):
if dut == "trex":
core = str()
tid = "-".join((
dut,
phy.replace('af_xdp', 'af-xdp'),
area,
framesize.lower(),
core.lower(),
test,
ttype.lower()
))
if tid not in [i["id"] for i in store_sel]:
store_sel.append({
"id": tid,
"dut": dut,
"phy": phy,
"area": area,
"test": test,
"framesize": framesize.lower(),
"core": core.lower(),
"testtype": ttype.lower()
})
store_sel = sorted(store_sel, key=lambda d: d["id"])
if C.CLEAR_ALL_INPUTS:
ctrl_panel.set(ctrl_panel.defaults)
elif trigger.idx == "rm-test" and lst_sel:
new_store_sel = list()
for idx, item in enumerate(store_sel):
if not lst_sel[idx]:
new_store_sel.append(item)
store_sel = new_store_sel
elif trigger.idx == "rm-test-all":
store_sel = list()
elif trigger.type == "telemetry-btn":
if trigger.idx in ("open", "back"):
tm.from_dataframe(self._data)
tm_data = tm.to_json()
tm_user["unique_metrics"] = tm.unique_metrics
tm_user["selected_metrics"] = list()
tm_user["unique_labels"] = dict()
tm_user["selected_labels"] = dict()
search_out = (
get_list_group_items(tm_user["unique_metrics"],
"tele-cl", False),
)
is_open = (True, False)
tm_btns_disabled[1], tm_btns_disabled[5] = False, True
elif trigger.idx == "select":
if any(cl_metrics):
tm.from_json(tm_data)
if not tm_user["selected_metrics"]:
tm_user["selected_metrics"] = \
tm_user["unique_metrics"]
metrics = [a for a, b in \
zip(tm_user["selected_metrics"], cl_metrics) if b]
tm_user["selected_metrics"] = metrics
tm_user["unique_labels"] = \
tm.get_selected_labels(metrics)
tm_user["unique_metrics_with_labels"] = \
tm.unique_metrics_with_labels
list_metrics[0] = tm.str_metrics
tm_dd[0] = _get_dd_container(tm_user["unique_labels"])
if list_metrics[0]:
tm_btns_disabled[1] = True
tm_btns_disabled[4] = False
is_open = (False, True)
else:
is_open = (True, False)
elif trigger.idx == "add":
tm.from_json(tm_data)
tm_panels.append(tm_user["selected_metrics_with_labels"])
tm_all_in_one.append(all_in_one)
tm_ignore_host.append(ignore_host)
is_open = (False, False)
tm_btns_disabled[1], tm_btns_disabled[5] = True, True
on_draw = [True, True]
elif trigger.idx == "cancel":
is_open = (False, False)
tm_btns_disabled[1], tm_btns_disabled[5] = True, True
elif trigger.idx == "rm-all":
tm_panels = list()
tm_all_in_one = list()
tm_ignore_host = list()
tm_user = None
is_open = (False, False)
tm_btns_disabled[1], tm_btns_disabled[5] = True, True
plotting_area_telemetry = C.PLACEHOLDER
elif trigger.type == "telemetry-search-in":
tm.from_metrics(tm_user["unique_metrics"])
tm_user["selected_metrics"] = \
tm.search_unique_metrics(trigger.value)
search_out = (get_list_group_items(
tm_user["selected_metrics"],
type="tele-cl",
colorize=False
), )
is_open = (True, False)
elif trigger.type == "tm-dd":
tm.from_metrics_with_labels(
tm_user["unique_metrics_with_labels"]
)
selected = dict()
previous_itm = None
for itm in tm_dd_in:
if itm is None:
show_new = True
elif isinstance(itm, str):
show_new = False
selected[itm] = list()
elif isinstance(itm, list):
if previous_itm is not None:
selected[previous_itm] = itm
show_new = True
previous_itm = itm
tm_dd[0] = _get_dd_container(
tm_user["unique_labels"],
selected,
show_new
)
sel_metrics = tm.filter_selected_metrics_by_labels(selected)
tm_user["selected_metrics_with_labels"] = sel_metrics.to_dict()
if not sel_metrics.empty:
list_metrics[0] = tm.metrics_to_str(sel_metrics)
tm_btns_disabled[5] = False
else:
list_metrics[0] = str()
elif trigger.type == "tm-btn-remove":
del tm_panels[trigger.idx]
del tm_all_in_one[trigger.idx]
del tm_ignore_host[trigger.idx]
del store["telemetry-graphs"][trigger.idx]
tm.from_json(tm_data)
on_draw = [True, True]
new_url_params = {
"store_sel": store_sel,
"norm": ctrl_panel.get("cl-normalize-val")
}
if tm_panels:
new_url_params["telemetry"] = tm_panels
new_url_params["all-in-one"] = tm_all_in_one
new_url_params["ignore-host"] = tm_ignore_host
if on_draw[0]: # Trending
if store_sel:
lg_selected = get_list_group_items(store_sel, "sel-cl")
if store["trending-graphs"]:
graphs = store["trending-graphs"]
else:
graphs = graph_trending(
self._data,
store_sel,
self._graph_layout,
bool(ctrl_panel.get("cl-normalize-val"))
)
if graphs and graphs[0]:
store["trending-graphs"] = graphs
plotting_area_trending = \
Layout._plotting_area_trending(graphs)
# Telemetry
start_idx = len(store["telemetry-graphs"])
end_idx = len(tm_panels)
if not end_idx:
plotting_area_telemetry = C.PLACEHOLDER
elif on_draw[1] and (end_idx >= start_idx):
if len(tm_all_in_one) != end_idx:
tm_all_in_one = [[None], ] * end_idx
if len(tm_ignore_host) != end_idx:
tm_ignore_host = [[None], ] * end_idx
for idx in range(start_idx, end_idx):
store["telemetry-graphs"].append(graph_tm_trending(
tm.select_tm_trending_data(
tm_panels[idx],
ignore_host=bool(tm_ignore_host[idx][0])
),
self._graph_layout,
bool(tm_all_in_one[idx][0])
))
plotting_area_telemetry = \
Layout._plotting_area_telemetry(
store["telemetry-graphs"]
)
col_plotting_area = C.STYLE_ENABLED
row_card_sel_tests = C.STYLE_ENABLED
row_btns_sel_tests = C.STYLE_ENABLED
row_btns_add_tm = C.STYLE_ENABLED
else:
plotting_area_trending = no_update
plotting_area_telemetry = C.PLACEHOLDER
col_plotting_area = C.STYLE_DISABLED
row_card_sel_tests = C.STYLE_DISABLED
row_btns_sel_tests = C.STYLE_DISABLED
row_btns_add_tm = C.STYLE_DISABLED
lg_selected = no_update
store_sel = list()
tm_panels = list()
tm_all_in_one = list()
tm_ignore_host = list()
tm_user = None
else:
plotting_area_trending = no_update
col_plotting_area = no_update
row_card_sel_tests = no_update
row_btns_sel_tests = no_update
row_btns_add_tm = no_update
lg_selected = no_update
store["url"] = gen_new_url(parsed_url, new_url_params)
store["control-panel"] = ctrl_panel.panel
store["selected-tests"] = store_sel
store["telemetry-data"] = tm_data
store["selected-metrics"] = tm_user
store["telemetry-panels"] = tm_panels
store["telemetry-all-in-one"] = tm_all_in_one
store["telemetry-ignore-host"] = tm_ignore_host
ret_val = [
store,
plotting_area_trending,
plotting_area_telemetry,
col_plotting_area,
row_card_sel_tests,
row_btns_sel_tests,
row_btns_add_tm,
lg_selected,
search_out,
is_open,
tm_btns_disabled,
tm_dd,
list_metrics
]
ret_val.extend(ctrl_panel.values)
return ret_val
@app.callback(
Output("plot-mod-url", "is_open"),
Output("mod-url", "children"),
State("store", "data"),
State("plot-mod-url", "is_open"),
Input("plot-btn-url", "n_clicks")
)
def toggle_plot_mod_url(store, is_open, n_clicks):
"""Toggle the modal window with url.
"""
if not store:
raise PreventUpdate
if n_clicks:
return not is_open, store.get("url", str())
return is_open, store["url"]
def _get_dd_container(
all_labels: dict,
selected_labels: dict=dict(),
show_new=True
) -> list:
"""Generate a container with dropdown selection boxes depenting on
the input data.
:param all_labels: A dictionary with unique labels and their
possible values.
:param selected_labels: A dictionalry with user selected lables and
their values.
:param show_new: If True, a dropdown selection box to add a new
label is displayed.
:type all_labels: dict
:type selected_labels: dict
:type show_new: bool
:returns: A list of dbc rows with dropdown selection boxes.
:rtype: list
"""
def _row(
id: str,
lopts: list=list(),
lval: str=str(),
vopts: list=list(),
vvals: list=list()
) -> dbc.Row:
"""Generates a dbc row with dropdown boxes.
:param id: A string added to the dropdown ID.
:param lopts: A list of options for 'label' dropdown.
:param lval: Value of 'label' dropdown.
:param vopts: A list of options for 'value' dropdown.
:param vvals: A list of values for 'value' dropdown.
:type id: str
:type lopts: list
:type lval: str
:type vopts: list
:type vvals: list
:returns: dbc row with dropdown boxes.
:rtype: dbc.Row
"""
children = list()
if lopts:
children.append(
dbc.Col(
width=6,
children=[
dcc.Dropdown(
id={
"type": "tm-dd",
"index": f"label-{id}"
},
placeholder="Select a label...",
optionHeight=20,
multi=False,
options=lopts,
value=lval if lval else None
)
]
)
)
if vopts:
children.append(
dbc.Col(
width=6,
children=[
dcc.Dropdown(
id={
"type": "tm-dd",
"index": f"value-{id}"
},
placeholder="Select a value...",
optionHeight=20,
multi=True,
options=vopts,
value=vvals if vvals else None
)
]
)
)
return dbc.Row(class_name="g-0 p-1", children=children)
container = list()
# Display rows with items in 'selected_labels'; label on the left,
# values on the right:
keys_left = list(all_labels.keys())
for idx, label in enumerate(selected_labels.keys()):
container.append(_row(
id=idx,
lopts=deepcopy(keys_left),
lval=label,
vopts=all_labels[label],
vvals=selected_labels[label]
))
keys_left.remove(label)
# Display row with dd with labels on the left, right side is empty:
if show_new and keys_left:
container.append(_row(id="new", lopts=keys_left))
return container
@app.callback(
Output("metadata-tput-lat", "children"),
Output("metadata-hdrh-graph", "children"),
Output("offcanvas-metadata", "is_open"),
Input({"type": "graph", "index": ALL}, "clickData"),
prevent_initial_call=True
)
def _show_metadata_from_graphs(graph_data: dict) -> tuple:
"""Generates the data for the offcanvas displayed when a particular
point in a graph is clicked on.
:param graph_data: The data from the clicked point in the graph.
:type graph_data: dict
:returns: The data to be displayed on the offcanvas and the
information to show the offcanvas.
:rtype: tuple(list, list, bool)
"""
trigger = Trigger(callback_context.triggered)
try:
if trigger.idx == "tput":
idx = 0
elif trigger.idx == "bandwidth":
idx = 1
elif trigger.idx == "lat":
idx = 2
else:
raise PreventUpdate
graph_data = graph_data[idx]["points"][0]
except (IndexError, KeyError, ValueError, TypeError):
raise PreventUpdate
metadata = no_update
graph = list()
list_group_items = list()
for itm in graph_data.get("text", None).split("<br>"):
if not itm:
continue
lst_itm = itm.split(": ")
if lst_itm[0] == "csit-ref":
list_group_item = dbc.ListGroupItem([
dbc.Badge(lst_itm[0]),
html.A(
lst_itm[1],
href=f"{C.URL_JENKINS}{lst_itm[1]}",
target="_blank"
)
])
else:
list_group_item = dbc.ListGroupItem([
dbc.Badge(lst_itm[0]),
lst_itm[1]
])
list_group_items.append(list_group_item)
if trigger.idx == "tput":
title = "Throughput"
elif trigger.idx == "bandwidth":
title = "Bandwidth"
elif trigger.idx == "lat":
title = "Latency"
hdrh_data = graph_data.get("customdata", None)
if hdrh_data:
graph = [dbc.Card(
class_name="gy-2 p-0",
children=[
dbc.CardHeader(hdrh_data.pop("name")),
dbc.CardBody(
dcc.Graph(
id="hdrh-latency-graph",
figure=graph_hdrh_latency(
hdrh_data, self._graph_layout
)
)
)
])
]
else:
raise PreventUpdate
metadata = [
dbc.Card(
class_name="gy-2 p-0",
children=[
dbc.CardHeader(children=[
dcc.Clipboard(
target_id="tput-lat-metadata",
title="Copy",
style={"display": "inline-block"}
),
title
]),
dbc.CardBody(
dbc.ListGroup(list_group_items, flush=True),
id="tput-lat-metadata",
class_name="p-0",
)
]
)
]
return metadata, graph, True
@app.callback(
Output("download-trending-data", "data"),
State("store", "data"),
Input("plot-btn-download", "n_clicks"),
Input({"type": "tm-btn-download", "index": ALL}, "n_clicks"),
prevent_initial_call=True
)
def _download_data(store: list, *_) -> dict:
"""Download the data
:param store_sel: List of tests selected by user stored in the
browser.
:type store_sel: list
:returns: dict of data frame content (base64 encoded) and meta data
used by the Download component.
:rtype: dict
"""
if not store:
raise PreventUpdate
if not store["selected-tests"]:
raise PreventUpdate
df = pd.DataFrame()
trigger = Trigger(callback_context.triggered)
if not trigger.value:
raise PreventUpdate
if trigger.type == "plot-btn-download":
data = list()
for itm in store["selected-tests"]:
sel_data = select_trending_data(self._data, itm)
if sel_data is None:
continue
data.append(sel_data)
df = pd.concat(data, ignore_index=True, copy=False)
file_name = C.TREND_DOWNLOAD_FILE_NAME
elif trigger.type == "tm-btn-download":
tm = TelemetryData(store["selected-tests"])
tm.from_json(store["telemetry-data"])
df = tm.select_tm_trending_data(
store["telemetry-panels"][trigger.idx]
)
file_name = C.TELEMETRY_DOWNLOAD_FILE_NAME
else:
raise PreventUpdate
return dcc.send_data_frame(df.to_csv, file_name)
@app.callback(
Output("offcanvas-documentation", "is_open"),
Input("btn-documentation", "n_clicks"),
State("offcanvas-documentation", "is_open")
)
def toggle_offcanvas_documentation(n_clicks, is_open):
if n_clicks:
return not is_open
return is_open
|