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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.3
+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.3.dist-info → robotframework_testdoc-0.2.6.dist-info}/RECORD

@@ -1,28 +1,28 @@
-robotframework_testdoc-0.2.3.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=MqY7MAVoFwW-vv1tuJ7pZuzcfqa1aEAbyyQWaFJhWMc,5002
+testdoc/cli.py,sha256=el9eqTr4MjxF91XancigF6U7nJ5ffSXw7Wnhna3OkW0,5027
 testdoc/default.toml,sha256=PK7O2gat8326ZYOXBC1mt6-5ceBhdbgs0BL1uo4XLjQ,87
-testdoc/testdoc.py,sha256=cVJguXoFhkCM2nkUlZGB8m-6rBhKwthFFtdtz0T2l4Q,772
+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=jVFJrBz7-DqHcGYzcwcLhpYGUOmA2xZSoJdsaPtGQJY,1656
+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/testsuiteparser.py,sha256=K7nHa6Kf64kixlGrlsv7leIDl30ct01TE0jxgnXJxl8,2788
-testdoc/parser/modifier/sourceprefixmodifier.py,sha256=Vy_keEKztF7UrjtWjmkU7usGR7E-xLvxJOWocPRu6KI,3950
+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=uJTuF3KxtDt4m4nqJ9yF6NzdsjXUZGhRYsP9y9hqQ5k,3964
 testdoc/parser/modifier/suitefilemodifier.py,sha256=OuDuleQj4dRjUcu0AROEPZ-2vR3lWJfWmQVuoWLkXuY,4865
-robotframework_testdoc-0.2.3.dist-info/METADATA,sha256=2dnkYPT0Z_y3dWX9oYHYqKp62QhdcfBSjgBfJcQ1upw,6947
-robotframework_testdoc-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-robotframework_testdoc-0.2.3.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
-robotframework_testdoc-0.2.3.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
-robotframework_testdoc-0.2.3.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/cli.py

@@ -25,7 +25,7 @@ CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 @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("PATH", nargs=-1, required=True)
 @click.argument("OUTPUT")
 def main(
         title,

testdoc/helper/pathconverter.py

@@ -15,11 +15,13 @@ class PathConverter():
         config_path = self.args.config_file
 
         # 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]}"'
+        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:
-            msg = f"Suite Directory: '{suite_path}'"
+            suite_path = PathConverter().conv_generic_path(path=suite_path)
 
         # Convert path to output file
         output_path = PathConverter().conv_generic_path(path=output_path)
@@ -30,6 +32,16 @@ class PathConverter():
 
         # 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)

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/parser/testsuiteparser.py

@@ -1,15 +1,27 @@
+# Portions of this file are derived from Robot Framework, licensed under the Apache License 2.0.
+# Derived code: see class `RobotSuiteFiltering`.
 import os
 from pathlib import Path
 
 from robot.api import SuiteVisitor, TestSuite
 from .testcaseparser import TestCaseParser
 from .modifier.suitefilemodifier import SuiteFileModifier
+from ..helper.cliargs import CommandLineArguments
+from..helper.pathconverter import PathConverter
+
+from robot.conf import RobotSettings
+from robot.running import TestSuiteBuilder
+from robot.testdoc import USAGE
+from robot.utils import (
+    abspath, Application, is_list_like
+)
 
 class RobotSuiteParser(SuiteVisitor):
     def __init__(self):
         self.suite_counter = 0
         self.suites = []
         self.tests = []
+        self.args = CommandLineArguments().data
 
     def visit_suite(self, suite):
         
@@ -19,7 +31,7 @@ class RobotSuiteParser(SuiteVisitor):
         # Test Suite Parser
         suite_info = {
             "id": str(suite.longname).lower().replace(".", "_").replace(" ", "_"),
-            "filename": str(Path(suite.source).name),
+            "filename": str(Path(suite.source).name) if suite.source else suite.name,
             "name": suite.name,
             "doc": "<br>".join(line.replace("\\n","") for line in suite.doc.splitlines() if line.strip()) if suite.doc else None,
             "is_folder": self._is_directory(suite),
@@ -41,9 +53,14 @@ class RobotSuiteParser(SuiteVisitor):
         suite_info["total_tests"] = total_tests
         self.suites.append(suite_info)
 
-    def parse_suite(self, suite_path):
-        suite = TestSuite.from_file_system(suite_path)
-        suite = TestCaseParser().consider_tags(suite)
+    def parse_suite(self):
+        # Use official Robot Framework Application Package to parse cli arguments and modify suite object.
+        robot_options = self._convert_args()
+        _rfs = RobotSuiteFiltering()
+        _rfs.execute_cli(robot_options, False)
+        suite = _rfs._suite_object
+
+        # Custom suite object modification with new test doc library
         suite = SuiteFileModifier()._modify_root_suite_details(suite)
         suite.visit(self)
         return self.suites
@@ -72,3 +89,60 @@ class RobotSuiteParser(SuiteVisitor):
         existing_suite = next((s for s in self.suites if s["name"] == suite.name), None)
         if existing_suite:
             return
+        
+    def _convert_args(self):
+        """ Convert given cli args to match internal robotframework syntax """
+        _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 = []
+        for item in _include:
+            robot_options.append("-i")
+            robot_options.append(f"{item}")
+        for item in _exclude:
+            robot_options.append("-e")
+            robot_options.append(f"{item}")
+        for item in _source:
+            _os_indep_path = PathConverter().conv_generic_path(item)
+            robot_options.append(f"{_os_indep_path}")
+        robot_options.append(self.args.output_file)
+        return robot_options
+
+class RobotSuiteFiltering(Application):
+    """ Use official RF Application package to build test suite object with given cli options & arguments """
+    OPTIONS = """
+Options
+=======
+NOT SUPPORTED YET: -T --title title       Set the title of the generated documentation.
+                         Underscores in the title are converted to spaces.
+                         The default title is the name of the top level suite.
+NOT SUPPORTED YET: -N --name name         Override the name of the top level suite.
+NOT SUPPORTED YET: -D --doc document      Override the documentation of the top level suite.
+NOT SUPPORTED YET: -M --metadata name:value *  Set/override metadata of the top level suite.
+NOT SUPPORTED YET: -G --settag tag *      Set given tag(s) to all test cases.
+NOT SUPPORTED YET: -t --test name *       Include tests by name.
+NOT SUPPORTED YET: -s --suite name *      Include suites by name.
+  -i --include tag *     Include tests by tags.
+  -e --exclude tag *     Exclude tests by tags.
+"""
+    def __init__(self):
+        self._suite_object = None
+        Application.__init__(self, USAGE, arg_limits=(2,))
+
+    def main(self, datasources, title=None, **options):
+        abspath(datasources.pop())
+        settings = RobotSettings(options)
+        if not is_list_like(datasources):
+            datasources = [datasources]
+        suite = TestSuiteBuilder(process_curdir=False).build(*datasources)
+        suite.configure(**settings.suite_config)
+        self._suite_object = suite

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():
@@ -10,7 +10,7 @@ class TestDoc():
         suite_path, output_path, config_path = PathConverter().path_convertion()
         
         # Parse suite object & return complete suite object with all information
-        suite_object = RobotSuiteParser().parse_suite(suite_path)
+        suite_object = RobotSuiteParser().parse_suite()
         
         # Run SuiteFileModifier to modify the test suite object
         suite_object = SuiteFileModifier().run(suite_object)