X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fdash%2Fapp%2Fpal%2Ftrending%2Flayout.py;h=2be19f8439f5e9d0de4be9a96af49ae4e28528f4;hp=fa5f8218ad95102616025b0400fe4dbc3de3bc29;hb=808797d2d913eac7581a4e4cba3fb826ddbff775;hpb=cb61767fb2133890a786fc8f580109e9f8f3c5c5 diff --git a/resources/tools/dash/app/pal/trending/layout.py b/resources/tools/dash/app/pal/trending/layout.py index fa5f8218ad..2be19f8439 100644 --- a/resources/tools/dash/app/pal/trending/layout.py +++ b/resources/tools/dash/app/pal/trending/layout.py @@ -14,9 +14,11 @@ """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 @@ -26,61 +28,140 @@ from yaml import load, FullLoader, YAMLError from datetime import datetime, timedelta 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 .graphs import graph_trending, graph_hdrh_latency, \ select_trending_data class Layout: + """The layout of the dash app and the callbacks. """ - """ - - 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 - }] + 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: + """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. - PLACEHOLDER = html.Nobr("") - - def __init__(self, app, html_layout_file, spec_file, graph_layout_file, - data_spec_file): - """ + :param app: Flask application running the dash application. + :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 data_spec_file: Path and name of the file specifying the data to + be read from parquets for this application. + :param tooltip_file: Path and name of the yaml file specifying the + tooltips. + :param time_period: It defines the time period for data read from the + parquets in days from now back to the past. + :type app: Flask + :type html_layout_file: str + :type graph_layout_file: str + :type data_spec_file: str + :type tooltip_file: str + :type time_period: int """ # Inputs self._app = app self._html_layout_file = html_layout_file - self._spec_file = spec_file self._graph_layout_file = graph_layout_file self._data_spec_file = data_spec_file + self._tooltip_file = tooltip_file + self._time_period = time_period # Read the data: data_mrr = Data( data_spec_file=self._data_spec_file, debug=True - ).read_trending_mrr() + ).read_trending_mrr(days=self._time_period) data_ndrpdr = Data( data_spec_file=self._data_spec_file, debug=True - ).read_trending_ndrpdr() + ).read_trending_ndrpdr(days=self._time_period) self._data = pd.concat([data_mrr, data_ndrpdr], ignore_index=True) + data_time_period = \ + (datetime.utcnow() - self._data["start_time"].min()).days + if self._time_period > data_time_period: + self._time_period = data_time_period + + + # Get structure of tests: + tbs = dict() + for _, row in self._data[["job", "test_id"]].drop_duplicates().\ + iterrows(): + lst_job = row["job"].split("-") + dut = lst_job[1] + ttype = lst_job[3] + 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 ttype == "mrr": + if "MRR" not in tbs[dut][infra][area][test]["test-type"]: + tbs[dut][infra][area][test]["test-type"].append("MRR") + elif ttype == "ndrpdr": + if "NDR" not in tbs[dut][infra][area][test]["test-type"]: + tbs[dut][infra][area][test]["test-type"].extend( + ("NDR", "PDR")) + self._spec_tbs = tbs + # Read from files: self._html_layout = "" - self._spec_tbs = None self._graph_layout = None + self._tooltips = dict() try: with open(self._html_layout_file, "r") as file_read: @@ -91,32 +172,30 @@ class Layout: ) try: - with open(self._spec_file, "r") as file_read: - self._spec_tbs = load(file_read, Loader=FullLoader) + 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._spec_file,}\n{err}" + 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._spec_file,}\n" - f"{err}" + f"{self._graph_layout_file}\n{err}" ) try: - with open(self._graph_layout_file, "r") as file_read: - self._graph_layout = load(file_read, Loader=FullLoader) + with open(self._tooltip_file, "r") as file_read: + self._tooltips = 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}" + logging.warning( + f"Not possible to open the file {self._tooltip_file}\n{err}" ) except YAMLError as err: - raise RuntimeError( + logging.warning( f"An error occurred while parsing the specification file " - f"{self._graph_layout_file}\n" - f"{err}" + f"{self._tooltip_file}\n{err}" ) # Callbacks: @@ -139,9 +218,24 @@ class Layout: def layout(self): return self._graph_layout + @property + def time_period(self): + return self._time_period + 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", @@ -170,12 +264,9 @@ class Layout: id="row-main", class_name="g-0", children=[ - dcc.Store( - id="selected-tests" - ), - dcc.Store( - id="control-panel" - ), + dcc.Store(id="selected-tests"), + dcc.Store(id="control-panel"), + dcc.Location(id="url", refresh=False), self._add_ctrl_col(), self._add_plotting_col(), ] @@ -197,6 +288,9 @@ class Layout: 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( id="navbarsimple-main", @@ -219,6 +313,9 @@ class Layout: 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( id="col-controls", @@ -229,29 +326,36 @@ class Layout: def _add_plotting_col(self) -> dbc.Col: """Add column with plots and tables. It is placed on the right side. + + :returns: Column with tables. + :rtype: dbc.Col """ return dbc.Col( id="col-plotting-area", children=[ - dbc.Row( # Throughput - id="row-graph-tput", - class_name="g-0 p-2", - children=[ - self.PLACEHOLDER - ] - ), - dbc.Row( # Latency - id="row-graph-lat", - class_name="g-0 p-2", - children=[ - self.PLACEHOLDER - ] - ), - dbc.Row( # Download - id="row-btn-download", - class_name="g-0 p-2", + dcc.Loading( children=[ - self.PLACEHOLDER + dbc.Row( # Throughput + id="row-graph-tput", + class_name="g-0 p-2", + children=[ + C.PLACEHOLDER + ] + ), + dbc.Row( # Latency + id="row-graph-lat", + class_name="g-0 p-2", + children=[ + C.PLACEHOLDER + ] + ), + dbc.Row( # Download + id="row-btn-download", + class_name="g-0 p-2", + children=[ + C.PLACEHOLDER + ] + ) ] ) ], @@ -259,7 +363,10 @@ class Layout: ) def _add_ctrl_panel(self) -> dbc.Row: - """ + """Add control panel. + + :returns: Control panel. + :rtype: dbc.Row """ return dbc.Row( id="row-ctrl-panel", @@ -270,14 +377,45 @@ class Layout: children=[ dbc.InputGroup( [ - dbc.InputGroupText("Infra"), + dbc.InputGroupText( + children=show_tooltip(self._tooltips, + "help-dut", "DUT") + ), + dbc.Select( + id="dd-ctrl-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"] + ) + ) + ], + class_name="mb-3", + size="sm", + ), + ] + ), + dbc.Row( + class_name="g-0", + children=[ + dbc.InputGroup( + [ + dbc.InputGroupText( + children=show_tooltip(self._tooltips, + "help-infra", "Infra") + ), dbc.Select( id="dd-ctrl-phy", - placeholder="Select a Physical Test Bed Topology...", - options=[ - {"label": k, "value": k} for k in self.spec_tbs.keys() - ], - ), + placeholder=( + "Select a Physical Test Bed " + "Topology..." + ) + ) ], class_name="mb-3", size="sm", @@ -289,7 +427,10 @@ class Layout: children=[ dbc.InputGroup( [ - dbc.InputGroupText("Area"), + dbc.InputGroupText( + children=show_tooltip(self._tooltips, + "help-area", "Area") + ), dbc.Select( id="dd-ctrl-area", placeholder="Select an Area...", @@ -306,7 +447,10 @@ class Layout: children=[ dbc.InputGroup( [ - dbc.InputGroupText("Test"), + dbc.InputGroupText( + children=show_tooltip(self._tooltips, + "help-test", "Test") + ), dbc.Select( id="dd-ctrl-test", placeholder="Select a Test...", @@ -319,28 +463,29 @@ class Layout: ] ), dbc.Row( - id="row-ctrl-core", + id="row-ctrl-framesize", class_name="gy-1", children=[ dbc.Label( - "Number of Cores", + children=show_tooltip(self._tooltips, + "help-framesize", "Frame Size"), class_name="p-0" ), dbc.Col( children=[ dbc.Checklist( - id="cl-ctrl-core-all", - options=self.CL_ALL_DISABLED, - inline=False, + id="cl-ctrl-framesize-all", + options=C.CL_ALL_DISABLED, + inline=True, switch=False - ) + ), ], width=3 ), dbc.Col( children=[ dbc.Checklist( - id="cl-ctrl-core", + id="cl-ctrl-framesize", inline=True, switch=False ) @@ -349,28 +494,29 @@ class Layout: ] ), dbc.Row( - id="row-ctrl-framesize", + id="row-ctrl-core", class_name="gy-1", children=[ dbc.Label( - "Frame Size", + children=show_tooltip(self._tooltips, + "help-cores", "Number of Cores"), class_name="p-0" ), dbc.Col( children=[ dbc.Checklist( - id="cl-ctrl-framesize-all", - options=self.CL_ALL_DISABLED, - inline=True, + id="cl-ctrl-core-all", + options=C.CL_ALL_DISABLED, + inline=False, switch=False - ), + ) ], width=3 ), dbc.Col( children=[ dbc.Checklist( - id="cl-ctrl-framesize", + id="cl-ctrl-core", inline=True, switch=False ) @@ -383,14 +529,15 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - "Test Type", + children=show_tooltip(self._tooltips, + "help-ttype", "Test Type"), class_name="p-0" ), dbc.Col( children=[ dbc.Checklist( id="cl-ctrl-testtype-all", - options=self.CL_ALL_DISABLED, + options=C.CL_ALL_DISABLED, inline=True, switch=False ), @@ -408,6 +555,34 @@ class Layout: ) ] ), + dbc.Row( + id="row-ctrl-normalize", + class_name="gy-1", + children=[ + dbc.Label( + children=show_tooltip(self._tooltips, + "help-normalize", "Normalize"), + class_name="p-0" + ), + dbc.Col( + children=[ + dbc.Checklist( + id="cl-ctrl-normalize", + options=[{ + "value": "normalize", + "label": ( + "Normalize results to CPU" + "frequency 2GHz" + ) + }], + value=[], + inline=True, + switch=False + ), + ] + ) + ] + ), dbc.Row( class_name="gy-1 p-0", children=[ @@ -427,23 +602,31 @@ class Layout: dbc.Row( class_name="gy-1", children=[ + dbc.Label( + class_name="gy-1", + children=show_tooltip(self._tooltips, + "help-time-period", "Time Period"), + ), dcc.DatePickerRange( id="dpr-period", className="d-flex justify-content-center", min_date_allowed=\ - datetime.utcnow()-timedelta(days=180), + datetime.utcnow() - timedelta( + days=self.time_period), max_date_allowed=datetime.utcnow(), initial_visible_month=datetime.utcnow(), - start_date=datetime.utcnow() - timedelta(days=180), + start_date=\ + datetime.utcnow() - timedelta( + days=self.time_period), end_date=datetime.utcnow(), - display_format="D MMMM YY" + display_format="D MMM YY" ) ] ), dbc.Row( id="row-card-sel-tests", class_name="gy-1", - style=self.STYLE_DISABLED, + style=C.STYLE_DISABLED, children=[ dbc.Label( "Selected tests", @@ -460,7 +643,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", @@ -488,16 +671,25 @@ class Layout: ) class ControlPanel: + """A class representing the control panel. + """ + def __init__(self, panel: dict) -> None: + """Initialisation of the control pannel by default values. If + particular values are provided (parameter "panel") they are set + afterwards. - CL_ALL_DISABLED = [{ - "label": "All", - "value": "all", - "disabled": True - }] + :param panel: Custom values to be set to the control panel. + :param default: Default values to be set to the control panel. + :type panel: dict + :type defaults: dict + """ # Defines also the order of keys self._defaults = { + "dd-ctrl-dut-value": str(), + "dd-ctrl-phy-options": list(), + "dd-ctrl-phy-disabled": True, "dd-ctrl-phy-value": str(), "dd-ctrl-area-options": list(), "dd-ctrl-area-disabled": True, @@ -508,16 +700,17 @@ 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(), } @@ -535,6 +728,13 @@ class Layout: return self._panel def set(self, kwargs: dict) -> None: + """Set the values of the Control panel. + + :param kwargs: key - value pairs to be set. + :type kwargs: dict + :raises KeyError: If the key in kwargs is not present in the Control + panel. + """ for key, val in kwargs.items(): if key in self._panel: self._panel[key] = val @@ -542,72 +742,101 @@ class Layout: raise KeyError(f"The key {key} is not defined.") def get(self, key: str) -> any: + """Returns the value of a key from the Control panel. + + :param key: The key which value should be returned. + :type key: str + :returns: The value of the key. + :rtype: any + :raises KeyError: If the key in kwargs is not present in the Control + panel. + """ return self._panel[key] def values(self) -> tuple: + """Returns the values from the Control panel as a list. + + :returns: The values from the Control panel. + :rtype: list + """ 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 + def callbacks(self, app): + """Callbacks for the whole application. - @staticmethod - def _list_tests(selection: dict) -> list: - """Display selected tests with checkboxes + :param app: The application. + :type app: Flask """ - if selection: - return [ - {"label": v["id"], "value": v["id"]} for v in selection - ] - else: - return list() - def callbacks(self, app): + def _generate_plotting_area(figs: tuple, url: str) -> tuple: + """Generate the plotting area with all its content. - def _generate_plotting_arrea(args: tuple) -> tuple: - """ + :param figs: Figures to be placed in the plotting area. + :param utl: The URL to be placed in the plotting area bellow the + tables. + :type figs: tuple of plotly.graph_objects.Figure + :type url: str + :returns: tuple of elements to be shown in the plotting area. + :rtype: tuple(dcc.Graph, dcc.Graph, list(dbc.Col, dbc.Col)) """ - (fig_tput, fig_lat) = args + (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 = [ - dcc.Loading( - dcc.Graph( - id={"type": "graph", "index": "tput"}, - figure=fig_tput - ) - ), + dcc.Graph( + id={"type": "graph", "index": "tput"}, + figure=fig_tput + ) ] row_btn_dwnld = [ - dcc.Loading(children=[ - dbc.Button( - id="btn-download-data", - children=["Download Data"], - class_name="me-1", - color="info" - ), - dcc.Download(id="download-data") - ]), + dbc.Col( # Download + width=2, + children=[ + dcc.Loading(children=[ + dbc.Button( + id="btn-download-data", + children=show_tooltip(self._tooltips, + "help-download", "Download Data"), + class_name="me-1", + color="info" + ), + dcc.Download(id="download-data") + ]), + ] + ), + dbc.Col( # Show URL + width=10, + children=[ + dbc.InputGroup( + class_name="me-1", + children=[ + dbc.InputGroupText( + style=C.URL_STYLE, + children=show_tooltip(self._tooltips, + "help-url", "URL", "input-url") + ), + dbc.Input( + id="input-url", + readonly=True, + type="url", + style=C.URL_STYLE, + value=url + ) + ] + ) + ] + ) ] if fig_lat: row_fig_lat = [ - dcc.Loading( - dcc.Graph( - id={"type": "graph", "index": "lat"}, - figure=fig_lat - ) + dcc.Graph( + id={"type": "graph", "index": "lat"}, + figure=fig_lat ) ] @@ -621,6 +850,9 @@ class Layout: Output("row-btn-download", "children"), Output("row-card-sel-tests", "style"), Output("row-btns-sel-tests", "style"), + Output("dd-ctrl-dut", "value"), + Output("dd-ctrl-phy", "options"), + Output("dd-ctrl-phy", "disabled"), Output("dd-ctrl-phy", "value"), Output("dd-ctrl-area", "options"), Output("dd-ctrl-area", "disabled"), @@ -641,10 +873,12 @@ class Layout: Output("cl-ctrl-testtype-all", "value"), Output("cl-ctrl-testtype-all", "options"), Output("btn-ctrl-add", "disabled"), + Output("cl-ctrl-normalize", "value"), Output("cl-selected", "options"), # User selection State("control-panel", "data"), # Store State("selected-tests", "data"), # Store State("cl-selected", "value"), # User selection + Input("dd-ctrl-dut", "value"), Input("dd-ctrl-phy", "value"), Input("dd-ctrl-area", "value"), Input("dd-ctrl-test", "value"), @@ -654,24 +888,76 @@ class Layout: Input("cl-ctrl-framesize-all", "value"), Input("cl-ctrl-testtype", "value"), Input("cl-ctrl-testtype-all", "value"), + Input("cl-ctrl-normalize", "value"), Input("btn-ctrl-add", "n_clicks"), Input("dpr-period", "start_date"), Input("dpr-period", "end_date"), Input("btn-sel-remove", "n_clicks"), Input("btn-sel-remove-all", "n_clicks"), + Input("url", "href") ) def _update_ctrl_panel(cp_data: dict, store_sel: list, list_sel: list, - dd_phy: str, dd_area: str, dd_test: str, cl_core: list, + dd_dut: str, dd_phy: str, dd_area: str, dd_test: str, cl_core: list, cl_core_all: list, cl_framesize: list, cl_framesize_all: list, - cl_testtype: list, cl_testtype_all: list, btn_add: int, - d_start: str, d_end: str, btn_remove: int, - btn_remove_all: int) -> tuple: - """ + cl_testtype: list, cl_testtype_all: list, cl_normalize: list, + btn_add: int, d_start: str, d_end: str, btn_remove: int, + btn_remove_all: int, href: str) -> tuple: + """Update the application when the event is detected. + + :param cp_data: Current status of the control panel stored in + browser. + :param store_sel: List of tests selected by user stored in the + browser. + :param list_sel: List of tests selected by the user shown in the + checklist. + :param dd_dut: Input - DUTs. + :param dd_phy: Input - topo- arch-nic-driver. + :param dd_area: Input - Tested area. + :param dd_test: Input - Test. + :param cl_core: Input - Number of cores. + :param cl_core_all: Input - All numbers of cores. + :param cl_framesize: Input - Frame sizes. + :param cl_framesize_all: Input - All frame sizes. + :param cl_testtype: Input - Test type (NDR, PDR, MRR). + :param cl_testtype_all: Input - All test types. + :param cl_normalize: Input - Normalize the results. + :param btn_add: Input - Button "Add Selected" tests. + :param d_start: Date and time where the data processing starts. + :param d_end: Date and time where the data processing ends. + :param btn_remove: Input - Button "Remove selected" tests. + :param btn_remove_all: Input - Button "Remove All" tests. + :param href: Input - The URL provided by the browser. + :type cp_data: dict + :type store_sel: list + :type list_sel: list + :type dd_dut: str + :type dd_phy: str + :type dd_area: str + :type dd_test: str + :type cl_core: list + :type cl_core_all: list + :type cl_framesize: list + :type cl_framesize_all: list + :type cl_testtype: list + :type cl_testtype_all: list + :type cl_normalize: list + :type btn_add: int + :type d_start: str + :type d_end: str + :type btn_remove: int + :type btn_remove_all: int + :type href: str + :returns: New values for web page elements. + :rtype: tuple """ - d_start = datetime(int(d_start[0:4]), int(d_start[5:7]), - int(d_start[8:10])) - d_end = datetime(int(d_end[0:4]), int(d_end[5:7]), int(d_end[8:10])) + ctrl_panel = self.ControlPanel(cp_data) + + d_start = get_date(d_start) + d_end = get_date(d_end) + + # Parse the url: + parsed_url = url_decode(href) row_fig_tput = no_update row_fig_lat = no_update @@ -679,48 +965,85 @@ class Layout: row_card_sel_tests = no_update row_btns_sel_tests = no_update - ctrl_panel = self.ControlPanel(cp_data) - trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0] - if trigger_id == "dd-ctrl-phy": + if trigger_id == "dd-ctrl-dut": try: - options = [ - {"label": self.spec_tbs[dd_phy][v]["label"], "value": v} - for v in [v for v in self.spec_tbs[dd_phy].keys()] - ] + dut = self.spec_tbs[dd_dut] + options = sorted( + [{"label": v, "value": v}for v in dut.keys()], + key=lambda d: d["label"] + ) disabled = False except KeyError: options = list() - disabled = no_update + disabled = True + ctrl_panel.set({ + "dd-ctrl-dut-value": dd_dut, + "dd-ctrl-phy-value": str(), + "dd-ctrl-phy-options": options, + "dd-ctrl-phy-disabled": disabled, + "dd-ctrl-area-value": str(), + "dd-ctrl-area-options": list(), + "dd-ctrl-area-disabled": True, + "dd-ctrl-test-value": str(), + "dd-ctrl-test-options": list(), + "dd-ctrl-test-disabled": True, + "cl-ctrl-core-options": list(), + "cl-ctrl-core-value": list(), + "cl-ctrl-core-all-value": list(), + "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": 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": 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": label(v), "value": v} for v in phy.keys()], + key=lambda d: d["label"] + ) + disabled = False + except KeyError: + options = list() + disabled = True ctrl_panel.set({ "dd-ctrl-phy-value": dd_phy, "dd-ctrl-area-value": str(), "dd-ctrl-area-options": options, "dd-ctrl-area-disabled": disabled, + "dd-ctrl-test-value": str(), "dd-ctrl-test-options": list(), "dd-ctrl-test-disabled": True, "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, - "btn-ctrl-add-disabled": True, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, }) elif trigger_id == "dd-ctrl-area": try: + dut = ctrl_panel.get("dd-ctrl-dut-value") phy = ctrl_panel.get("dd-ctrl-phy-value") - options = [ - {"label": v, "value": v} - for v in self.spec_tbs[phy][dd_area]["test"] - ] + area = self.spec_tbs[dut][phy][dd_area] + options = sorted( + [{"label": v, "value": v} for v in area.keys()], + key=lambda d: d["label"] + ) disabled = False except KeyError: options = list() @@ -733,55 +1056,52 @@ 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, - "btn-ctrl-add-disabled": True, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, }) elif trigger_id == "dd-ctrl-test": core_opts = list() framesize_opts = list() testtype_opts = list() + dut = ctrl_panel.get("dd-ctrl-dut-value") phy = ctrl_panel.get("dd-ctrl-phy-value") area = ctrl_panel.get("dd-ctrl-area-value") - if phy and area and dd_test: - core_opts = [ - {"label": v, "value": v} - for v in self.spec_tbs[phy][area]["core"] - ] - framesize_opts = [ - {"label": v, "value": v} - for v in self.spec_tbs[phy][area]["frame-size"] - ] - testtype_opts = [ - {"label": v, "value": v} - for v in self.spec_tbs[phy][area]["test-type"] - ] + test = self.spec_tbs[dut][phy][area][dd_test] + cores = test["core"] + fsizes = test["frame-size"] + ttypes = test["test-type"] + if dut and phy and area and dd_test: + core_opts = [{"label": v, "value": v} + for v in sorted(cores)] + framesize_opts = [{"label": v, "value": v} + for v in sorted(fsizes)] + testtype_opts = [{"label": v, "value": v} + for v in sorted(ttypes)] ctrl_panel.set({ "dd-ctrl-test-value": dd_test, "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, - "btn-ctrl-add-disabled": False, + "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="" @@ -791,8 +1111,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" @@ -802,8 +1122,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="" @@ -813,8 +1133,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" @@ -824,8 +1144,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="" @@ -835,8 +1155,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" @@ -847,6 +1167,7 @@ class Layout: }) elif trigger_id == "btn-ctrl-add": _ = btn_add + dut = ctrl_panel.get("dd-ctrl-dut-value") phy = ctrl_panel.get("dd-ctrl-phy-value") area = ctrl_panel.get("dd-ctrl-area-value") test = ctrl_panel.get("dd-ctrl-test-value") @@ -854,23 +1175,23 @@ class Layout: framesizes = ctrl_panel.get("cl-ctrl-framesize-value") testtypes = ctrl_panel.get("cl-ctrl-testtype-value") # Add selected test to the list of tests in store: - if phy and area and test and cores and framesizes and testtypes: + if all((dut, phy, area, test, cores, framesizes, testtypes)): if store_sel is None: store_sel = list() for core in cores: for framesize in framesizes: for ttype in testtypes: - tid = ( - f"{phy.replace('af_xdp', 'af-xdp')}-" - f"{area}-" - f"{framesize.lower()}-" - f"{core.lower()}-" - f"{test}-" - f"{ttype.lower()}" - ) + 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 [itm["id"] for itm in store_sel]: store_sel.append({ "id": tid, + "dut": dut, "phy": phy, "area": area, "test": test, @@ -878,36 +1199,20 @@ class Layout: "core": core.lower(), "testtype": ttype.lower() }) - row_card_sel_tests = self.STYLE_ENABLED - row_btns_sel_tests = self.STYLE_ENABLED - ctrl_panel.set(ctrl_panel.defaults) - ctrl_panel.set({ - "cl-selected-options": self._list_tests(store_sel) - }) - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_arrea( - graph_trending( - self.data, store_sel, self.layout, d_start, d_end - ) - ) - elif trigger_id == "dpr-period": - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_arrea( - graph_trending( - self.data, store_sel, self.layout, d_start, d_end - ) - ) + store_sel = sorted(store_sel, key=lambda d: d["id"]) + 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() - }) + ctrl_panel.set({"cl-selected-options": list()}) elif trigger_id == "btn-sel-remove": _ = btn_remove if list_sel: @@ -916,26 +1221,56 @@ class Layout: if item["id"] not in list_sel: new_store_sel.append(item) store_sel = new_store_sel + elif trigger_id == "url": + # TODO: Add verification + url_params = parsed_url["params"] + if url_params: + store_sel = literal_eval( + url_params.get("store_sel", 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 = C.STYLE_ENABLED + row_btns_sel_tests = C.STYLE_ENABLED + + 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_arrea( - graph_trending( - self.data, store_sel, self.layout, d_start, d_end + _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": 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() - }) + ctrl_panel.set({"cl-selected-options": list()}) + + if ctrl_panel.get("cl-ctrl-core-value") and \ + ctrl_panel.get("cl-ctrl-framesize-value") and \ + ctrl_panel.get("cl-ctrl-testtype-value"): + disabled = False + else: + disabled = True + ctrl_panel.set({ + "btn-ctrl-add-disabled": disabled, + "cl-normalize-value": cl_normalize + }) ret_val = [ ctrl_panel.panel, store_sel, @@ -953,7 +1288,14 @@ class Layout: 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) """ try: trigger_id = loads( @@ -1023,7 +1365,16 @@ class Layout: prevent_initial_call=True ) def _download_data(store_sel, n_clicks): - """ + """Download the data + + :param store_sel: List of tests selected by user stored in the + browser. + :param n_clicks: Number of clicks on the button "Download". + :type store_sel: list + :type n_clicks: int + :returns: dict of data frame content (base64 encoded) and meta data + used by the Download component. + :rtype: dict """ if not n_clicks: @@ -1039,4 +1390,4 @@ class Layout: continue df = pd.concat([df, sel_data], ignore_index=True) - return dcc.send_data_frame(df.to_csv, "trending_data.csv") + return dcc.send_data_frame(df.to_csv, C.TREND_DOWNLOAD_FILE_NAME)