UTI: Move common functions to utils.
[csit.git] / resources / tools / dash / app / pal / trending / layout.py
index c21e4b3..0fe28eb 100644 (file)
@@ -30,8 +30,11 @@ from copy import deepcopy
 from json import loads, JSONDecodeError
 from ast import literal_eval
 
+from ..utils.constants import Constants as C
+from ..utils.utils import show_tooltip, label, sync_checklists, list_tests, \
+    get_date, gen_new_url
+from ..utils.url_processing import url_decode
 from ..data.data import Data
-from ..data.url_processing import url_decode, url_encode
 from .graphs import graph_trending, graph_hdrh_latency, \
     select_trending_data
 
@@ -40,51 +43,6 @@ class Layout:
     """
     """
 
-    # If True, clear all inputs in control panel when button "ADD SELECTED" is
-    # pressed.
-    CLEAR_ALL_INPUTS = False
-
-    STYLE_DISABLED = {"display": "none"}
-    STYLE_ENABLED = {"display": "inherit"}
-
-    CL_ALL_DISABLED = [{
-        "label": "All",
-        "value": "all",
-        "disabled": True
-    }]
-    CL_ALL_ENABLED = [{
-        "label": "All",
-        "value": "all",
-        "disabled": False
-    }]
-
-    PLACEHOLDER = html.Nobr("")
-
-    DRIVERS = ("avf", "af-xdp", "rdma", "dpdk")
-
-    LABELS = {
-        "dpdk": "DPDK",
-        "container_memif": "LXC/DRC Container Memif",
-        "crypto": "IPSec IPv4 Routing",
-        "ip4": "IPv4 Routing",
-        "ip6": "IPv6 Routing",
-        "ip4_tunnels": "IPv4 Tunnels",
-        "l2": "L2 Ethernet Switching",
-        "srv6": "SRv6 Routing",
-        "vm_vhost": "VMs vhost-user",
-        "nfv_density-dcr_memif-chain_ipsec": "CNF Service Chains Routing IPSec",
-        "nfv_density-vm_vhost-chain_dot1qip4vxlan":"VNF Service Chains Tunnels",
-        "nfv_density-vm_vhost-chain": "VNF Service Chains Routing",
-        "nfv_density-dcr_memif-pipeline": "CNF Service Pipelines Routing",
-        "nfv_density-dcr_memif-chain": "CNF Service Chains Routing",
-    }
-
-    URL_STYLE = {
-        "background-color": "#d2ebf5",
-        "border-color": "#bce1f1",
-        "color": "#135d7c"
-    }
-
     def __init__(self, app: Flask, html_layout_file: str,
         graph_layout_file: str, data_spec_file: str, tooltip_file: str,
         time_period: str=None) -> None:
@@ -135,7 +93,7 @@ class Layout:
                 replace("2n-", "")
             test = lst_test[-1]
             nic = suite.split("-")[0]
-            for drv in self.DRIVERS:
+            for drv in C.DRIVERS:
                 if drv in test:
                     if drv == "af-xdp":
                         driver = "af_xdp"
@@ -241,32 +199,6 @@ class Layout:
     def time_period(self):
         return self._time_period
 
-    def label(self, key: str) -> str:
-        return self.LABELS.get(key, key)
-
-    def _show_tooltip(self, id: str, title: str,
-            clipboard_id: str=None) -> list:
-        """
-        """
-        return [
-            dcc.Clipboard(target_id=clipboard_id, title="Copy URL") \
-                if clipboard_id else str(),
-            f"{title} ",
-            dbc.Badge(
-                id=id,
-                children="?",
-                pill=True,
-                color="white",
-                text_color="info",
-                class_name="border ms-1",
-            ),
-            dbc.Tooltip(
-                children=self._tooltips.get(id, str()),
-                target=id,
-                placement="auto"
-            )
-        ]
-
     def add_content(self):
         """
         """
