X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fdash%2Fapp%2Fpal%2Fstats%2Flayout.py;h=cbb8cc77816d4ecc94aadc72b0fbc2a136a3fd3e;hp=405fd8b1a3a41ebcca654d3a120060690473f263;hb=c3ce5119c09eb40607a4b82f242c10ff2c56284a;hpb=cd417be7f836eb9346fad4f87bd4f75dc1d9a429 diff --git a/resources/tools/dash/app/pal/stats/layout.py b/resources/tools/dash/app/pal/stats/layout.py index 405fd8b1a3..cbb8cc7781 100644 --- a/resources/tools/dash/app/pal/stats/layout.py +++ b/resources/tools/dash/app/pal/stats/layout.py @@ -14,6 +14,7 @@ """Plotly Dash HTML layout override. """ +import logging import pandas as pd import dash_bootstrap_components as dbc @@ -28,7 +29,8 @@ from datetime import datetime, timedelta from copy import deepcopy from ..data.data import Data -from .graphs import graph_statistics +from ..data.url_processing import url_decode, url_encode +from .graphs import graph_statistics, select_data class Layout: @@ -37,8 +39,14 @@ class Layout: DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx" + URL_STYLE = { + "background-color": "#d2ebf5", + "border-color": "#bce1f1", + "color": "#135d7c" + } + def __init__(self, app: Flask, html_layout_file: str, spec_file: str, - graph_layout_file: str, data_spec_file: str, + graph_layout_file: str, data_spec_file: str, tooltip_file: str, time_period: int=None) -> None: """ """ @@ -49,6 +57,7 @@ class Layout: 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: @@ -70,7 +79,7 @@ class Layout: if self._time_period > data_time_period: self._time_period = data_time_period - self._jobs = sorted(list(data_stats["job"].unique())) + jobs = sorted(list(data_stats["job"].unique())) job_info = { "job": list(), "dut": list(), @@ -78,7 +87,7 @@ class Layout: "cadence": list(), "tbed": list() } - for job in self._jobs: + for job in jobs: lst_job = job.split("-") job_info["job"].append(job) job_info["dut"].append(lst_job[1]) @@ -87,20 +96,7 @@ class Layout: job_info["tbed"].append("-".join(lst_job[-2:])) self.df_job_info = pd.DataFrame.from_dict(job_info) - lst_job = self.DEFAULT_JOB.split("-") - self._default = { - "job": self.DEFAULT_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])) - } + self._default = self._set_job_params(self.DEFAULT_JOB) tst_info = { "job": list(), @@ -111,7 +107,8 @@ class Layout: "passed": list(), "failed": list() } - for job in self._jobs: + for job in jobs: + # TODO: Add list of failed tests for each build df_job = df_tst_info.loc[(df_tst_info["job"] == job)] builds = df_job["build"].unique() for build in builds: @@ -137,6 +134,7 @@ class Layout: # Read from files: self._html_layout = "" self._graph_layout = None + self._tooltips = dict() try: with open(self._html_layout_file, "r") as file_read: @@ -157,10 +155,23 @@ class Layout: except YAMLError as err: raise RuntimeError( f"An error occurred while parsing the specification file " - f"{self._graph_layout_file}\n" - f"{err}" + 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}" + ) + + self._default_fig_passed, self._default_fig_duration = graph_statistics( self.data, self._default["job"], self.layout ) @@ -230,6 +241,46 @@ class Layout: (self.df_job_info["tbed"] == testbed) )]["job"].item() + def _set_job_params(self, job: str) -> 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: + """ + """ + 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): """ @@ -238,9 +289,8 @@ class Layout: return html.Div( id="div-main", children=[ - dcc.Store( - id="control-panel" - ), + dcc.Store(id="control-panel"), + dcc.Location(id="url", refresh=False), dbc.Row( id="row-navbar", class_name="g-0", @@ -345,19 +395,48 @@ class Layout: ]) ] ), - dbc.Row( # Download - id="row-btn-download", + dbc.Row( class_name="g-0 p-2", + align="center", + justify="start", children=[ - 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=self._show_tooltip( + "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=self.URL_STYLE, + children=self._show_tooltip( + "help-url", "URL", "input-url") + ), + dbc.Input( + id="input-url", + readonly=True, + type="url", + style=self.URL_STYLE, + value="" + ) + ] + ) + ] + ) ] ) ], @@ -378,14 +457,17 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - "Device under Test", - class_name="p-0" + class_name="p-0", + children=self._show_tooltip( + "help-dut", "Device under Test") ), - dbc.RadioItems( - id="ri-duts", - inline=True, - value=self.default["dut"], - options=self.default["duts"] + dbc.Row( + dbc.RadioItems( + id="ri-duts", + inline=True, + value=self.default["dut"], + options=self.default["duts"] + ) ) ] ), @@ -393,8 +475,9 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - "Test Type", - class_name="p-0" + class_name="p-0", + children=self._show_tooltip( + "help-ttype", "Test Type"), ), dbc.RadioItems( id="ri-ttypes", @@ -408,8 +491,9 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - "Cadence", - class_name="p-0" + class_name="p-0", + children=self._show_tooltip( + "help-cadence", "Cadence"), ), dbc.RadioItems( id="ri-cadences", @@ -423,8 +507,9 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - "Test Bed", - class_name="p-0" + class_name="p-0", + children=self._show_tooltip( + "help-tbed", "Test Bed"), ), dbc.Select( id="dd-tbeds", @@ -443,29 +528,33 @@ class Layout: children=self.default["job"] ) ] + ), + dbc.Row( + class_name="g-0 p-2", + children=[ + dbc.Label( + class_name="gy-1", + children=self._show_tooltip( + "help-time-period", "Time Period"), + ), + dcc.DatePickerRange( + id="dpr-period", + className="d-flex justify-content-center", + min_date_allowed=\ + datetime.utcnow() - timedelta( + days=self.time_period), + max_date_allowed=datetime.utcnow(), + initial_visible_month=datetime.utcnow(), + start_date=\ + datetime.utcnow() - timedelta( + days=self.time_period), + end_date=datetime.utcnow(), + display_format="D MMM YY" + ) + ] ) ] ), - dbc.Row( - class_name="g-0 p-2", - children=[ - dbc.Label("Choose the Time Period"), - dcc.DatePickerRange( - id="dpr-period", - className="d-flex justify-content-center", - min_date_allowed=\ - datetime.utcnow() - timedelta( - days=self.time_period), - max_date_allowed=datetime.utcnow(), - initial_visible_month=datetime.utcnow(), - start_date=\ - datetime.utcnow() - timedelta( - days=self.time_period), - end_date=datetime.utcnow(), - display_format="D MMMM YY" - ) - ] - ) ] ) @@ -509,16 +598,19 @@ class Layout: @staticmethod def _generate_options(opts: list) -> list: - """ - """ return [{"label": i, "value": i} for i in opts] + @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): @app.callback( Output("control-panel", "data"), # Store Output("graph-passed", "figure"), Output("graph-duration", "figure"), + Output("input-url", "value"), Output("ri-ttypes", "options"), Output("ri-cadences", "options"), Output("dd-tbeds", "options"), @@ -534,18 +626,25 @@ class Layout: Input("dd-tbeds", "value"), Input("dpr-period", "start_date"), Input("dpr-period", "end_date"), - prevent_initial_call=True + Input("url", "href") + # prevent_initial_call=True ) def _update_ctrl_panel(cp_data: dict, dut:str, ttype: str, cadence:str, - tbed: str, d_start: str, d_end: str) -> tuple: + tbed: str, start: str, end: str, href: str) -> tuple: """ """ ctrl_panel = self.ControlPanel(cp_data, self.default) - 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])) + start = self._get_date(start) + end = self._get_date(end) + + # 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": @@ -597,6 +696,25 @@ class Layout: }) elif trigger_id == "dpr-period": pass + elif trigger_id == "url": + # TODO: Add verification + if url_params: + new_job = url_params.get("job", list())[0] + new_start = url_params.get("start", list())[0] + new_end = url_params.get("end", list())[0] + if new_job and new_start and new_end: + start = self._get_date(new_start) + end = self._get_date(new_end) + job_params = self._set_job_params(new_job) + ctrl_panel = self.ControlPanel(None, job_params) + else: + ctrl_panel = self.ControlPanel(cp_data, self.default) + 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") + ) job = self._get_job( ctrl_panel.get("ri-duts-value"), @@ -604,26 +722,63 @@ class Layout: ctrl_panel.get("ri-cadences-value"), ctrl_panel.get("dd-tbeds-value") ) - ctrl_panel.set({"al-job-children": job}) - fig_passed, fig_duration = graph_statistics( - self.data, job, self.layout, d_start, d_end) - ret_val = [ctrl_panel.panel, fig_passed, fig_duration] + ctrl_panel.set({"al-job-children": job}) + fig_passed, fig_duration = graph_statistics(self.data, job, + self.layout, start, end) + + if parsed_url: + new_url = url_encode({ + "scheme": parsed_url["scheme"], + "netloc": parsed_url["netloc"], + "path": parsed_url["path"], + "params": { + "job": job, + "start": start, + "end": end + } + }) + else: + new_url = str() + + ret_val = [ + ctrl_panel.panel, + fig_passed, + fig_duration, + new_url + ] ret_val.extend(ctrl_panel.values()) return ret_val @app.callback( Output("download-data", "data"), + State("control-panel", "data"), # Store + State("dpr-period", "start_date"), + State("dpr-period", "end_date"), Input("btn-download-data", "n_clicks"), prevent_initial_call=True ) - def _download_data(n_clicks): + def _download_data(cp_data: dict, start: str, end: str, n_clicks: int): """ """ - if not n_clicks: + if not (n_clicks): raise PreventUpdate - return dcc.send_data_frame(self.data.to_csv, "statistics.csv") + ctrl_panel = self.ControlPanel(cp_data, self.default) + + 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") + ) + + start = datetime(int(start[0:4]), int(start[5:7]), int(start[8:10])) + end = datetime(int(end[0:4]), int(end[5:7]), int(end[8:10])) + data = select_data(self.data, job, start, end) + data = data.drop(columns=["job", ]) + + return dcc.send_data_frame(data.T.to_csv, f"{job}-stats.csv") @app.callback( Output("row-metadata", "children"),