robotframework-testdoc 0.1.5__tar.gz → 0.1.8__tar.gz

{robotframework_testdoc-0.1.5 → robotframework_testdoc-0.1.8}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.1.5
+Version: 0.1.8
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
-Author-email: Marvin Klerx <marvinklerx1@gmail.com>
+Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: MIT
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

robotframework_testdoc-0.1.8/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.5 → robotframework_testdoc-0.1.8}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "robotframework-testdoc"
-version = "0.1.5"
+version = "0.1.8"
 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 = "marvinklerx1@gmail.com" }]
+authors = [{ name = "Marvin Klerx", email = "marvinklerx20@gmail.com" }]
 license = { text = "MIT" }
 
 dependencies = [
@@ -25,4 +25,4 @@ testdoc = "testdoc.cli:main"
 line-length = 150
 lint.select = ["E", "F"]  # Pyflakes & pycodestyle
 lint.ignore = ["E722"]
-exclude = ["build", "dist"]
+exclude = ["build", "dist"]

{robotframework_testdoc-0.1.5 → robotframework_testdoc-0.1.8}/src/robotframework_testdoc.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.1.5
+Version: 0.1.8
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
-Author-email: Marvin Klerx <marvinklerx1@gmail.com>
+Author-email: Marvin Klerx <marvinklerx20@gmail.com>
 License: MIT
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{robotframework_testdoc-0.1.5 → robotframework_testdoc-0.1.8}/src/robotframework_testdoc.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ 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/style_blue.png
 docs/style_dark.png
 docs/style_robot.png

{robotframework_testdoc-0.1.5 → robotframework_testdoc-0.1.8}/src/testdoc/cli.py

@@ -47,14 +47,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()

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

@@ -0,0 +1,84 @@
+from dataclasses import dataclass, field
+from typing import Any, List
+import tomli
+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
+    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):
+        with open(file_path, "rb") as f:
+            config = tomli.load(f)
+
+        _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.5 → robotframework_testdoc-0.1.8}/src/testdoc/parser/testcaseparser.py

@@ -1,4 +1,5 @@
 from robot.api import TestSuite
+from robot.errors import DataError
 from ..helper.cliargs import CommandLineArguments
 
 class TestCaseParser():
@@ -25,8 +26,11 @@ class TestCaseParser():
         
     # Consider tags via officially provided robot api
     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
+        try: 
+            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
+        except DataError as e:
+            raise DataError(e.message)

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

@@ -1,44 +0,0 @@
-from dataclasses import dataclass, field
-from typing import List
-import tomli
-
-@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
-    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
-    
-    def load_from_config_file(self, file_path: str):
-        with open(file_path, "rb") as f:
-            config = tomli.load(f)
-
-        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)