robotframework-pabot 4.0.6__py3-none-any.whl → 4.1.0__py3-none-any.whl

pabot/__init__.py

@@ -2,4 +2,4 @@ from __future__ import absolute_import
 
 from .pabotlib import PabotLib
 
-__version__ = "4.0.6"
+__version__ = "4.1.0"

pabot/arguments.py

@@ -106,8 +106,9 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
         "resourcefile": str,
         "pabotlibhost": str,
         "pabotlibport": int,
+        "pabotprerunmodifier": str,
         "processtimeout": int,
-        "ordering": _parse_ordering,
+        "ordering": str,
         "suitesfrom": str,
         "artifacts": lambda x: x.split(","),
         "shard": _parse_shard,
@@ -195,17 +196,6 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
     return remaining_args, pabot_args
 
 
-def _parse_ordering(filename):  # type: (str) -> List[ExecutionItem]
-    try:
-        with open(filename, "r") as orderingfile:
-            return [
-                parse_execution_item_line(line.strip())
-                for line in orderingfile.readlines()
-            ]
-    except:
-        raise DataError("Error parsing ordering file '%s'" % filename)
-
-
 def _delete_none_keys(d):  # type: (Dict[str, Optional[object]]) -> Dict[str, object]
     keys = set()
     for k in d:

pabot/execution_items.py

@@ -5,6 +5,7 @@ from robot import __version__ as ROBOT_VERSION
 from robot.errors import DataError
 from robot.utils import PY2, is_unicode
 
+import re
 
 @total_ordering
 class ExecutionItem(object):
@@ -97,20 +98,31 @@ class GroupItem(ExecutionItem):
 class RunnableItem(ExecutionItem):
     pass
 
-    depends = None  # type: str
+    depends = None  # type: List[str]
     depends_keyword = "#DEPENDS"
 
+    def _split_dependencies(self, line_name, depends_indexes):
+        depends_lst = [] if len(depends_indexes) < 2 else [line_name[i + len(self.depends_keyword) : j].strip() for i, j in zip(depends_indexes, depends_indexes[1:])]
+        depends_lst.append(line_name[depends_indexes[-1] + len(self.depends_keyword) : ].strip())
+        return depends_lst
+
+    def _merge_dependencies(self, line_start):
+        output_line = line_start
+        for d in self.depends:
+            output_line = output_line + " " + self.depends_keyword + " " + d
+        return output_line
+
     def set_name_and_depends(self, name):
         line_name = name.encode("utf-8") if PY2 and is_unicode(name) else name
-        depends_begin_index = line_name.find(self.depends_keyword)
+        depends_indexes = [d.start() for d in re.finditer(self.depends_keyword, line_name)]
         self.name = (
             line_name
-            if depends_begin_index == -1
-            else line_name[0:depends_begin_index].strip()
+            if len(depends_indexes) == 0
+            else line_name[0:depends_indexes[0]].strip()
         )
         self.depends = (
-            line_name[depends_begin_index + len(self.depends_keyword) :].strip()
-            if depends_begin_index != -1
+            self._split_dependencies(line_name, depends_indexes)
+            if len(depends_indexes) != 0
             else None
         )
 
@@ -118,7 +130,7 @@ class RunnableItem(ExecutionItem):
         # type: () -> str
         line_without_depends = "--" + self.type + " " + self.name
         return (
-            line_without_depends + " " + self.depends_keyword + " " + self.depends
+            self._merge_dependencies(line_without_depends)
             if self.depends
             else line_without_depends
         )

pabot/pabot.py

@@ -15,73 +15,12 @@
 #  limitations under the License.
 #
 #  partly based on work by Nokia Solutions and Networks Oyj
