robotframework-testdoc 0.2.4__tar.gz → 0.2.7__tar.gz

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.4
+Version: 0.2.7
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: Apache-2.0
@@ -118,6 +118,51 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+### pyproject.toml vs. custom toml file
+
+Using the ``pyproject`` requires to define the ``testdoc`` sections with the prefix ``tool.``   
+Example section start: ``[tool.testdoc]``
+
+Using your own custom toml-file, does not require you to use the prefix. Here, you can just use ``[testdoc]`` as section header.
+
+
+### Example Configuration File
+```toml
+[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
+# Use 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"
+```
+
 ## HTML Template Selection
 
 You can choose between multiple HTML template for the design of your test documentation.    
@@ -165,15 +210,21 @@ Therefore, please use the following syntax: for the toml file
 # Use the default theme
 default = "default"
 default = 0
-# Use the default theme
+# Use the dark theme
 default = "dark"
 default = 1
-# Use the default theme
+# Use the blue theme
 default = "blue"
 default = 2
-# Use the default theme
+# Use the robot theme
 default = "robot"
 default = 3
+# Use the dark robot theme
+default = "robot_dark"
+default = 4
+# Use the green theme
+default = "green"
+default = 5
 ```
 
 For setting it via CLI, please use the following:

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/README.md

@@ -95,6 +95,51 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+### pyproject.toml vs. custom toml file
+
+Using the ``pyproject`` requires to define the ``testdoc`` sections with the prefix ``tool.``   
+Example section start: ``[tool.testdoc]``
+
+Using your own custom toml-file, does not require you to use the prefix. Here, you can just use ``[testdoc]`` as section header.
+
+
+### Example Configuration File
+```toml
+[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
+# Use 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"
+```
+
 ## HTML Template Selection
 
 You can choose between multiple HTML template for the design of your test documentation.    
@@ -142,15 +187,21 @@ Therefore, please use the following syntax: for the toml file
 # Use the default theme
 default = "default"
 default = 0
-# Use the default theme
+# Use the dark theme
 default = "dark"
 default = 1
-# Use the default theme
+# Use the blue theme
 default = "blue"
 default = 2
-# Use the default theme
+# Use the robot theme
 default = "robot"
 default = 3
+# Use the dark robot theme
+default = "robot_dark"
+default = 4
+# Use the green theme
+default = "green"
+default = 5
 ```
 
 For setting it via CLI, please use the following:

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/atest/test_cli.py

@@ -30,5 +30,5 @@ def test_cli_cmd_verbose():
     assert result.exit_code == 0
     assert "Generated" in result.output
     assert "output.html" in result.output
-    assert "test_cli.robot" in result.output
+    assert "Saving" in result.output
     assert os.path.exists(output)

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "robotframework-testdoc"
-version = "0.2.4"
+version = "0.2.7"
 description = "A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts."
 readme = "README.md"
 requires-python = ">=3.7"

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/robotframework_testdoc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.4
+Version: 0.2.7
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: Apache-2.0
@@ -118,6 +118,51 @@ For using this config file, just call the following command:
 testdoc -c path/to/config.toml tests/ TestDocumentation.html
 ```
 
+### pyproject.toml vs. custom toml file
+
+Using the ``pyproject`` requires to define the ``testdoc`` sections with the prefix ``tool.``   
+Example section start: ``[tool.testdoc]``
+
+Using your own custom toml-file, does not require you to use the prefix. Here, you can just use ``[testdoc]`` as section header.
+
+
+### Example Configuration File
+```toml
+[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
+# Use 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"
+```
+
 ## HTML Template Selection
 
 You can choose between multiple HTML template for the design of your test documentation.    
@@ -165,15 +210,21 @@ Therefore, please use the following syntax: for the toml file
 # Use the default theme
 default = "default"
 default = 0
-# Use the default theme
+# Use the dark theme
 default = "dark"
 default = 1
-# Use the default theme
+# Use the blue theme
 default = "blue"
 default = 2
-# Use the default theme
+# Use the robot theme
 default = "robot"
 default = 3
+# Use the dark robot theme
+default = "robot_dark"
+default = 4
+# Use the green theme
+default = "green"
+default = 5
 ```
 
 For setting it via CLI, please use the following:

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/robotframework_testdoc.egg-info/SOURCES.txt

@@ -32,13 +32,13 @@ 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/rendering/render.py
 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
-src/testdoc/html_rendering/render.py
 src/testdoc/parser/testcaseparser.py
 src/testdoc/parser/testsuiteparser.py
 src/testdoc/parser/modifier/sourceprefixmodifier.py

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/cli.py

@@ -1,5 +1,4 @@
 import click
-import os
 
 from .testdoc import TestDoc
 from .helper.cliargs import CommandLineArguments
@@ -47,8 +46,12 @@ def main(
         path,
         output,
     ):
-    """
-    Welcome to robotframework-testdoc - the new test documentation generator for your Robot Framework tests!
+    """Welcome to robotframework-testdoc - the new test documentation generator for your Robot Framework tests!
+
+# Basic Usage:
+$ testdoc tests/ TestDocumentation.html
+
+See more in the README.md of the GitHub Project: https://github.com/MarvKler/robotframework-testdoc/blob/main/README.md
     """
     color = "green"
     entrypoint_msg = """
@@ -62,38 +65,36 @@ def main(
     click.echo(click.style(entrypoint_msg, fg=color)
     )
 
-    args_instance = CommandLineArguments()
-    if configfile:
-        if os.path.exists(configfile):
-            args_instance.load_from_config_file(configfile)
-        else:
-            click.echo(click.style(f"⚠️ Config File not found: {configfile}", fg="yellow"))
+    args_to_set = dict(
+        title=title,
+        name=name,
+        doc=doc,
+        metadata=dict(item.split("=", 1) for item in metadata) if metadata else None,
+        sourceprefix=sourceprefix,
+        include=list(include),
+        exclude=list(exclude),
+        hide_tags=hide_tags,
+        hide_test_doc=hide_test_doc,
+        hide_suite_doc=hide_suite_doc,
+        hide_source=hide_source,
+        hide_keywords=hide_keywords,
+        style=style,
+        html_template=html_template,
+        config_file=configfile,
+        verbose_mode=verbose,
+        suite_file=list(path),
+        output_file=output,
+    )
+
+    # Expose CLI args
+    args_to_set = {k: v for k, v in args_to_set.items() if v is not None}
+    CommandLineArguments().set_args(**args_to_set)
 
-    args = args_instance.data
-    cli_params = {
-        "title": title or None,
-        "name": name or None,
-        "doc": doc or None,
-        "metadata": dict(item.split("=", 1) for item in metadata) if metadata else None,
-        "sourceprefix": sourceprefix,
-        "include": list(include) if include else None,
-        "exclude": list(exclude) if exclude else None,
-        "hide_tags": hide_tags or None,
-        "hide_test_doc": hide_test_doc or None,
-        "hide_suite_doc": hide_suite_doc or None,
-        "hide_source": hide_source or None,
-        "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
-    args.output_file = output
+    # Read & expose TOML args
+    if configfile:
+        from .helper.toml_reader import TOMLReader
+        TOMLReader().load_from_config_file(configfile)
 
-    for key, value in cli_params.items():
-        if value is not None:
-            setattr(args, key, value)    
     TestDoc().main()
 
 if __name__ == "__main__":

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/default.toml

@@ -1,3 +1,3 @@
 # Find here some default settings like the used default theme
 [default]
-theme = "dark"
+theme = "robot_dark"

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

@@ -0,0 +1,100 @@
+class CommandLineArguments:
+    _instance = None
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+            cls._instance._args = {}
+        return cls._instance
+
+    def update_args_if_not_set(self, **kwargs):
+        for key, value in kwargs.items():
+            if key not in self._args:
+                self._args[key] = value
+    
+    def set_args(self, **kwargs):
+        self._args = kwargs
+
+    def __getattr__(self, name):
+        if name in self._args:
+            return self._args[name]
+        raise AttributeError(f"'CommandLineArguments' object has no attribute '{name}'")
+    
+    @property
+    def title(self):
+        return self._args.get("title", "Robot Framework - Test Documentation")
+    
+    @property
+    def name(self):
+        return self._args.get("name", None)
+    
+    @property
+    def doc(self):
+        return self._args.get("doc", None)
+    
+    @property
+    def metadata(self):
+        return self._args.get("metadata", None)
+    
+    @property
+    def sourceprefix(self):
+        return self._args.get("sourceprefix", None)
+    
+    @property
+    def include(self):
+        return self._args.get("include", [])
+    
+    @property
+    def exclude(self):
+        return self._args.get("exclude", [])
+    
+    @property
+    def hide_tags(self):
+        return self._args.get("hide_tags", False)
+    
+    @property
+    def hide_test_doc(self):
+        return self._args.get("hide_test_doc", False)
+    
+    @property
+    def hide_suite_doc(self):
+        return self._args.get("hide_suite_doc", False)
+    
+    @property
+    def hide_source(self):
+        return self._args.get("hide_source", False)
+    
+    @property
+    def hide_keywords(self):
+        return self._args.get("hide_keywords", False)
+    
+    @property
+    def config_file(self):
+        return self._args.get("config_file", None)
+    
+    @property
+    def verbose_mode(self):
+        return self._args.get("verbose_mode", False)
+    
+    @property
+    def suite_file(self):
+        return self._args.get("suite_file", None)
+    
+    @property
+    def style(self):
+        return self._args.get("style", None)
+    
+    @property
+    def html_template(self):
+        return self._args.get("html_template", "v2")
+    
+    @property
+    def output_file(self):
+        return self._args.get("output_file", None)
+    
+    @property
+    def colors(self):
+        return self._args.get("colors", None)
+    
+    @property
+    def all_as_dict(self):
+        return self._args

robotframework_testdoc-0.2.7/src/testdoc/helper/pathconverter.py

@@ -0,0 +1,30 @@
+import os
+
+from .cliargs import CommandLineArguments
+from .logger import Logger
+
+class PathConverter():
+
+    def __init__(self):
+        self.args = CommandLineArguments()
+
+    def path_convertion(self) -> str:
+        output_path = self.args.output_file
+        output_path = PathConverter().conv_generic_path(path=output_path)
+        
+        # Print to console
+        if self.args.verbose_mode:
+            Logger().LogKeyValue("Saving to output file: ", output_path)
+        return output_path
+
+    def conv_generic_path(self,
+            path: str
+        ) -> str:
+        """
+        Generate OS independent path.
+        """
+        abs_path = os.path.abspath(path)
+        generic_path = os.path.normpath(abs_path)
+        if os.name == "nt":
+            generic_path = generic_path.replace("\\", "/")
+        return generic_path

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

@@ -0,0 +1,50 @@
+from .cliargs import CommandLineArguments
+
+import tomli
+import os
+
+class TOMLReader():
+
+    ###
+    ### Generic function to read toml files
+    ###
+    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}")
+        
+    
+    ###
+    ### Functions to handle TOML files with configuration for testdoc tool
+    ###
+    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)
+
+    def _handle_pyproject_config(self, config: dict):
+        testdoc_config = config.get("tool", {}).get("testdoc", {})
+        self._apply_config_to_cliargs(testdoc_config)
+
+    def _handle_custom_config(self, config: dict):
+        self._apply_config_to_cliargs(config)
+
+    def _apply_config_to_cliargs(self, config: dict):
+        args_to_set = {}
+
+        for key, value in config.items():
+            if isinstance(value, tuple):
+                value = list(value)
+            args_to_set[key] = value
+
+        CommandLineArguments().update_args_if_not_set(**args_to_set)
+
+    def _is_pyproject_config(self, file_path) -> bool:
+        return os.path.basename(file_path) == "pyproject.toml"

{robotframework_testdoc-0.2.4/src/testdoc/html_rendering → robotframework_testdoc-0.2.7/src/testdoc/html/rendering}/render.py

@@ -1,15 +1,15 @@
 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
+from ...html.themes.theme_config import ThemeConfig
+from ...helper.cliargs import CommandLineArguments
+from ...helper.datetimeconverter import DateTimeConverter
+from ...helper.logger import Logger
 
 class TestDocHtmlRendering():
 
     def __init__(self):
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
         self._html_templ_selection()
 
     def _html_templ_selection(self):
@@ -17,11 +17,11 @@ class TestDocHtmlRendering():
         if self.args.html_template == "v1":
             self.HTML_TEMPLATE_VERSION = self.args.html_template
             self.HTML_TEMPLATE_NAME = "jinja_template_01.html"
-            self.TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "html", "templates", self.HTML_TEMPLATE_VERSION)
+            self.TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "templates", self.HTML_TEMPLATE_VERSION)
         elif self.args.html_template == "v2":
             self.HTML_TEMPLATE_VERSION = self.args.html_template
             self.HTML_TEMPLATE_NAME = "jinja_template_03.html"
