robotframework-testdoc 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

{robotframework_testdoc-0.2.4.dist-info → robotframework_testdoc-0.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.4
+Version: 0.2.6
 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

{robotframework_testdoc-0.2.4.dist-info → robotframework_testdoc-0.2.6.dist-info}/RECORD

@@ -1,28 +1,28 @@
-robotframework_testdoc-0.2.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_testdoc-0.2.6.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=el9eqTr4MjxF91XancigF6U7nJ5ffSXw7Wnhna3OkW0,5027
 testdoc/default.toml,sha256=PK7O2gat8326ZYOXBC1mt6-5ceBhdbgs0BL1uo4XLjQ,87
-testdoc/testdoc.py,sha256=tOombA0ozz-Z0AwjWiqQRSZEQsQlauAx2Ur4TFGhSZ4,762
+testdoc/testdoc.py,sha256=WpghXZ_frebqJ0BkP_5EM34bVfyLTaCr1z-lYbitS08,762
 testdoc/helper/cliargs.py,sha256=nsgxXho8QAtcxF5B0OCriLuUEByGQwagDkvR7ISAGWA,2627
 testdoc/helper/datetimeconverter.py,sha256=1IuJ_rZlKKut3pallS9WSdlQ00YNQX2Nhf2oYWt7QDc,159
 testdoc/helper/logger.py,sha256=STPEEdMIGpK004xHDskj8zzW3knBWP05GllYajQMaSY,272
 testdoc/helper/pathconverter.py,sha256=iY7VBofJxiQHevlLO_kek80mwmaB9gdnHWmUzHowCqk,2096
 testdoc/helper/toml_reader.py,sha256=JUpCdUQAwS-zImH0fU9leziM8Mc9CXAAHFUs6E0eQRA,323
 testdoc/html/images/robotframework.svg,sha256=w1yNL6XtuHOCCwzjGX3pZQG7ZcJghzllvc7cQ9MKKbQ,1426
+testdoc/html/rendering/render.py,sha256=Q_zDQHPrr00tHlzEGdDuHV66jljbSFBIn3XuLgJKdPw,1957
 testdoc/html/templates/v1/jinja_template_01.html,sha256=H0CVKV3HljrdQeT_4hWJq3xNw6kc5vqiJtzCXoWBtdY,18389
 testdoc/html/templates/v1/jinja_template_02.html,sha256=0CFAqCHQ035hsHgxZsirHgsdZO5-jdUH9SUQmy3EHkg,5152
-testdoc/html/templates/v2/jinja_template_03.html,sha256=gpQj8Fso-7sdQmC6rL_ym29CVf5fQXL0l0FoT7unS7c,16136
+testdoc/html/templates/v2/jinja_template_03.html,sha256=r0PJIgDp8oATZBp2hHD30djGZRMpSJA9GKuXa0HkCFc,15886
 testdoc/html/themes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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=Ij6Jtut7oUCM-z_FIz04A0showacIAIqbkArBg7I2u8,1969
-testdoc/parser/testcaseparser.py,sha256=CXZRS1mvHx1O6G2FgqF8T_dWp1RcSJbeN7Le0ZInows,6405
+testdoc/parser/testcaseparser.py,sha256=tfaBfcz2t8Iiu558oDNCGQjQuWphbJTJlsInCTTTgFU,6835
 testdoc/parser/testsuiteparser.py,sha256=7-t_Kdw6527x_bQ_IWJgrvUnGC2umK9mjjJToWVWC_k,6020
-testdoc/parser/modifier/sourceprefixmodifier.py,sha256=Vy_keEKztF7UrjtWjmkU7usGR7E-xLvxJOWocPRu6KI,3950
+testdoc/parser/modifier/sourceprefixmodifier.py,sha256=uJTuF3KxtDt4m4nqJ9yF6NzdsjXUZGhRYsP9y9hqQ5k,3964
 testdoc/parser/modifier/suitefilemodifier.py,sha256=OuDuleQj4dRjUcu0AROEPZ-2vR3lWJfWmQVuoWLkXuY,4865
-robotframework_testdoc-0.2.4.dist-info/METADATA,sha256=WgiWRg8dvdknyZwbEZjylKf-RwbC1uk8Ooqyhj8XzPE,6947
-robotframework_testdoc-0.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-robotframework_testdoc-0.2.4.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
-robotframework_testdoc-0.2.4.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
-robotframework_testdoc-0.2.4.dist-info/RECORD,,
+robotframework_testdoc-0.2.6.dist-info/METADATA,sha256=HJPzhuHpUoO2EWXPhaxBnU1aKlyz_xXOffhZXcgj14A,6947
+robotframework_testdoc-0.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+robotframework_testdoc-0.2.6.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
+robotframework_testdoc-0.2.6.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
+robotframework_testdoc-0.2.6.dist-info/RECORD,,

testdoc/{html_rendering → html/rendering}/render.py

@@ -1,10 +1,10 @@
 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():
 
@@ -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!")         
 

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 %}

testdoc/parser/modifier/sourceprefixmodifier.py

@@ -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
 

testdoc/parser/testcaseparser.py

@@ -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:

testdoc/testdoc.py

@@ -1,6 +1,6 @@
 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():