robotframework-pabot 5.1.0__tar.gz → 5.2.0b1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-pabot
-Version: 5.1.0
+Version: 5.2.0b1
 Summary: Parallel test runner for Robot Framework
 Home-page: https://pabot.org
 Download-URL: https://pypi.python.org/pypi/robotframework-pabot
@@ -12,17 +12,14 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Testing
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Robot Framework
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-License-File: LICENSE.txt
 Requires-Dist: robotframework>=3.2
 Requires-Dist: robotframework-stacktrace>=0.4.1
 Requires-Dist: natsort>=8.2.0
 Dynamic: download-url
-Dynamic: license-file
 
 # Pabot
 
@@ -47,7 +44,7 @@ A parallel executor for [Robot Framework](http://www.robotframework.org) tests.
 - [Contributing](#contributing-to-the-project)
 - [Command-line options](#command-line-options)
 - [PabotLib](#pabotlib)
-- [Controlling execution order](#controlling-execution-order-and-level-of-parallelism)
+- [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
 - [Programmatic use](#programmatic-use)
 - [Global variables](#global-variables)
 - [Output Files Generated by Pabot](#output-files-generated-by-pabot)
@@ -98,6 +95,12 @@ There are several ways you can help in improving this tool:
    - Report an issue or an improvement idea to the [issue tracker](https://github.com/mkorpela/pabot/issues)
    - Contribute by programming and making a pull request (easiest way is to work on an issue from the issue tracker)
 
+Before contributing, please read our detailed contributing guidelines:
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Security Policy](SECURITY.md)
+
 ## Command-line options
 <!-- NOTE: 
 The sections inside these docstring markers are also used in Pabot's --help output.
@@ -114,7 +117,8 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
         --processtimeout num|
         --shard i/n|
         --artifacts extensions|--artifactsinsubfolders|
-        --resourcefile file|--argumentfile[num] file|--suitesfrom file|--ordering file|
+        --resourcefile file|--argumentfile[num] file|--suitesfrom file
+        --ordering <FILENAME> [static|dynamic] [skip|run_all]|
         --chunk|
         --pabotprerunmodifier modifier|
         --no-rebot|
@@ -124,7 +128,7 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
 
 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:
+Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#command-line-options) and also following pabot options:
 
 **--verbose**     
   More output from the parallel execution.
@@ -202,8 +206,10 @@ Supports all [Robot Framework command line options](https://robotframework.org/r
   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]**   
-  Optionally give execution order from a file.
+**--ordering [FILE PATH] [MODE] [FAILURE POLICY]**   
+  Optionally give execution order from a file. See README.md section: [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
+  - MODE (optional): [static (default)|dynamic]
+  - FAILURE POLICY (optional, only in dynamic mode): [skip|run_all (default)]
 
 **--chunk**   
   Optionally chunk tests to PROCESSES number of robot runs. This can save time because all the suites will share the same 
@@ -245,6 +251,9 @@ These can be helpful when you must ensure that only one of the processes uses so
 
 PabotLib Docs are located at https://pabot.org/PabotLib.html.
 
+Note that PabotLib uses the XML-RPC protocol, which does not support all possible object types. 
+These limitations are described in the Robot Framework documentation in chapter [Supported argument and return value types](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#supported-argument-and-return-value-types).
+
 ### PabotLib example:
 
 test.robot
@@ -290,18 +299,28 @@ pabot call using resources from valueset.dat
 
       pabot --pabotlib --resourcefile valueset.dat test.robot
 
-### Controlling execution order and level of parallelism
+### Controlling execution order, mode, and level of parallelism
 
 .pabotsuitenames file contains the list of suites that will be executed.
-File is created during pabot execution if not already there.
-The file is a cache that pabot uses when re-executing same tests to speed up processing. 
-This file can be partially manually edited but easier option is to use ```--ordering FILENAME```.
-First 4 rows contain information that should not be edited - pabot will edit these when something changes.
-After this come the suite names.
+This file is created during pabot execution if it does not already exist. It acts as a cache to speed up processing when re-executing the same tests.
+The file can be manually edited partially, but a simpler and more controlled approach is to use:
+
+```bash
+--ordering <FILENAME> [static|dynamic] [skip|run_all]
+```
+
+- **FILENAME** – path to the ordering file.  
+- **mode** – optional execution mode, either `static` (default) or `dynamic`.  
+    - `static` executes suites in predefined stages.  
+    - `dynamic` executes tests as soon as all their dependencies are satisfied, allowing more optimal parallel execution.  
+- **failure_policy** – determines behavior when dependencies fail. Used only in dynamic mode. Optional:  
+    - `skip` – dependent tests are skipped if a dependency fails.  
+    - `run_all` – all tests run regardless of failures (default).  
 
-With ```--ordering FILENAME``` you can have a list that controls order also. The syntax is same as .pabotsuitenames file syntax but does not contain 4 hash rows that are present in .pabotsuitenames. 
+The ordering file syntax is similar to `.pabotsuitenames` but does not include the first 4 hash rows used by pabot. The ordering file defines the **execution order and dependencies** of suites and tests.  
+The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
 
-Note: The `--ordering` file is intended only for defining the execution order of suites and tests. The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
+#### Controlling execution order
 
 There different possibilities to influence the execution:
 
@@ -313,7 +332,7 @@ There different possibilities to influence the execution:
 --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:
+  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-suite-name) you can use either the new or old full test path. For example:
 
 ```
 --test New Suite Name.Sub Suite.Test 1
@@ -323,8 +342,14 @@ OR
 
   * 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. 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.
+  * 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.
+      * Ordering mode effect to execution:
+        * **Dynamic mode** will schedule dependent tests as soon as all their dependencies are satisfied. Note that in dynamic mode `#WAIT` is ignored, but you can achieve same results with using only `#DEPENDS` keywords.
+        *  **Static mode** preserves stage barriers and executes the next stage only after all tests in the previous stage finish.
+      * 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:
 
 ```
@@ -378,7 +403,7 @@ where order.txt is:
 #SLEEP 8
 ```
 
-prints something like this:
+Possible output could be:
 
 ```
 2025-02-15 19:15:00.408321 [0] [ID:1] SLEEPING 6 SECONDS BEFORE STARTING Data 1.suite C
@@ -466,6 +491,7 @@ pabot_results/
 │       ├── robot_stdout.out
 │       ├── robot_stderr.out
 │       └── artifacts...
+pabot_manager.log            # Pabot's own main log. Basically same than prints in console
 ```
 
 Each `PABOTQUEUEINDEX` folder contains as default:

{robotframework_pabot-5.1.0 → robotframework_pabot-5.2.0b1}/README.md

@@ -21,7 +21,7 @@ A parallel executor for [Robot Framework](http://www.robotframework.org) tests.
 - [Contributing](#contributing-to-the-project)
 - [Command-line options](#command-line-options)
 - [PabotLib](#pabotlib)
-- [Controlling execution order](#controlling-execution-order-and-level-of-parallelism)
+- [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
 - [Programmatic use](#programmatic-use)
 - [Global variables](#global-variables)
 - [Output Files Generated by Pabot](#output-files-generated-by-pabot)
@@ -72,6 +72,12 @@ There are several ways you can help in improving this tool:
    - Report an issue or an improvement idea to the [issue tracker](https://github.com/mkorpela/pabot/issues)
    - Contribute by programming and making a pull request (easiest way is to work on an issue from the issue tracker)
 
+Before contributing, please read our detailed contributing guidelines:
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Security Policy](SECURITY.md)
+
 ## Command-line options
 <!-- NOTE: 
 The sections inside these docstring markers are also used in Pabot's --help output.
@@ -88,7 +94,8 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
         --processtimeout num|
         --shard i/n|
         --artifacts extensions|--artifactsinsubfolders|
-        --resourcefile file|--argumentfile[num] file|--suitesfrom file|--ordering file|
+        --resourcefile file|--argumentfile[num] file|--suitesfrom file
+        --ordering <FILENAME> [static|dynamic] [skip|run_all]|
         --chunk|
         --pabotprerunmodifier modifier|
         --no-rebot|
@@ -98,7 +105,7 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
 
 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:
+Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#command-line-options) and also following pabot options:
 
 **--verbose**     
   More output from the parallel execution.
@@ -176,8 +183,10 @@ Supports all [Robot Framework command line options](https://robotframework.org/r
   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]**   
-  Optionally give execution order from a file.
+**--ordering [FILE PATH] [MODE] [FAILURE POLICY]**   
+  Optionally give execution order from a file. See README.md section: [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
+  - MODE (optional): [static (default)|dynamic]
+  - FAILURE POLICY (optional, only in dynamic mode): [skip|run_all (default)]
 
 **--chunk**   
   Optionally chunk tests to PROCESSES number of robot runs. This can save time because all the suites will share the same 
@@ -219,6 +228,9 @@ These can be helpful when you must ensure that only one of the processes uses so
 
 PabotLib Docs are located at https://pabot.org/PabotLib.html.
 
+Note that PabotLib uses the XML-RPC protocol, which does not support all possible object types. 
+These limitations are described in the Robot Framework documentation in chapter [Supported argument and return value types](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#supported-argument-and-return-value-types).
+
 ### PabotLib example:
 
 test.robot
@@ -264,18 +276,28 @@ pabot call using resources from valueset.dat
 
       pabot --pabotlib --resourcefile valueset.dat test.robot
 
-### Controlling execution order and level of parallelism
+### Controlling execution order, mode, and level of parallelism
 
 .pabotsuitenames file contains the list of suites that will be executed.
-File is created during pabot execution if not already there.
-The file is a cache that pabot uses when re-executing same tests to speed up processing. 
-This file can be partially manually edited but easier option is to use ```--ordering FILENAME```.
-First 4 rows contain information that should not be edited - pabot will edit these when something changes.
-After this come the suite names.
+This file is created during pabot execution if it does not already exist. It acts as a cache to speed up processing when re-executing the same tests.
+The file can be manually edited partially, but a simpler and more controlled approach is to use:
+
+```bash
+--ordering <FILENAME> [static|dynamic] [skip|run_all]
+```
+
+- **FILENAME** – path to the ordering file.  
+- **mode** – optional execution mode, either `static` (default) or `dynamic`.  
+    - `static` executes suites in predefined stages.  
+    - `dynamic` executes tests as soon as all their dependencies are satisfied, allowing more optimal parallel execution.  
+- **failure_policy** – determines behavior when dependencies fail. Used only in dynamic mode. Optional:  
+    - `skip` – dependent tests are skipped if a dependency fails.  
+    - `run_all` – all tests run regardless of failures (default).  
 
-With ```--ordering FILENAME``` you can have a list that controls order also. The syntax is same as .pabotsuitenames file syntax but does not contain 4 hash rows that are present in .pabotsuitenames. 
+The ordering file syntax is similar to `.pabotsuitenames` but does not include the first 4 hash rows used by pabot. The ordering file defines the **execution order and dependencies** of suites and tests.  
+The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
 
-Note: The `--ordering` file is intended only for defining the execution order of suites and tests. The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
+#### Controlling execution order
 
 There different possibilities to influence the execution:
 
@@ -287,7 +309,7 @@ There different possibilities to influence the execution:
 --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:
+  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-suite-name) you can use either the new or old full test path. For example:
 
 ```
 --test New Suite Name.Sub Suite.Test 1
@@ -297,8 +319,14 @@ OR
 
   * 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. 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.
+  * 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.
+      * Ordering mode effect to execution:
+        * **Dynamic mode** will schedule dependent tests as soon as all their dependencies are satisfied. Note that in dynamic mode `#WAIT` is ignored, but you can achieve same results with using only `#DEPENDS` keywords.
+        *  **Static mode** preserves stage barriers and executes the next stage only after all tests in the previous stage finish.
+      * 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:
 
 ```
@@ -352,7 +380,7 @@ where order.txt is:
 #SLEEP 8
 ```
 
-prints something like this:
+Possible output could be:
 
 ```
 2025-02-15 19:15:00.408321 [0] [ID:1] SLEEPING 6 SECONDS BEFORE STARTING Data 1.suite C
@@ -440,6 +468,7 @@ pabot_results/
 │       ├── robot_stdout.out
 │       ├── robot_stderr.out
 │       └── artifacts...
+pabot_manager.log            # Pabot's own main log. Basically same than prints in console
 ```
 
 Each `PABOTQUEUEINDEX` folder contains as default:

robotframework_pabot-5.2.0b1/pyproject.toml

@@ -0,0 +1,12 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+filterwarnings = [
+    "ignore:'robot.utils.PY2' is deprecated:DeprecationWarning:robot.utils",
+    "ignore:'robot.utils.is_unicode' is deprecated:DeprecationWarning:robot.utils",
+    "ignore::pytest.PytestCollectionWarning:module=tests.test_pabotlib",
+]

{robotframework_pabot-5.1.0 → robotframework_pabot-5.2.0b1}/setup.cfg

@@ -11,12 +11,12 @@ description = Parallel test runner for Robot Framework
 long_description = file: README.md
 long_description_content_type = text/markdown
 license = Apache License, Version 2.0
+license_files = 
 classifiers = 
 	Intended Audience :: Developers
 	Natural Language :: English
 	Programming Language :: Python :: 3
 	Topic :: Software Development :: Testing
-	License :: OSI Approved :: Apache Software License
 	Development Status :: 5 - Production/Stable
 	Framework :: Robot Framework
 
@@ -30,6 +30,8 @@ install_requires =
 	robotframework>=3.2
 	robotframework-stacktrace>=0.4.1
 	natsort>=8.2.0
+license_files = 
+	LICENSE
 
 [options.packages.find]
 where = src