robotframework-dashboard 1.3.1__py3-none-any.whl

robotframework_dashboard/css/styling.css

@@ -0,0 +1,431 @@
+/* LIGHT MODE STYLING */
+body {
+    background-color: #eee;
+}
+
+.border-bottom {
+    border-color: rgba(0, 0, 0, 0.175) !important;
+}
+
+.fullscreen,
+.sticky-top,
+body {
+    background-color: #eee;
+}
+
+.grid-stack {
+    max-height: 2400px;
+}
+
+.grid-stack-item-content {
+    background-color: white;
+}
+
+.form-switch .form-check-input:not(:checked) {
+    background-image: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'%3e%3ccircle r='3' fill='black'/></svg>");
+    border-color: black;
+}
+
+.stat-label {
+    font-size: 1rem;
+    color: darkgrey;
+}
+
+.white-text {
+    color: black;
+}
+
+/* DARK MODE STYLING */
+.dark-mode :root {
+    color-scheme: dark;
+}
+
+.dark-mode .grid-stack-item-content,
+.dark-mode .overview-card .card {
+    background: rgba(30, 41, 59, 0.9);
+}
+
+.dark-mode .fullscreen {
+    background: rgba(30, 41, 59, 1);
+}
+
+.dark-mode .modal-content {
+    background: #0f172a;
+}
+
+.dark-mode .border-bottom {
+    border-color: rgba(255, 255, 255, 0.15) !important;
+}
+
+.dark-mode .sticky-top,
+.dark-mode .card,
+.dark-mode body,
+.dark-mode .modal-dialog {
+    background: #0f172a;
+    color: #eee;
+}
+
+.dark-mode .list-group-item:not(.disabled),
+.dark-mode .form-label,
+.dark-mode .form-control,
+.dark-mode .form-select {
+    color: #eee;
+}
+
+.dark-mode .list-group-item .disabled {
+    color: rgba(173, 181, 189, 0.75);
+}
+
+.dark-mode .form-switch .form-check-input:not(:checked) {
+    background-image: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'%3e%3ccircle r='3' fill='white'/></svg>");
+    border-color: #eee;
+}
+
+.dark-mode .table>:not(caption)>*>* {
+    color: #eee;
+}
+
+.dark-mode .collapse-icon {
+    color: #eee;
+}
+
+.dark-mode .stat-label {
+    font-size: 0.85rem;
+    color: #9ca3af;
+}
+
+.dark-mode .white-text {
+    color: #eee;
+}
+
+/* GENERAL STYLING */
+:root {
+    font-family: Helvetica, sans-serif;
+}
+
+.html-scroll {
+    overflow-y: scroll;
+}
+
+.modal-open {
+    padding-right: 0px !important;
+}
+
+h4,
+h5,
+h6 {
+    margin-bottom: 0rem;
+}
+
+body.lock-scroll {
+    overflow: hidden;
+}
+
+#settings,
+#database,
+.nav-item,
+.information-icon,
+.bar-graph,
+.line-graph,
+.fullscreen-graph,
+.close-graph,
+.timeline-graph,
+.radar-graph,
+.heatmap-graph,
+.pie-graph,
+.percentage-graph,
+.stats-graph,
+.boxplot-graph,
+.shown-graph,
+.hidden-graph,
+.shown-section,
+.hidden-section,
+.move-up-table,
+.move-down-table,
+.move-up-section,
+.move-down-section {
+    cursor: pointer;
+}
+
+.navbar-disabled {
+    opacity: 0.5;
+    user-select: none;
+}
+
+.navbar-disabled a {
+    pointer-events: none;
+}
+
+.navbar-disabled a:hover {
+    pointer-events: auto;
+}
+
+.tooltip-popup {
+    position: fixed;
+    max-width: 360px;
+    padding: 8px 12px;
+    border-radius: 8px;
+    background-color: white;
+    color: black;
+    box-shadow: 0 2px 8px rgba(0, 0, 0, 0.3);
+    font-size: 0.95rem;
+    white-space: pre-line;
+    pointer-events: none;
+    z-index: 9999;
+    box-sizing: border-box;
+}
+
+.dark-mode .tooltip-popup {
+    background-color: #0f172a;
+    color: #eee;
+}
+
+.navbar {
+    margin-bottom: 1rem;
+}
+
+.card {
+    margin-bottom: 1rem;
+    box-shadow: 0 4px 20px rgba(0, 0, 0, 0.5);
+}
+
+.stats {
+    float: right;
+    text-align: right;
+    font-size: 0.9em;
+    white-space: nowrap;
+}
+
+.fullscreen {
+    position: fixed !important;
+    width: 100% !important;
+    height: 100% !important;
+    left: 0 !important;
+    top: 0 !important;
+    z-index: 10 !important;
+    padding: 20px 20px 20px 20px !important;
+    border-radius: 0px !important;
+}
+
+.dropdown-menu {
+    width: max-content;
+}
+
+.version-selected-dot {
+    display: inline-block;
+    width: 6px;
+    height: 6px;
+    background-color: #ec5800;
+    border-radius: 50%;
+    margin-left: 5px;
+    margin-bottom: 2px;
+    vertical-align: middle;
+}
+
+.selectBox {
+    position: relative;
+}
+
+.selectBox select {
+    width: 100%;
+}
+
+.overSelect {
+    position: absolute;
+    left: 0;
+    right: 0;
+    top: 0;
+    bottom: 0;
+}
+
+.filterCheckBoxes {
+    display: none;
+    position: absolute;
+    z-index: 2;
+}
+
+.filterCheckBoxes label {
+    display: block;
+}
+
+.border {
+    min-height: 42px;
+}
+
+.stat-value {
+    font-size: 1.5rem;
+    font-weight: 600;
+}
+
+.fullscreen .stat-value {
+    font-size: 4rem;
+}
+
+.fullscreen .stat-label {
+    font-size: 2rem;
+}
+
+.green-text,
+.text-passed {
+    color: rgba(151, 189, 97, 0.9);
+}
+
+.border-passed {
+    border-color: rgba(151, 189, 97, 0.9);
+}
+
+.red-text,
+.text-failed {
+    color: rgba(206, 62, 1, 0.9);
+}
+
+.border-failed {
+    border-color: rgba(206, 62, 1, 0.9);
+}
+
+.yellow-text {
+    color: rgba(254, 216, 79, 0.9);
+}
+
+.border-skipped {
+    border-color: rgba(254, 216, 79, 0.9);
+}
+
+.blue-text {
+    color: dodgerblue;
+}
+
+.overview-canvas {
+    height: 200px;
+}
+
+.overview-card {
+    cursor: pointer;
+    min-width: 300px;
+}
+
+.overview-card .card {
+    border-radius: 1rem
+}
+
+.project-run-cards-container {
+    display: flex;
+    flex-wrap: wrap;
+    column-gap: 24px;
+}
+
+.project-run-cards-container .overview-card {
+    flex: 0 1 calc((100% - 48px) / 3); /* 3 per row, subtract total gap */
+}
+
+.run-card-version-title {
+    gap: 0.25rem;
+    width: fit-content;
+}
+
+.run-card-version-title:hover h5 {
+    color: #ec5800 !important;
+}
+
+.run-card-small-version {
+    display: flex;
+    gap: 0.25rem;
+    width: fit-content;
+}
+
+.run-card-small-version:hover div{
+    color: #ec5800 !important;
+}
+
+.grid-stack-item-content {
+    border-radius: 8px;
+    display: flex;
+    flex-direction: column;
+    padding: 20px;
+    box-shadow: 0 4px 20px rgba(0, 0, 0, 0.5);
+}
+
+.graph-header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    margin-bottom: 8px;
+}
+
+.graph-header h6 {
+    margin: 0;
+    font-weight: 600;
+}
+
+.graph-controls {
+    display: flex;
+    gap: 8px;
+}
+
+.grid-stack-item-content .graph-body {
+    flex: 1 1 auto;
+    display: flex;
+    overflow-x: hidden;
+    overflow-y: auto;
+    width: 100%;
+}
+
+.graph-body .row {
+    flex-wrap: wrap;
+    margin-left: 0;
+    margin-right: 0;
+}
+
+.grid-stack-item-content .graph-body .vertical {
+    overflow-y: auto;
+}
+
+canvas {
+    display: block;
+}
+
+#alertContainer {
+    z-index: 1100;
+    top: 7rem;
+    max-width: 80%
+}
+
+.alert-dismissible {
+    padding-right: 16px !important;
+}
+
+.grid-stack-item-content:has(.hidden-graph:not([hidden])),
+.table-section:has(.hidden-graph:not([hidden])),
+.card:has(.hidden-section:not([hidden])) {
+    opacity: 0.5;
+}
+
+.modal.dimmed {
+    pointer-events: none;
+    filter: brightness(0.5);
+}
+
+#runTag {
+    max-height: 400px;
+    overflow: auto;
+}
+
+@media print {
+    table {
+        width: 100%;
+        page-break-inside: auto;
+    }
+
+    .grid-stack-item-contentvas {
+        width: 100%;
+        overflow: hidden;
+        page-break-inside: avoid;
+        break-inside: avoid;
+        display: block;
+    }
+
+    canvas {
+        height: auto !important;
+        max-width: 100% !important;
+    }
+}