-            self.TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "html", "templates", self.HTML_TEMPLATE_VERSION)
+            self.TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "templates", self.HTML_TEMPLATE_VERSION)
         else:
             raise ValueError(f"CLI Argument 'html_template' got value '{self.args.html_template}' - value not known!")         
 

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/html/templates/v2/jinja_template_03.html

@@ -77,11 +77,7 @@
                                 <tr>
                                     <td style="width: 10%; font-weight: bold;">🏷 Tags:</td>
                                     <td style="text-align: left;">
-                                        {% if test.tags and test.tags is string %}
-                                            {{ test.tags }}
-                                        {% else %}
-                                            {{ test.tags | join(', ') }}
-                                        {% endif %}
+                                        {{ test.tags | join(', ') }}
                                     </td>
                                 </tr>
                             {% endif %}

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/html/themes/theme_config.py

@@ -1,5 +1,5 @@
 from ...helper.cliargs import CommandLineArguments
-from .themes import DEFAULT_THEME, ROBOT_THEME, DARK_THEME, BLUE_THEME
+from .themes import DEFAULT_THEME, ROBOT_THEME, DARK_THEME, BLUE_THEME, ROBOT_THEME_DARK, GREEN_THEME
 
 import os
 import tomli
@@ -9,7 +9,7 @@ class ThemeConfig():
     default_config = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "..", "default.toml")
     
     def __init__(self):
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
         with open(self.default_config, "rb") as file:
             self.config = tomli.load(file)
 
