robotframework-testdoc 0.1.2__py3-none-any.whl

testdoc/html/templates/jinja_template_01.html

@@ -0,0 +1,334 @@
+<!-- Jinja Makro für rekursive Suite-Anzeige -->
+{% macro render_suite(suite, index, first) %}
+    <div class="accordion-item">
+        <h2 class="accordion-header" id="heading{{ index }}">
+            
+                {% if suite.is_folder %}
+                    <button class="accordion-button {% if not first %}collapsed{% endif %}" type="button"
+                            data-bs-toggle="collapse"
+                            data-bs-target="#collapse{{ index }}"
+                            aria-expanded="{% if first %}true{% else %}false{% endif %}"
+                            aria-controls="collapse{{ index }}">
+                        <span class="custom-chevron">
+                            ⯈
+                        </span>
+                        📁 Suite Directory:&nbsp;<strong>{{ suite.name }}</strong>
+                    </button>
+                {% else %}
+                    <button class="accordion-button {% if not first %}collapsed{% endif %}" type="button"
+                            data-bs-toggle="collapse"
+                            data-bs-target="#collapse{{ index }}"
+                            aria-expanded="{% if first %}true{% else %}false{% endif %}"
+                            aria-controls="collapse{{ index }}"
+                            style="border: 2px solid {{ colors.robot_icon }};">
+                        <span class="custom-chevron">
+                            ⯈
+                        </span>
+                        <svg class="svg-icon" width="20" height="20" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+                            <title>Robot Framework</title>
+                            <path d="M4.9565 10.2246c0-1.8766 1.5257-3.4023 3.4-3.4023 1.8766 0 3.4024 1.5257 3.4024 3.4023 0 .6838-.5526 1.2364-1.2341 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364 0-.513-.4185-.9296-.9338-.9296-.5129 0-.9317.4165-.9317.9296 0 .6838-.5523 1.2364-1.234 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364m14.0868 5.717c0 .6842-.5524 1.2363-1.2341 1.2363H6.3575c-.6818 0-1.2344-.552-1.2344-1.2363 0-.6837.5526-1.2363 1.2344-1.2363h11.4517c.6817 0 1.234 5526 1.234 1.2363m-5.351-5.0244c-.3814-.5657-.2323-1.3328.3334-1.7143l2.8628-1.9334c.5613-.3902 1.3329-.2324 1.7144.3289.3815.5654.2323 1.3329-.3334 1.7144l-2.8628 1.9333c-.5442.3831-1.3348.2379-1.7144-.3289zm7.8393 7.6018a.8815.8815 0 0 1-.258.6227l-2.1277 2.1277a.8822.8822 0 0 1-.623.258H5.4772a.8822.8822 0 0 1-.623-.258l-2.1277-2.1277a.8815.8815 0 0 1-.258-.6227V5.4818a.8797.8797 0 0 1 .258-.6228l2.1277-2.1282a.8816.8816 0 0 1 .623-.2578h13.0456a.8816.8816 0 0 1 .623.2578l2.1277 2.1282a.8797.8797 0 0 1 .258.6228V18.519zm1.811-15.0835L20.5644.6577A2.2454 2.2454 0 0 0 18.9775 0H5.0207A2.2445 2.2445 0 0 0 3.433.658L.657 3.4359A2.2449 2.2449 0 0 0 0 5.0228v13.9547c0 .5953.2366 1.1667.6575 1.5872l2.778 2.7779c.421.421.9918.6573 1.5871.6573h13.9548a2.2448 2.2448 0 0 0 1.5872-.6573l2.7779-2.7779A2.2436 2.2436 0 0 0 24 18.9775V5.023a2.2451 2.2451 0 0 0-.6575-1.5875z"/>
+                        </svg>    
+                        &nbsp;Suite File:&nbsp;<strong>{{ suite.name }}.robot</strong>
+                    </button>
+                {% endif %}
+        </h2>
+        <div id="collapse{{ index }}" class="accordion-collapse collapse"
+             aria-labelledby="heading{{ index }}">
+            <div class="accordion-body">
+                <div class="alert alert-secondary small-text text-start p-2 mb-3" role="alert">
+                    <table style="width: 100%; border-collapse: collapse;">
+                        {% if suite.is_folder %}
+                            {% if suite.doc is not none %}
+                                <tr>
+                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
+                                    <td style="text-align: left;">{{ suite.doc }}</td>
+                                </tr>
+                            {% endif %}
+                            {% if suite.metadata is not none %}
+                                <tr>
+                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">⚙️ Metadata:</td>
+                                    <td style="text-align: left;">{{ suite.metadata }}</td>
+                                </tr>
+                            {% endif %}
+                            <tr>
+                                <td style="width: 10%; font-weight: bold;">📊 Number of Tests:</td>
+                                <td style="text-align: left;">{{ suite.total_tests  }}</td>
+                            </tr>
+                        {% else %}
+                            {% if suite.doc is not none %}
+                                <tr>
+                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
+                                    <td style="text-align: left;">{{ suite.doc }}</td>
+                                </tr>
+                            {% endif %}
+                            {% if suite.source is not none %}
+                                <tr>
+                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
+                                    <td style="text-align: left;">
+                                        <a href="{{ suite.source }}" target="_blank">{{ suite.source }}</a>
+                                    </td>
+                                </tr>
+                            {% endif %}
+                            <tr>
+                                <td style="width: 10%; font-weight: bold;">📊 Number of Tests:</td>
+                                <td style="text-align: left;">{{ suite.num_tests }}</td>
+                            </tr>
+                        {% endif %}
+                    </table>
+                </div>
+
+                {% if suite.tests %}
+                    <div class="accordion mt-3" id="testAccordion{{ index }}">
+                        {% for test in suite.tests %}
+                        <div class="accordion-item">
+                            <h2 class="accordion-header" id="headingTest{{ index }}-{{ loop.index }}">
+                                <button class="accordion-button collapsed" type="button"
+                                        data-bs-toggle="collapse"
+                                        data-bs-target="#collapseTest{{ index }}-{{ loop.index }}"
+                                        aria-expanded="false"
+                                        aria-controls="collapseTest{{ index }}-{{ loop.index }}">
+                                        <span class="custom-chevron">
+                                            ⯈
+                                        </span>
+                                        <svg class="svg-icon" width="20" height="20" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+                                            <title>Robot Framework</title>
+                                            <path d="M4.9565 10.2246c0-1.8766 1.5257-3.4023 3.4-3.4023 1.8766 0 3.4024 1.5257 3.4024 3.4023 0 .6838-.5526 1.2364-1.2341 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364 0-.513-.4185-.9296-.9338-.9296-.5129 0-.9317.4165-.9317.9296 0 .6838-.5523 1.2364-1.234 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364m14.0868 5.717c0 .6842-.5524 1.2363-1.2341 1.2363H6.3575c-.6818 0-1.2344-.552-1.2344-1.2363 0-.6837.5526-1.2363 1.2344-1.2363h11.4517c.6817 0 1.234 5526 1.234 1.2363m-5.351-5.0244c-.3814-.5657-.2323-1.3328.3334-1.7143l2.8628-1.9334c.5613-.3902 1.3329-.2324 1.7144.3289.3815.5654.2323 1.3329-.3334 1.7144l-2.8628 1.9333c-.5442.3831-1.3348.2379-1.7144-.3289zm7.8393 7.6018a.8815.8815 0 0 1-.258.6227l-2.1277 2.1277a.8822.8822 0 0 1-.623.258H5.4772a.8822.8822 0 0 1-.623-.258l-2.1277-2.1277a.8815.8815 0 0 1-.258-.6227V5.4818a.8797.8797 0 0 1 .258-.6228l2.1277-2.1282a.8816.8816 0 0 1 .623-.2578h13.0456a.8816.8816 0 0 1 .623.2578l2.1277 2.1282a.8797.8797 0 0 1 .258.6228V18.519zm1.811-15.0835L20.5644.6577A2.2454 2.2454 0 0 0 18.9775 0H5.0207A2.2445 2.2445 0 0 0 3.433.658L.657 3.4359A2.2449 2.2449 0 0 0 0 5.0228v13.9547c0 .5953.2366 1.1667.6575 1.5872l2.778 2.7779c.421.421.9918.6573 1.5871.6573h13.9548a2.2448 2.2448 0 0 0 1.5872-.6573l2.7779-2.7779A2.2436 2.2436 0 0 0 24 18.9775V5.023a2.2451 2.2451 0 0 0-.6575-1.5875z"/>
+                                        </svg>
+                                        &nbsp;Test Case:&nbsp;<strong>{{ test.name }}</strong>
+                                </button>
+                            </h2>
+                            <div id="collapseTest{{ index }}-{{ loop.index }}" class="accordion-collapse collapse"
+                                 aria-labelledby="headingTest{{ index }}-{{ loop.index }}">
+                                <div class="accordion-body">
+                                    <div class="alert alert-light text-start p-2 mb-3" role="alert">
+                                        {% set has_info = test.doc is not none or test.source is not none or test.tags is not none or test.keywords is not none %}
+                                        <table style="width: 100%; border-collapse: collapse;">
+                                            {% if test.doc is not none %}
+                                                <tr>
+                                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
+                                                    <td style="text-align: left;">{{ test.doc }}</td>
+                                                </tr>
+                                            {% endif %}
+                                            {% if test.source is not none %}
+                                                <tr>
+                                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
+                                                    <td style="text-align: left;">
+                                                        <a href="{{ test.source }}" target="_blank">{{ test.source }}</a>
+                                                    </td>
+                                                </tr>
+                                            {% endif %}
+                                            {% if test.tags is not none %}
+                                                <tr>
+                                                    <td style="width: 10%; font-weight: bold;">🏷 Tags:</td>
+                                                    <td style="text-align: left;">
+                                                        {% if test.tags %}
+                                                            {{ test.tags | join(', ') }}
+                                                        {% endif %}
+                                                    </td>
+                                                </tr>
+                                            {% endif %}
+                                            {% if test.keywords is not none %}
+                                                <tr>
+                                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">🔑 Keywords:</td>
+                                                    <td style="text-align: left;">
+                                                        {% if test.keywords %}
+                                                            - {{ test.keywords | join('<br>- ') }}
+                                                        {% endif %}
+                                                    </td>
+                                                </tr>
+                                            {% endif %}
+                                            {% if not has_info %}
+                                                <tr>
+                                                    <td class="info-msg" style="width: 10%; vertical-align: top; text-align: center;">
+                                                        No Details Available!
+                                                    </td>
+                                                </tr>
+                                            {% endif %}
+                                        </table>
+                                    </div>
+                                </div>
+                            </div>
+                        </div>
+                        {% endfor %}
+                    </div>
+                {% endif %}
+
+                {% if suite.sub_suites %}
+                    <div class="accordion mt-3">
+                        {% for sub_suite in suite.sub_suites %}
+                            {{ render_suite(sub_suite, index|string + loop.index|string) }}
+                        {% endfor %}
+                    </div>
+                {% endif %}
+
+
+            </div>
+        </div>
+    </div>
+{% endmacro %}
+
+
+<!-- Templates - Main Part -->
+<!DOCTYPE html>
+<html lang="de">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Robot Framework - Test Documentation</title>
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
+        
+        <!-- In-File CSS Style Sheet -->
+        <style>
+            /* Hintergrundfarbe der Seite */
+            html, body, .container-fluid {
+                background-color: {{ colors.background }};
+                color: {{ colors.text_color }}
+                font-size: 14px;
+            }
+
+            a {
+                color: {{ colors.text_color }}
+            }
+            a:hover {
+                color: {{ colors.robot_icon }}
+            }
+
+            .custom-line {
+                background-color: {{ colors.robot_icon }}
+            }
+        
+            #testSuiteAccordion {
+                background-color: {{ colors.background }} !important;
+                max-width: 98%;
+                margin: 0 auto;
+            }
+
+            .svg-icon {
+                fill: {{ colors.robot_icon }};
+            }
+        
+            /* Style für das Accordion */
+            .accordion-item {
+                background-color: {{ colors.inner_color }} !important;
+                border-radius: 6px;
+                margin: 1px;
+                border: 1px solid {{ colors.border_color }};
+                font-size: 14px;
+                box-sizing: border-box;
+            }
+        
+            .accordion-header {
+                font-size: 14px;
+            }
+        
+            .accordion-button {
+                background-color: {{ colors.inner_color }};
+                color: {{ colors.text_color }};
+                font-size: 14px;
+                height: 35px;
+            }
+        
+            .accordion-button:hover {
+                background-color: {{ colors.button_hover_color }} !important;
+            }
+
+            .accordion-button:not(.collapsed),
+            .accordion-button:focus,
+            .accordion-button:active {
+                background-color: {{ colors.button_active_color }} !important;
+                box-shadow: none !important;
+                color: {{ colors.text_color }} !important;
+            }
+
+            .custom-chevron {
+                color: {{ colors.text_color }};
+                margin-right: 8px;
+            }
+
+            .accordion-button.collapsed .custom-chevron {
+                transform: rotate(0deg);
+                transition: transform 0.3s ease;
+            }
+
+            .accordion-button .custom-chevron {
+                transform: rotate(90deg);
+                transition: transform 0.3s ease;
+            }
+
+            .accordion-button::after {
+                background-image: none !important;
+                content: none !important;
+            }
+        
+            .accordion-body {
+                background-color: {{ colors.inner_color }};
+                padding: 5px;
+                font-size: 14px;
+            }
+        
+            /* Liste der Testfälle */
+            .list-group-item {
+                background-color: #fff;
+                border: 1px solid {{ colors.border_color }};
+                display: flex;
+                align-items: center;
+                font-size: 14px;
+                padding: 6px 10px;
+            }
+        
+            /* Testfall Hover Effekt */
+            .list-group-item:hover {
+                background-color: {{ colors.inner_color }};
+            }
+        
+            /* Tabelle für Test Suite Informationen */
+            .alert {
+                font-size: 14px;
+                padding: 6px 10px;
+                background-color: {{ colors.inner_color }};
+                border: 1px solid {{ colors.border_color }};
+            }
+        
+            table {
+                height: 10px;
+                font-size: 13px;
+                color: {{ colors.text_color }};
+            }
+        
+            td {
+                padding: 1px 1px;
+            }
+        
+            /* Titelgröße */
+            h1 {
+                color: {{ colors.title_color }};
+                font-size: 30px;
+            }
+
+            .info-msg {
+                color: {{ colors.title_color }};
+            }
+
+            .generated_at {
+                color: {{ colors.title_color }}
+            }
+        </style>
+    </head>
+    <body class="d-flex flex-column min-vh-100">
+        <div class="container-fluid mt-5 flex-grow-1">
+            <h1 class="text-center">{{ title }}</h1>
+
+            <div class="accordion mt-4" id="testSuiteAccordion">
+                {% for suite in suites %}
+                    {{ render_suite(suite, loop.index, loop.first) }}
+                {% endfor %}
+            </div>
+        </div>
+
+        <!-- Footer -->
+        <p class="text-center generated_at py-1 border-top">
+            Generated at: {{ generated_at }}<br>robotframework-testdoc 2.0 by Marvin Klerx
+        </p>
+    </body>
+</html>