+
+# Help documentation from README.md:
 """A parallel executor for Robot Framework test cases.
 Version [PABOT_VERSION]
 
-Supports all Robot Framework command line options and also following
-options (these must be before normal RF options):
-
---verbose
-  more output
-
---command [ACTUAL COMMANDS TO START ROBOT EXECUTOR] --end-command
-  RF script for situations where pybot is not used directly
-
---processes [NUMBER OF PROCESSES]
-  How many parallel executors to use (default max of 2 and cpu count).
-  Special option "all" will use as many processes as there are
-  executable suites or tests.
-
---testlevelsplit
-  Split execution on test level instead of default suite level.
-  If .pabotsuitenames contains both tests and suites then this
-  will only affect new suites and split only them.
-  Leaving this flag out when both suites and tests in
-  .pabotsuitenames file will also only affect new suites and
-  add them as suite files.
-
---resourcefile [FILEPATH]
-  Indicator for a file that can contain shared variables for
-  distributing resources.
-
---no-pabotlib
-  Disable the PabotLib remote server if you don't need locking or resource distribution features.
-  PabotLib remote server is started by default.
-
---pabotlibhost [HOSTNAME]          
-  Connect to an already running instance of the PabotLib remote server at the given host
-  (disables the local PabotLib server start). For example, to connect to a 
-  remote PabotLib server running on another machine:
-  
-      pabot --pabotlibhost 192.168.1.123 --pabotlibport 8271 tests/
-
-  The remote PabotLib server can be started separately using:
-      python -m pabot.pabotlib <path_to_resourcefile> <host> <port>
-      python -m pabot.pabotlib resource.txt 192.168.1.123 8271
-
---pabotlibport [PORT]
-  Port number of the PabotLib remote server (default is 8270)
-
---processtimeout [TIMEOUT]
-  Maximum time in seconds to wait for a process before killing it. If not set, there's no timeout.
-
---ordering [FILE PATH]
-  Optionally give execution order from a file.
-
---suitesfrom [FILEPATH TO OUTPUTXML]
-  Optionally read suites from output.xml file. Failed suites will run
-  first and longer running ones will be executed before shorter ones.
-
---argumentfile[INTEGER] [FILEPATH]
-  Run same suite with multiple argumentfile options.
-  For example "--argumentfile1 arg1.txt --argumentfile2 arg2.txt".
-
---shard [SHARD]/[SHARD COUNT]
-  Optionally split execution into smaller pieces. This can
-  be used for distributing testing to multiple machines.
-
---chunk
-  Optionally chunk tests to PROCESSES number of robot runs.
+PLACEHOLDER_README.MD
 
 Copyright 2022 Mikko Korpela - Apache 2 License
 """