@@ -38,4 +38,8 @@ class ThemeConfig():
             return ROBOT_THEME
         if theme == "blue" or theme == 3:
             return BLUE_THEME
+        if theme == "robot_dark" or theme == 4:
+            return ROBOT_THEME_DARK
+        if theme == "green" or theme == 5:
+            return GREEN_THEME
         

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/html/themes/themes.py

@@ -13,14 +13,36 @@ DEFAULT_THEME = {
 ROBOT_THEME = {
     "background": "#f8f9fa",
     "inner_color": "#f8f9fa",
-    "button_active_color": "#C2C2C2",
-    "button_hover_color": "#C2C2C2",
+    "button_active_color": "#dcdcdc",
+    "button_hover_color": "#dcdcdc",
     "border_color": "black",
     "text_color": "black",
     "title_color": "black",
     "robot_icon": "#00c0b5",
 }
 
+ROBOT_THEME_DARK = {
+    "background": "#1b1b1d",
+    "inner_color": "#1b1b1d",
+    "button_active_color": "#272729",
+    "button_hover_color": "#5F5F5F",
+    "border_color": "#e3e3e3",
+    "text_color": "#e3e3e3",
+    "title_color": "#e3e3e3",
+    "robot_icon": "#00c0b5",
+}
+
+GREEN_THEME = {
+    "background": "#1e1e1e",
+    "inner_color": "#1e1e1e",
+    "button_active_color": "#272729",
+    "button_hover_color": "#5F5F5F",
+    "border_color": "#e3e3e3",
+    "text_color": "#009770",
+    "title_color": "#009770",
+    "robot_icon": "#009770",
+}
+
 DARK_THEME = {    
     "background": "#303030",
     "inner_color": "#303030",

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/parser/modifier/sourceprefixmodifier.py

@@ -39,7 +39,7 @@ class SourcePrefixModifier():
     GITLAB_CONNECTOR = "-/blob/main/"
     
     def __init__(self):
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
 
     def _prefix_validation(self, prefix: str) -> list:
         if "::" not in prefix:
@@ -85,7 +85,7 @@ class GitLabModifier():
         git_root = self._get_git_root(file_path)
         git_branch = self._get_git_branch(git_root)
         if not git_root:
-            return "GitLink error"
+            return "Unable to fetch GitLab URL!"
         rel_path = os.path.relpath(file_path, git_root).replace(os.sep, "/")
         return prefix.rstrip("/") + "/-/blob/" + git_branch + "/" + rel_path
 

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/parser/modifier/suitefilemodifier.py

@@ -7,7 +7,7 @@ from .sourceprefixmodifier import SourcePrefixModifier
 class SuiteFileModifier():
     
     def __init__(self):
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
         self.suite = None
         
     #############################################################################################################################

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/parser/testcaseparser.py

@@ -7,7 +7,7 @@ import textwrap
 class TestCaseParser():
 
     def __init__(self):
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
 
     def parse_test(self,
             suite: TestSuite,
@@ -19,7 +19,7 @@ class TestCaseParser():
                 "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",
+                "tags": test.tags if test.tags else ["No Tags Configured"],
                 "source": str(test.source),
                 "keywords": self._keyword_parser(test.body)
             }
@@ -47,7 +47,7 @@ class TestCaseParser():
 
         # Fallback in case of no keywords
         if len(_keyword_object) == 0:
-            return "No Keyword Calls in Test"
+            return ["No Keyword Calls in Test"]
         return _keyword_object
         
     def _handle_keyword_types(self, kw: Keyword, indent: int = 0):
@@ -105,6 +105,19 @@ class TestCaseParser():
                     result.extend(self._handle_keyword_types(subkw, indent=indent+1))
             result.append(f"{_indent}END")
 
+        # GROUP loop
+        elif kw_type == "GROUP":
+            header = f"{_indent}GROUP"
+            if not kw.name == "":
+                header += f"{_sd}{kw.name}"
+            if hasattr(kw, 'condition') and kw.condition:
+                header += f"    {kw.condition}"
+            result.append(header)
+            if hasattr(kw, 'body'):
+                for subkw in kw.body:
+                    result.extend(self._handle_keyword_types(subkw, indent=indent+1))
+            result.append(f"{_indent}END")
+
         # WHILE loop
         elif kw_type == "WHILE":
             header = f"{_indent}WHILE"
@@ -134,13 +147,9 @@ class TestCaseParser():
         elif kw_type in ("BREAK", "CONTINUE", "RETURN", "ERROR"):
             entry = f"{_indent}{kw_type}"
             if hasattr(kw, 'values') and kw.values:
-                entry += f"    {'    '.join(kw.values)}"
+                entry += f"    {_sd.join(kw.values)}"
             result.append(entry)
 
-        # Other types
-        elif kw_type in ("COMMENT", "EMPTY"):
-            pass
-
         # Unknown types
         elif hasattr(kw, 'body'):
             for subkw in kw.body:

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/parser/testsuiteparser.py

@@ -21,7 +21,7 @@ class RobotSuiteParser(SuiteVisitor):
         self.suite_counter = 0
         self.suites = []
         self.tests = []
-        self.args = CommandLineArguments().data
+        self.args = CommandLineArguments()
 
     def visit_suite(self, suite):
         
@@ -95,13 +95,6 @@ class RobotSuiteParser(SuiteVisitor):
         _include = self.args.include
         _exclude = self.args.exclude
         _source = self.args.suite_file
-        # Type Conversions
-        if type(_include) is not list:
-            _include = list(_include)
-        if type(_exclude) is not list:
-            _exclude = list(_exclude)
-        if type(_source) is not list:
-            _source = list(_source)
 
         # Format / Syntax Conversions
         robot_options = []

{robotframework_testdoc-0.2.4 → robotframework_testdoc-0.2.7}/src/testdoc/testdoc.py

@@ -1,14 +1,11 @@
 from .helper.pathconverter import PathConverter
 from .parser.testsuiteparser import RobotSuiteParser
-from .html_rendering.render import TestDocHtmlRendering
+from .html.rendering.render import TestDocHtmlRendering
 from .parser.modifier.suitefilemodifier import SuiteFileModifier
 
 class TestDoc():
     
-    def main(self):
-        # Convert to correct pathes
-        suite_path, output_path, config_path = PathConverter().path_convertion()
-        
+    def main(self):        
         # Parse suite object & return complete suite object with all information
         suite_object = RobotSuiteParser().parse_suite()
         
@@ -16,4 +13,4 @@ class TestDoc():
         suite_object = SuiteFileModifier().run(suite_object)
 
         # Render HTML file
-        TestDocHtmlRendering().render_testdoc(suite_object, output_path)
+        TestDocHtmlRendering().render_testdoc(suite_object, PathConverter().path_convertion())

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

@@ -1,83 +0,0 @@
-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.2.4/src/testdoc/helper/pathconverter.py

@@ -1,62 +0,0 @@
-import os
-
-from .cliargs import CommandLineArguments
-from .logger import Logger
-
-class PathConverter():
-
-    def __init__(self):
-        self.args = CommandLineArguments().data
-
-    def path_convertion(self) -> str:
-        
-        suite_path = self.args.suite_file
-        output_path = self.args.output_file
-        config_path = self.args.config_file
-
-        # Convert path to suite file / directory
-        if type(suite_path) is tuple:
-            suite_path = list(suite_path)
-            for idx, item in enumerate(suite_path):
-                _mod = PathConverter().conv_generic_path(item)
-                suite_path[idx] = _mod
-        else:
-            suite_path = PathConverter().conv_generic_path(path=suite_path)
-
-        # Convert path to output file
-        output_path = PathConverter().conv_generic_path(path=output_path)
-
-        # Convert path to config file
-        if self.args.config_file:
-            config_path = PathConverter().conv_generic_path(path=config_path)
-
-        # Print to console
-        if self.args.verbose_mode:
-            msg = ""
-            if type(suite_path) is not list:
-                suite_path = list(suite_path)
-
-            for item in suite_path:
-                if ".robot" in suite_path:
-                    msg += f'Suite File: "{str(suite_path).split("/")[-1]}"\n'
-                else:
-                    msg += f"Suite Directory: '{suite_path}'\n"
-
-            Logger().Log("=== TestDoc  ===")
-            Logger().LogKeyValue("Generating Test Documentation for: ", msg)
-            Logger().LogKeyValue("Saving to output file: ", output_path)
-            Logger().LogKeyValue("Using config file: ", config_path) if config_path else None
-
-        return suite_path, output_path, config_path
-
-    def conv_generic_path(self,
-            path: str
-        ) -> str:
-        """
-        Generate OS independent path.
-        """
-        abs_path = os.path.abspath(path)
-        generic_path = os.path.normpath(abs_path)
-        if os.name == "nt":
-            generic_path = generic_path.replace("\\", "/")
-        return generic_path

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

@@ -1,11 +0,0 @@
-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}")