Merge pull request #663 from joonaskuisma/bugfix

Various fixes, improvements, and new --artifacts notimestamps feature

Author: joonaskuisma

.github/workflows/update-status-label.yml

@@ -1,33 +1,28 @@
-name: Issue and PR Status Labels
+name: Issue Status Labels
 
 on:
   issues:
     types: [opened, closed]
-  pull_request:
-    types: [closed]
 
 jobs:
   update-status:
     runs-on: ubuntu-latest
     permissions:
       issues: write
-      pull-requests: write
 
     steps:
       - name: Set up Python (needed by GitHub Actions)
         uses: actions/setup-python@v4
         with:
           python-version: '3.12'
 
-      - name: Update issue and PR status
+      - name: Update issue status
         uses: actions/github-script@v6
         with:
           script: |
             const issueLabels = {
               open: 'status: open',
-              completed: 'status: completed',
-              pr_submitted: 'status: pr submitted',
-              needs_review: 'status: needs review'
+              completed: 'status: completed'
             };
 
             async function removeOldStatusLabels(issue_number) {
@@ -70,17 +65,3 @@ jobs:
                 });
               }
             }
-
-            // Handle PR labels only (no external issue modifications)
-            if (context.eventName === 'pull_request') {
-              const pr = context.payload.pull_request;
-              const prNumber = pr.number;
-              await removeOldStatusLabels(prNumber);
-              if (context.payload.action === 'closed' && pr.merged) {
-                await github.rest.issues.addLabels({
-                  ...context.repo,
-                  issue_number: prNumber,
-                  labels: [issueLabels.completed]
-                });
-              }
-            }

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

src/pabot/__init__.py

@@ -7,4 +7,4 @@
 except ImportError:
     pass
 
-__version__ = "5.0.0"
+__version__ = "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