robotframework-pabot 4.3.2__py3-none-any.whl → 5.1.0__py3-none-any.whl

pabot/__init__.py

@@ -7,4 +7,4 @@ try:
 except ImportError:
     pass
 
-__version__ = "4.3.2"
+__version__ = "5.1.0"

pabot/arguments.py

@@ -142,6 +142,14 @@ def _parse_shard(arg):
     return int(parts[0]), int(parts[1])
 
 
+def _parse_artifacts(arg):
+    # type: (str) -> Tuple[List[str], bool]
+    artifacts = arg.split(',')
+    if artifacts[-1] == 'notimestamps':
+        return (artifacts[:-1], False)
+    return (artifacts, True)
+
+
 def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str, object]]
     pabot_args = {
         "command": ["pybot" if ROBOT_VERSION < "3.1" else "robot"],
@@ -155,6 +163,7 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
         "processes": _processes_count(),
         "processtimeout": None,
         "artifacts": ["png"],
+        "artifactstimestamps": True,
         "artifactsinsubfolders": False,
         "shardindex": 0,
         "shardcount": 1,
@@ -181,7 +190,7 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
         "processtimeout": int,
         "ordering": str,
         "suitesfrom": str,
-        "artifacts": lambda x: x.split(","),
+        "artifacts": _parse_artifacts,
         "shard": _parse_shard,
     }
 
@@ -239,6 +248,9 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
                 elif arg_name == "pabotlibhost":
                     pabot_args["pabotlib"] = False
                     pabot_args[arg_name] = value
+                elif arg_name == "artifacts":
+                    pabot_args["artifacts"] = value[0]
+                    pabot_args["artifactstimestamps"] = value[1]
                 else:
                     pabot_args[arg_name] = value
                 i += 2

pabot/execution_items.py

@@ -1,5 +1,5 @@
 from functools import total_ordering
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union, Set
 
 from robot import __version__ as ROBOT_VERSION
 from robot.errors import DataError
@@ -8,36 +8,68 @@ from robot.utils import PY2, is_unicode
 import re
 
 
-def create_dependency_tree(items):  
+def create_dependency_tree(items):
     # type: (List[ExecutionItem]) -> List[List[ExecutionItem]]
-    independent_tests = list(filter(lambda item: not item.depends, items))
-    dependency_tree = [independent_tests]
-    dependent_tests = list(filter(lambda item: item.depends, items))
-    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)
+    dependency_tree = []  # type: List[List[ExecutionItem]]
+    scheduled = set()  # type: Set[str]
+    name_to_item = {item.name: item for item in items}  # type: Dict[str, ExecutionItem]
+
+    while items:
+        stage = []  #type: List[ExecutionItem]
+        stage_names = set()  # type: Set[str]
+
+        for item in items:
+            if all(dep in scheduled for dep in item.depends):
+                stage.append(item)
+                stage_names.add(item.name)
             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(items):
-        raise DataError(
-            "Invalid test configuration: Circular or unmet dependencies detected between test suites. Please check your #DEPENDS definitions."
-        )
+                break  # Preserve input order
+
+        if not stage:
+            # Try to find any schedulable item even if it's out of order
+            for item in items:
+                if all(dep in scheduled for dep in item.depends):
+                    stage = [item]
+                    stage_names = {item.name}
+                    break
+
+        if not stage:
+            # Prepare a detailed error message
+            unscheduled_items = [item.name for item in items]
+            unsatisfied_deps = {
+                item.name: [d for d in item.depends if d not in scheduled and d not in name_to_item]
+                for item in items
+            }
+            potential_cycles = {
+                item.name: [d for d in item.depends if d in unscheduled_items]
+                for item in items if item.depends
+            }
+
+            message = ["Invalid test configuration:"]
+
+            message_unsatisfied = []
+            for item, deps in unsatisfied_deps.items():
+                if deps:
+                    message_unsatisfied.append(f"    - {item} depends on missing: {', '.join(deps)}")
+            if message_unsatisfied:
+                message.append("  Unsatisfied dependencies:")
+                message.extend(message_unsatisfied)
+                message.append("  For these tests, check that there is not #WAIT between them and that they are not inside different groups { }")
+
+            message_cycles = []
+            for item, deps in potential_cycles.items():
+                if deps:
+                    message_cycles.append(f"    - {item} <-> {', '.join(deps)}")
+            if message_cycles:
+                message.append("  Possible circular dependencies:")
+                message.extend(message_cycles)
+
+            raise DataError("\n".join(message))
+
+        dependency_tree.append(stage)
+        scheduled.update(stage_names)
+        items = [item for item in items if item.name not in stage_names]
+
     return dependency_tree
 
 
@@ -47,6 +79,7 @@ class ExecutionItem(object):
     type = None  # type: str
     name = None  # type: str
     sleep = 0  # type: int
+    depends = []  # type: List[str]  # Note that depends is used by RunnableItems.
 
     def top_name(self):
         # type: () -> str
@@ -156,7 +189,6 @@ class GroupItem(ExecutionItem):
 class RunnableItem(ExecutionItem):
     pass
 
-    depends = None  # type: List[str]
     depends_keyword = "#DEPENDS"
 
     def _split_dependencies(self, line_name, depends_indexes):
@@ -182,7 +214,7 @@ class RunnableItem(ExecutionItem):
         self.depends = (
             self._split_dependencies(line_name, depends_indexes)
             if len(depends_indexes) != 0
-            else None
+            else []
         )
 
     def line(self):
@@ -243,6 +275,10 @@ class SuiteItem(RunnableItem):
         # TODO Make this happen
         return []
 
+    def modify_options_for_executor(self, options):
+        if not(options.get("runemptysuite") and options.get("suite")):
+            options[self.type] = self.name
+
 
 class TestItem(RunnableItem):
     type = "test"

pabot/pabot.py

@@ -109,10 +109,6 @@ EXECUTION_POOL_ID_LOCK = threading.Lock()
 POPEN_LOCK = threading.Lock()
 _PABOTLIBURI = "127.0.0.1:8270"
 _PABOTLIBPROCESS = None  # type: Optional[subprocess.Popen]
-_BOURNELIKE_SHELL_BAD_CHARS_WITHOUT_DQUOTE = (
-    "!#$^&*?[(){}<>~;'`\\|= \t\n"  # does not contain '"'
-)
-_BAD_CHARS_SET = set(_BOURNELIKE_SHELL_BAD_CHARS_WITHOUT_DQUOTE)
 _NUMBER_OF_ITEMS_TO_BE_EXECUTED = 0
 _ABNORMAL_EXIT_HAPPENED = False
 
