robotframework-testdoc 0.1.7__tar.gz → 0.2.0__tar.gz

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/.gitignore

@@ -9,3 +9,5 @@ output_doc.html
 output.html
 src/testdoc/html/templates/jinja_template_02.html
 image.png
+output_doc_robot.html
+devel.html

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.1.7
+Version: 0.2.0
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: MIT
@@ -15,6 +15,12 @@ Dynamic: license-file
 
 # Robot Framework TestDoc
 
+## Statistics
+
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+
 ## Installation
 
 Install the tool using the following command:
@@ -98,6 +104,37 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+## HTML Template Selection
+
+You can choose between multiple HTML template for the design of your test documentation.    
+These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
+
+### Default Design
+
+- v2
+
+### Available HTML Templates
+
+You can choose one of the following designs:
+- v1
+- v2
+
+### Version 1
+
+#### Visit Tests
+
+![alt text](docs/html_v1_common.png)
+
+### Version 2
+
+#### Visit Tests on Root Suite Level
+
+![alt text](docs/html_v2_root.png)
+
+#### Visit Tests on Suite File Level
+
+![alt text](docs/html_v2_suitefile.png)
+
 ## Theme Selection / Color Configuration
 
 You can select between several themes (color configurations) for your HTML document to create!

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/README.md

@@ -1,5 +1,11 @@
 # Robot Framework TestDoc
 
+## Statistics
+
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+
 ## Installation
 
 Install the tool using the following command:
@@ -83,6 +89,37 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+## HTML Template Selection
+
+You can choose between multiple HTML template for the design of your test documentation.    
+These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
+
+### Default Design
+
+- v2
+
+### Available HTML Templates
+
+You can choose one of the following designs:
+- v1
+- v2
+
+### Version 1
+
+#### Visit Tests
+
+![alt text](docs/html_v1_common.png)
+
+### Version 2
+
+#### Visit Tests on Root Suite Level
+
+![alt text](docs/html_v2_root.png)
+
+#### Visit Tests on Suite File Level
+
+![alt text](docs/html_v2_suitefile.png)
+
 ## Theme Selection / Color Configuration
 
 You can select between several themes (color configurations) for your HTML document to create!

robotframework_testdoc-0.2.0/atest/config_pyproject/example_pyproject.toml

@@ -0,0 +1,32 @@
+[tool.testdoc]
+title = "New title of HTML document"
+name = "New name of root suite element"
+doc = "New doc text of root suite element"
+sourceprefix = "gitlab::https://gitlab.com/myrepo/repo_path"
+include = ["TagA", "TagB"]
+exclude = ["TagC"]
+hide_tags = true
+hide_test_doc = true
+hide_suite_doc = true
+hide_source = true
+hide_keywords = true
+style = "blue"
+verbose_mode = false
+
+[tool.testdoc.metadata]
+Author = "Your-Name"
+Version = "1.0.0"
+Source = "AnySourceAsMetaData"
+
+[tool.testdoc.colors]
+# Use predefined theme:
+default = "blue"
+# or custom colors:
+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"

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/pyproject.toml

@@ -4,11 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "robotframework-testdoc"
-version = "0.1.7"
+version = "0.2.0"
 description = "A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts."
 readme = "README.md"
 requires-python = ">=3.7"