testdoc/html/themes/theme_config.py

@@ -0,0 +1,27 @@
+from ...helper.cliargs import CommandLineArguments
+from .themes import DEFAULT_THEME, ROBOT_THEME, DARK_THEME, BLUE_THEME
+
+class ThemeConfig():
+    
+    def __init__(self):
+        self.args = CommandLineArguments().data
+
+    def theme(self):
+        _theme = self.args.colors
+        if _theme:
+            if "default" in _theme:
+                return self._get_predefined_theme(_theme.get("default"))    
+            return _theme
+        return DARK_THEME
+    
+    def _get_predefined_theme(self, theme: str):
+        theme = theme.strip()
+        if theme == "default" or theme == 0:
+            return DEFAULT_THEME
+        if theme == "dark" or theme == 1:
+            return DARK_THEME
+        if theme == "robot" or theme == 2:
+            return ROBOT_THEME
+        if theme == "blue" or theme == 3:
+            return BLUE_THEME
+        

testdoc/html/themes/themes.py

@@ -0,0 +1,44 @@
+# default
+DEFAULT_THEME = {
+    "background": "#f8f9fa",
+    "inner_color": "#f8f9fa",
+    "button_active_color": "#f8f9fa",
+    "button_hover_color": "#C2C2C2",
+    "border_color": "#353535",
+    "text_color": "#353535",
+    "title_color": "#343a40",
+    "robot_icon": "#00c0b5",
+}
+
+ROBOT_THEME = {
+    "background": "#f8f9fa",
+    "inner_color": "#f8f9fa",
+    "button_active_color": "#C2C2C2",
+    "button_hover_color": "#C2C2C2",
+    "border_color": "black",
+    "text_color": "black",
+    "title_color": "black",
+    "robot_icon": "#00c0b5",
+}
+
+DARK_THEME = {    
+    "background": "#303030",
+    "inner_color": "#303030",
+    "button_active_color": "#5F5F5F",
+    "button_hover_color": "#5F5F5F",
+    "border_color": "white",
+    "text_color": "white",
+    "title_color": "#00c0b5",
+    "robot_icon": "#00c0b5",
+}
+
+BLUE_THEME = {
+    "background": "#000028",
+    "inner_color": "#000028",
+    "button_active_color": "#193966",
+    "button_hover_color": "#193966",
+    "border_color": "#CCCCCC",
+    "text_color": "#CCCCCC",
+    "title_color": "#00ffb9",
+    "robot_icon": "#00ffb9",
+}