@@ -184,6 +123,27 @@ _ROBOT_EXTENSIONS = [
 _ALL_ELAPSED = []  # type: List[Union[int, float]]
 
 
+def extract_section(filename, start_marker, end_marker):
+    with open(filename, "r", encoding="utf-8") as f:
+        lines = f.readlines()
+
+    inside_section = False
+    extracted_lines = []
+
+    for line in lines:
+        if start_marker in line:
+            inside_section = True
+            continue
+        if end_marker in line:
+            inside_section = False
+            break
+        if inside_section:
+            # Add line from README.md without [] and (https: address)
+            extracted_lines.append(re.sub(r'\[([^\]]+)\]\(https?://[^\)]+\)', r'\1', line))
+
+    return "".join(extracted_lines).strip()
+
+
 class Color:
     SUPPORTED_OSES = ["posix"]
 
@@ -880,6 +840,8 @@ def solve_shard_suites(suite_names, pabot_args):
 
 
 def solve_suite_names(outs_dir, datasources, options, pabot_args):
+    if pabot_args.get("pabotprerunmodifier"):
+        options['prerunmodifier'].append(pabot_args['pabotprerunmodifier'])
     h = Hashes(
         dirs=get_hash_of_dirs(datasources),
         cmd=get_hash_of_command(options, pabot_args),
@@ -915,7 +877,7 @@ def solve_suite_names(outs_dir, datasources, options, pabot_args):
                 for l in lines[4:]
             )
             execution_item_lines = [parse_execution_item_line(l) for l in lines[4:]]
-            if corrupted or h != file_h or file_hash != hash_of_file:
+            if corrupted or h != file_h or file_hash != hash_of_file or pabot_args.get("pabotprerunmodifier"):
                 return _regenerate(
                     file_h,
                     h,
@@ -1949,7 +1911,11 @@ def main_program(args):
         _start_message_writer()
         options, datasources, pabot_args, opts_for_run = parse_args(args)
         if pabot_args["help"]:
-            print(__doc__.replace("[PABOT_VERSION]", PABOT_VERSION))
+            help_print = __doc__.replace(
+                "PLACEHOLDER_README.MD",
+                extract_section("README.md", "<!-- START DOCSTRING -->", "<!-- END DOCSTRING -->")
+                )
+            print(help_print.replace("[PABOT_VERSION]", PABOT_VERSION))
             return 0
         if len(datasources) == 0:
             print("[ " + _wrap_with(Color.RED, "ERROR") + " ]: No datasources given.")
@@ -1988,7 +1954,8 @@ def main_program(args):
         )
         return result_code if not _ABNORMAL_EXIT_HAPPENED else 252
     except Information as i:
-        print(__doc__.replace("[PABOT_VERSION]", PABOT_VERSION))
+        version_print = __doc__.replace("\nPLACEHOLDER_README.MD\n", "")
+        print(version_print.replace("[PABOT_VERSION]", PABOT_VERSION))
         print(i.message)
     except DataError as err:
         print(err.message)
@@ -2010,10 +1977,24 @@ def main_program(args):
         _stop_message_writer()
 
 
+def _parse_ordering(filename):  # type: (str) -> List[ExecutionItem]
+    try:
+        with open(filename, "r") as orderingfile:
+            return [
+                parse_execution_item_line(line.strip())
+                for line in orderingfile.readlines()
+            ]
+    except FileNotFoundError:
+        raise DataError("Error: File '%s' not found." % filename)
+    except:
+        raise DataError("Error parsing ordering file '%s'" % filename)
+
+
 def _group_suites(outs_dir, datasources, options, pabot_args):
     suite_names = solve_suite_names(outs_dir, datasources, options, pabot_args)
     _verify_depends(suite_names)
-    ordered_suites = _preserve_order(suite_names, pabot_args.get("ordering"))
+    ordering_arg = _parse_ordering(pabot_args.get("ordering")) if (pabot_args.get("ordering")) is not None else None
+    ordered_suites = _preserve_order(suite_names, ordering_arg)
     shard_suites = solve_shard_suites(ordered_suites, pabot_args)
     grouped_suites = (
         _chunked_suite_names(shard_suites, pabot_args["processes"])
@@ -2083,20 +2064,27 @@ def _group_by_depend(suite_names):
         return [suite_names]
     independent_tests = list(filter(lambda suite: not suite.depends, runnable_suites))
     dependency_tree = [independent_tests]
-    while True:
-        dependent_tests = list(filter(lambda suite: suite.depends, runnable_suites))
-        dependent_on_last_stage = list(
-            filter(
-                lambda suite: any(
-                    test_in_tier_before.name == suite.depends
-                    for test_in_tier_before in dependency_tree[-1]
-                ),
-                dependent_tests,
-            )
-        )
-        if not dependent_on_last_stage:
-            break
-        dependency_tree += [dependent_on_last_stage]
+    dependent_tests = list(filter(lambda suite: suite.depends, runnable_suites))
+    unknown_dependent_tests = dependent_tests
+    while len(unknown_dependent_tests) > 0:
+        run_in_this_stage, run_later = [], []
+        for d in unknown_dependent_tests:
+            stage_indexes = []
+            for i, stage in enumerate(dependency_tree):
+                for test in stage:
+                    if test.name in d.depends:
+                        stage_indexes.append(i)
+            # All #DEPENDS test are already run:
+            if len(stage_indexes) == len(d.depends):
+                run_in_this_stage.append(d)
+            else:
+                run_later.append(d)
+        unknown_dependent_tests = run_later
+        if len(run_in_this_stage) == 0:
+            text = "There are circular or unmet dependencies using #DEPENDS. Check this/these test(s): " + str(run_later)
+            raise DataError(text)
+        else:
+            dependency_tree.append(run_in_this_stage)
     flattened_dependency_tree = sum(dependency_tree, [])
     if len(flattened_dependency_tree) != len(runnable_suites):
         raise DataError(

{robotframework_pabot-4.0.6.dist-info → robotframework_pabot-4.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: robotframework-pabot
-Version: 4.0.6
+Version: 4.1.0
 Summary: Parallel test runner for Robot Framework
 Home-page: https://pabot.org
 Download-URL: https://pypi.python.org/pypi/robotframework-pabot
@@ -20,5 +20,6 @@ License-File: LICENSE.txt
 Requires-Dist: robotframework>=3.2
 Requires-Dist: robotframework-stacktrace>=0.4.1
 Requires-Dist: natsort>=8.2.0
+Dynamic: download-url
 
 A parallel executor for Robot Framework tests. With Pabot you can split one execution into multiple and save test execution time.

{robotframework_pabot-4.0.6.dist-info → robotframework_pabot-4.1.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 pabot/SharedLibrary.py,sha256=mIipGs3ZhKYEakKprcbrMI4P_Un6qI8gE7086xpHaLY,2552
-pabot/__init__.py,sha256=elJbj_En-artFbF8FUbxiP7LhJwfmeOz_G2a4FTLO8c,94
-pabot/arguments.py,sha256=PQuJiRYwkfhzbQLat4rOflfAvDONuBAWhu1SOmVV858,7149
+pabot/__init__.py,sha256=yBQqfUgp6NEiDxMJ80_JZcdX9DSOJKt_-R-hAiiT23c,94
+pabot/arguments.py,sha256=F0EDLv2qYqmw2_kOSUIyJGGwwRSgEwyQp-uGdoTlAFo,6816
 pabot/clientwrapper.py,sha256=yz7battGs0exysnDeLDWJuzpb2Q-qSjitwxZMO2TlJw,231
 pabot/coordinatorwrapper.py,sha256=nQQ7IowD6c246y8y9nsx0HZbt8vS2XODhPVDjm-lyi0,195
-pabot/execution_items.py,sha256=ktPoGx0yXK6Q_4A8CYW3OFCnCyZQnJb8cPYZULmwyAU,8320
-pabot/pabot.py,sha256=QPzClIudUFWZIMRkWjiqGFFVDBXP-40bWUG5PbjJaX4,68695
+pabot/execution_items.py,sha256=qs15SZjGE5CQAO0UpNuVWZ60wTLdWGDK1CkbBz7JtfQ,8892
+pabot/pabot.py,sha256=GBP_LoO5BcvkX5A0Z4BX3fidoD0SGhBzjhQYajkeyf8,68417
 pabot/pabotlib.py,sha256=FRZKaKy1ybyRkE-0SpaCsUWzxZAzNNU5dAywSm1QoPk,22324
 pabot/result_merger.py,sha256=8iIptBn5MdgiW-OdhwVR2DZ0hUYuQeQXwIHAEPkMTuw,9095
 pabot/robotremoteserver.py,sha256=L3O2QRKSGSE4ux5M1ip5XJMaelqaxQWJxd9wLLdtpzM,22272
@@ -14,9 +14,9 @@ pabot/py3/client.py,sha256=Od9L4vZ0sozMHq_W_ITQHBBt8kAej40DG58wnxmbHGM,1434
 pabot/py3/coordinator.py,sha256=kBshCzA_1QX_f0WNk42QBJyDYSwSlNM-UEBxOReOj6E,2313
 pabot/py3/messages.py,sha256=7mFr4_0x1JHm5sW8TvKq28Xs_JoeIGku2bX7AyO0kng,2557
 pabot/py3/worker.py,sha256=5rfp4ZiW6gf8GRz6eC0-KUkfx847A91lVtRYpLAv2sg,1612
-robotframework_pabot-4.0.6.dist-info/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-robotframework_pabot-4.0.6.dist-info/METADATA,sha256=jsSx4f-wusBvzPDEXAJzRkEmhGTkpSxbHJi7EuGJR9k,997
-robotframework_pabot-4.0.6.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-robotframework_pabot-4.0.6.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
-robotframework_pabot-4.0.6.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
-robotframework_pabot-4.0.6.dist-info/RECORD,,
+robotframework_pabot-4.1.0.dist-info/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+robotframework_pabot-4.1.0.dist-info/METADATA,sha256=jP70LRXHbIDdkpV8h0x1H31nh7Gk59qIGc5IdsJmMA4,1019
+robotframework_pabot-4.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+robotframework_pabot-4.1.0.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
+robotframework_pabot-4.1.0.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
+robotframework_pabot-4.1.0.dist-info/RECORD,,

{robotframework_pabot-4.0.6.dist-info → robotframework_pabot-4.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any