-authors = [{ name = "Marvin Klerx", email = "marvinklerx20@gmail.com" }]
+authors = [
+    { name = "Marvin Klerx", email = "marvinklerx20@gmail.com" }
+]
 license = { text = "MIT" }
 
 dependencies = [
@@ -21,8 +23,18 @@ dependencies = [
 [project.scripts]
 testdoc = "testdoc.cli:main"
 
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"testdoc" = [
+    "html/images/*.svg",
+    "html/templates/**/*.html",
+    "default.toml"
+]
+
 [tool.ruff]
 line-length = 150
 lint.select = ["E", "F"]  # Pyflakes & pycodestyle
 lint.ignore = ["E722"]
-exclude = ["build", "dist"]
+exclude = ["build", "dist"]

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/src/robotframework_testdoc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.1.7
+Version: 0.2.0
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: MIT
@@ -15,6 +15,12 @@ Dynamic: license-file
 
 # Robot Framework TestDoc
 
+## Statistics
+
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+
 ## Installation
 
 Install the tool using the following command:
@@ -98,6 +104,37 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+## HTML Template Selection
+
+You can choose between multiple HTML template for the design of your test documentation.    
+These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
+
+### Default Design
+
+- v2
+
+### Available HTML Templates
+
+You can choose one of the following designs:
+- v1
+- v2
+
+### Version 1
+
+#### Visit Tests
+
+![alt text](docs/html_v1_common.png)
+
+### Version 2
+
+#### Visit Tests on Root Suite Level
+
+![alt text](docs/html_v2_root.png)
+
+#### Visit Tests on Suite File Level
+
+![alt text](docs/html_v2_suitefile.png)
+
 ## Theme Selection / Color Configuration
 
 You can select between several themes (color configurations) for your HTML document to create!

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/src/robotframework_testdoc.egg-info/SOURCES.txt

@@ -8,6 +8,10 @@ atest/test_cli.py
 atest/test_cli.robot
 atest/config/config_with_colors.toml
 atest/config/testdoc.toml
+atest/config_pyproject/example_pyproject.toml
+docs/html_v1_common.png
+docs/html_v2_root.png
+docs/html_v2_suitefile.png
 docs/style_blue.png
 docs/style_dark.png
 docs/style_robot.png
@@ -26,8 +30,11 @@ src/testdoc/helper/cliargs.py
 src/testdoc/helper/datetimeconverter.py
 src/testdoc/helper/logger.py
 src/testdoc/helper/pathconverter.py
+src/testdoc/helper/toml_reader.py
 src/testdoc/html/images/robotframework.svg
-src/testdoc/html/templates/jinja_template_01.html
+src/testdoc/html/templates/v1/jinja_template_01.html
+src/testdoc/html/templates/v1/jinja_template_02.html
+src/testdoc/html/templates/v2/jinja_template_03.html
 src/testdoc/html/themes/__init__.py
 src/testdoc/html/themes/theme_config.py
 src/testdoc/html/themes/themes.py

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/src/testdoc/cli.py

@@ -4,7 +4,8 @@ import os
 from .testdoc import TestDoc
 from .helper.cliargs import CommandLineArguments
 
-@click.command()
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
+@click.command(context_settings=CONTEXT_SETTINGS)
 @click.option("-t","--title",       required=False, help="Modify the title of the test documentation page")
 @click.option("-n","--name",        required=False, help="Modify the name of the root suite element")
 @click.option("-d","--doc",         required=False, help="Modify the documentation of the root suite element")
@@ -20,8 +21,10 @@ from .helper.cliargs import CommandLineArguments
 @click.option("--hide-source",      is_flag=True, required=False, help="If given, test suite/ test case source is hidden")
 @click.option("--hide-keywords",    is_flag=True, required=False, help="If given, keyword calls in test cases are hidden")
 @click.option("-S", "--style", required=False, help="Choose a predefined default style theme - 'default', 'robot', 'dark' or 'blue' ")
+@click.option("-ht","--html-template", required=False, help="Select the HTML template - possible values: 'v1', 'v2'")
 @click.option("-c", "--configfile", required=False, help="Optional .toml configuration file (includes all cmd-args)")
 @click.option("-v", "--verbose",    is_flag=True, required=False, help="More precise debugging into shell")
+@click.version_option(package_name='robotframework-testdoc')
 @click.argument("PATH")
 @click.argument("OUTPUT")
 def main(
@@ -38,6 +41,7 @@ def main(
         hide_source,
         hide_keywords,
         style,
+        html_template,
         configfile,
         verbose,
         path,
@@ -47,14 +51,15 @@ def main(
     Welcome to robotframework-testdoc - the new test documentation generator for your Robot Framework tests!
     """
     color = "green"
-    click.echo(click.style("""
+    entrypoint_msg = """
 ████████╗███████╗███████╗████████╗██████╗ ███████╗███████╗
 ╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝██   ██╗██   ██║██╔════╝
    ██║   █████╗  ███████╗   ██║   ██   ██║██   ██║██║     
    ██║   ██╔══╝  ╚════██║   ██║   ██   ██║██   ██║██║       
    ██║   ███████╗███████║   ██║   ██████╔╝███████║███████╗
    ╚═╝   ╚══════╝╚══════╝   ╚═╝   ╚═════╝ ╚══════╝ ╚═════╝  
-      """, fg=color)
+      """
+    click.echo(click.style(entrypoint_msg, fg=color)
     )
 
     args_instance = CommandLineArguments()
@@ -80,6 +85,7 @@ def main(
         "hide_keywords": hide_keywords or None,
         "verbose_mode": verbose or None,
         "style": style or None,
+        "html_template": html_template or None,
         "config_file": configfile or None,
     }
     args.suite_file = path

robotframework_testdoc-0.2.0/src/testdoc/helper/cliargs.py

@@ -0,0 +1,83 @@
+from dataclasses import dataclass, field
+from typing import Any, List
+from .toml_reader import TOMLReader
+import os
+
+@dataclass
+class CommandLineArgumentsData:
+    title: str = "Robot Framework - Test Documentation"
+    name: str = None
+    doc: str = None
+    metadata: dict = None
+    sourceprefix: str = None
+    include: List[str] = field(default_factory=list)
+    exclude: List[str] = field(default_factory=list)
+    hide_tags: bool = False
+    hide_test_doc: bool = False
+    hide_suite_doc: bool = False
+    hide_source: bool = False
+    hide_keywords: bool = False
+    config_file: str = None
+    verbose_mode: bool = False
+    suite_file: str = None
+    style: str = None
+    html_template: str = "v2"
+    output_file: str = None
+    colors: dict = None
+
+class CommandLineArguments:
+    _instance = None
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+            
+            cls.data = CommandLineArgumentsData()
+        return cls._instance
+    
+    ###
+    ### Load configuration file
+    ###
+    def load_from_config_file(self, file_path: str):
+        config = TOMLReader()._read_toml(file_path)
+        _is_pyproject = self._is_pyproject_config(file_path)
+        if _is_pyproject:
+            self._handle_pyproject_config(config)
+        else:
+            self._handle_custom_config(config)
+
+    ###
+    ### Read pyproject.toml
+    ###
+    def _handle_pyproject_config(self, config: dict[str, Any]):
+        testdoc_config = config.get("tool", {}).get("testdoc", {})
+
+        if "colors" in testdoc_config:
+            self.data.colors = testdoc_config["colors"]
+
+        if "metadata" in testdoc_config:
+            if hasattr(self.data, "metadata"):
+                setattr(self.data, "metadata", testdoc_config["metadata"])
+
+        for key, value in testdoc_config.items():
+            if key in ("colors", "metadata"):
+                continue
+            if hasattr(self.data, key):
+                setattr(self.data, key, value)
+
+    ###
+    ### Read custom.toml
+    ###
+    def _handle_custom_config(self, config: dict[str, Any]):
+        if "colors" in config:
+            self.data.colors = config["colors"]
+
+        for key, value in config.items():
+            if hasattr(self.data, key):
+                setattr(self.data, key, value)
+
+    #####################################################################################
+
+    def _is_pyproject_config(self, file_path) -> bool:
+        return os.path.basename(file_path) == "pyproject.toml"
+    
+    #####################################################################################

{robotframework_testdoc-0.1.7 → robotframework_testdoc-0.2.0}/src/testdoc/helper/pathconverter.py

@@ -17,7 +17,7 @@ class PathConverter():
         # Convert path to suite file / directory
         suite_path = PathConverter().conv_generic_path(path=suite_path)
         if ".robot" in suite_path:
-            msg = f"Suite File: '{str(suite_path).split("/")[-1]}'"
+            msg = f'Suite File: "{str(suite_path).split("/")[-1]}"'
         else:
             msg = f"Suite Directory: '{suite_path}'"
 

robotframework_testdoc-0.2.0/src/testdoc/helper/toml_reader.py

@@ -0,0 +1,11 @@
+import tomli
+
+class TOMLReader():
+
+    def _read_toml(self, file_path:str):
+        try:
+            with open(file_path, "rb") as f:
+                config = tomli.load(f)
+                return config
+        except Exception as e:
+            raise ImportError(f"Cannot read toml file in: {file_path} with error: \n{e}")

{robotframework_testdoc-0.1.7/src/testdoc/html/templates → robotframework_testdoc-0.2.0/src/testdoc/html/templates/v1}/jinja_template_01.html

@@ -121,7 +121,9 @@
                                                 <tr>
                                                     <td style="width: 10%; font-weight: bold;">🏷 Tags:</td>
                                                     <td style="text-align: left;">
-                                                        {% if test.tags %}
+                                                        {% if test.tags and test.tags is string %}
+                                                            {{ test.tags }}
+                                                        {% else %}
                                                             {{ test.tags | join(', ') }}
                                                         {% endif %}
                                                     </td>
@@ -132,7 +134,7 @@
                                                     <td style="width: 10%; font-weight: bold; vertical-align: top;">🔑 Keywords:</td>
                                                     <td style="text-align: left;">
                                                         {% if test.keywords %}
-                                                            - {{ test.keywords | join('<br>- ') }}
+                                                            <pre>- {{ test.keywords | join('\n- ') }}</pre>
                                                         {% endif %}
                                                     </td>
                                                 </tr>

robotframework_testdoc-0.2.0/src/testdoc/html/templates/v1/jinja_template_02.html

@@ -0,0 +1,116 @@
+<!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>
+    <style>
+        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 }};
+        }
+        .sidebar {
+            min-width: 250px;
+            max-width: 250px;
+            background-color: {{ colors.inner_color }};
+            border-right: 1px solid {{ colors.border_color }};
+            height: 100vh;
+            overflow-y: auto;
+        }
+        .content {
+            padding: 20px;
+            flex-grow: 1;
+        }
+        .suite-item {
+            padding: 8px 16px;
+            cursor: pointer;
+        }
+        .suite-item:hover {
+            background-color: {{ colors.button_hover_color }};
+        }
+        .accordion-item, .accordion-body {
+            background-color: {{ colors.inner_color }};
+            border-color: {{ colors.border_color }};
+            color: {{ colors.text_color }};
+        }
+        .accordion-button {
+            background-color: {{ colors.inner_color }};
+            color: {{ colors.text_color }};
+        }
+        .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 }};
+        }
+        .generated_at {
+            color: {{ colors.title_color }};
+        }
+    </style>
+</head>
+<body class="d-flex flex-column min-vh-100">
+    <div class="d-flex flex-grow-1">
+        <div class="sidebar">
+            <h5 class="text-center mt-3">📁 Suites</h5>
+            <ul class="list-unstyled">
+                {% for suite in suites %}
+                    <li class="suite-item" onclick="showSuite('{{ loop.index0 }}')">{{ suite.name }}</li>
+                {% endfor %}
+            </ul>
+        </div>
+        <div class="content">
+            {% for suite in suites %}
+                <div id="suite-{{ loop.index0 }}" class="suite-view" style="display: {% if loop.first %}block{% else %}none{% endif %};">
+                    <h4>{{ suite.name }}</h4>
+                    {% if suite.doc %}<p><strong>📝 Docs:</strong> {{ suite.doc }}</p>{% endif %}
+                    {% if suite.source %}<p><strong>🔗 Source:</strong> <a href="{{ suite.source }}" target="_blank">{{ suite.source }}</a></p>{% endif %}
+                    <p><strong>📊 Number of Tests:</strong> {{ suite.num_tests }}</p>
+
+                    {% for test in suite.tests %}
+                        <div class="accordion mb-3">
+                            <div class="accordion-item">
+                                <h2 class="accordion-header">
+                                    <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#test-{{ loop.index0 }}-{{ loop.index }}">
+                                        🔍 {{ test.name }}
+                                    </button>
+                                </h2>
+                                <div id="test-{{ loop.index0 }}-{{ loop.index }}" class="accordion-collapse collapse">
+                                    <div class="accordion-body">
+                                        {% if test.doc %}<p><strong>📝 Docs:</strong><br>{{ test.doc }}</p>{% endif %}
+                                        {% if test.source %}<p><strong>🔗 Source:</strong> <a href="{{ test.source }}" target="_blank">{{ test.source }}</a></p>{% endif %}
+                                        {% if test.tags %}<p><strong>🏷 Tags:</strong> {{ test.tags | join(', ') }}</p>{% endif %}
+                                        {% if test.keywords %}<p><strong>🔑 Keywords:</strong><br>- {{ test.keywords | join('<br>- ') }}</p>{% endif %}
+                                    </div>
+                                </div>
+                            </div>
+                        </div>
+                    {% endfor %}
+                </div>
+            {% endfor %}
+        </div>
+    </div>
+    <p class="text-center generated_at py-1 border-top">
+        Generated at: {{ generated_at }}<br>robotframework-testdoc by Marvin Klerx
+    </p>
+    <script>
+        function showSuite(index) {
+            const views = document.querySelectorAll('.suite-view');
+            views.forEach(view => view.style.display = 'none');
+            document.getElementById('suite-' + index).style.display = 'block';
+        }
+    </script>
+</body>
+</html>