@@ -198,8 +194,13 @@ def extract_section(lines, start_marker="<!-- START DOCSTRING -->", end_marker="
         if end_marker in line:
             break
         if inside_section:
-            # Remove Markdown links but keep the text
-            extracted_lines.append(re.sub(r'\[([^\]]+)\]\(https?://[^\)]+\)', r'\1', line))
+            # Remove Markdown hyperlinks but keep text
+            line = re.sub(r'\[([^\]]+)\]\(https?://[^\)]+\)', r'\1', line)
+            # Remove Markdown section links but keep text
+            line = re.sub(r'\[([^\]]+)\]\(#[^\)]+\)', r'\1', line)
+            # Remove ** and backticks `
+            line = re.sub(r'(\*\*|`)', '', line)
+            extracted_lines.append(line)
 
     return "".join(extracted_lines).strip()
 
@@ -213,16 +214,6 @@ class Color:
     YELLOW = "\033[93m"
 
 
-def _mapOptionalQuote(command_args):
-    # type: (List[str]) -> List[str]
-    if os.name == "posix":
-        return [quote(arg) for arg in command_args]
-    return [
-        arg if set(arg).isdisjoint(_BAD_CHARS_SET) else '"%s"' % arg
-        for arg in command_args
-    ]
-
-
 def execute_and_wait_with(item):
     # type: ('QueueItem') -> None
     global CTRL_C_PRESSED, _NUMBER_OF_ITEMS_TO_BE_EXECUTED
@@ -240,13 +231,13 @@ def execute_and_wait_with(item):
         name = item.display_name
         outs_dir = os.path.join(item.outs_dir, item.argfile_index, str(item.index))
         os.makedirs(outs_dir)
-        cmd = _create_command_for_execution(
+        run_cmd, run_options = _create_command_for_execution(
             caller_id, datasources, is_last, item, outs_dir
         )
         if item.hive:
             _hived_execute(
                 item.hive,
-                cmd,
+                run_cmd + run_options,
                 outs_dir,
                 name,
                 item.verbose,
@@ -256,7 +247,8 @@ def execute_and_wait_with(item):
             )
         else:
             _try_execute_and_wait(
-                cmd,
+                run_cmd,
+                run_options,
                 outs_dir,
                 name,
                 item.verbose,
@@ -268,7 +260,7 @@ def execute_and_wait_with(item):
                 sleep_before_start=item.sleep_before_start
             )
         outputxml_preprocessing(
-            item.options, outs_dir, name, item.verbose, _make_id(), caller_id
+            item.options, outs_dir, name, item.verbose, _make_id(), caller_id, item.index
         )
     except:
         _write(traceback.format_exc())
@@ -278,9 +270,8 @@ def _create_command_for_execution(caller_id, datasources, is_last, item, outs_di
     options = item.options.copy()
     if item.command == ["robot"] and not options["listener"]:
         options["listener"] = ["RobotStackTracer"]
-    cmd = (
-        item.command
-        + _options_for_custom_executor(
+    run_options = (
+        _options_for_custom_executor(
             options,
             outs_dir,
             item.execution_item,
@@ -291,12 +282,9 @@ def _create_command_for_execution(caller_id, datasources, is_last, item, outs_di
             item.last_level,
             item.processes,
         )
-        # If the datasource ends with a backslash '\', it is deleted to ensure 
-        # correct handling of the escape character later on.
-        + [os.path.normpath(s) for s in datasources]
+        + datasources
     )
-    return _mapOptionalQuote(cmd)
-
+    return item.command, run_options
 
 def _pabotlib_in_use():
     return _PABOTLIBPROCESS or _PABOTLIBURI != "127.0.0.1:8270"
@@ -317,7 +305,8 @@ def _hived_execute(
 
 
 def _try_execute_and_wait(
-    cmd,
+    run_cmd,
+    run_options,
     outs_dir,
     item_name,
     verbose,
@@ -328,16 +317,17 @@ def _try_execute_and_wait(
     process_timeout=None,
     sleep_before_start=0
 ):
-    # type: (List[str], str, str, bool, int, str, int, bool, Optional[int], int) -> None
+    # type: (List[str], List[str], str, str, bool, int, str, int, bool, Optional[int], int) -> None
     plib = None
     is_ignored = False
     if _pabotlib_in_use():
         plib = Remote(_PABOTLIBURI)
     try:
-        with open(os.path.join(outs_dir, cmd[0] + "_stdout.out"), "w") as stdout:
-            with open(os.path.join(outs_dir, cmd[0] + "_stderr.out"), "w") as stderr:
+        with open(os.path.join(outs_dir, run_cmd[-1] + "_stdout.out"), "w") as stdout:
+            with open(os.path.join(outs_dir, run_cmd[-1] + "_stderr.out"), "w") as stderr:
                 process, (rc, elapsed) = _run(
-                    cmd,
+                    run_cmd,
+                    run_options,
                     stderr,
                     stdout,
                     item_name,
@@ -369,7 +359,7 @@ def _try_execute_and_wait(
         show_stdout_on_failure,
     )
     if is_ignored and os.path.isdir(outs_dir):
-        shutil.rmtree(outs_dir)
+        _rmtree_with_path(outs_dir)
 
 
 def _result_to_stdout(
@@ -418,8 +408,8 @@ def _is_ignored(plib, caller_id):  # type: (Remote, str) -> bool
 
 # optionally invoke rebot for output.xml preprocessing to get --RemoveKeywords
 # and --flattenkeywords applied => result: much smaller output.xml files + faster merging + avoid MemoryErrors
-def outputxml_preprocessing(options, outs_dir, item_name, verbose, pool_id, caller_id):
-    # type: (Dict[str, Any], str, str, bool, int, str) -> None
+def outputxml_preprocessing(options, outs_dir, item_name, verbose, pool_id, caller_id, item_id):
+    # type: (Dict[str, Any], str, str, bool, int, str, int) -> None
     try:
         remove_keywords = options["removekeywords"]
         flatten_keywords = options["flattenkeywords"]
@@ -432,11 +422,15 @@ def outputxml_preprocessing(options, outs_dir, item_name, verbose, pool_id, call
             remove_keywords_args += ["--removekeywords", k]
         for k in flatten_keywords:
             flatten_keywords_args += ["--flattenkeywords", k]
-        outputxmlfile = os.path.join(outs_dir, "output.xml")
+        output_name = options.get("output", "output.xml")
+        outputxmlfile = os.path.join(outs_dir, output_name)
+        if not os.path.isfile(outputxmlfile):
+            raise DataError(f"Preprosessing cannot be done because file {outputxmlfile} not exists.")
         oldsize = os.path.getsize(outputxmlfile)
-        cmd = (
+        process_empty = ["--processemptysuite"] if options.get("runemptysuite") else []
+        run_cmd = ["rebot"]
+        run_options = (
             [
-                "rebot",
                 "--log",
                 "NONE",
                 "--report",
@@ -447,18 +441,20 @@ def outputxml_preprocessing(options, outs_dir, item_name, verbose, pool_id, call
                 "off",
                 "--NoStatusRC",
             ]
+            + process_empty
             + remove_keywords_args
             + flatten_keywords_args
             + ["--output", outputxmlfile, outputxmlfile]
         )
-        cmd = _mapOptionalQuote(cmd)
         _try_execute_and_wait(
-            cmd,
+            run_cmd,
+            run_options,
             outs_dir,
-            "preprocessing output.xml on " + item_name,
+            f"preprocessing {output_name} on " + item_name,
             verbose,
             pool_id,
             caller_id,
+            item_id,
         )
         newsize = os.path.getsize(outputxmlfile)
         perc = 100 * newsize / oldsize
@@ -519,8 +515,37 @@ def _increase_completed(plib, my_index):
             )
 
 
+def _write_internal_argument_file(cmd_args, filename):
+    # type: (List[str], str) -> None
+    """
+    Writes a list of command-line arguments to a file.
+    If an argument starts with '-' or '--', its value (the next item) is written on the same line.
+
+    Example:
+        ['--name', 'value', '--flag', '--other', 'x']
+        becomes:
+            --name value
+            --flag
+            --other x
+
+    :param cmd_args: List of argument strings to write
+    :param filename: Target filename
+    """
+    with open(filename, "w", encoding="utf-8") as f:
+        i = 0
+        while i < len(cmd_args):
+            current = cmd_args[i]
+            if current.startswith("-") and i + 1 < len(cmd_args) and not cmd_args[i + 1].startswith("-"):
+                f.write(f"{current} {cmd_args[i + 1]}\n")
+                i += 2
+            else:
+                f.write(f"{current}\n")
+                i += 1
+
+
 def _run(
-    command,
+    run_command,
+    run_options,
     stderr,
     stdout,
     item_name,
@@ -531,7 +556,7 @@ def _run(
     process_timeout,
     sleep_before_start,
 ):
-    # type: (List[str], IO[Any], IO[Any], str, bool, int, int, str, Optional[int], int) -> Tuple[Union[subprocess.Popen[bytes], subprocess.Popen], Tuple[int, float]]
+    # type: (List[str], List[str], IO[Any], IO[Any], str, bool, int, int, str, Optional[int], int) -> Tuple[Union[subprocess.Popen[bytes], subprocess.Popen], Tuple[int, float]]
     timestamp = datetime.datetime.now()
     if sleep_before_start > 0:
         _write(
@@ -540,7 +565,10 @@ def _run(
         )
         time.sleep(sleep_before_start)
     timestamp = datetime.datetime.now()
-    cmd = " ".join(command)
+    command_name = run_command[-1].replace(" ", "_")
+    argfile_path = os.path.join(outs_dir, f"{command_name}_argfile.txt")
+    _write_internal_argument_file(run_options, filename=argfile_path)
+    cmd = ' '.join(run_command + ['-A'] + [argfile_path])
     if PY2:
         cmd = cmd.decode("utf-8").encode(SYSTEM_ENCODING)
     # avoid hitting https://bugs.python.org/issue10394
@@ -701,14 +729,14 @@ def _options_for_executor(
         if pabotLastLevel not in options["variable"]:
             options["variable"].append(pabotLastLevel)
     if argfile:
-        _modify_options_for_argfile_use(argfile, options, execution_item.top_name())
+        _modify_options_for_argfile_use(argfile, options)
         options["argumentfile"] = argfile
     if options.get("test", False) and options.get("include", []):
         del options["include"]
     return _set_terminal_coloring_options(options)
 
 
-def _modify_options_for_argfile_use(argfile, options, root_name):
+def _modify_options_for_argfile_use(argfile, options):
     argfile_opts, _ = ArgumentParser(
         USAGE,
         **_filter_argument_parser_options(
@@ -717,21 +745,23 @@ def _modify_options_for_argfile_use(argfile, options, root_name):
             env_options="ROBOT_OPTIONS",
         ),
     ).parse_args(["--argumentfile", argfile])
-    old_name = options.get("name", root_name)
     if argfile_opts["name"]:
         new_name = argfile_opts["name"]
-        _replace_base_name(new_name, old_name, options, "suite")
+        _replace_base_name(new_name, options, "suite")
         if not options["suite"]:
-            _replace_base_name(new_name, old_name, options, "test")
+            _replace_base_name(new_name, options, "test")
         if "name" in options:
             del options["name"]
 
 
-def _replace_base_name(new_name, old_name, options, key):
-    if isinstance(options.get(key, None), str):
-        options[key] = new_name + options[key][len(old_name) :]
+def _replace_base_name(new_name, options, key):
+    if isinstance(options.get(key), str):
+        options[key] = f"{new_name}.{options[key].split('.', 1)[1]}" if '.' in options[key] else new_name
     elif key in options:
-        options[key] = [new_name + s[len(old_name) :] for s in options.get(key, [])]
+        options[key] = [
+            f"{new_name}.{s.split('.', 1)[1]}" if '.' in s else new_name
+            for s in options.get(key, [])
+        ]
 
 
 def _set_terminal_coloring_options(options):
@@ -985,7 +1015,9 @@ def _levelsplit(
         tests = []  # type: List[ExecutionItem]
         for s in suites:
             tests.extend(s.tests)
-        return tests
+        # If there are no tests, it may be that --runemptysuite option is used, so fallback suites
+        if tests:
+            return tests
     return list(suites)
 
 
@@ -1449,20 +1481,42 @@ def _output_dir(options, cleanup=True):
     outputdir = options.get("outputdir", ".")
     outpath = os.path.join(outputdir, "pabot_results")
     if cleanup and os.path.isdir(outpath):
-        shutil.rmtree(outpath)
+        _rmtree_with_path(outpath)
     return outpath
 
 
-def _copy_output_artifacts(options, file_extensions=None, include_subfolders=False):
+def _rmtree_with_path(path):
+    """
+    Remove a directory tree and, if a PermissionError occurs,
+    re-raise it with the absolute path included in the message.
+    """
+    try:
+        shutil.rmtree(path)
+    except PermissionError as e:
+        abs_path = os.path.abspath(path)
+        raise PermissionError(f"Failed to delete path {abs_path}") from e
+
+
+def _get_timestamp_id(timestamp_str, add_timestamp):
+    # type: (str, bool) -> Optional[str]
+    if add_timestamp:
+        return str(datetime.datetime.strptime(timestamp_str, "%Y-%m-%d %H:%M:%S.%f").strftime("%Y%m%d_%H%M%S"))
+    return None
+
+
+def _copy_output_artifacts(options, timestamp_id=None, file_extensions=None, include_subfolders=False, index=None):
     file_extensions = file_extensions or ["png"]
     pabot_outputdir = _output_dir(options, cleanup=False)
     outputdir = options.get("outputdir", ".")
     copied_artifacts = []
-    for location, _, file_names in os.walk(pabot_outputdir):
+    one_run_outputdir = pabot_outputdir
+    if index:  # For argumentfileN option:
+        one_run_outputdir = os.path.join(pabot_outputdir, index)
+    for location, _, file_names in os.walk(one_run_outputdir):
         for file_name in file_names:
             file_ext = file_name.split(".")[-1]
             if file_ext in file_extensions:
-                rel_path = os.path.relpath(location, pabot_outputdir)
+                rel_path = os.path.relpath(location, one_run_outputdir)
                 prefix = rel_path.split(os.sep)[0]  # folders named "process-id"
                 dst_folder_path = outputdir
                 # if it is a file from sub-folders of "location"
@@ -1474,7 +1528,9 @@ def _copy_output_artifacts(options, file_extensions=None, include_subfolders=Fal
                     dst_folder_path = os.path.join(outputdir, subfolder_path)
                     if not os.path.isdir(dst_folder_path):
                         os.makedirs(dst_folder_path)
-                dst_file_name = "-".join([prefix, file_name])
+                dst_file_name_parts = [timestamp_id, index, prefix, file_name]
+                filtered_name = [str(p) for p in dst_file_name_parts if p is not None]
+                dst_file_name = "-".join(filtered_name)
                 shutil.copy2(
                     os.path.join(location, file_name),
                     os.path.join(dst_folder_path, dst_file_name),
@@ -1483,20 +1539,22 @@ def _copy_output_artifacts(options, file_extensions=None, include_subfolders=Fal
     return copied_artifacts
 
 
-def _check_pabot_results_for_missing_xml(base_dir):
+def _check_pabot_results_for_missing_xml(base_dir, command_name, output_xml_name):
     missing = []
     for root, dirs, _ in os.walk(base_dir):
         if root == base_dir:
             for subdir in dirs:
                 subdir_path = os.path.join(base_dir, subdir)
-                has_xml = any(fname.endswith('.xml') for fname in os.listdir(subdir_path))
+                has_xml = any(fname.endswith(output_xml_name) for fname in os.listdir(subdir_path))
                 if not has_xml:
-                    missing.append(os.path.join(subdir_path, 'robot_stderr.out'))
+                    command_name = command_name.replace(" ", "_")
+                    missing.append(os.path.join(subdir_path, f'{command_name}_stderr.out'))
             break
     return missing
 
 
 def _report_results(outs_dir, pabot_args, options, start_time_string, tests_root_name):
+    output_xml_name = options.get("output") or "output.xml"
     if "pythonpath" in options:
         del options["pythonpath"]
     if ROBOT_VERSION < "4.0":
@@ -1516,7 +1574,7 @@ def _report_results(outs_dir, pabot_args, options, start_time_string, tests_root
         outputs = []  # type: List[str]
         for index, _ in pabot_args["argumentfiles"]:
             copied_artifacts = _copy_output_artifacts(
-                options, pabot_args["artifacts"], pabot_args["artifactsinsubfolders"]
+                options, _get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"]), pabot_args["artifacts"], pabot_args["artifactsinsubfolders"], index
             )
             outputs += [
                 _merge_one_run(
@@ -1525,10 +1583,11 @@ def _report_results(outs_dir, pabot_args, options, start_time_string, tests_root
                     tests_root_name,
                     stats,
                     copied_artifacts,
+                    timestamp_id=_get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"]),
                     outputfile=os.path.join("pabot_results", "output%s.xml" % index),
                 )
             ]
-            missing_outputs.extend(_check_pabot_results_for_missing_xml(os.path.join(outs_dir, index)))
+            missing_outputs.extend(_check_pabot_results_for_missing_xml(os.path.join(outs_dir, index), pabot_args.get('command')[-1], output_xml_name))
         if "output" not in options:
             options["output"] = "output.xml"
         _write_stats(stats)
@@ -1537,7 +1596,7 @@ def _report_results(outs_dir, pabot_args, options, start_time_string, tests_root
         exit_code = _report_results_for_one_run(
             outs_dir, pabot_args, options, start_time_string, tests_root_name, stats
         )
-        missing_outputs.extend(_check_pabot_results_for_missing_xml(outs_dir))
+        missing_outputs.extend(_check_pabot_results_for_missing_xml(outs_dir, pabot_args.get('command')[-1], output_xml_name))
     if missing_outputs:
         _write(("[ " + _wrap_with(Color.YELLOW, 'WARNING') + " ] "
                 "One or more subprocesses encountered an error and the "
@@ -1574,11 +1633,12 @@ def _write_stats(stats):
 def _report_results_for_one_run(
     outs_dir, pabot_args, options, start_time_string, tests_root_name, stats
 ):
+    _write(pabot_args)
     copied_artifacts = _copy_output_artifacts(
-        options, pabot_args["artifacts"], pabot_args["artifactsinsubfolders"]
+        options, _get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"]), pabot_args["artifacts"], pabot_args["artifactsinsubfolders"]
     )
     output_path = _merge_one_run(
-        outs_dir, options, tests_root_name, stats, copied_artifacts
+        outs_dir, options, tests_root_name, stats, copied_artifacts, _get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"])
     )
     _write_stats(stats)
     if (
@@ -1597,13 +1657,14 @@ def _report_results_for_one_run(
 
 
 def _merge_one_run(
-    outs_dir, options, tests_root_name, stats, copied_artifacts, outputfile=None
+    outs_dir, options, tests_root_name, stats, copied_artifacts, timestamp_id, outputfile=None
 ):
     outputfile = outputfile or options.get("output", "output.xml")
     output_path = os.path.abspath(
         os.path.join(options.get("outputdir", "."), outputfile)
     )
-    files = natsorted(glob(os.path.join(_glob_escape(outs_dir), "**/*.xml")))
+    filename = options.get("output") or "output.xml"
+    files = natsorted(glob(os.path.join(_glob_escape(outs_dir), f"**/*{filename}"), recursive=True))
     if not files:
         _write('WARN: No output files in "%s"' % outs_dir, Color.YELLOW)
         return ""
@@ -1615,7 +1676,7 @@ def _merge_one_run(
     if PY2:
         files = [f.decode(SYSTEM_ENCODING) if not is_unicode(f) else f for f in files]
     resu = merge(
-        files, options, tests_root_name, copied_artifacts, invalid_xml_callback
+        files, options, tests_root_name, copied_artifacts, timestamp_id, invalid_xml_callback
     )
     _update_stats(resu, stats)
     if ROBOT_VERSION >= "7.0" and options.get("legacyoutput"):
@@ -1689,9 +1750,19 @@ def _stop_message_writer():
     MESSAGE_QUEUE.join()
 
 
-def _get_free_port(pabot_args):
-    if pabot_args["pabotlibport"] != 0:
-        return pabot_args["pabotlibport"]
+def _is_port_available(port):
+    """Check if a given port on localhost is available."""
+    with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
+        try:
+            s.bind(("localhost", port))
+            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            return True
+        except OSError:
+            return False
+
+
+def _get_free_port():
+    """Return a free TCP port on localhost."""
     with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
         s.bind(("localhost", 0))
         s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
@@ -1700,29 +1771,43 @@ def _get_free_port(pabot_args):
 
 def _start_remote_library(pabot_args):  # type: (dict) -> Optional[subprocess.Popen]
     global _PABOTLIBURI
-    free_port = _get_free_port(pabot_args)
-    _PABOTLIBURI = "%s:%s" % (pabot_args["pabotlibhost"], free_port)
-    if not pabot_args["pabotlib"]:
+    # If pabotlib is not enabled, do nothing
+    if not pabot_args.get("pabotlib"):
         return None
-    if pabot_args.get("resourcefile") and not os.path.exists(
-        pabot_args["resourcefile"]
-    ):
+
+    host = pabot_args.get("pabotlibhost", "127.0.0.1")
+    port = pabot_args.get("pabotlibport", 8270)
+
+    # If host is default and user specified a non-zero port, check if it's available
+    if host == "127.0.0.1" and port != 0 and not _is_port_available(port):
+        _write(
+            f"Warning: specified pabotlibport {port} is already in use. "
+            "A free port will be assigned automatically.",
+            Color.YELLOW,
+        )
+        port = _get_free_port()
+
+    # If host is default and port = 0, assign a free port
+    if host == "127.0.0.1" and port == 0:
+        port = _get_free_port()
+
+    _PABOTLIBURI = f"{host}:{port}"
+    resourcefile = pabot_args.get("resourcefile") or ""
+    if resourcefile and not os.path.exists(resourcefile):
         _write(
             "Warning: specified resource file doesn't exist."
             " Some tests may fail or continue forever.",
             Color.YELLOW,
         )
-        pabot_args["resourcefile"] = None
-    return subprocess.Popen(
-        '"{python}" -m {pabotlibname} {resourcefile} {pabotlibhost} {pabotlibport}'.format(
-            python=sys.executable,
-            pabotlibname=pabotlib.__name__,
-            resourcefile=pabot_args.get("resourcefile"),
-            pabotlibhost=pabot_args["pabotlibhost"],
-            pabotlibport=free_port,
-        ),
-        shell=True,
-    )
+        resourcefile = ""
+    cmd = [
+        sys.executable,
+        "-m", pabotlib.__name__,
+        resourcefile,
+        pabot_args["pabotlibhost"],
+        str(port),
+    ]
+    return subprocess.Popen(cmd)
 
 
 def _stop_remote_library(process):  # type: (subprocess.Popen) -> None
@@ -2122,10 +2207,11 @@ def _parse_ordering(filename):  # type: (str) -> List[ExecutionItem]
         raise DataError("Error parsing ordering file '%s'" % filename)
 
 
-# TODO: After issue #646, it seems necessary to thoroughly rethink how this functionality should work.
 def _check_ordering(ordering_file, suite_names):  # type: (List[ExecutionItem], List[ExecutionItem]) -> None
     list_of_suite_names = [s.name for s in suite_names]
     skipped_runnable_items = []
+    suite_and_test_names = []
+    duplicates = []
     if ordering_file:
         for item in ordering_file:
             if item.type in ['suite', 'test']:
@@ -2135,10 +2221,17 @@ def _check_ordering(ordering_file, suite_names):  # type: (List[ExecutionItem],
                     # the --suite option, and the given name is part of the full name of any test or suite.
                     if item.name != ' Invalid' and not (item.type == 'suite' and any((s == item.name or s.startswith(item.name + ".")) for s in list_of_suite_names)):
                         skipped_runnable_items.append(f"{item.type.title()} item: '{item.name}'")
+                if item.name in suite_and_test_names:
+                    duplicates.append(f"{item.type.title()} item: '{item.name}'")
+                suite_and_test_names.append(item.name)
     if skipped_runnable_items:
         _write("Note: The ordering file contains test or suite items that are not included in the current test run. The following items will be ignored/skipped:")
         for item in skipped_runnable_items:
             _write(f"  - {item}")
+    if duplicates:
+        _write("Note: The ordering file contains duplicate suite or test items. Only the first occurrence is taken into account. These are duplicates:")
+        for item in duplicates:
+            _write(f"  - {item}")
 
 
 def _group_suites(outs_dir, datasources, options, pabot_args):
@@ -2147,8 +2240,15 @@ def _group_suites(outs_dir, datasources, options, pabot_args):
     ordering_arg = _parse_ordering(pabot_args.get("ordering")) if (pabot_args.get("ordering")) is not None else None
     if ordering_arg:
         _verify_depends(ordering_arg)
-        # TODO: After issue #646, it seems necessary to thoroughly rethink how this functionality should work.
-        #_check_ordering(ordering_arg, suite_names)
+        if options.get("name"):
+            ordering_arg = _update_ordering_names(ordering_arg, options['name'])
+        _check_ordering(ordering_arg, suite_names)
+    if pabot_args.get("testlevelsplit") and ordering_arg and any(item.type == 'suite' for item in ordering_arg):
+        reduced_suite_names = _reduce_items(suite_names, ordering_arg)
+        if options.get("runemptysuite") and not reduced_suite_names:
+            return [suite_names]
+        if reduced_suite_names:
+            suite_names = reduced_suite_names
     ordering_arg_with_sleep = _set_sleep_times(ordering_arg)
     ordered_suites = _preserve_order(suite_names, ordering_arg_with_sleep)
     shard_suites = solve_shard_suites(ordered_suites, pabot_args)
@@ -2161,6 +2261,58 @@ def _group_suites(outs_dir, datasources, options, pabot_args):
     return grouped_by_depend
 
 
+def _update_ordering_names(ordering, new_top_name):
+    # type: (List[ExecutionItem], str) -> List[ExecutionItem]
+    output = []
+    for item in ordering:
+        if item.type in ['suite', 'test']:
+            splitted_name = item.name.split('.')
+            splitted_name[0] = new_top_name
+            item.name = '.'.join(splitted_name)
+        output.append(item)
+    return output
+
+
+def _reduce_items(items, selected_suites):
+    # type: (List[ExecutionItem], List[ExecutionItem]) -> List[ExecutionItem]
+    """
+    Reduce a list of test items by replacing covered test cases with suite items from selected_suites.
+    Raises DataError if:
+    - Any test is covered by more than one selected suite.
+    """
+    reduced = []
+    suite_coverage = {}
+    test_to_suite = {}
+
+    for suite in selected_suites:
+        if suite.type == 'suite':
+            suite_name = str(suite.name)
+            covered_tests = [
+                item for item in items
+                if item.type == "test" and str(item.name).startswith(suite_name + ".")
+            ]
+
+            if covered_tests:
+                for test in covered_tests:
+                    test_name = str(test.name)
+                    if test_name in test_to_suite:
+                        raise DataError(
+                            f"Invalid test configuration: Test '{test_name}' is matched by multiple suites: "
+                            f"'{test_to_suite[test_name]}' and '{suite_name}'."
+                        )
+                    test_to_suite[test_name] = suite_name
+
+                suite_coverage[suite_name] = set(str(t.name) for t in covered_tests)
+                reduced.append(suite)
+
+    # Add tests not covered by any suite
+    for item in items:
+        if item.type == "test" and str(item.name) not in test_to_suite:
+            reduced.append(item)
+
+    return reduced
+
+
 def _set_sleep_times(ordering_arg):
     # type: (List[ExecutionItem]) -> List[ExecutionItem]
     set_sleep_value = 0
@@ -2227,23 +2379,11 @@ def _verify_depends(suite_names):
         )
 
 
-def _group_by_depend(suite_names):
-    # type: (List[ExecutionItem]) -> List[List[ExecutionItem]]
-    group_items = list(filter(lambda suite: isinstance(suite, GroupItem), suite_names))
-    runnable_suites = list(
-        filter(lambda suite: isinstance(suite, RunnableItem), suite_names)
-    )
-    dependency_tree = create_dependency_tree(runnable_suites)
-    # Since groups cannot depend on others, they are placed at the beginning.
-    dependency_tree[0][0:0] = group_items
-    return dependency_tree
-
-
 def _all_grouped_suites_by_depend(grouped_suites):
     # type: (List[List[ExecutionItem]]) -> List[List[ExecutionItem]]
     grouped_by_depend = []
     for group_suite in grouped_suites:  # These groups are divided by #WAIT
-        grouped_by_depend.extend(_group_by_depend(group_suite))
+        grouped_by_depend.extend(create_dependency_tree(group_suite))
     return grouped_by_depend
 
 

pabot/pabotlib.py

@@ -60,7 +60,7 @@ class _PabotLib(object):
         self, resourcefile
     ):  # type: (Optional[str]) -> Dict[str, Dict[str, Any]]
         vals = {}  # type: Dict[str, Dict[str, Any]]
-        if resourcefile is None:
+        if not resourcefile:
             return vals
         conf = configparser.ConfigParser()
         conf.read(resourcefile)

pabot/result_merger.py

@@ -35,7 +35,7 @@ from robot.model import SuiteVisitor
 
 
 class ResultMerger(SuiteVisitor):
-    def __init__(self, result, tests_root_name, out_dir, copied_artifacts, legacy_output):
+    def __init__(self, result, tests_root_name, out_dir, copied_artifacts, timestamp_id, legacy_output):
         self.root = result.suite
         self.errors = result.errors
         self.current = None
@@ -44,6 +44,7 @@ class ResultMerger(SuiteVisitor):
         self._prefix = ""
         self._out_dir = out_dir
         self.legacy_output = legacy_output
+        self.timestamp_id = timestamp_id
 
         self._patterns = []
         regexp_template = (
@@ -65,7 +66,7 @@ class ResultMerger(SuiteVisitor):
             raise
 
     def _set_prefix(self, source):
-        self._prefix = prefix(source)
+        self._prefix = prefix(source, self.timestamp_id)
 
     def start_suite(self, suite):
         if self._skip_until and self._skip_until != suite:
@@ -194,9 +195,19 @@ class ResultsCombiner(CombinedResult):
         self.errors.add(other.errors)
 
 
-def prefix(source):
+def prefix(source, timestamp_id):
     try:
-        return os.path.split(os.path.dirname(source))[1]
+        path_without_id, id = os.path.split(os.path.dirname(source))
+        if not id:
+            return ""
+        if os.path.split(path_without_id)[1] == 'pabot_results':
+            return "-".join([str(p) for p in [timestamp_id, id] if p is not None])
+        else:
+            # --argumentfileN in use: (there should be one subdir level more)
+            _, index = os.path.split(path_without_id)
+            if not index:
+                return ""
+            return "-".join([str(p) for p in [timestamp_id, index, id] if p is not None])
     except:
         return ""
 
@@ -225,6 +236,7 @@ def merge_groups(
     invalid_xml_callback,
     out_dir,
     copied_artifacts,
+    timestamp_id,
     legacy_output
 ):
     merged = []
@@ -232,7 +244,7 @@ def merge_groups(
         results, critical_tags, non_critical_tags, invalid_xml_callback
     ).values():
         base = group[0]
-        merger = ResultMerger(base, tests_root_name, out_dir, copied_artifacts, legacy_output)
+        merger = ResultMerger(base, tests_root_name, out_dir, copied_artifacts, timestamp_id, legacy_output)
         for out in group:
             merger.merge(out)
         merged.append(base)
@@ -244,6 +256,7 @@ def merge(
     rebot_options,
     tests_root_name,
     copied_artifacts,
+    timestamp_id,
     invalid_xml_callback=None,
 ):
     assert len(result_files) > 0
@@ -263,6 +276,7 @@ def merge(
         invalid_xml_callback,
         settings.output_directory,
         copied_artifacts,
+        timestamp_id,
         rebot_options.get('legacyoutput')
     )
     if len(merged) == 1:

{robotframework_pabot-4.3.2.dist-info → robotframework_pabot-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-pabot
-Version: 4.3.2
+Version: 5.1.0
 Summary: Parallel test runner for Robot Framework
 Home-page: https://pabot.org
 Download-URL: https://pypi.python.org/pypi/robotframework-pabot
@@ -39,6 +39,22 @@ A parallel executor for [Robot Framework](http://www.robotframework.org) tests.
 
 [![Pabot presentation at robocon.io 2018](http://img.youtube.com/vi/i0RV6SJSIn8/0.jpg)](https://youtu.be/i0RV6SJSIn8 "Pabot presentation at robocon.io 2018")
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Basic use](#basic-use)
+- [Contact](#contact)
+- [Contributing](#contributing-to-the-project)
+- [Command-line options](#command-line-options)
+- [PabotLib](#pabotlib)
+- [Controlling execution order](#controlling-execution-order-and-level-of-parallelism)
+- [Programmatic use](#programmatic-use)
+- [Global variables](#global-variables)
+- [Output Files Generated by Pabot](#output-files-generated-by-pabot)
+- [Artifacts Handling and Parallel Execution Notes](#artifacts-handling-and-parallel-execution-notes)
+
+----
+
 ## Installation:
 
 From PyPi:
@@ -83,7 +99,16 @@ There are several ways you can help in improving this tool:
    - Contribute by programming and making a pull request (easiest way is to work on an issue from the issue tracker)
 
 ## Command-line options
+<!-- NOTE: 
+The sections inside these docstring markers are also used in Pabot's --help output.
+Currently, the following transformations are applied:
+- Remove Markdown links but keep the text
+- Remove ** and backticks `
+
+If you modify this part, make sure the Markdown section still looks clean and readable in the --help output.  -->
+
 <!-- START DOCSTRING -->
+```
 pabot [--verbose|--testlevelsplit|--command .. --end-command|
         --processes num|--no-pabotlib|--pabotlibhost host|--pabotlibport port|
         --processtimeout num|
@@ -95,52 +120,60 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
         --no-rebot|
         --help|--version]
       [robot options] [path ...]
+```
 
 PabotLib remote server is started by default to enable locking and resource distribution between parallel test executions.
 
 Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#all-command-line-options) and also following pabot options:
 
---verbose     
+**--verbose**     
   More output from the parallel execution.
 
---testlevelsplit          
+**--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.
 
---command [ACTUAL COMMANDS TO START ROBOT EXECUTOR] --end-command    
+**--command [ACTUAL COMMANDS TO START ROBOT EXECUTOR] --end-command**    
   RF script for situations where robot is not used directly.
 
---processes [NUMBER OF PROCESSES]          
+**--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.
 
---no-pabotlib  
+**--no-pabotlib**  
   Disable the PabotLib remote server if you don't need locking or resource distribution features.
 
---pabotlibhost [HOSTNAME]          
+**--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 server can be also started and executed separately from pabot instances:
+  The remote server can also be started and executed separately from pabot instances:
   
       python -m pabot.pabotlib <path_to_resourcefile> <host> <port>
       python -m pabot.pabotlib resource.txt 192.168.1.123 8271
   
   This enables sharing a resource with multiple Robot Framework instances.
 
---pabotlibport [PORT]          
+  Additional details:
+  - The default value for --pabotlibhost is 127.0.0.1.
+  - If you provide a hostname other than 127.0.0.1, the local PabotLib server startup is automatically disabled.
+
+**--pabotlibport [PORT]**          
   Port number of the PabotLib remote server (default is 8270). See --pabotlibhost for more information.
 
---processtimeout [TIMEOUT]          
+  Behavior with port and host settings:
+  - If you set the port value to 0 and --pabotlibhost is 127.0.0.1 (default), a free port on localhost will be assigned automatically.
+
+**--processtimeout [TIMEOUT]**          
   Maximum time in seconds to wait for a process before killing it. If not set, there's no timeout.
 
---shard [INDEX]/[TOTAL]   
+**--shard [INDEX]/[TOTAL]**   
   Optionally split execution into smaller pieces. This can be used for distributing testing to multiple machines.
   
---artifacts [FILE EXTENSIONS]   
+**--artifacts [FILE EXTENSIONS]**   
   List of file extensions (comma separated). Defines which files (screenshots, videos etc.) from separate reporting 
   directories would be copied and included in a final report. Possible links to copied files in RF log would be updated 
   (only relative paths supported). The default value is `png`.
@@ -149,49 +182,51 @@ Supports all [Robot Framework command line options](https://robotframework.org/r
 
      --artifacts png,mp4,txt
 
---artifactsinsubfolders   
+  The artifact naming conventions are described in the README.md section: [Output Files Generated by Pabot](#output-files-generated-by-pabot).
+
+**--artifactsinsubfolders**   
   Copy artifacts located not only directly in the RF output dir, but also in it's sub-folders.
 
---resourcefile [FILEPATH]          
+**--resourcefile [FILEPATH]**          
   Indicator for a file that can contain shared variables for distributing resources. This needs to be used together with 
   pabotlib option. Resource file syntax is same as Windows ini files. Where a section is a shared set of variables.
 
---argumentfile[INTEGER] [FILEPATH]          
+**--argumentfile[INTEGER] [FILEPATH]**          
   Run same suites with multiple [argumentfile](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#argument-files) options.
 
   For example:
 
      --argumentfile1 arg1.txt --argumentfile2 arg2.txt
 
---suitesfrom [FILEPATH TO OUTPUTXML]          
+**--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.
 
---ordering [FILE PATH]   
+**--ordering [FILE PATH]**   
   Optionally give execution order from a file.
 
---chunk   
+**--chunk**   
   Optionally chunk tests to PROCESSES number of robot runs. This can save time because all the suites will share the same 
   setups and teardowns.
 
---pabotprerunmodifier [PRERUNMODIFIER MODULE OR CLASS]   
+**--pabotprerunmodifier [PRERUNMODIFIER MODULE OR CLASS]**   
   Like Robot Framework's --prerunmodifier, but executed only once in the pabot's main process after all other 
   --prerunmodifiers. But unlike the regular --prerunmodifier command, --pabotprerunmodifier is not executed again in each 
   pabot subprocesses. Depending on the intended use, this may be desirable as well as more efficient. Can be used, for 
   example, to modify the list of tests to be performed.
 
---no-rebot    
+**--no-rebot**    
   If specified, the tests will execute as usual, but Rebot will not be called to merge the logs. This option is designed 
   for scenarios where Rebot should be run later due to large log files, ensuring better memory and resource availability. 
   Subprocess results are stored in the pabot_results folder.
 
---help             
+**--help**             
   Print usage instructions.
  
---version                
+**--version**                
   Print version information.
 
-Example usages:
+**Example usages:**
 
      pabot test_directory
      pabot --exclude FOO directory_to_tests
@@ -271,11 +306,24 @@ Note: The `--ordering` file is intended only for defining the execution order of
 There different possibilities to influence the execution:
 
   * The order of suites can be changed.
-  * If a directory (or a directory structure) should be executed sequentially, add the directory suite name to a row as a ```--suite``` option.
-  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-the-name) you can also give partial suite name without the base suite.
+  * If a directory (or a directory structure) should be executed sequentially, add the directory suite name to a row as a ```--suite``` option. This usage is also supported when `--testlevelsplit` is enabled. As an alternative to using `--suite` options, you can also group tests into sequential batches using `{}` braces. (See below for details.) Note that if multiple `--suite` options are used, they must not reference the same test case. This means you cannot specify both parent and child suite names at the same time. For instance:
+
+```
+--suite Top Suite.Sub Suite
+--suite Top Suite
+```
+
+  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-the-name) you can use either the new or old full test path. For example:
+
+```
+--test New Suite Name.Sub Suite.Test 1
+OR
+--test Old Suite Name.Sub Suite.Test 1
+```
+
   * You can add a line with text `#WAIT` to force executor to wait until all previous suites have been executed.
   * You can group suites and tests together to same executor process by adding line `{` before the group and `}` after. Note that `#WAIT` cannot be used inside a group.
-  * You can introduce dependencies using the word `#DEPENDS` after a test declaration. This keyword can be used several times if it is necessary to refer to several different tests. Please take care that in case of circular dependencies an exception will be thrown. Note that each `#WAIT` splits suites into separate execution blocks, and it's not possible to define dependencies for suites or tests that are inside another `#WAIT` block or inside another `{}` brackets.
+  * You can introduce dependencies using the word `#DEPENDS` after a test declaration. This keyword can be used several times if it is necessary to refer to several different tests. The ordering algorithm is designed to preserve the exact user-defined order as closely as possible. However, if a test's execution dependencies are not yet satisfied, the test is postponed and moved to the earliest possible stage where all its dependencies are fulfilled. Please take care that in case of circular dependencies an exception will be thrown. Note that each `#WAIT` splits suites into separate execution blocks, and it's not possible to define dependencies for suites or tests that are inside another `#WAIT` block or inside another `{}` braces.
   * Note: Within a group `{}`, neither execution order nor the `#DEPENDS` keyword currently works. This is due to limitations in Robot Framework, which is invoked within Pabot subprocesses. These limitations may be addressed in a future release of Robot Framework. For now, tests or suites within a group will be executed in the order Robot Framework discovers them — typically in alphabetical order.
   * An example could be:
 
@@ -369,4 +417,74 @@ Pabot will insert following global variables to Robot Framework namespace. These
       PABOTEXECUTIONPOOLID - this contains the pool id (an integer) for the current Robot Framework executor. This is helpful for example when visualizing the execution flow from your own listener.
       PABOTNUMBEROFPROCESSES - max number of concurrent processes that pabot may use in execution.
       CALLER_ID - a universally unique identifier for this execution.
- 
+
+
+### Output Files Generated by Pabot
+
+Pabot generates several output files and folders during execution, both for internal use and for analysis purposes.
+
+#### Internal File: `.pabotsuitenames`
+
+Pabot creates a `.pabotsuitenames` file in the working directory. This is an internal hash file used to speed up execution in certain scenarios.  
+This file can also be used as a base for the `--ordering` file as described earlier. Although technically it can be modified, it will be overwritten during the next execution.  
+Therefore, it is **recommended** to maintain a separate file for the `--ordering` option if needed.
+
+#### Output Directory Structure
+
+In addition to the standard `log.html`, `report.html`, and `output.xml` files, the specified `--outputdir` will contain:
+
+- A folder named `pabot_results`, and  
+- All defined artifacts (default: `.png` files)  
+- Optionally, artifacts from subfolders if `--artifactsinsubfolders` is used
+
+Artifacts are **copied** into the output directory and renamed with the following structure:
+
+```
+TIMESTAMP-ARGUMENT_INDEX-PABOTQUEUEINDEX
+```
+
+If you use the special option `notimestamps` at the end of the `--artifacts` command, (For example:  `--artifacts png,txt,notimestamps`) the timestamp part will be omitted, and the name will be in the format: 
+
+```
+ARGUMENT_INDEX-PABOTQUEUEINDEX
+```
+
+- **TIMESTAMP** = Time of `pabot` command invocation (not the screenshot's actual timestamp), format: `YYYYmmdd_HHMMSS`
+- **ARGUMENT_INDEX** = Optional index number, only used if `--argumentfileN` options are given
+- **PABOTQUEUEINDEX** = Process queue index (see section [Global Variables](#global-variables))
+
+#### `pabot_results` Folder Structure
+
+The structure of the `pabot_results` folder is as follows:
+
+```
+pabot_results/
+├── [N]/                     # Optional: N = argument file index (if --argumentfileN is used)
+│   └── PABOTQUEUEINDEX/     # One per subprocess
+│       ├── output.xml
+│       ├── robot_argfile.txt
+│       ├── robot_stdout.out
+│       ├── robot_stderr.out
+│       └── artifacts...
+```
+
+Each `PABOTQUEUEINDEX` folder contains as default:
+
+- `robot_argfile.txt` – Arguments used in that subprocess
+- `robot_stdout.out` and `robot_stderr.out` – Stdout and stderr of the subprocess
+- `output.xml` – The partial output file to be merged later
+- Artifacts – Screenshots or other files copied from subprocess folders
+
+> **Note:** The entire `pabot_results` folder is considered temporary and will be **deleted/overwritten** on the next `pabot` run using the same `--outputdir`.
+
+
+### Artifacts Handling and Parallel Execution Notes
+
+Due to parallel execution, artifacts like screenshots should ideally be:
+
+- Embedded directly into the XML using tools like [SeleniumLibrary](https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html#Set%20Screenshot%20Directory) with the `EMBED` option  
+  _Example:_  
+  `Library  SeleniumLibrary  screenshot_root_directory=EMBED`
+- Or saved to the subprocess’s working directory (usually default behavior), ensuring separation across processes
+
+If you manually specify a shared screenshot directory in your test code, **all processes will write to it concurrently**, which may cause issues such as overwriting or missing files if screenshots are taken simultaneously.

{robotframework_pabot-4.3.2.dist-info → robotframework_pabot-5.1.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 pabot/SharedLibrary.py,sha256=mIipGs3ZhKYEakKprcbrMI4P_Un6qI8gE7086xpHaLY,2552
-pabot/__init__.py,sha256=h6cCOibZvyBUm_rgLAWdrpXF7RiLsoI65Y3VqVm_WrM,200
-pabot/arguments.py,sha256=m38y8mXKJ5BHlxSrsEI0gXlkzR5hv88G9i-FL_BouQ4,9168
+pabot/__init__.py,sha256=0g7UY0dKCwXzo3sH_STKWVLBEVtZnj96gmuak8fdlf0,200
+pabot/arguments.py,sha256=M1T2QAA0v2BO1bbryLC82RIA0VZZaEGfXnQiXfNcHOU,9577
 pabot/clientwrapper.py,sha256=yz7battGs0exysnDeLDWJuzpb2Q-qSjitwxZMO2TlJw,231
 pabot/coordinatorwrapper.py,sha256=nQQ7IowD6c246y8y9nsx0HZbt8vS2XODhPVDjm-lyi0,195
-pabot/execution_items.py,sha256=HCd54LsIEZJjnL0TZC_tuac2DSVL4JHes6veJlpCE94,12058
-pabot/pabot.py,sha256=zRhp1bgvXmMpB1H8DU-Y0rMGsZ8Z_oTkOsXDZv_qrGU,75356
-pabot/pabotlib.py,sha256=FRZKaKy1ybyRkE-0SpaCsUWzxZAzNNU5dAywSm1QoPk,22324
-pabot/result_merger.py,sha256=8iIptBn5MdgiW-OdhwVR2DZ0hUYuQeQXwIHAEPkMTuw,9095
+pabot/execution_items.py,sha256=zDVGW0AAeVbM-scC3Yui2TxvIPx1wYyFKHTPU2BkJkY,13329
+pabot/pabot.py,sha256=wxkCGUzvibj7Jtdqhuyzo7F5k5xOPgVXICWZXbt7cn8,81246
+pabot/pabotlib.py,sha256=vHbqV7L7mIvDzXBh9UcdULrwhBHNn70EDXF_31MNFO4,22320
+pabot/result_merger.py,sha256=g4mm-BhhMK57Z6j6dpvfL5El1g5onOtfV4RByNrO8g0,9744
 pabot/robotremoteserver.py,sha256=L3O2QRKSGSE4ux5M1ip5XJMaelqaxQWJxd9wLLdtpzM,22272
 pabot/workerwrapper.py,sha256=BdELUVDs5BmEkdNBcYTlnP22Cj0tUpZEunYQMAKyKWU,185
 pabot/py3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -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.3.2.dist-info/licenses/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-robotframework_pabot-4.3.2.dist-info/METADATA,sha256=T30IE6XvBzbaKaEQl9YenlrkWTGNOnB8iqWGUsw3CSE,16417
-robotframework_pabot-4.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-robotframework_pabot-4.3.2.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
-robotframework_pabot-4.3.2.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
-robotframework_pabot-4.3.2.dist-info/RECORD,,
+robotframework_pabot-5.1.0.dist-info/licenses/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+robotframework_pabot-5.1.0.dist-info/METADATA,sha256=-3nvXfoJrNCoqf6XVZccsiGhqiU8quQWI3cGk_RV0hY,22070
+robotframework_pabot-5.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+robotframework_pabot-5.1.0.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
+robotframework_pabot-5.1.0.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
+robotframework_pabot-5.1.0.dist-info/RECORD,,