X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fdash%2Fapp%2Fpal%2Fnews%2Flayout.py;h=504f7cb80132ae1db66881e80547b20d0005cf4d;hb=refs%2Fchanges%2F11%2F37111%2F3;hp=2f66ce5c817f272cde1dfac8e6cc9082ae1bef4a;hpb=371bac71bc789bf9d68fa1b8ba77f21c4876244f;p=csit.git diff --git a/resources/tools/dash/app/pal/news/layout.py b/resources/tools/dash/app/pal/news/layout.py index 2f66ce5c81..504f7cb801 100644 --- a/resources/tools/dash/app/pal/news/layout.py +++ b/resources/tools/dash/app/pal/news/layout.py @@ -22,31 +22,27 @@ from flask import Flask from dash import dcc from dash import html from dash import callback_context -from dash import Input, Output, State +from dash import Input, Output from yaml import load, FullLoader, YAMLError -from copy import deepcopy from ..data.data import Data -from ..data.utils import classify_anomalies -from .tables import table_news +from ..utils.constants import Constants as C +from ..utils.utils import classify_anomalies, show_tooltip, gen_new_url +from ..utils.url_processing import url_decode +from ..data.data import Data +from .tables import table_summary class Layout: """The layout of the dash app and the callbacks. """ - # The default job displayed when the page is loaded first time. - DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx" - - # Time period for regressions and progressions. - TIME_PERIOD = 21 # [days] - def __init__(self, app: Flask, html_layout_file: str, data_spec_file: str, tooltip_file: str) -> None: """Initialization: - save the input parameters, - read and pre-process the data, - - prepare data fro the control panel, + - prepare data for the control panel, - read HTML layout file, - read tooltips from the tooltip file. @@ -73,29 +69,27 @@ class Layout: data_stats, data_mrr, data_ndrpdr = Data( data_spec_file=self._data_spec_file, debug=True - ).read_stats(days=self.TIME_PERIOD) + ).read_stats(days=C.NEWS_TIME_PERIOD) df_tst_info = pd.concat([data_mrr, data_ndrpdr], ignore_index=True) # Prepare information for the control panel: - jobs = sorted(list(df_tst_info["job"].unique())) - job_info = { + self._jobs = sorted(list(df_tst_info["job"].unique())) + d_job_info = { "job": list(), "dut": list(), "ttype": list(), "cadence": list(), "tbed": list() } - for job in jobs: + for job in self._jobs: lst_job = job.split("-") - job_info["job"].append(job) - job_info["dut"].append(lst_job[1]) - job_info["ttype"].append(lst_job[3]) - job_info["cadence"].append(lst_job[4]) - job_info["tbed"].append("-".join(lst_job[-2:])) - self.df_job_info = pd.DataFrame.from_dict(job_info) - - self._default = self._set_job_params(self.DEFAULT_JOB) + d_job_info["job"].append(job) + d_job_info["dut"].append(lst_job[1]) + d_job_info["ttype"].append(lst_job[3]) + d_job_info["cadence"].append(lst_job[4]) + d_job_info["tbed"].append("-".join(lst_job[-2:])) + self.job_info = pd.DataFrame.from_dict(d_job_info) # Pre-process the data: @@ -119,10 +113,10 @@ class Layout: "regressions": list(), "progressions": list() } - for job in jobs: + for job in self._jobs: # Create lists of failed tests: df_job = df_tst_info.loc[(df_tst_info["job"] == job)] - last_build = max(df_job["build"].unique()) + last_build = str(max(pd.to_numeric(df_job["build"].unique()))) df_build = df_job.loc[(df_job["build"] == last_build)] tst_info["job"].append(job) tst_info["build"].append(last_build) @@ -255,7 +249,10 @@ class Layout: f"{self._tooltip_file}\n{err}" ) - self._default_tab_failed = table_news(self.data, self._default["job"]) + self._default_period = C.NEWS_SHORT + self._default_active = (False, True, False) + self._default_table = \ + table_summary(self._data, self._jobs, self._default_period) # Callbacks: if self._app is not None and hasattr(self, 'callbacks'): @@ -265,171 +262,6 @@ class Layout: def html_layout(self) -> dict: return self._html_layout - @property - def data(self) -> pd.DataFrame: - return self._data - - @property - def default(self) -> dict: - return self._default - - def _get_duts(self) -> list: - """Get the list of DUTs from the pre-processed information about jobs. - - :returns: Alphabeticaly sorted list of DUTs. - :rtype: list - """ - return sorted(list(self.df_job_info["dut"].unique())) - - def _get_ttypes(self, dut: str) -> list: - """Get the list of test types from the pre-processed information about - jobs. - - :param dut: The DUT for which the list of test types will be populated. - :type dut: str - :returns: Alphabeticaly sorted list of test types. - :rtype: list - """ - return sorted(list(self.df_job_info.loc[( - self.df_job_info["dut"] == dut - )]["ttype"].unique())) - - def _get_cadences(self, dut: str, ttype: str) -> list: - """Get the list of cadences from the pre-processed information about - jobs. - - :param dut: The DUT for which the list of cadences will be populated. - :param ttype: The test type for which the list of cadences will be - populated. - :type dut: str - :type ttype: str - :returns: Alphabeticaly sorted list of cadences. - :rtype: list - """ - return sorted(list(self.df_job_info.loc[( - (self.df_job_info["dut"] == dut) & - (self.df_job_info["ttype"] == ttype) - )]["cadence"].unique())) - - def _get_test_beds(self, dut: str, ttype: str, cadence: str) -> list: - """Get the list of test beds from the pre-processed information about - jobs. - - :param dut: The DUT for which the list of test beds will be populated. - :param ttype: The test type for which the list of test beds will be - populated. - :param cadence: The cadence for which the list of test beds will be - populated. - :type dut: str - :type ttype: str - :type cadence: str - :returns: Alphabeticaly sorted list of test beds. - :rtype: list - """ - return sorted(list(self.df_job_info.loc[( - (self.df_job_info["dut"] == dut) & - (self.df_job_info["ttype"] == ttype) & - (self.df_job_info["cadence"] == cadence) - )]["tbed"].unique())) - - def _get_job(self, dut, ttype, cadence, testbed): - """Get the name of a job defined by dut, ttype, cadence, test bed. - Input information comes from the control panel. - - :param dut: The DUT for which the job name will be created. - :param ttype: The test type for which the job name will be created. - :param cadence: The cadence for which the job name will be created. - :param testbed: The test bed for which the job name will be created. - :type dut: str - :type ttype: str - :type cadence: str - :type testbed: str - :returns: Job name. - :rtype: str - """ - return self.df_job_info.loc[( - (self.df_job_info["dut"] == dut) & - (self.df_job_info["ttype"] == ttype) & - (self.df_job_info["cadence"] == cadence) & - (self.df_job_info["tbed"] == testbed) - )]["job"].item() - - @staticmethod - def _generate_options(opts: list) -> list: - """Return list of options for radio items in control panel. The items in - the list are dictionaries with keys "label" and "value". - - :params opts: List of options (str) to be used for the generated list. - :type opts: list - :returns: List of options (dict). - :rtype: list - """ - return [{"label": i, "value": i} for i in opts] - - def _set_job_params(self, job: str) -> dict: - """Create a dictionary with all options and values for (and from) the - given job. - - :params job: The name of job for and from which the dictionary will be - created. - :type job: str - :returns: Dictionary with all options and values for (and from) the - given job. - :rtype: dict - """ - - lst_job = job.split("-") - return { - "job": job, - "dut": lst_job[1], - "ttype": lst_job[3], - "cadence": lst_job[4], - "tbed": "-".join(lst_job[-2:]), - "duts": self._generate_options(self._get_duts()), - "ttypes": self._generate_options(self._get_ttypes(lst_job[1])), - "cadences": self._generate_options(self._get_cadences( - lst_job[1], lst_job[3])), - "tbeds": self._generate_options(self._get_test_beds( - lst_job[1], lst_job[3], lst_job[4])) - } - - def _show_tooltip(self, id: str, title: str, - clipboard_id: str=None) -> list: - """Generate list of elements to display a text (e.g. a title) with a - tooltip and optionaly with Copy&Paste icon and the clipboard - functionality enabled. - - :param id: Tooltip ID. - :param title: A text for which the tooltip will be displayed. - :param clipboard_id: If defined, a Copy&Paste icon is displayed and the - clipboard functionality is enabled. - :type id: str - :type title: str - :type clipboard_id: str - :returns: List of elements to display a text with a tooltip and - optionaly with Copy&Paste icon. - :rtype: 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): """Top level method which generated the web page. @@ -440,7 +272,7 @@ class Layout: If no HTML layout is provided, an error message is displayed instead. - :returns: The HTML div with teh whole page. + :returns: The HTML div with the whole page. :rtype: html.Div """ @@ -448,7 +280,7 @@ class Layout: return html.Div( id="div-main", children=[ - dcc.Store(id="control-panel"), + dcc.Location(id="url", refresh=False), dbc.Row( id="row-navbar", class_name="g-0", @@ -509,7 +341,7 @@ class Layout: """Add column with control panel. It is placed on the left side. :returns: Column with the control panel. - :rtype: dbc.col + :rtype: dbc.Col """ return dbc.Col( @@ -523,16 +355,47 @@ class Layout: """Add column with tables. It is placed on the right side. :returns: Column with tables. - :rtype: dbc.col + :rtype: dbc.Col """ return dbc.Col( id="col-plotting-area", children=[ - dbc.Row( # Failed tests - id="row-table-failed", - class_name="g-0 p-2", - children=self._default_tab_failed + dcc.Loading( + children=[ + dbc.Row( # Failed tests + id="row-table", + class_name="g-0 p-2", + children=self._default_table + ), + dbc.Row( + class_name="g-0 p-2", + align="center", + justify="start", + 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="" + ) + ] + ) + ] + ) + ] ) ], width=9, @@ -552,217 +415,107 @@ class Layout: class_name="g-0 p-2", children=[ dbc.Row( - class_name="gy-1", + class_name="g-0", children=[ dbc.Label( - class_name="p-0", - children=self._show_tooltip( - "help-dut", "Device under Test") + class_name="g-0", + children=show_tooltip(self._tooltips, + "help-summary-period", "Window") ), dbc.Row( - dbc.RadioItems( - id="ri-duts", - inline=True, - value=self.default["dut"], - options=self.default["duts"] + dbc.ButtonGroup( + id="bg-time-period", + class_name="g-0", + children=[ + dbc.Button( + id="period-last", + children="Last Run", + className="me-1", + outline=True, + color="info" + ), + dbc.Button( + id="period-short", + children=\ + f"Last {C.NEWS_SHORT} Runs", + className="me-1", + outline=True, + active=True, + color="info" + ), + dbc.Button( + id="period-long", + children="All Runs", + className="me-1", + outline=True, + color="info" + ) + ] ) ) ] - ), - dbc.Row( - class_name="gy-1", - children=[ - dbc.Label( - class_name="p-0", - children=self._show_tooltip( - "help-ttype", "Test Type"), - ), - dbc.RadioItems( - id="ri-ttypes", - inline=True, - value=self.default["ttype"], - options=self.default["ttypes"] - ) - ] - ), - dbc.Row( - class_name="gy-1", - children=[ - dbc.Label( - class_name="p-0", - children=self._show_tooltip( - "help-cadence", "Cadence"), - ), - dbc.RadioItems( - id="ri-cadences", - inline=True, - value=self.default["cadence"], - options=self.default["cadences"] - ) - ] - ), - dbc.Row( - class_name="gy-1", - children=[ - dbc.Label( - class_name="p-0", - children=self._show_tooltip( - "help-tbed", "Test Bed"), - ), - dbc.Select( - id="dd-tbeds", - placeholder="Select a test bed...", - value=self.default["tbed"], - options=self.default["tbeds"] - ) - ] - ), - dbc.Row( - class_name="gy-1", - children=[ - dbc.Alert( - id="al-job", - color="info", - children=self.default["job"] - ) - ] ) ] - ), + ) ] ) - class ControlPanel: - """ - """ - - def __init__(self, panel: dict, default: dict) -> None: - """ - """ - - self._defaults = { - "ri-ttypes-options": default["ttypes"], - "ri-cadences-options": default["cadences"], - "dd-tbeds-options": default["tbeds"], - "ri-duts-value": default["dut"], - "ri-ttypes-value": default["ttype"], - "ri-cadences-value": default["cadence"], - "dd-tbeds-value": default["tbed"], - "al-job-children": default["job"] - } - self._panel = deepcopy(self._defaults) - if panel: - for key in self._defaults: - self._panel[key] = panel[key] - - def set(self, kwargs: dict) -> None: - for key, val in kwargs.items(): - if key in self._panel: - self._panel[key] = val - else: - raise KeyError(f"The key {key} is not defined.") - - @property - def defaults(self) -> dict: - return self._defaults - - @property - def panel(self) -> dict: - return self._panel - - def get(self, key: str) -> any: - return self._panel[key] - - def values(self) -> list: - return list(self._panel.values()) - def callbacks(self, app): + """Callbacks for the whole application. + + :param app: The application. + :type app: Flask + """ @app.callback( - Output("control-panel", "data"), # Store - Output("row-table-failed", "children"), - Output("ri-ttypes", "options"), - Output("ri-cadences", "options"), - Output("dd-tbeds", "options"), - Output("ri-duts", "value"), - Output("ri-ttypes", "value"), - Output("ri-cadences", "value"), - Output("dd-tbeds", "value"), - Output("al-job", "children"), - State("control-panel", "data"), # Store - Input("ri-duts", "value"), - Input("ri-ttypes", "value"), - Input("ri-cadences", "value"), - Input("dd-tbeds", "value"), + Output("row-table", "children"), + Output("input-url", "value"), + Output("period-last", "active"), + Output("period-short", "active"), + Output("period-long", "active"), + Input("period-last", "n_clicks"), + Input("period-short", "n_clicks"), + Input("period-long", "n_clicks"), + Input("url", "href") ) - def _update_ctrl_panel(cp_data: dict, dut:str, ttype: str, cadence:str, - tbed: str) -> tuple: - """ + def _update_application(btn_last: int, btn_short: int, btn_long: int, + href: str) -> tuple: + """Update the application when the event is detected. + + :returns: New values for web page elements. + :rtype: tuple """ - ctrl_panel = self.ControlPanel(cp_data, self.default) + _, _, _ = btn_last, btn_short, btn_long + + periods = { + "period-last": C.NEWS_LAST, + "period-short": C.NEWS_SHORT, + "period-long": C.NEWS_LONG + } + actives = { + "period-last": (True, False, False), + "period-short": (False, True, False), + "period-long": (False, False, True) + } + + # Parse the url: + parsed_url = url_decode(href) + if parsed_url: + url_params = parsed_url["params"] + else: + url_params = None trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0] - if trigger_id == "ri-duts": - ttype_opts = self._generate_options(self._get_ttypes(dut)) - ttype_val = ttype_opts[0]["value"] - cad_opts = self._generate_options( - self._get_cadences(dut, ttype_val)) - cad_val = cad_opts[0]["value"] - tbed_opts = self._generate_options( - self._get_test_beds(dut, ttype_val, cad_val)) - tbed_val = tbed_opts[0]["value"] - ctrl_panel.set({ - "ri-duts-value": dut, - "ri-ttypes-options": ttype_opts, - "ri-ttypes-value": ttype_val, - "ri-cadences-options": cad_opts, - "ri-cadences-value": cad_val, - "dd-tbeds-options": tbed_opts, - "dd-tbeds-value": tbed_val - }) - elif trigger_id == "ri-ttypes": - cad_opts = self._generate_options( - self._get_cadences(ctrl_panel.get("ri-duts-value"), ttype)) - cad_val = cad_opts[0]["value"] - tbed_opts = self._generate_options( - self._get_test_beds(ctrl_panel.get("ri-duts-value"), - ttype, cad_val)) - tbed_val = tbed_opts[0]["value"] - ctrl_panel.set({ - "ri-ttypes-value": ttype, - "ri-cadences-options": cad_opts, - "ri-cadences-value": cad_val, - "dd-tbeds-options": tbed_opts, - "dd-tbeds-value": tbed_val - }) - elif trigger_id == "ri-cadences": - tbed_opts = self._generate_options( - self._get_test_beds(ctrl_panel.get("ri-duts-value"), - ctrl_panel.get("ri-ttypes-value"), cadence)) - tbed_val = tbed_opts[0]["value"] - ctrl_panel.set({ - "ri-cadences-value": cadence, - "dd-tbeds-options": tbed_opts, - "dd-tbeds-value": tbed_val - }) - elif trigger_id == "dd-tbeds": - ctrl_panel.set({ - "dd-tbeds-value": tbed - }) - - job = self._get_job( - ctrl_panel.get("ri-duts-value"), - ctrl_panel.get("ri-ttypes-value"), - ctrl_panel.get("ri-cadences-value"), - ctrl_panel.get("dd-tbeds-value") - ) - ctrl_panel.set({"al-job-children": job}) - tab_failed = table_news(self.data, job) + if trigger_id == "url" and url_params: + trigger_id = url_params.get("period", list())[0] + + period = periods.get(trigger_id, self._default_period) + active = actives.get(trigger_id, self._default_active) ret_val = [ - ctrl_panel.panel, - tab_failed + table_summary(self._data, self._jobs, period), + gen_new_url(parsed_url, {"period": trigger_id}) ] - ret_val.extend(ctrl_panel.values()) + ret_val.extend(active) return ret_val