robotframework_dashboard/dashboard.py

@@ -0,0 +1,126 @@
+from os.path import join, abspath, dirname
+from pathlib import Path
+from datetime import datetime
+from json import dumps
+from zlib import compress
+from base64 import b64encode
+
+from .dependencies import DependencyProcessor
+from .version import __version__
+
+
+class DashboardGenerator:
+    """
+    Class that handles the generation of the dashboard HTML
+    """
+
+    def generate_dashboard(
+        self,
+        name_dashboard: str,
+        data: dict,
+        generation_datetime: datetime,
+        dashboard_title: str,
+        server: bool,
+        json_config: str,
+        message_config: list,
+        quantity: int,
+        use_logs: bool,
+        offline: bool,
+    ):
+        """
+        Function that generates the dashboard by replacing all relevant placeholders.
+        """
+        dependency_processor = DependencyProcessor()
+
+        # load template
+        index_html = join(dirname(abspath(__file__)), "templates", "dashboard.html")
+        with open(index_html, "r", encoding="utf-8") as file:
+            dashboard_data = file.read()
+            dashboard_data = dashboard_data.replace(
+                "<!-- placeholder_javascript -->", dependency_processor.get_js_block()
+            )
+            dashboard_data = dashboard_data.replace(
+                "<!-- placeholder_css -->", dependency_processor.get_css_block()
+            )
+            dashboard_data = dashboard_data.replace(
+                "<!-- placeholder_dependencies -->",
+                dependency_processor.get_dependencies_block(offline),
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_version"', __version__
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_runs"', f'"{self._compress_and_encode(data["runs"])}"'
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_suites"', f'"{self._compress_and_encode(data["suites"])}"'
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_tests"', f'"{self._compress_and_encode(data["tests"])}"'
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_keywords"',
+                f'"{self._compress_and_encode(data["keywords"])}"',
+            )
+            dashboard_data = dashboard_data.replace(
+                '"placeholder_amount"', str(quantity)
+            )
+            if dashboard_title != "":
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_dashboard_title"', dashboard_title
+                )
+            else:
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_dashboard_title"',
+                    f"Robot Framework Dashboard - {str(generation_datetime)[:-7]}",
+                )
+            if server:
+                dashboard_data = dashboard_data.replace('"placeholder_server"', "true")
+            else:
+                dashboard_data = dashboard_data.replace('"placeholder_server"', "false")
+            if message_config:
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_message_config"',
+                    str(message_config).replace("'", '"'),
+                )
+            if json_config:
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_json_config"',
+                    json_config,
+                )
+            if use_logs:
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_use_logs"', "true"
+                )
+            else:
+                dashboard_data = dashboard_data.replace(
+                    '"placeholder_use_logs"', "false"
+                )
+
+        # handle possible subdirectories
+        path = Path(name_dashboard)
+        path.parent.mkdir(exist_ok=True, parents=True)
+
+        # minify html
+        dashboard_data = self._minify_text(dashboard_data)
+
+        # write template
+        with open(name_dashboard, "w", encoding="utf-8") as file:
+            file.write(dashboard_data)
+
+        # warn in case of empty database
+        if len(data["runs"]) == 0:
+            print("  WARNING: There are no runs so the dashboard will be empty!")
+
+    def _compress_and_encode(self, obj):
+        json_data = dumps(obj).encode("utf-8")
+        compressed = compress(json_data)
+        return b64encode(compressed).decode("utf-8")
+
+    def _minify_text(self, text):
+        cleaned_lines = []
+        for line in text.splitlines():
+            stripped = line.strip()
+            if stripped:  # keep only non-empty lines
+                cleaned_lines.append(stripped)
+        return "\n".join(cleaned_lines)