robotframework-pabot 5.0.0__tar.gz → 5.1.0__tar.gz

{robotframework_pabot-5.0.0/src/robotframework_pabot.egg-info → robotframework_pabot-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-pabot
-Version: 5.0.0
+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
@@ -99,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|
@@ -111,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`.
@@ -165,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
@@ -424,6 +443,12 @@ Artifacts are **copied** into the output directory and renamed with the followin
 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))

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/README.md

@@ -73,7 +73,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|
@@ -85,52 +94,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`.
@@ -139,49 +156,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
@@ -398,6 +417,12 @@ Artifacts are **copied** into the output directory and renamed with the followin
 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))

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/src/pabot/__init__.py

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

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/src/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

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/src/pabot/pabot.py

@@ -194,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()
 
@@ -354,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(
@@ -750,10 +755,13 @@ def _modify_options_for_argfile_use(argfile, options):
 
 
 def _replace_base_name(new_name, options, key):
-    if isinstance(options.get(key, None), str):
-        options[key] = new_name + '.' + options[key].split('.', 1)[1]
+    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.split('.', 1)[1] 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):
@@ -1473,15 +1481,30 @@ 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 _get_timestamp_id(timestamp_str):
-    return datetime.datetime.strptime(timestamp_str, "%Y-%m-%d %H:%M:%S.%f").strftime("%Y%m%d_%H%M%S")
+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, file_extensions=None, include_subfolders=False, index=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", ".")
@@ -1505,9 +1528,9 @@ def _copy_output_artifacts(options, timestamp_id, file_extensions=None, include_
                     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([timestamp_id, prefix, file_name])
-                if index:
-                    dst_file_name = "-".join([timestamp_id, index, 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),
@@ -1551,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, _get_timestamp_id(start_time_string), pabot_args["artifacts"], pabot_args["artifactsinsubfolders"], index
+                options, _get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"]), pabot_args["artifacts"], pabot_args["artifactsinsubfolders"], index
             )
             outputs += [
                 _merge_one_run(
@@ -1560,7 +1583,7 @@ 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),
+                    timestamp_id=_get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"]),
                     outputfile=os.path.join("pabot_results", "output%s.xml" % index),
                 )
             ]
@@ -1610,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, _get_timestamp_id(start_time_string), 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, _get_timestamp_id(start_time_string)
+        outs_dir, options, tests_root_name, stats, copied_artifacts, _get_timestamp_id(start_time_string, pabot_args["artifactstimestamps"])
     )
     _write_stats(stats)
     if (
@@ -1726,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)
@@ -1737,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

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/src/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)

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/src/pabot/result_merger.py

@@ -201,13 +201,13 @@ def prefix(source, timestamp_id):
         if not id:
             return ""
         if os.path.split(path_without_id)[1] == 'pabot_results':
-            return "-".join([timestamp_id, id])
+            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([timestamp_id, index, id])
+            return "-".join([str(p) for p in [timestamp_id, index, id] if p is not None])
     except:
         return ""
 

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0/src/robotframework_pabot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-pabot
-Version: 5.0.0
+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
@@ -99,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|
@@ -111,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`.
@@ -165,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
@@ -424,6 +443,12 @@ Artifacts are **copied** into the output directory and renamed with the followin
 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))

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/tests/test_missing_subprocess_output.py

@@ -78,6 +78,7 @@ Testing 3
             'processes': 3, 
             'processtimeout': None, 
             'artifacts': ['png'], 
+            "artifactstimestamps": True,
             'artifactsinsubfolders': False, 
             'shardindex': 0, 
             'shardcount': 1, 

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/tests/test_pabot.py

@@ -1208,6 +1208,40 @@ class PabotTests(unittest.TestCase):
                 "file copied wrongly: {}".format(f),
             )
 
+    def test_copy_output_artifacts_direct_screenshots_only_without_timestamps(self):
+        out_dir = os.path.join(
+            os.path.abspath(os.path.dirname(__file__)),
+            "outputs/outputs_with_artifacts/out_dir",
+        )
+        _opts = {"outputdir": out_dir}
+        test_time_id = None
+        pabot._copy_output_artifacts(options=_opts, timestamp_id=test_time_id)
+        files_should_be_copied = [
+            "0-fake_screenshot_root.png",
+            "1-fake_screenshot_root.png",
+        ]
+
+        for f in files_should_be_copied:
+            file_path = os.path.join(_opts["outputdir"], f)
+            self.assertTrue(os.path.isfile(file_path), "file not copied: {}".format(f))
+            os.remove(file_path)  # clean up
+
+        files_should_not_be_copied = [
+            "screenshots/0-fake_screenshot_subfolder_1.png",
+            "screenshots/0-fake_screenshot_subfolder_2.png"
+            "screenshots/1-fake_screenshot_subfolder_1.png",
+            "screenshots/2-fake_screenshot_subfolder_2.png",
+            "other_artifacts/0-some_artifact.foo",
+            "other_artifacts/0-another_artifact.bar",
+            "other_artifacts/1-some_artifact.foo",
+            "other_artifacts/1-another_artifact.bar",
+        ]
+        for f in files_should_not_be_copied:
+            self.assertFalse(
+                os.path.isfile(os.path.join(_opts["outputdir"], f)),
+                "file copied wrongly: {}".format(f),
+            )
+
     def test_copy_output_artifacts_include_subfolders(self):
         out_dir = os.path.join(
             os.path.abspath(os.path.dirname(__file__)),

{robotframework_pabot-5.0.0 → robotframework_pabot-5.1.0}/tests/test_pabotprerunmodifier.py

@@ -20,9 +20,12 @@ def check_robot_version_and_return_name():
 
 
 def get_tmpdir_name(input: str) -> str:
+    # Remove all underscores from the end
+    result = input.rstrip('_')
+
     # Remove everything before the first occurrence of two or more consecutive underscores,
     # while preserving underscores as spaces with the same count
-    result = re.sub(r'^.*?(__+)', lambda m: ' ' * len(m.group(1)), input).strip()
+    result = re.sub(r'^.*?(__+)', lambda m: ' ' * len(m.group(1)), result).strip()
 
     # Capitalize letters following space, underscores or digits (e.g. after ' ', '_', '1')
     result = re.sub(r'([ _\d])([a-z])', lambda m: m.group(1) + m.group(2).upper(), result)