thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-12-11 17:02:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
d233743200
ClickHouse/tests/ci/report.py

757 lines
24 KiB
Python
Raw Normal View History

Trying style check
2021-09-10 11:52:21 +00:00
# -*- coding: utf-8 -*-
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
from ast import literal_eval
from dataclasses import dataclass
from pathlib import Path
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
from typing import Dict, Final, Iterable, List, Literal, Optional, Tuple
tests/ci: encode HTML entities in the reports Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
2023-01-15 16:02:57 +00:00
from html import escape
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
import csv
Trying style check
2021-09-10 11:52:21 +00:00
import datetime
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
import json
import logging
import os
Work around issues with GH callable actions
2023-11-07 14:56:00 +00:00
from build_download_helper import get_gh_api
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
from ci_config import BuildConfig, CI_CONFIG
Trying style check
2021-09-10 11:52:21 +00:00
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
logger = logging.getLogger(__name__)
Create report status constants
2023-09-01 17:15:11 +00:00
ERROR: Final = "error"
FAILURE: Final = "failure"
PENDING: Final = "pending"
SUCCESS: Final = "success"
OK: Final = "OK"
FAIL: Final = "FAIL"
StatusType = Literal["error", "failure", "pending", "success"]
# The order of statuses from the worst to the best
_STATES = {ERROR: 0, FAILURE: 1, PENDING: 2, SUCCESS: 3}
def get_worst_status(statuses: Iterable[str]) -> str:
worst_status = None
for status in statuses:
if _STATES.get(status) is None:
continue
if worst_status is None:
worst_status = status
continue
if _STATES.get(status) < _STATES.get(worst_status):
worst_status = status
if worst_status == ERROR:
break
if worst_status is None:
return ""
return worst_status
Hipster's HTML
2023-01-06 03:19:10 +00:00
### BEST FRONTEND PRACTICES BELOW
Trying style check
2021-09-10 11:52:21 +00:00
Use the same style for all reports
2023-09-01 12:05:18 +00:00
HEAD_HTML_TEMPLATE = """
Trying style check
2021-09-10 11:52:21 +00:00
<!DOCTYPE html>
<html>
Use the same style for all reports
2023-09-01 12:05:18 +00:00
<head>
Trying style check
2021-09-10 11:52:21 +00:00
<style>
Opt-out
2023-01-07 02:40:18 +00:00
:root {{
--color: white;
--background: hsl(190deg, 90%, 5%) linear-gradient(180deg, hsl(190deg, 90%, 10%), hsl(190deg, 90%, 0%));
--td-background: hsl(190deg, 90%, 15%);
--th-background: hsl(180deg, 90%, 15%);
Change the color of links in dark reports a little bit
2023-01-10 00:03:05 +00:00
--link-color: #FF5;
Opt-out
2023-01-07 02:40:18 +00:00
--link-hover-color: #F40;
--menu-background: hsl(190deg, 90%, 20%);
--menu-hover-background: hsl(190deg, 100%, 50%);
--menu-hover-color: black;
--text-gradient: linear-gradient(90deg, #8F8, #F88);
--shadow-intensity: 1;
--tr-hover-filter: brightness(120%);
--table-border-color: black;
Fix Python
2023-01-07 22:23:20 +00:00
}}
Opt-out
2023-01-07 02:40:18 +00:00
[data-theme="light"] {{
--color: black;
--background: hsl(190deg, 90%, 90%) linear-gradient(180deg, #EEE, #DEE);
--td-background: white;
--th-background: #EEE;
--link-color: #08F;
--link-hover-color: #F40;
--menu-background: white;
--menu-hover-background: white;
--menu-hover-color: #F40;
--text-gradient: linear-gradient(90deg, black, black);
--shadow-intensity: 0.1;
--tr-hover-filter: brightness(95%);
--table-border-color: #DDD;
}}
Hipster's HTML
2023-01-06 03:19:10 +00:00
.gradient {{
Opt-out
2023-01-07 02:40:18 +00:00
background-image: var(--text-gradient);
Hipster's HTML
2023-01-06 03:19:10 +00:00
background-size: 100%;
background-repeat: repeat;
background-clip: text;
-webkit-text-fill-color: transparent;
-moz-text-fill-color: transparent;
-webkit-background-clip: text;
-moz-background-clip: text;
}}
Opt-out
2023-01-07 02:40:18 +00:00
html {{ min-height: 100%; font-family: "DejaVu Sans", "Noto Sans", Arial, sans-serif; background: var(--background); color: var(--color); }}
Trying style check
2021-09-10 11:52:21 +00:00
h1 {{ margin-left: 10px; }}
Opt-out
2023-01-07 02:40:18 +00:00
th, td {{ padding: 5px 10px 5px 10px; text-align: left; vertical-align: top; line-height: 1.5; border: 1px solid var(--table-border-color); }}
td {{ background: var(--td-background); }}
th {{ background: var(--th-background); }}
a {{ color: var(--link-color); text-decoration: none; }}
a:hover, a:active {{ color: var(--link-hover-color); text-decoration: none; }}
table {{ box-shadow: 0 8px 25px -5px rgba(0, 0, 0, var(--shadow-intensity)); border-collapse: collapse; border-spacing: 0; }}
p.links a {{ padding: 5px; margin: 3px; background: var(--menu-background); line-height: 2.5; white-space: nowrap; box-shadow: 0 8px 25px -5px rgba(0, 0, 0, var(--shadow-intensity)); }}
p.links a:hover {{ background: var(--menu-hover-background); color: var(--menu-hover-color); }}
Trying style check
2021-09-10 11:52:21 +00:00
th {{ cursor: pointer; }}
Opt-out
2023-01-07 02:40:18 +00:00
tr:hover {{ filter: var(--tr-hover-filter); }}
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
.expandable {{ cursor: pointer; }}
.expandable-content {{ display: none; }}
Opt-out
2023-01-07 02:40:18 +00:00
#fish {{ display: none; float: right; position: relative; top: -20em; right: 2vw; margin-bottom: -20em; width: 30vw; filter: brightness(7%); z-index: -1; }}
.themes {{
float: right;
font-size: 20pt;
margin-bottom: 1rem;
}}
#toggle-dark, #toggle-light {{
padding-right: 0.5rem;
user-select: none;
cursor: pointer;
}}
#toggle-dark:hover, #toggle-light:hover {{
display: inline-block;
transform: translate(1px, 1px);
filter: brightness(125%);
}}
Trying style check
2021-09-10 11:52:21 +00:00
</style>
<title>{title}</title>
</head>
<body>
<div class="main">
Opt-out
2023-01-07 02:40:18 +00:00
<span class="nowrap themes"><span id="toggle-dark">🌚</span><span id="toggle-light">🌞</span></span>
Hipster's HTML
2023-01-06 03:19:10 +00:00
<h1><span class="gradient">{header}</span></h1>
Use the same style for all reports
2023-09-01 12:05:18 +00:00
"""
FOOTER_HTML_TEMPLATE = """<img id="fish" src="https://presentations.clickhouse.com/images/fish.png" />
Trying style check
2021-09-10 11:52:21 +00:00
<script type="text/javascript">
/// Straight from https://stackoverflow.com/questions/14267781/sorting-html-table-with-javascript
Update docker to IPv6
2021-10-22 12:23:41 +00:00
const getCellValue = (tr, idx) => {{
var classes = tr.classList;
var elem = tr;
fix report.py
2023-09-12 11:54:35 +00:00
if (classes.contains("expandable-content") || classes.contains("expandable-content.open"))
Update docker to IPv6
2021-10-22 12:23:41 +00:00
elem = tr.previousElementSibling;
return elem.children[idx].innerText || elem.children[idx].textContent;
}}
Trying style check
2021-09-10 11:52:21 +00:00
const comparer = (idx, asc) => (a, b) => ((v1, v2) =>
v1 !== '' && v2 !== '' && !isNaN(v1) && !isNaN(v2) ? v1 - v2 : v1.toString().localeCompare(v2)
)(getCellValue(asc ? a : b, idx), getCellValue(asc ? b : a, idx));
document.querySelectorAll('th').forEach(th => th.addEventListener('click', (() => {{
const table = th.closest('table');
Array.from(table.querySelectorAll('tr:nth-child(n+2)'))
.sort(comparer(Array.from(th.parentNode.children).indexOf(th), this.asc = !this.asc))
.forEach(tr => table.appendChild(tr) );
}})));
Update docker to IPv6
2021-10-22 12:23:41 +00:00
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
Array.from(document.getElementsByClassName("expandable")).forEach(tr => tr.addEventListener('click', function() {{
Update docker to IPv6
2021-10-22 12:23:41 +00:00
var content = this.nextElementSibling;
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
content.classList.toggle("expandable-content");
Update docker to IPv6
2021-10-22 12:23:41 +00:00
}}));
Hipster's HTML
2023-01-06 03:19:10 +00:00
Opt-out
2023-01-07 02:40:18 +00:00
let theme = 'dark';
function setTheme(new_theme) {{
theme = new_theme;
document.documentElement.setAttribute('data-theme', theme);
window.localStorage.setItem('theme', theme);
drawFish();
}}
function drawFish() {{
document.getElementById('fish').style.display = (document.body.clientHeight > 3000 && theme == 'dark') ? 'block' : 'none';
Hipster's HTML
2023-01-06 03:19:10 +00:00
}}
Opt-out
2023-01-07 02:40:18 +00:00
document.getElementById('toggle-light').addEventListener('click', e => setTheme('light'));
document.getElementById('toggle-dark').addEventListener('click', e => setTheme('dark'));
let new_theme = window.localStorage.getItem('theme');
if (new_theme && new_theme != theme) {{
setTheme(new_theme);
}}
drawFish();
Trying style check
2021-09-10 11:52:21 +00:00
</script>
Hipster's HTML
2023-01-06 03:19:10 +00:00
</body>
Trying style check
2021-09-10 11:52:21 +00:00
</html>
"""
Use the same style for all reports
2023-09-01 12:05:18 +00:00
HTML_BASE_TEST_TEMPLATE = (
f"{HEAD_HTML_TEMPLATE}"
"""<p class="links">
<a href="{raw_log_url}">{raw_log_name}</a>
<a href="{commit_url}">Commit</a>
{additional_urls}
<a href="{task_url}">Task (github actions)</a>
<a href="{job_url}">Job (github actions)</a>
</p>
{test_part}
"""
f"{FOOTER_HTML_TEMPLATE}"
)
Trying style check
2021-09-10 11:52:21 +00:00
HTML_TEST_PART = """
<table>
<tr>
{headers}
</tr>
{rows}
</table>
"""
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
BASE_HEADERS = ["Test name", "Test status"]
Trying style check
2021-09-10 11:52:21 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
@dataclass
class TestResult:
name: str
status: str
# the following fields are optional
time: Optional[float] = None
log_files: Optional[List[Path]] = None
raw_logs: Optional[str] = None
# the field for uploaded logs URLs
log_urls: Optional[List[str]] = None
def set_raw_logs(self, raw_logs: str) -> None:
self.raw_logs = raw_logs
def set_log_files(self, log_files_literal: str) -> None:
Fix possible issue in process_logs by strict typing
2023-01-04 15:52:32 +00:00
self.log_files = [] # type: Optional[List[Path]]
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
log_paths = literal_eval(log_files_literal)
if not isinstance(log_paths, list):
raise ValueError(
f"Malformed input: must be a list literal: {log_files_literal}"
)
for log_path in log_paths:
file = Path(log_path)
introduce sqllogic runner
2023-04-16 10:11:35 +00:00
assert file.exists(), file
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
self.log_files.append(file)
Address review comment
2023-09-12 18:06:00 +00:00
@staticmethod
Automatic style fix
2023-09-12 18:31:34 +00:00
def create_check_timeout_expired(timeout: float) -> "TestResult":
Address review comment
2023-09-12 18:06:00 +00:00
return TestResult("Check timeout expired", "FAIL", timeout)
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
TestResults = List[TestResult]
def read_test_results(results_path: Path, with_raw_logs: bool = True) -> TestResults:
results = [] # type: TestResults
with open(results_path, "r", encoding="utf-8") as descriptor:
reader = csv.reader(descriptor, delimiter="\t")
for line in reader:
name = line[0]
status = line[1]
time = None
add some context to stress test failures
2023-02-01 00:00:00 +00:00
if len(line) >= 3 and line[2] and line[2] != "\\N":
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
# The value can be emtpy, but when it's not,
# it's the time spent on the test
try:
time = float(line[2])
except ValueError:
pass
result = TestResult(name, status, time)
if len(line) == 4 and line[3]:
# The value can be emtpy, but when it's not,
# the 4th value is a pythonic list, e.g. ['file1', 'file2']
if with_raw_logs:
better context for stress tests failures
2023-02-02 00:02:12 +00:00
# Python does not support TSV, so we unescape manually
Automatic style fix
2023-02-02 12:40:50 +00:00
result.set_raw_logs(
line[3].replace("\\t", "\t").replace("\\n", "\n")
Automatic style fix
2023-02-02 00:59:49 +00:00
)
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
else:
result.set_log_files(line[3])
results.append(result)
return results
Add typing to create_build_html_report
2023-01-04 11:18:53 +00:00
@dataclass
class BuildResult:
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
build_name: str
log_url: str
build_urls: List[str]
version: str
status: StatusType
Add typing to create_build_html_report
2023-01-04 11:18:53 +00:00
elapsed_seconds: int
Work around issues with GH callable actions
2023-11-07 14:56:00 +00:00
job_api_url: str
_job_name: Optional[str] = None
_job_html_url: Optional[str] = None
_job_html_link: Optional[str] = None
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
_grouped_urls: Optional[List[List[str]]] = None
@property
def build_config(self) -> Optional[BuildConfig]:
return CI_CONFIG.build_config.get(self.build_name, None)
@property
def comment(self) -> str:
if self.build_config is None:
return self._wrong_config_message
return self.build_config.comment
@property
def compiler(self) -> str:
if self.build_config is None:
return self._wrong_config_message
return self.build_config.compiler
@property
def debug_build(self) -> bool:
if self.build_config is None:
return False
return self.build_config.debug_build
@property
def sanitizer(self) -> str:
if self.build_config is None:
return self._wrong_config_message
return self.build_config.sanitizer
@property
def grouped_urls(self) -> List[List[str]]:
"Combine and preserve build_urls by artifact types"
if self._grouped_urls is not None:
return self._grouped_urls
if not self.build_urls:
self._grouped_urls = [[]]
return self._grouped_urls
artifacts_groups = {
"apk": [],
"deb": [],
"binary": [],
"tgz": [],
"rpm": [],
"performance": [],
} # type: Dict[str, List[str]]
for url in self.build_urls:
if url.endswith("performance.tar.zst"):
artifacts_groups["performance"].append(url)
elif (
url.endswith(".deb")
or url.endswith(".buildinfo")
or url.endswith(".changes")
or url.endswith(".tar.gz")
):
artifacts_groups["deb"].append(url)
elif url.endswith(".apk"):
artifacts_groups["apk"].append(url)
elif url.endswith(".rpm"):
artifacts_groups["rpm"].append(url)
elif url.endswith(".tgz") or url.endswith(".tgz.sha512"):
artifacts_groups["tgz"].append(url)
else:
artifacts_groups["binary"].append(url)
self._grouped_urls = [urls for urls in artifacts_groups.values() if urls]
return self._grouped_urls
@property
def _wrong_config_message(self) -> str:
return "missing"
@property
def file_name(self) -> Path:
return self.get_report_name(self.build_name)
@property
def is_missing(self) -> bool:
"The report is created for missing json file"
return not (
self.log_url
or self.build_urls
or self.version != "missing"
or self.status != ERROR
)
@property
def job_link(self) -> str:
Work around issues with GH callable actions
2023-11-07 14:56:00 +00:00
if self._job_html_link is not None:
return self._job_html_link
self._job_html_link = f'<a href="{self.job_html_url}">{self.job_name}</a>'
return self._job_html_link
@property
def job_html_url(self) -> str:
if self._job_html_url is not None:
return self._job_html_url
self._set_properties()
return self._job_html_url or ""
@property
def job_name(self) -> str:
if self._job_name is not None:
return self._job_name
self._set_properties()
return self._job_name or ""
@job_name.setter
def job_name(self, job_name: str) -> None:
self._job_name = job_name
def _set_properties(self) -> None:
if all(p is not None for p in (self._job_name, self._job_html_url)):
return
try:
job_data = get_gh_api(self.job_api_url).json()
except Exception:
job_data = {}
# job_name can be set manually
self._job_name = self._job_name or job_data.get("name", "unknown")
self._job_html_url = job_data.get("html_url", "")
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
@staticmethod
def get_report_name(name: str) -> Path:
return Path(f"build_report_{name}.json")
@staticmethod
def read_json(directory: Path, build_name: str) -> "BuildResult":
path = directory / BuildResult.get_report_name(build_name)
try:
with open(path, "r", encoding="utf-8") as pf:
data = json.load(pf) # type: dict
except FileNotFoundError:
logger.warning(
"File %s for build named '%s' is not found", path, build_name
)
return BuildResult.missing_result(build_name)
return BuildResult(
data.get("build_name", build_name),
data.get("log_url", ""),
data.get("build_urls", []),
data.get("version", ""),
data.get("status", ERROR),
data.get("elapsed_seconds", 0),
Work around issues with GH callable actions
2023-11-07 14:56:00 +00:00
data.get("job_api_url", ""),
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
)
@staticmethod
def missing_result(build_name: str) -> "BuildResult":
return BuildResult(build_name, "", [], "missing", ERROR, 0, "missing")
def write_json(self, directory: Path) -> Path:
path = directory / self.file_name
path.write_text(
json.dumps(
{
"build_name": self.build_name,
"log_url": self.log_url,
"build_urls": self.build_urls,
"version": self.version,
"status": self.status,
"elapsed_seconds": self.elapsed_seconds,
Work around issues with GH callable actions
2023-11-07 14:56:00 +00:00
"job_api_url": self.job_api_url,
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
}
),
encoding="utf-8",
)
# TODO: remove after the artifacts are in S3 completely
env_path = Path(os.getenv("GITHUB_ENV", "/dev/null"))
with env_path.open("a", encoding="utf-8") as ef:
ef.write(f"BUILD_URLS={path.stem}")
return path
Add typing to create_build_html_report
2023-01-04 11:18:53 +00:00
BuildResults = List[BuildResult]
Different status colors in report for bugfix validation
2022-03-11 13:36:29 +00:00
class ReportColorTheme:
class ReportColor:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
yellow = "#FFB400"
red = "#F00"
green = "#0A0"
blue = "#00B4FF"
Different status colors in report for bugfix validation
2022-03-11 13:36:29 +00:00
default = (ReportColor.green, ReportColor.red, ReportColor.yellow)
bugfixcheck = (ReportColor.yellow, ReportColor.blue, ReportColor.blue)
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
ColorTheme = Tuple[str, str, str]
Add typing, capitalize only the first letter w/o lowering the rest
2023-04-25 16:15:09 +00:00
def _format_header(
header: str, branch_name: str, branch_url: Optional[str] = None
) -> str:
# Following line does not lower CI->Ci and SQLancer->Sqlancer. It only
# capitalizes the first letter and doesn't touch the rest of the word
result = " ".join([w[0].upper() + w[1:] for w in header.split(" ") if w])
Trying style check
2021-09-10 11:52:21 +00:00
result = result.replace("Clickhouse", "ClickHouse")
result = result.replace("clickhouse", "ClickHouse")
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
if "ClickHouse" not in result:
Add typing, capitalize only the first letter w/o lowering the rest
2023-04-25 16:15:09 +00:00
result = f"ClickHouse {result}"
Trying style check
2021-09-10 11:52:21 +00:00
if branch_url:
Add typing, capitalize only the first letter w/o lowering the rest
2023-04-25 16:15:09 +00:00
result = f'{result} for <a href="{branch_url}">{branch_name}</a>'
Trying style check
2021-09-10 11:52:21 +00:00
else:
Add typing, capitalize only the first letter w/o lowering the rest
2023-04-25 16:15:09 +00:00
result = f"{result} for {branch_name}"
Trying style check
2021-09-10 11:52:21 +00:00
return result
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
def _get_status_style(status: str, colortheme: Optional[ColorTheme] = None) -> str:
Create report status constants
2023-09-01 17:15:11 +00:00
ok_statuses = (OK, SUCCESS, "PASSED")
fail_statuses = (FAIL, FAILURE, ERROR, "FAILED", "Timeout", "NOT_FAILED")
Different status colors in report for bugfix validation
2022-03-11 13:36:29 +00:00
if colortheme is None:
colortheme = ReportColorTheme.default
Trying style check
2021-09-10 11:52:21 +00:00
style = "font-weight: bold;"
Different status colors in report for bugfix validation
2022-03-11 13:36:29 +00:00
if status in ok_statuses:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
style += f"color: {colortheme[0]};"
Different status colors in report for bugfix validation
2022-03-11 13:36:29 +00:00
elif status in fail_statuses:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
style += f"color: {colortheme[1]};"
Trying style check
2021-09-10 11:52:21 +00:00
else:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
style += f"color: {colortheme[2]};"
Trying style check
2021-09-10 11:52:21 +00:00
return style
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
def _get_html_url_name(url):
if isinstance(url, str):
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
return os.path.basename(url).replace("%2B", "+").replace("%20", " ")
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
if isinstance(url, tuple):
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
return url[1].replace("%2B", "+").replace("%20", " ")
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
return None
Trying style check
2021-09-10 11:52:21 +00:00
def _get_html_url(url):
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
href = None
name = None
Trying style check
2021-09-10 11:52:21 +00:00
if isinstance(url, str):
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
href, name = url, _get_html_url_name(url)
Trying style check
2021-09-10 11:52:21 +00:00
if isinstance(url, tuple):
Update report.py
2022-02-21 07:29:10 +00:00
href, name = url[0], _get_html_url_name(url)
Sort additional_html_urls in test report in CI
2022-02-20 17:00:18 +00:00
if href and name:
Use f-strings in report.py
2022-11-14 14:48:51 +00:00
return f'<a href="{href}">{_get_html_url_name(url)}</a>'
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
return ""
def create_test_html_report(
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
header: str,
test_results: TestResults,
raw_log_url: str,
task_url: str,
job_url: str,
branch_url: str,
branch_name: str,
commit_url: str,
additional_urls: Optional[List[str]] = None,
statuscolors: Optional[ColorTheme] = None,
) -> str:
tests/ci/report.py: fix pylint warnings
2021-10-27 07:03:24 +00:00
if additional_urls is None:
additional_urls = []
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
if test_results:
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
rows_part = []
Trying style check
2021-09-10 11:52:21 +00:00
num_fails = 0
has_test_time = False
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
has_log_urls = False
Display entires for failed tests at the top of report
2022-05-31 16:16:13 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
# Display entires with logs at the top (they correspond to failed tests)
test_results.sort(
Fix wrong report sorting and changing global BASE_HEADERS
2023-01-11 22:39:00 +00:00
key=lambda result: result.raw_logs is None and result.log_files is None
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
)
Display entires for failed tests at the top of report
2022-05-31 16:16:13 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
for test_result in test_results:
colspan = 0
if test_result.log_files is not None:
has_log_urls = True
Trying style check
2021-09-10 11:52:21 +00:00
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row = []
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
if test_result.raw_logs is not None:
row.append('<tr class="expandable">')
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
else:
row.append("<tr>")
row.append(f"<td>{test_result.name}</td>")
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
colspan += 1
style = _get_status_style(test_result.status, colortheme=statuscolors)
Trying style check
2021-09-10 11:52:21 +00:00
# Allow to quickly scroll to the first failure.
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
fail_id = ""
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
has_error = test_result.status in ("FAIL", "NOT_FAILED")
EXPECTED_TO_FAIL -> NOT_FAILED
2023-05-05 17:53:15 +00:00
if has_error:
Trying style check
2021-09-10 11:52:21 +00:00
num_fails = num_fails + 1
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
fail_id = f'id="fail{num_fails}" '
Trying style check
2021-09-10 11:52:21 +00:00
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row.append(f'<td {fail_id}style="{style}">{test_result.status}</td>')
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
colspan += 1
Trying style check
2021-09-10 11:52:21 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
if test_result.time is not None:
has_test_time = True
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row.append(f"<td>{test_result.time}</td>")
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
colspan += 1
Trying style check
2021-09-10 11:52:21 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
if test_result.log_urls is not None:
Fix the `Logs` header for case when only log_urls is set
2023-04-28 21:51:53 +00:00
has_log_urls = True
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
test_logs_html = "<br>".join(
[_get_html_url(url) for url in test_result.log_urls]
)
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row.append(f"<td>{test_logs_html}</td>")
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
colspan += 1
Trying style check
2021-09-10 11:52:21 +00:00
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row.append("</tr>")
upd
2023-09-11 16:13:52 +00:00
rows_part.append("\n".join(row))
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
if test_result.raw_logs is not None:
tests/ci: encode HTML entities in the reports Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
2023-01-15 16:02:57 +00:00
raw_logs = escape(test_result.raw_logs)
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
row_raw_logs = (
sucessfull items in report can be expandable
2023-09-11 17:06:16 +00:00
'<tr class="expandable-content">'
tests/ci: encode HTML entities in the reports Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
2023-01-15 16:02:57 +00:00
f'<td colspan="{colspan}"><pre>{raw_logs}</pre></td>'
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
"</tr>"
)
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
rows_part.append(row_raw_logs)
Trying style check
2021-09-10 11:52:21 +00:00
Fix wrong report sorting and changing global BASE_HEADERS
2023-01-11 22:39:00 +00:00
headers = BASE_HEADERS.copy()
Trying style check
2021-09-10 11:52:21 +00:00
if has_test_time:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
headers.append("Test time, sec.")
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
if has_log_urls:
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
headers.append("Logs")
Trying style check
2021-09-10 11:52:21 +00:00
Fix mypy errors in report.py
2022-11-14 14:47:09 +00:00
headers_html = "".join(["<th>" + h + "</th>" for h in headers])
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
test_part = HTML_TEST_PART.format(headers=headers_html, rows="".join(rows_part))
Trying style check
2021-09-10 11:52:21 +00:00
else:
test_part = ""
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
additional_html_urls = " ".join(
[_get_html_url(url) for url in sorted(additional_urls, key=_get_html_url_name)]
)
Trying style check
2021-09-10 11:52:21 +00:00
Add job url to test reports
2022-08-09 16:49:55 +00:00
raw_log_name = os.path.basename(raw_log_url)
Use a job ID as ref text
2022-08-11 10:05:16 +00:00
if "?" in raw_log_name:
raw_log_name = raw_log_name.split("?")[0]
Add job url to test reports
2022-08-09 16:49:55 +00:00
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
html = HTML_BASE_TEST_TEMPLATE.format(
Trying style check
2021-09-10 11:52:21 +00:00
title=_format_header(header, branch_name),
header=_format_header(header, branch_name, branch_url),
Add job url to test reports
2022-08-09 16:49:55 +00:00
raw_log_name=raw_log_name,
Trying style check
2021-09-10 11:52:21 +00:00
raw_log_url=raw_log_url,
task_url=task_url,
Add job url to test reports
2022-08-09 16:49:55 +00:00
job_url=job_url,
Trying style check
2021-09-10 11:52:21 +00:00
test_part=test_part,
branch_name=branch_name,
commit_url=commit_url,
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
additional_urls=additional_html_urls,
Trying style check
2021-09-10 11:52:21 +00:00
)
Rework test_results list/tuple/whatever into class
2023-01-03 14:23:19 +00:00
return html
Trying style check
2021-09-10 11:52:21 +00:00
Use the same style for all reports
2023-09-01 12:05:18 +00:00
HTML_BASE_BUILD_TEMPLATE = (
f"{HEAD_HTML_TEMPLATE}"
"""<p class="links">
<a href="{commit_url}">Commit</a>
<a href="{task_url}">Task (github actions)</a>
</p>
Trying style check
2021-09-10 11:52:21 +00:00
<table>
<tr>
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
<th>Config/job name</th>
Trying style check
2021-09-10 11:52:21 +00:00
<th>Compiler</th>
<th>Build type</th>
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
<th>Version</th>
Trying style check
2021-09-10 11:52:21 +00:00
<th>Sanitizer</th>
<th>Status</th>
<th>Build log</th>
<th>Build time</th>
<th class="artifacts">Artifacts</th>
add comments to build reports (#50200)
2023-05-24 20:29:36 +00:00
<th>Comment</th>
Trying style check
2021-09-10 11:52:21 +00:00
</tr>
{rows}
</table>
"""
Use the same style for all reports
2023-09-01 12:05:18 +00:00
f"{FOOTER_HTML_TEMPLATE}"
)
Trying style check
2021-09-10 11:52:21 +00:00
LINK_TEMPLATE = '<a href="{url}">{text}</a>'
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
def create_build_html_report(
Add typing to create_build_html_report
2023-01-04 11:18:53 +00:00
header: str,
build_results: BuildResults,
task_url: str,
branch_url: str,
branch_name: str,
commit_url: str,
) -> str:
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
rows = []
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
for build_result in build_results:
for artifact_urls in build_result.grouped_urls:
row = ["<tr>"]
row.append(
f"<td>{build_result.build_name}<br/>{build_result.job_link}</td>"
)
row.append(f"<td>{build_result.compiler}</td>")
if build_result.debug_build:
row.append("<td>debug</td>")
else:
row.append("<td>relwithdebuginfo</td>")
row.append(f"<td>{build_result.version}</td>")
if build_result.sanitizer:
row.append(f"<td>{build_result.sanitizer}</td>")
else:
row.append("<td>none</td>")
if build_result.status:
style = _get_status_style(build_result.status)
row.append(f'<td style="{style}">{build_result.status}</td>')
else:
style = _get_status_style(ERROR)
row.append(f'<td style="{style}">error</td>')
Trying style check
2021-09-10 11:52:21 +00:00
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
row.append(f'<td><a href="{build_result.log_url}">link</a></td>')
add comments to build reports (#50200)
2023-05-24 20:29:36 +00:00
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
delta = "unknown"
if build_result.elapsed_seconds:
delta = str(datetime.timedelta(seconds=build_result.elapsed_seconds))
row.append(f"<td>{delta}</td>")
links = []
link_separator = "<br/>"
if artifact_urls:
for artifact_url in artifact_urls:
links.append(
LINK_TEMPLATE.format(
text=_get_html_url_name(artifact_url), url=artifact_url
)
)
row.append(f"<td>{link_separator.join(links)}</td>")
Move sparse checkout logic to ci_config
2023-11-08 11:52:19 +00:00
comment = build_result.comment
if (
build_result.build_config is not None
and build_result.build_config.sparse_checkout
):
comment += " (note: sparse checkout is used)"
row.append(f"<td>{comment}</td>")
Use a single BuildResult class across builds and report checks
2023-09-01 20:35:31 +00:00
row.append("</tr>")
rows.append("".join(row))
Trying style check
2021-09-10 11:52:21 +00:00
return HTML_BASE_BUILD_TEMPLATE.format(
title=_format_header(header, branch_name),
header=_format_header(header, branch_name, branch_url),
Combine rows for build templates with lists
2023-09-01 13:01:34 +00:00
rows="".join(rows),
Trying style check
2021-09-10 11:52:21 +00:00
task_url=task_url,
branch_name=branch_name,
Apply black formatter to all *.py files in the repo
2022-03-22 16:39:58 +00:00
commit_url=commit_url,
)
Reference in New Issue Copy Permalink