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

robotframework_testdoc-0.2.2/.github/workflows/build-publish.yml → robotframework_testdoc-0.2.4/.github/workflows/build.yml

@@ -1,10 +1,9 @@
-name: Build Python Package
+name: Build & Test Python Package
 
 on:
   push:
     branches:
       - main
-      - '**'
     tags-ignore:
       - 'v*.*.*'
     paths:
@@ -20,9 +19,8 @@ on:
       - pyproject.toml
 
 jobs:
-  build:
+  code-quality:
     runs-on: ubuntu-latest
-
     steps:
     - name: Checkout Repository
       uses: actions/checkout@v3
@@ -40,9 +38,28 @@ jobs:
     - name: Lint with Ruff
       run: ruff check .
 
+  test-build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install Build Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build ruff pytest
+    
     - name: Build Package
       run: python -m build
-
+    
     - name: Test CLI Command
       run: |
         pip install .
@@ -50,11 +67,4 @@ jobs:
 
     - name: Run Unit Tests
       run: pytest atest/
-
-    # - name: Publish to TestPyPI
-    #   env:
-    #     TWINE_USERNAME: __token__
-    #     TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
-    #   run: |
-    #     pip install twine
-    #     twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+  

{robotframework_testdoc-0.2.2 → robotframework_testdoc-0.2.4}/.github/workflows/release.yml

@@ -53,3 +53,12 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: twine upload dist/*
 
+    # Backup:
+    # - name: Publish to TestPyPI
+    #   env:
+    #     TWINE_USERNAME: __token__
+    #     TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+    #   run: |
+    #     pip install twine
+    #     twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+

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

@@ -1,11 +1,17 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.2
+Version: 0.2.4
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
-License: MIT
+License: Apache-2.0
 Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
 Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -23,9 +29,11 @@ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/rob
 
 ## Statistics
 
-[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
-[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
-[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
+[![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)   
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)    
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)   
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)   
 
 ## Installation
 

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

@@ -6,9 +6,11 @@ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/rob
 
 ## Statistics
 
-[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
-[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
-[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
+[![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)   
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)    
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)   
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)   
 
 ## Installation
 

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

@@ -4,14 +4,24 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "robotframework-testdoc"
-version = "0.2.2"
+version = "0.2.4"
 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 = "marvinklerx20@gmail.com" }
 ]
-license = { text = "MIT" }
+license = { text = "Apache-2.0" }
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+#   "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12"
+]
 
 dependencies = [
     "click",

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

@@ -1,11 +1,17 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.2.2
+Version: 0.2.4
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Author-email: Marvin Klerx <marvinklerx20@gmail.com>
-License: MIT
+License: Apache-2.0
 Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
 Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -23,9 +29,11 @@ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/rob
 
 ## Statistics
 
-[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
-[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
-[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
+[![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)   
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)    
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)   
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)   
 
 ## Installation
 

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

@@ -2,7 +2,7 @@
 LICENSE
 README.md
 pyproject.toml
-.github/workflows/build-publish.yml
+.github/workflows/build.yml
 .github/workflows/release.yml
 atest/test_cli.py
 atest/test_cli.robot

{robotframework_testdoc-0.2.2 → robotframework_testdoc-0.2.4}/src/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,

{robotframework_testdoc-0.2.2 → robotframework_testdoc-0.2.4}/src/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)

robotframework_testdoc-0.2.4/src/testdoc/parser/testsuiteparser.py

@@ -0,0 +1,148 @@
+# 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):
+        
+        # Skip suite if its already parsed into list
+        self._already_parsed(suite)
+
+        # Test Suite Parser
+        suite_info = {
+            "id": str(suite.longname).lower().replace(".", "_").replace(" ", "_"),
+            "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),
+            "num_tests": len(suite.tests),
+            "source": str(suite.source),
+            "total_tests": 0,
+            "tests": [],
+            "sub_suites": [],
+            "metadata": "<br>".join([f"{k}: {v}" for k, v in suite.metadata.items()]) if suite.metadata else None
+        }
+
+        # Parse Test Cases
+        suite_info = TestCaseParser().parse_test(suite, suite_info)
+
+        # Collect sub-suites recursive
+        suite_info, total_tests = self._recursive_sub_suite(suite, suite_info)
+
+        # Append to suites object
+        suite_info["total_tests"] = total_tests
+        self.suites.append(suite_info)
+
+    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
+    
+    ##############################################################################################
+    # Helper:
+    ##############################################################################################
+
+    def _recursive_sub_suite(self,
+            suite: TestSuite,
+            suite_info: dict
+        ):
+        total_tests = suite_info["num_tests"]
+        for sub_suite in suite.suites:
+            sub_parser = RobotSuiteParser()
+            sub_parser.visit_suite(sub_suite)
+            suite_info["sub_suites"].extend(sub_parser.suites)
+            total_tests += sum(s["total_tests"] for s in sub_parser.suites)
+        return suite_info, total_tests
+
+    def _is_directory(self, suite) -> bool:
+        suite_path = suite.source if suite.source else ""
+        return(os.path.isdir(suite_path) if suite_path else False)
+    
+    def _already_parsed(self, suite):
+        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

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

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

robotframework_testdoc-0.2.2/src/testdoc/parser/testsuiteparser.py

@@ -1,74 +0,0 @@
-import os
-from pathlib import Path
-
-from robot.api import SuiteVisitor, TestSuite
-from .testcaseparser import TestCaseParser
-from .modifier.suitefilemodifier import SuiteFileModifier
-
-class RobotSuiteParser(SuiteVisitor):
-    def __init__(self):
-        self.suite_counter = 0
-        self.suites = []
-        self.tests = []
-
-    def visit_suite(self, suite):
-        
-        # Skip suite if its already parsed into list
-        self._already_parsed(suite)
-
-        # Test Suite Parser
-        suite_info = {
-            "id": str(suite.longname).lower().replace(".", "_").replace(" ", "_"),
-            "filename": str(Path(suite.source).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),
-            "num_tests": len(suite.tests),
-            "source": str(suite.source),
-            "total_tests": 0,
-            "tests": [],
-            "sub_suites": [],
-            "metadata": "<br>".join([f"{k}: {v}" for k, v in suite.metadata.items()]) if suite.metadata else None
-        }
-
-        # Parse Test Cases
-        suite_info = TestCaseParser().parse_test(suite, suite_info)
-
-        # Collect sub-suites recursive
-        suite_info, total_tests = self._recursive_sub_suite(suite, suite_info)
-
-        # Append to suites object
-        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)
-        suite = SuiteFileModifier()._modify_root_suite_details(suite)
-        suite.visit(self)
-        return self.suites
-    
-    ##############################################################################################
-    # Helper:
-    ##############################################################################################
-
-    def _recursive_sub_suite(self,
-            suite: TestSuite,
-            suite_info: dict
-        ):
-        total_tests = suite_info["num_tests"]
-        for sub_suite in suite.suites:
-            sub_parser = RobotSuiteParser()
-            sub_parser.visit_suite(sub_suite)
-            suite_info["sub_suites"].extend(sub_parser.suites)
-            total_tests += sum(s["total_tests"] for s in sub_parser.suites)
-        return suite_info, total_tests
-
-    def _is_directory(self, suite) -> bool:
-        suite_path = suite.source if suite.source else ""
-        return(os.path.isdir(suite_path) if suite_path else False)
-    
-    def _already_parsed(self, suite):
-        existing_suite = next((s for s in self.suites if s["name"] == suite.name), None)
-        if existing_suite:
-            return