robotframework-testdoc 0.1.5__py3-none-any.whl → 0.1.8__py3-none-any.whl

{robotframework_testdoc-0.1.5.dist-info → robotframework_testdoc-0.1.8.dist-info}/METADATA

@@ -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.dist-info → robotframework_testdoc-0.1.8.dist-info}/RECORD

@@ -1,10 +1,10 @@
-robotframework_testdoc-0.1.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_testdoc-0.1.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
 testdoc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 testdoc/__main__.py,sha256=09c4nsw4Vnp1LaK0CnlofJQFbKmeFexOXyTBDY9NrFk,67
-testdoc/cli.py,sha256=WyiuX9ONHMeeXAxXrF3XjR8Pal_WFg04dGVON7msrLc,4623
+testdoc/cli.py,sha256=bh_Fh78v5K8ajmSHazI6HGEJ3-pJyZOvcGm1SznU0jA,4659
 testdoc/default.toml,sha256=PK7O2gat8326ZYOXBC1mt6-5ceBhdbgs0BL1uo4XLjQ,87
 testdoc/testdoc.py,sha256=cVJguXoFhkCM2nkUlZGB8m-6rBhKwthFFtdtz0T2l4Q,772
-testdoc/helper/cliargs.py,sha256=eT7-1WGhHXbVSdC4LetkQQmhrhuISF35V3Aody-ymEk,1285
+testdoc/helper/cliargs.py,sha256=EtGqiUDKeMBkGZUSjtyFrPBjeOt5BnHazB5MlvfW8uk,2599
 testdoc/helper/datetimeconverter.py,sha256=1IuJ_rZlKKut3pallS9WSdlQ00YNQX2Nhf2oYWt7QDc,159
 testdoc/helper/logger.py,sha256=STPEEdMIGpK004xHDskj8zzW3knBWP05GllYajQMaSY,272
 testdoc/helper/pathconverter.py,sha256=Il4SX8EdpKPjOiZt97zC4TBLxp2tKUhfyyS2J1qWpyg,1656
@@ -14,12 +14,12 @@ testdoc/html/themes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 testdoc/html/themes/theme_config.py,sha256=3AFUSoddhAZswcEsshbvqcnmbLOFaBYUFy-lrfNBV3Q,1495
 testdoc/html/themes/themes.py,sha256=6xlHW7O-XO9Z1B33_aRwzffkuWR65jM7CYXsZWUjdmY,1091
 testdoc/html_rendering/render.py,sha256=BzPGyePwjCFZAXRHDF-ccM2xRKY-6Cnym1-uDb9i1AQ,1083
-testdoc/parser/testcaseparser.py,sha256=69WGA2aM2NsC1mU8PVGXfW23TEoYhJDjEfsyNwW2AoM,1243
+testdoc/parser/testcaseparser.py,sha256=tCRj_OH6DkdB_2Np2kvRVSpTHWdFh46IIip2AiFb0HA,1382
 testdoc/parser/testsuiteparser.py,sha256=eqFMaEa2aXYCkoAl8wLmA7NsPOx8oxY8KfTKVxyGIPU,2595
 testdoc/parser/modifier/sourceprefixmodifier.py,sha256=Vy_keEKztF7UrjtWjmkU7usGR7E-xLvxJOWocPRu6KI,3950
 testdoc/parser/modifier/suitefilemodifier.py,sha256=OuDuleQj4dRjUcu0AROEPZ-2vR3lWJfWmQVuoWLkXuY,4865
-robotframework_testdoc-0.1.5.dist-info/METADATA,sha256=xzo1mMtpPf_-pQ8nU4cZ5bB1vcBcwf8AStjqwN7ABpE,4970
-robotframework_testdoc-0.1.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-robotframework_testdoc-0.1.5.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
-robotframework_testdoc-0.1.5.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
-robotframework_testdoc-0.1.5.dist-info/RECORD,,
+robotframework_testdoc-0.1.8.dist-info/METADATA,sha256=ktSWzaMXgU0CRYK_M57Gqh--dNOOyP1k47ZwAPWCVVU,4971
+robotframework_testdoc-0.1.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+robotframework_testdoc-0.1.8.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
+robotframework_testdoc-0.1.8.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
+robotframework_testdoc-0.1.8.dist-info/RECORD,,

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()

testdoc/helper/cliargs.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass, field
-from typing import List
+from typing import Any, List
 import tomli
+import os
 
 @dataclass
 class CommandLineArgumentsData:
@@ -32,13 +33,52 @@ class CommandLineArguments:
             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)
+                setattr(self.data, key, value)
+
+    #####################################################################################
+
+    def _is_pyproject_config(self, file_path) -> bool:
+        return os.path.basename(file_path) == "pyproject.toml"
+    
+    #####################################################################################

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)