testdoc/html_rendering/render.py

@@ -0,0 +1,31 @@
+from jinja2 import Environment, FileSystemLoader
+import os
+
+from ..html.themes.theme_config import ThemeConfig
+from ..helper.cliargs import CommandLineArguments
+from ..helper.datetimeconverter import DateTimeConverter
+from ..helper.logger import Logger
+
+class TestDocHtmlRendering():
+
+    TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "html", "templates")
+    
+    def __init__(self):
+        self.args = CommandLineArguments().data
+
+    def render_testdoc(self,
+            suites,
+            output_file
+        ):
+        env = Environment(loader=FileSystemLoader(self.TEMPLATE_DIR))
+        template = env.get_template("jinja_template_01.html")
+
+        rendered_html = template.render(
+            suites=suites,
+            generated_at=DateTimeConverter().get_generated_datetime(),
+            title=self.args.title,
+            colors=ThemeConfig().theme()
+        )
+        with open(output_file, "w", encoding="utf-8") as f:
+            f.write(rendered_html)
+        Logger().LogKeyValue("Generated Test Documentation File: ", output_file)

testdoc/parser/modifier/sourceprefixmodifier.py

@@ -0,0 +1,78 @@
+import os
+
+from robot.api import  TestSuite
+
+from ...helper.cliargs import CommandLineArguments
+from ...helper.logger import Logger
+
+class SourcePrefixModifier():
+    
+    GITLAB_CONNECTOR = "-/blob/main/"
+    
+    def __init__(self):
+        self.args = CommandLineArguments().data
+    
+    def _modify(self, suite: TestSuite, prefix: str):
+        prefix_type, prefix = self._prefix_validation(prefix)
+        if "gitlab" in prefix_type:
+            SourcePrefixGitLab()._apply_gitlab_source_to_suite(suite, prefix)
+        else:
+            raise ValueError(f"No matching source-prefix modifier found for: {prefix_type} with prefix: {prefix}")
+
+    def _prefix_validation(self, prefix: str) -> list:
+        if "::" not in prefix:
+            raise ValueError("Missing source-prefix type - expected type in format like 'gitlab::source-prefix!'")
+        prefix = self.args.sourceprefix.split("::")
+        return prefix[0], prefix[1]
+    
+    def modify_source_prefix(self, suite_object: TestSuite) -> TestSuite:
+        Logger().LogKeyValue("Using Prefix for Source: ", self.args.sourceprefix, "yellow") if self.args.verbose_mode else None
+        for suite in suite_object:
+            self._modify(suite, self.args.sourceprefix)
+        return suite_object
+    
+class SourcePrefixGitLab():
+    """
+    Source Prefix Modifier for "GitLab" Projects.
+    Expected CMD Line Arg: "gitlab::prefix"
+    """
+    def _get_git_root(self, path):
+        current = os.path.abspath(path)
+        while current != os.path.dirname(current):
+            if os.path.isdir(os.path.join(current, ".git")):
+                return current
+            current = os.path.dirname(current)
+        return None
+    
+    def _get_git_branch(self, git_root):
+        head_file = os.path.join(git_root, ".git", "HEAD")
+        if not os.path.isfile(head_file):
+            return "main"
+        with open(head_file, "r") as f:
+            content = f.read().strip()
+            if content.startswith("ref:"):
+                return content.split("/")[-1]
+        return "main"
+
+    def _convert_to_gitlab_url(self, file_path, prefix):
+        git_root = self._get_git_root(file_path)
+        git_branch = self._get_git_branch(git_root)
+        if not git_root:
+            return "GitLink error"
+        rel_path = os.path.relpath(file_path, git_root).replace(os.sep, "/")
+        return prefix.rstrip("/") + "/-/blob/" + git_branch + "/" + rel_path
+
+    def _apply_gitlab_source_to_suite(self, suite_dict, prefix):
+        try:
+            suite_dict["source"] = self._convert_to_gitlab_url(suite_dict["source"], prefix)
+        except:
+            suite_dict["source"] = "GitLink error"
+
+        for test in suite_dict.get("tests", []):
+            try:
+                test["source"] = self._convert_to_gitlab_url(test["source"], prefix)
+            except:
+                test["source"] = "GitLink error"
+
+        for sub_suite in suite_dict.get("sub_suites", []):
+            self._apply_gitlab_source_to_suite(sub_suite, prefix)