@@ -364,21 +296,21 @@ class Layout:
                             id="row-graph-tput",
                             class_name="g-0 p-2",
                             children=[
-                                self.PLACEHOLDER
+                                C.PLACEHOLDER
                             ]
                         ),
                         dbc.Row(  # Latency
                             id="row-graph-lat",
                             class_name="g-0 p-2",
                             children=[
-                                self.PLACEHOLDER
+                                C.PLACEHOLDER
                             ]
                         ),
                         dbc.Row(  # Download
                             id="row-btn-download",
                             class_name="g-0 p-2",
                             children=[
-                                self.PLACEHOLDER
+                                C.PLACEHOLDER
                             ]
                         )
                     ]
@@ -400,7 +332,7 @@ class Layout:
                         dbc.InputGroup(
                             [
                                 dbc.InputGroupText(
-                                    children=self._show_tooltip(
+                                    children=show_tooltip(self._tooltips,
                                         "help-dut", "DUT")
                                 ),
                                 dbc.Select(
@@ -428,7 +360,7 @@ class Layout:
                         dbc.InputGroup(
                             [
                                 dbc.InputGroupText(
-                                    children=self._show_tooltip(
+                                    children=show_tooltip(self._tooltips,
                                         "help-infra", "Infra")
                                 ),
                                 dbc.Select(
@@ -450,7 +382,7 @@ class Layout:
                         dbc.InputGroup(
                             [
                                 dbc.InputGroupText(
-                                    children=self._show_tooltip(
+                                    children=show_tooltip(self._tooltips,
                                         "help-area", "Area")
                                 ),
                                 dbc.Select(
@@ -470,7 +402,7 @@ class Layout:
                         dbc.InputGroup(
                             [
                                 dbc.InputGroupText(
-                                    children=self._show_tooltip(
+                                    children=show_tooltip(self._tooltips,
                                         "help-test", "Test")
                                 ),
                                 dbc.Select(
@@ -489,7 +421,7 @@ class Layout:
                     class_name="gy-1",
                     children=[
                         dbc.Label(
-                            children=self._show_tooltip(
+                            children=show_tooltip(self._tooltips,
                                 "help-framesize", "Frame Size"),
                             class_name="p-0"
                         ),
@@ -497,7 +429,7 @@ class Layout:
                             children=[
                                 dbc.Checklist(
                                     id="cl-ctrl-framesize-all",
-                                    options=self.CL_ALL_DISABLED,
+                                    options=C.CL_ALL_DISABLED,
                                     inline=True,
                                     switch=False
                                 ),
@@ -520,7 +452,7 @@ class Layout:
                     class_name="gy-1",
                     children=[
                         dbc.Label(
-                            children=self._show_tooltip(
+                            children=show_tooltip(self._tooltips,
                                 "help-cores", "Number of Cores"),
                             class_name="p-0"
                         ),
@@ -528,7 +460,7 @@ class Layout:
                             children=[
                                 dbc.Checklist(
                                     id="cl-ctrl-core-all",
-                                    options=self.CL_ALL_DISABLED,
+                                    options=C.CL_ALL_DISABLED,
                                     inline=False,
                                     switch=False
                                 )
@@ -551,7 +483,7 @@ class Layout:
                     class_name="gy-1",
                     children=[
                         dbc.Label(
-                            children=self._show_tooltip(
+                            children=show_tooltip(self._tooltips,
                                 "help-ttype", "Test Type"),
                             class_name="p-0"
                         ),
@@ -559,7 +491,7 @@ class Layout:
                             children=[
                                 dbc.Checklist(
                                     id="cl-ctrl-testtype-all",
-                                    options=self.CL_ALL_DISABLED,
+                                    options=C.CL_ALL_DISABLED,
                                     inline=True,
                                     switch=False
                                 ),
@@ -582,7 +514,7 @@ class Layout:
                     class_name="gy-1",
                     children=[
                         dbc.Label(
-                            children=self._show_tooltip(
+                            children=show_tooltip(self._tooltips,
                                 "help-normalize", "Normalize"),
                             class_name="p-0"
                         ),
@@ -626,7 +558,7 @@ class Layout:
                     children=[
                         dbc.Label(
                             class_name="gy-1",
-                            children=self._show_tooltip(
+                            children=show_tooltip(self._tooltips,
                                 "help-time-period", "Time Period"),
                         ),
                         dcc.DatePickerRange(
@@ -648,7 +580,7 @@ class Layout:
                 dbc.Row(
                     id="row-card-sel-tests",
                     class_name="gy-1",
-                    style=self.STYLE_DISABLED,
+                    style=C.STYLE_DISABLED,
                     children=[
                         dbc.Label(
                             "Selected tests",
@@ -665,7 +597,7 @@ class Layout:
                 ),
                 dbc.Row(
                     id="row-btns-sel-tests",
-                    style=self.STYLE_DISABLED,
+                    style=C.STYLE_DISABLED,
                     children=[
                         dbc.ButtonGroup(
                             class_name="gy-2",
@@ -695,12 +627,6 @@ class Layout:
     class ControlPanel:
         def __init__(self, panel: dict) -> None:
 
-            CL_ALL_DISABLED = [{
-                "label": "All",
-                "value": "all",
-                "disabled": True
-            }]
-
             # Defines also the order of keys
             self._defaults = {
                 "dd-ctrl-dut-value": str(),
@@ -716,15 +642,15 @@ class Layout:
                 "cl-ctrl-core-options": list(),
                 "cl-ctrl-core-value": list(),
                 "cl-ctrl-core-all-value": list(),
-                "cl-ctrl-core-all-options": CL_ALL_DISABLED,
+                "cl-ctrl-core-all-options": C.CL_ALL_DISABLED,
                 "cl-ctrl-framesize-options": list(),
                 "cl-ctrl-framesize-value": list(),
                 "cl-ctrl-framesize-all-value": list(),
-                "cl-ctrl-framesize-all-options": CL_ALL_DISABLED,
+                "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED,
                 "cl-ctrl-testtype-options": list(),
                 "cl-ctrl-testtype-value": list(),
                 "cl-ctrl-testtype-all-value": list(),
-                "cl-ctrl-testtype-all-options": CL_ALL_DISABLED,
+                "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED,
                 "btn-ctrl-add-disabled": True,
                 "cl-normalize-value": list(),
                 "cl-selected-options": list(),
@@ -756,30 +682,6 @@ class Layout:
         def values(self) -> tuple:
             return tuple(self._panel.values())
 
-    @staticmethod
-    def _sync_checklists(opt: list, sel: list, all: list, id: str) -> tuple:
-        """
-        """
-        options = {v["value"] for v in opt}
-        if id =="all":
-            sel = list(options) if all else list()
-        else:
-            all = ["all", ] if set(sel) == options else list()
-        return sel, all
-
-    @staticmethod
-    def _list_tests(selection: dict) -> list:
-        """Display selected tests with checkboxes
-        """
-        if selection:
-            return [{"label": v["id"], "value": v["id"]} for v in selection]
-        else:
-            return list()
-
-    @staticmethod
-    def _get_date(s_date: str) -> datetime:
-        return datetime(int(s_date[0:4]), int(s_date[5:7]), int(s_date[8:10]))
-
     def callbacks(self, app):
 
         def _generate_plotting_area(figs: tuple, url: str) -> tuple:
@@ -788,9 +690,9 @@ class Layout:
 
             (fig_tput, fig_lat) = figs
 
-            row_fig_tput = self.PLACEHOLDER
-            row_fig_lat = self.PLACEHOLDER
-            row_btn_dwnld = self.PLACEHOLDER
+            row_fig_tput = C.PLACEHOLDER
+            row_fig_lat = C.PLACEHOLDER
+            row_btn_dwnld = C.PLACEHOLDER
 
             if fig_tput:
                 row_fig_tput = [
@@ -806,7 +708,7 @@ class Layout:
                             dcc.Loading(children=[
                                 dbc.Button(
                                     id="btn-download-data",
-                                    children=self._show_tooltip(
+                                    children=show_tooltip(self._tooltips,
                                         "help-download", "Download Data"),
                                     class_name="me-1",
                                     color="info"
@@ -822,15 +724,15 @@ class Layout:
                                 class_name="me-1",
                                 children=[
                                     dbc.InputGroupText(
-                                        style=self.URL_STYLE,
-                                        children=self._show_tooltip(
+                                        style=C.URL_STYLE,
+                                        children=show_tooltip(self._tooltips,
                                             "help-url", "URL", "input-url")
                                     ),
                                     dbc.Input(
                                         id="input-url",
                                         readonly=True,
                                         type="url",
-                                        style=self.URL_STYLE,
+                                        style=C.URL_STYLE,
                                         value=url
                                     )
                                 ]
@@ -911,29 +813,10 @@ class Layout:
             """
             """
 
-            def _gen_new_url(parsed_url: dict, store_sel: list,
-                    start: datetime, end: datetime) -> str:
-
-                if parsed_url:
-                    new_url = url_encode({
-                        "scheme": parsed_url["scheme"],
-                        "netloc": parsed_url["netloc"],
-                        "path": parsed_url["path"],
-                        "params": {
-                            "store_sel": store_sel,
-                            "start": start,
-                            "end": end
-                        }
-                    })
-                else:
-                    new_url = str()
-                return new_url
-
-
             ctrl_panel = self.ControlPanel(cp_data)
 
-            d_start = self._get_date(d_start)
-            d_end = self._get_date(d_end)
+            d_start = get_date(d_start)
+            d_end = get_date(d_end)
 
             # Parse the url:
             parsed_url = url_decode(href)
@@ -971,23 +854,22 @@ class Layout:
                     "cl-ctrl-core-options": list(),
                     "cl-ctrl-core-value": list(),
                     "cl-ctrl-core-all-value": list(),
-                    "cl-ctrl-core-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-core-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-framesize-options": list(),
                     "cl-ctrl-framesize-value": list(),
                     "cl-ctrl-framesize-all-value": list(),
-                    "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-testtype-options": list(),
                     "cl-ctrl-testtype-value": list(),
                     "cl-ctrl-testtype-all-value": list(),
-                    "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED,
                 })
             elif trigger_id == "dd-ctrl-phy":
                 try:
                     dut = ctrl_panel.get("dd-ctrl-dut-value")
                     phy = self.spec_tbs[dut][dd_phy]
                     options = sorted(
-                        [{"label": self.label(v), "value": v}
-                            for v in phy.keys()],
+                        [{"label": label(v), "value": v} for v in phy.keys()],
                         key=lambda d: d["label"]
                     )
                     disabled = False
@@ -1005,15 +887,15 @@ class Layout:
                     "cl-ctrl-core-options": list(),
                     "cl-ctrl-core-value": list(),
                     "cl-ctrl-core-all-value": list(),
-                    "cl-ctrl-core-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-core-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-framesize-options": list(),
                     "cl-ctrl-framesize-value": list(),
                     "cl-ctrl-framesize-all-value": list(),
-                    "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-testtype-options": list(),
                     "cl-ctrl-testtype-value": list(),
                     "cl-ctrl-testtype-all-value": list(),
-                    "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED,
                 })
             elif trigger_id == "dd-ctrl-area":
                 try:
@@ -1036,15 +918,15 @@ class Layout:
                     "cl-ctrl-core-options": list(),
                     "cl-ctrl-core-value": list(),
                     "cl-ctrl-core-all-value": list(),
-                    "cl-ctrl-core-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-core-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-framesize-options": list(),
                     "cl-ctrl-framesize-value": list(),
                     "cl-ctrl-framesize-all-value": list(),
-                    "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED,
                     "cl-ctrl-testtype-options": list(),
                     "cl-ctrl-testtype-value": list(),
                     "cl-ctrl-testtype-all-value": list(),
-                    "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED,
+                    "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED,
                 })
             elif trigger_id == "dd-ctrl-test":
                 core_opts = list()
@@ -1069,19 +951,19 @@ class Layout:
                         "cl-ctrl-core-options": core_opts,
                         "cl-ctrl-core-value": list(),
                         "cl-ctrl-core-all-value": list(),
-                        "cl-ctrl-core-all-options": self.CL_ALL_ENABLED,
+                        "cl-ctrl-core-all-options": C.CL_ALL_ENABLED,
                         "cl-ctrl-framesize-options": framesize_opts,
                         "cl-ctrl-framesize-value": list(),
                         "cl-ctrl-framesize-all-value": list(),
-                        "cl-ctrl-framesize-all-options": self.CL_ALL_ENABLED,
+                        "cl-ctrl-framesize-all-options": C.CL_ALL_ENABLED,
                         "cl-ctrl-testtype-options": testtype_opts,
                         "cl-ctrl-testtype-value": list(),
                         "cl-ctrl-testtype-all-value": list(),
-                        "cl-ctrl-testtype-all-options": self.CL_ALL_ENABLED,
+                        "cl-ctrl-testtype-all-options": C.CL_ALL_ENABLED,
                     })
             elif trigger_id == "cl-ctrl-core":
-                val_sel, val_all = self._sync_checklists(
-                    opt=ctrl_panel.get("cl-ctrl-core-options"),
+                val_sel, val_all = sync_checklists(
+                    options=ctrl_panel.get("cl-ctrl-core-options"),
                     sel=cl_core,
                     all=list(),
                     id=""
@@ -1091,8 +973,8 @@ class Layout:
                     "cl-ctrl-core-all-value": val_all,
                 })
             elif trigger_id == "cl-ctrl-core-all":
-                val_sel, val_all = self._sync_checklists(
-                    opt = ctrl_panel.get("cl-ctrl-core-options"),
+                val_sel, val_all = sync_checklists(
+                    options = ctrl_panel.get("cl-ctrl-core-options"),
                     sel=list(),
                     all=cl_core_all,
                     id="all"
@@ -1102,8 +984,8 @@ class Layout:
                     "cl-ctrl-core-all-value": val_all,
                 })
             elif trigger_id == "cl-ctrl-framesize":
-                val_sel, val_all = self._sync_checklists(
-                    opt = ctrl_panel.get("cl-ctrl-framesize-options"),
+                val_sel, val_all = sync_checklists(
+                    options = ctrl_panel.get("cl-ctrl-framesize-options"),
                     sel=cl_framesize,
                     all=list(),
                     id=""
@@ -1113,8 +995,8 @@ class Layout:
                     "cl-ctrl-framesize-all-value": val_all,
                 })
             elif trigger_id == "cl-ctrl-framesize-all":
-                val_sel, val_all = self._sync_checklists(
-                    opt = ctrl_panel.get("cl-ctrl-framesize-options"),
+                val_sel, val_all = sync_checklists(
+                    options = ctrl_panel.get("cl-ctrl-framesize-options"),
                     sel=list(),
                     all=cl_framesize_all,
                     id="all"
@@ -1124,8 +1006,8 @@ class Layout:
                     "cl-ctrl-framesize-all-value": val_all,
                 })
             elif trigger_id == "cl-ctrl-testtype":
-                val_sel, val_all = self._sync_checklists(
-                    opt = ctrl_panel.get("cl-ctrl-testtype-options"),
+                val_sel, val_all = sync_checklists(
+                    options = ctrl_panel.get("cl-ctrl-testtype-options"),
                     sel=cl_testtype,
                     all=list(),
                     id=""
@@ -1135,8 +1017,8 @@ class Layout:
                     "cl-ctrl-testtype-all-value": val_all,
                 })
             elif trigger_id == "cl-ctrl-testtype-all":
-                val_sel, val_all = self._sync_checklists(
-                    opt = ctrl_panel.get("cl-ctrl-testtype-options"),
+                val_sel, val_all = sync_checklists(
+                    options = ctrl_panel.get("cl-ctrl-testtype-options"),
                     sel=list(),
                     all=cl_testtype_all,
                     id="all"
@@ -1180,17 +1062,17 @@ class Layout:
                                         "testtype": ttype.lower()
                                     })
                     store_sel = sorted(store_sel, key=lambda d: d["id"])
-                    row_card_sel_tests = self.STYLE_ENABLED
-                    row_btns_sel_tests = self.STYLE_ENABLED
-                    if self.CLEAR_ALL_INPUTS:
+                    row_card_sel_tests = C.STYLE_ENABLED
+                    row_btns_sel_tests = C.STYLE_ENABLED
+                    if C.CLEAR_ALL_INPUTS:
                         ctrl_panel.set(ctrl_panel.defaults)
             elif trigger_id == "btn-sel-remove-all":
                 _ = btn_remove_all
-                row_fig_tput = self.PLACEHOLDER
-                row_fig_lat = self.PLACEHOLDER
-                row_btn_dwnld = self.PLACEHOLDER
-                row_card_sel_tests = self.STYLE_DISABLED
-                row_btns_sel_tests = self.STYLE_DISABLED
+                row_fig_tput = C.PLACEHOLDER
+                row_fig_lat = C.PLACEHOLDER
+                row_btn_dwnld = C.PLACEHOLDER
+                row_card_sel_tests = C.STYLE_DISABLED
+                row_btns_sel_tests = C.STYLE_DISABLED
                 store_sel = list()
                 ctrl_panel.set({"cl-selected-options": list()})
             elif trigger_id == "btn-sel-remove":
@@ -1207,30 +1089,37 @@ class Layout:
                 if url_params:
                     store_sel = literal_eval(
                         url_params.get("store_sel", list())[0])
-                    d_start = self._get_date(url_params.get("start", list())[0])
-                    d_end = self._get_date(url_params.get("end", list())[0])
+                    d_start = get_date(url_params.get("start", list())[0])
+                    d_end = get_date(url_params.get("end", list())[0])
                     if store_sel:
-                        row_card_sel_tests = self.STYLE_ENABLED
-                        row_btns_sel_tests = self.STYLE_ENABLED
+                        row_card_sel_tests = C.STYLE_ENABLED
+                        row_btns_sel_tests = C.STYLE_ENABLED
 
-            if trigger_id in ("btn-ctrl-add", "url", "dpr-period"
+            if trigger_id in ("btn-ctrl-add", "url", "dpr-period",
                     "btn-sel-remove", "cl-ctrl-normalize"):
                 if store_sel:
                     row_fig_tput, row_fig_lat, row_btn_dwnld = \
                         _generate_plotting_area(
                             graph_trending(self.data, store_sel, self.layout,
                                 d_start, d_end, bool(cl_normalize)),
-                            _gen_new_url(parsed_url, store_sel, d_start, d_end)
+                            gen_new_url(
+                                parsed_url,
+                                {
+                                    "store_sel": store_sel,
+                                    "start": d_start,
+                                    "end": d_end
+                                }
+                            )
                         )
                     ctrl_panel.set({
-                        "cl-selected-options": self._list_tests(store_sel)
+                        "cl-selected-options": list_tests(store_sel)
                     })
                 else:
-                    row_fig_tput = self.PLACEHOLDER
-                    row_fig_lat = self.PLACEHOLDER
-                    row_btn_dwnld = self.PLACEHOLDER
-                    row_card_sel_tests = self.STYLE_DISABLED
-                    row_btns_sel_tests = self.STYLE_DISABLED
+                    row_fig_tput = C.PLACEHOLDER
+                    row_fig_lat = C.PLACEHOLDER
+                    row_btn_dwnld = C.PLACEHOLDER
+                    row_card_sel_tests = C.STYLE_DISABLED
+                    row_btns_sel_tests = C.STYLE_DISABLED
                     store_sel = list()
                     ctrl_panel.set({"cl-selected-options": list()})