testdoc/parser/modifier/suitefilemodifier.py

@@ -0,0 +1,115 @@
+from robot.api import TestSuite
+
+from ...helper.cliargs import CommandLineArguments
+from ...helper.logger import Logger
+from .sourceprefixmodifier import SourcePrefixModifier
+
+class SuiteFileModifier():
+    
+    def __init__(self):
+        self.args = CommandLineArguments().data
+        self.suite = None
+        
+    #############################################################################################################################
+        
+    def run(self, suite_object: TestSuite = None):
+        if not suite_object:
+            raise KeyError(f"[{self.__class__}] - Error - Suite Object must not be None!")
+        self.suite = suite_object
+        
+        # Modify generic params / hide some params
+        self._modify_root_suite_name()
+        self._modify_root_suite_doc()
+        self._modify_root_suite_metadata()
+        self._modify_tags()
+        self._modify_test_doc()
+        self._modify_suite_doc()
+        self._modify_keywords()
+        self._modify_source()
+        return self.suite
+    
+    #############################################################################################################################
+    
+    def _modify_root_suite_name(self):
+        if not self.args.name:
+            return
+        Logger().LogKeyValue("Modified Name of Root Suite: ", self.args.name, "yellow") if self.args.verbose_mode else None
+        self.suite[0]["name"] = self.args.name
+    
+    #############################################################################################################################
+        
+    def _modify_root_suite_doc(self):
+        if not self.args.doc:
+            return
+        Logger().LogKeyValue("Modified Doc of Root Suite: ", self.args.name, "yellow") if self.args.verbose_mode else None
+        self.suite[0]["doc"] = self.args.doc
+    
+    #############################################################################################################################
+        
+    def _modify_root_suite_metadata(self):
+        if not self.args.metadata:
+            return
+        Logger().LogKeyValue("Modified Metadata of Root Suite: ", self.args.metadata, "yellow") if self.args.verbose_mode else None
+        formatted_metadata = "<br>".join([f"{k}: {v}" for k, v in self.args.metadata.items()])
+        self.suite[0]["metadata"] = formatted_metadata
+    
+    #############################################################################################################################
+    
+    def _modify_tags(self):
+        if not self.args.hide_tags:
+            return
+        Logger().LogKeyValue("Removed Info from Test Documentation: ", "Tags", "red") if self.args.verbose_mode else None
+        self._remove_suite_object_parameter(self.suite, "tags", "test")
+    
+    #############################################################################################################################
+    
+    def _modify_test_doc(self):
+        if not self.args.hide_test_doc:
+            return
+        Logger().LogKeyValue("Removed Info from Test Documentation: ", "Test Doc", "red") if self.args.verbose_mode else None
+        self._remove_suite_object_parameter(self.suite, "doc", "test")
+    
+    #############################################################################################################################
+    
+    def _modify_suite_doc(self):
+        if not self.args.hide_suite_doc:
+            return
+        Logger().LogKeyValue("Removed Info from Test Documentation: ", "Suite Doc", "red") if self.args.verbose_mode else None
+        self._remove_suite_object_parameter(self.suite, "doc", "suite")
+    
+    #############################################################################################################################
+    
+    def _modify_keywords(self):
+        if not self.args.hide_keywords:
+            return
+        Logger().LogKeyValue("Removed Info from Test Documentation: ", "Keywod Calls", "red") if self.args.verbose_mode else None
+        self._remove_suite_object_parameter(self.suite, "keywords", "test")
+    
+    #############################################################################################################################
+    
+    def _modify_source(self):
+        if self.args.hide_source:
+            Logger().LogKeyValue("Removed Info from Test Documentation: ", "Test Suite / Case Source", "red") if self.args.verbose_mode else None
+            self._remove_suite_object_parameter(self.suite, "source", "both")
+            return
+        
+        # Modify the source path for the test documentation
+        if self.args.sourceprefix:
+            self.suite = SourcePrefixModifier().modify_source_prefix(self.suite)
+
+    #############################################################################################################################
+    #############################################################################################################################
+    #############################################################################################################################
+    
+    def _remove_suite_object_parameter(self, suites: list, field: str, target: str = "test"):
+        """Remove a specific key from the test suite or test case object"""
+        for suite in suites:
+            if target in ("suite", "both"):
+                suite[field] = None
+            if target in ("test", "both"):
+                for test in suite.get("tests", []):
+                    test[field] = None
+            if "sub_suites" in suite:
+                self._remove_suite_object_parameter(suite["sub_suites"], field, target)
+                
+    #############################################################################################################################                

testdoc/parser/testcaseparser.py

@@ -0,0 +1,31 @@
+from robot.api import TestSuite
+from ..helper.cliargs import CommandLineArguments
+
+class TestCaseParser():
+
+    def __init__(self):
+        self.args = CommandLineArguments().data
+
+    def parse_test(self,
+            suite: TestSuite,
+            suite_info: dict
+        ) -> dict:
+
+        for test in suite.tests:
+            test_info = {
+                "name": test.name,
+                "doc": "<br>".join(line.replace("\\n","") for line in test.doc.splitlines() 
+                                   if line.strip()) if test.doc else "No Test Case Documentation Available", 
+                "tags": test.tags if test.tags else "No Tags Configured",
+                "source": str(test.source),
+                "keywords": [kw.name for kw in test.body if hasattr(kw, 'name')] or "No Keyword Calls in Test"
+            }
+            suite_info["tests"].append(test_info)
+        return suite_info
+        
+    def consider_tags(self, suite: TestSuite) -> TestSuite:
+        if len(self.args.include) > 0:
+            suite.configure(include_tags=self.args.include) 
+        if len(self.args.exclude) > 0:
+            suite.configure(exclude_tags=self.args.exclude)
+        return suite