| Name | robotframework-dependencysolver JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | A Robot Framework prerunmodifier for interdependent test cases execution. |
| upload_time | 2025-02-18 02:23:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
robotframework
dependencysolver
dependencylibrary
prerunmodifier
testautomation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# robotframework-dependencysolver
[](https://pypi.org/project/robotframework-dependencysolver/)
[](https://pepy.tech/projects/robotframework-dependencysolver)
## Table of Contents
- [Introduction](#introduction)
- [Versioning](#versioning)
- [Installation](#installation)
- [How define dependencies with DependencyLibrary](#how-define-dependencies-with-dependencylibrary)
- [Using DependencySolver](#using-dependencysolver)
- [Using with Pabot](#using-with-pabot)
- [Contributing](#contributing)
## Introduction
A [Robot Framework](https://robotframework.org/) prerunmodifier for interdependent test cases execution.
Ideally tests are independent, but when tests depend on earlier tests,
[DependencyLibrary](https://github.com/mentalisttraceur/robotframework-dependencylibrary) makes it easy to explicitly declare these dependencies
and have tests that depend on each other do the right thing.
The **DependencyLibrary** provides two Robot Framework keywords: `Depends On Test`
and `Depends On Suite` for defining dependencies between tests and suites.
This **DependencySolver** is a pre-run modifier for Robot Framework, designed to
execute dependent test chains. For instance, if Test C depends on Test B,
and Test B in turn depends on Test A, then all three tests must be run to
ensure Test C can execute successfully. However, if you run Robot Framework with
the command `robot -t 'test C' <path_to_your_test_folder>`, Test C will fail
because this command does not select Tests B and A.
For more details on using the **DependencySolver**, please refer to the section
[Using DependencySolver](##using-dependencysolver).
If you want to run tests parallel with [Pabot](https://pabot.org/), please
refer to section [Using With Pabot](#using-with-pabot).
## Versioning
This library\'s version numbers follow the [SemVer 2.0.0
specification](https://semver.org/spec/v2.0.0.html).
## Installation
If you already have [Python](https://www.python.org/) with [pip](https://pip.pypa.io/en/stable/) installed, you can simply run:
```cmd
pip install robotframework-dependencysolver
```
This will install the latest version of **robotframework-dependencysolver**, along with latest (or sufficiently recent if already installed) versions of **robotframework** and **robotframework-dependencylibrary**.
Additionally, if you are using the **pabot** library, you can ensure that you have a sufficiently recent version of **robotframework-pabot** by running:
```cmd
pip install robotframework-dependencysolver[pabot]
```
After desired installation command, you can verify a successful installation with the following command:
```cmd
depsol --version
```
## How define dependencies with DependencyLibrary
First, include the [DependencyLibrary](https://github.com/mentalisttraceur/robotframework-dependencylibrary) in your tests:
``` robotframework
*** Settings ***
Library DependencyLibrary
```
Typical usage:
``` robotframework
*** Test cases ***
Passing Test
No operation
A Test that Depends on "Passing Test"
Depends On Test Passing Test
Log The rest of the keywords in this test will run as normal.
```
> [!NOTE]
> `DependencySolver` recognizes only `Depends On` keywords defined in `[Setup]`
sections, even though these keywords can technically be used in other parts of
the test. Therefore, it is recommended to specify all dependencies under the
`[Setup]` section, using the built-in keyword `Run Keywords` if needed.
Dependencies, after all, are prerequisites for running a test.
When you need to declare multiple dependencies, just repeat the keyword:
``` robotframework
*** Test cases ***
Another Passing Test
No operation
A Test that Depends on Both "Passing Test" and "Another Passing Test"
[Setup] Run Keywords Depends On Test Passing Test
... AND Depends On Test Another Passing Test
Log The rest of the keywords in this test will run as normal.
```
You can also depend on the statuses of entire test suites:
``` robotframework
*** Test cases ***
A Test that Depends on an Entire Test Suite Passing
[Setup] Depends On Suite Some Test Suite Name
Log The rest of the keywords will run if that whole suite passed.
```
Note that to depend on a suite or a test from another suite, you must
either run Robot Framework with `--listener DependencyLibrary`, or that
suite must also include `DependencyLibrary` in its `*** Settings ***`.
Additionally, you can define `DependencyLibrary` in a common
`some_name.resource` file that is accessible across all suites.
### Skipped Dependencies
If a dependency was skipped, the depending test is also skipped:
``` robotframework
*** Test cases ***
Skipped Test
Skip This test is skipped for some reason.
A Test that Depends on "Skipped Test"
[Setup] Depends On Test Skipped Test
Log The rest of the keywords (including this log) will NOT run!
```
The skip message follows this format:
Dependency not met: test case 'Skipped Test' was skipped.
### Failing Dependencies
If a dependency failed, the depending test is skipped instead of
redundantly failing as well:
``` robotframework
*** Test cases ***
Failing Test
Fail This test failed for some reason.
A Test that Depends on "Failing Test"
[Setup] Depends On Test Failing Test
Log The rest of the keywords (including this log) will NOT run!
```
The skip message follows this format:
Dependency not met: test case 'Failing Test' failed.
### Mistake Warnings
If you depend on a test or suite that does not exist or has not run yet,
``` robotframework
*** Test cases ***
A Test that Depends on "Missing Test"
Depends On Test Missing Test
```
the test will warn and the warning message follows this format:
Dependency not met: test case 'Missing Test' not found.
If you make a test depend on itself or on the suite that contains it,
``` robotframework
*** Test cases ***
Depends on Self
Depends On Test Depends on Self
```
the test will warn and the warning message follows this format:
Dependency not met: test case 'Depends on Self' mid-execution.
## Using DependencySolver
After you have defined the dependencies of each test in the `[Setup]` section by
using `Depends On Test` or `Depends On Suite` keywords, then pre-run modifier
`DependencySolver` checks all `[Setup]` sections and solve dependencies before
running tests. You could use `Depends On Test` or `Depends On Suite` keywords
multiple times and/or together with other setup keywords by using build-in
`Run Keywords` at first.
Write test setup as follows:
```RobotFramework
*** Settings ***
Library DependencyLibrary
*** Test cases ***
Test A
[Setup] Do Test Setup...
[Tags] tagA
Do Something...
Test B
[Setup] Run Keywords Depends On Test name=Test A
... AND Do Test Setup...
[Tags] tagB
Do Something...
Test C
[Setup] Run Keywords Depends On Test name=Test B
... AND Do Test Setup...
[Tags] tagC
Do Something...
```
> [!IMPORTANT]
> `DependencySolver` does not impact the execution order of tests but simply includes the necessary tests and excludes the unnecessary ones. Dependencies can form any tree structure; however, cyclic dependencies (e.g., A -> B and B -> A) will result in an error.
When you have written test dependencies in `[Setup]` sections like above, then
by using `DependencySolver` as `prerunmodifier` you could run whole dependency
chain C -> B -> A by command:
```cmd
robot --prerunmodifier DependencySolver.depsol:-t:"Test C" <other_robot_commands> <path_to_your_test_folder>
```
Additionally, you could use tags also (but only static, not dynamic tags):
```cmd
robot --prerunmodifier DependencySolver.depsol:-i:tagC <other_robot_commands> <path_to_your_test_folder>
```
You can also use shortcut `depsol` directly. This actually calls `robot` with
`--prerunmodifier`, but it is propably more useful when you do not have any
(or at least not many) `<other_robot_commands>`. If you have already navigated
to `<path_to_your_test_folder>`, you does not need to give `--folder` option,
because default is current directory:
```cmd
depsol -t "test C"
```
Or
```cmd
depsol -i "tagC"
```
These commands will have the same effect as the two commands mentioned above.
For more options and help, please run
```cmd
depsol --help
```
`DependencySolver` generates the following two files in the current directory:
- **depsol.log**: An internal log showing the process of traversing and selecting dependencies.
- **depsol.pabot.txt**: A file for use with [Pabot](https://pabot.org/), detailing how the selected tests can be run in parallel while respecting dependencies.
## Using with Pabot
If you want to run tests with Pabot, you need at least version 4.1.0 of the
[robotframework-pabot](https://pypi.org/project/robotframework-pabot/) library.
This version introduces the --pabotprerunmodifier feature, which functions
similarly to prerunmodifier, but it is not passed down to subprocesses.
Instead, it is executed only once in Pabot's main process.
Once the appropriate version is installed, using Pabot is quite
straightforward. The simplest command is:
```cmd
pabot --testlevelsplit --pabotprerunmodifier DependencySolver.depsol:-i:tagC --ordering depsol.pabot.txt <other_commands_to_pabot> <path_to_your_test_folder>
```
However, note that since the example tests A, B, and C depend on each other,
they are grouped together using the `--ordering` file so they are executed in
the same process. The content of the `depsol.pabot.txt` file looks something
like this:
```
{
--test Suite.Test A
--test Suite.Test B #DEPENDS Suite.Test A
--test Suite.Test C #DEPENDS Suite.Test B
}
```
## Contributing
If you would like to request a new feature or modification to existing functionality, or report a bug, you can open an issue on [GitHub](https://github.com/joonaskuisma/robotframework-dependencysolver/issues). For any issues, please create a bug report and reference the version in question.
If you want to contribute and participate in the project, please read the [Developer Guide](README.dev.md) file first.
Raw data
{
"_id": null,
"home_page": null,
"name": "robotframework-dependencysolver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "robotframework, dependencysolver, dependencylibrary, prerunmodifier, testautomation",
"author": null,
"author_email": "Joonas Kuisma <kuisma.joonas@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/22/dc/586994742c0c0e0633cd90c1912aefc9ed79489f668f9ade23d271125ea7/robotframework_dependencysolver-0.3.1.tar.gz",
"platform": null,
"description": "# robotframework-dependencysolver\n\n[](https://pypi.org/project/robotframework-dependencysolver/)\n[](https://pepy.tech/projects/robotframework-dependencysolver)\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Versioning](#versioning)\n- [Installation](#installation)\n- [How define dependencies with DependencyLibrary](#how-define-dependencies-with-dependencylibrary)\n- [Using DependencySolver](#using-dependencysolver)\n- [Using with Pabot](#using-with-pabot)\n- [Contributing](#contributing)\n\n## Introduction\n\nA [Robot Framework](https://robotframework.org/) prerunmodifier for interdependent test cases execution.\n\nIdeally tests are independent, but when tests depend on earlier tests,\n[DependencyLibrary](https://github.com/mentalisttraceur/robotframework-dependencylibrary) makes it easy to explicitly declare these dependencies\nand have tests that depend on each other do the right thing.\n\nThe **DependencyLibrary** provides two Robot Framework keywords: `Depends On Test`\nand `Depends On Suite` for defining dependencies between tests and suites. \n\nThis **DependencySolver** is a pre-run modifier for Robot Framework, designed to \nexecute dependent test chains. For instance, if Test C depends on Test B, \nand Test B in turn depends on Test A, then all three tests must be run to \nensure Test C can execute successfully. However, if you run Robot Framework with\nthe command `robot -t 'test C' <path_to_your_test_folder>`, Test C will fail \nbecause this command does not select Tests B and A.\n\nFor more details on using the **DependencySolver**, please refer to the section \n[Using DependencySolver](##using-dependencysolver).\n\nIf you want to run tests parallel with [Pabot](https://pabot.org/), please \nrefer to section [Using With Pabot](#using-with-pabot).\n\n## Versioning\n\nThis library\\'s version numbers follow the [SemVer 2.0.0\nspecification](https://semver.org/spec/v2.0.0.html).\n\n## Installation\n\nIf you already have [Python](https://www.python.org/) with [pip](https://pip.pypa.io/en/stable/) installed, you can simply run:\n\n```cmd\npip install robotframework-dependencysolver\n```\n\nThis will install the latest version of **robotframework-dependencysolver**, along with latest (or sufficiently recent if already installed) versions of **robotframework** and **robotframework-dependencylibrary**.\n\nAdditionally, if you are using the **pabot** library, you can ensure that you have a sufficiently recent version of **robotframework-pabot** by running:\n\n```cmd\npip install robotframework-dependencysolver[pabot]\n```\n\nAfter desired installation command, you can verify a successful installation with the following command:\n\n```cmd\ndepsol --version\n```\n\n## How define dependencies with DependencyLibrary\n\nFirst, include the [DependencyLibrary](https://github.com/mentalisttraceur/robotframework-dependencylibrary) in your tests:\n\n``` robotframework\n*** Settings ***\nLibrary DependencyLibrary\n```\n\nTypical usage:\n\n``` robotframework\n*** Test cases ***\nPassing Test\n No operation\n\nA Test that Depends on \"Passing Test\"\n Depends On Test Passing Test\n Log The rest of the keywords in this test will run as normal.\n```\n> [!NOTE]\n> `DependencySolver` recognizes only `Depends On` keywords defined in `[Setup]`\nsections, even though these keywords can technically be used in other parts of \nthe test. Therefore, it is recommended to specify all dependencies under the \n`[Setup]` section, using the built-in keyword `Run Keywords` if needed. \nDependencies, after all, are prerequisites for running a test.\n\nWhen you need to declare multiple dependencies, just repeat the keyword:\n\n``` robotframework\n*** Test cases ***\nAnother Passing Test\n No operation\n\nA Test that Depends on Both \"Passing Test\" and \"Another Passing Test\"\n [Setup] Run Keywords Depends On Test Passing Test\n ... AND Depends On Test Another Passing Test\n Log The rest of the keywords in this test will run as normal.\n```\n\nYou can also depend on the statuses of entire test suites:\n\n``` robotframework\n*** Test cases ***\nA Test that Depends on an Entire Test Suite Passing\n [Setup] Depends On Suite Some Test Suite Name\n Log The rest of the keywords will run if that whole suite passed.\n```\n\nNote that to depend on a suite or a test from another suite, you must\neither run Robot Framework with `--listener DependencyLibrary`, or that\nsuite must also include `DependencyLibrary` in its `*** Settings ***`. \nAdditionally, you can define `DependencyLibrary` in a common \n`some_name.resource` file that is accessible across all suites.\n\n### Skipped Dependencies\n\nIf a dependency was skipped, the depending test is also skipped:\n\n``` robotframework\n*** Test cases ***\nSkipped Test\n Skip This test is skipped for some reason.\n\nA Test that Depends on \"Skipped Test\"\n [Setup] Depends On Test Skipped Test\n Log The rest of the keywords (including this log) will NOT run!\n```\n\nThe skip message follows this format:\n\n Dependency not met: test case 'Skipped Test' was skipped.\n\n### Failing Dependencies\n\nIf a dependency failed, the depending test is skipped instead of\nredundantly failing as well:\n\n``` robotframework\n*** Test cases ***\nFailing Test\n Fail This test failed for some reason.\n\nA Test that Depends on \"Failing Test\"\n [Setup] Depends On Test Failing Test\n Log The rest of the keywords (including this log) will NOT run!\n```\n\nThe skip message follows this format:\n\n Dependency not met: test case 'Failing Test' failed.\n\n### Mistake Warnings\n\nIf you depend on a test or suite that does not exist or has not run yet,\n\n``` robotframework\n*** Test cases ***\nA Test that Depends on \"Missing Test\"\n Depends On Test Missing Test\n```\n\nthe test will warn and the warning message follows this format:\n\n Dependency not met: test case 'Missing Test' not found.\n\nIf you make a test depend on itself or on the suite that contains it,\n\n``` robotframework\n*** Test cases ***\nDepends on Self\n Depends On Test Depends on Self\n```\n\nthe test will warn and the warning message follows this format:\n\n Dependency not met: test case 'Depends on Self' mid-execution.\n\n## Using DependencySolver\n\nAfter you have defined the dependencies of each test in the `[Setup]` section by\nusing `Depends On Test` or `Depends On Suite` keywords, then pre-run modifier \n`DependencySolver` checks all `[Setup]` sections and solve dependencies before \nrunning tests. You could use `Depends On Test` or `Depends On Suite` keywords \nmultiple times and/or together with other setup keywords by using build-in \n`Run Keywords` at first.\n\nWrite test setup as follows:\n\n```RobotFramework\n*** Settings ***\nLibrary DependencyLibrary\n\n\n*** Test cases ***\nTest A\n [Setup] Do Test Setup...\n [Tags] tagA\n Do Something...\n\nTest B\n [Setup] Run Keywords Depends On Test name=Test A\n ... AND Do Test Setup...\n [Tags] tagB\n Do Something...\n\nTest C\n [Setup] Run Keywords Depends On Test name=Test B\n ... AND Do Test Setup...\n [Tags] tagC\n Do Something...\n\n```\n\n> [!IMPORTANT]\n> `DependencySolver` does not impact the execution order of tests but simply includes the necessary tests and excludes the unnecessary ones. Dependencies can form any tree structure; however, cyclic dependencies (e.g., A -> B and B -> A) will result in an error.\n\nWhen you have written test dependencies in `[Setup]` sections like above, then \nby using `DependencySolver` as `prerunmodifier` you could run whole dependency \nchain C -> B -> A by command:\n\n```cmd\nrobot --prerunmodifier DependencySolver.depsol:-t:\"Test C\" <other_robot_commands> <path_to_your_test_folder>\n```\n\nAdditionally, you could use tags also (but only static, not dynamic tags):\n```cmd\nrobot --prerunmodifier DependencySolver.depsol:-i:tagC <other_robot_commands> <path_to_your_test_folder>\n```\n\nYou can also use shortcut `depsol` directly. This actually calls `robot` with\n`--prerunmodifier`, but it is propably more useful when you do not have any \n(or at least not many) `<other_robot_commands>`. If you have already navigated \nto `<path_to_your_test_folder>`, you does not need to give `--folder` option, \nbecause default is current directory:\n\n```cmd\ndepsol -t \"test C\"\n```\nOr\n```cmd\ndepsol -i \"tagC\"\n```\nThese commands will have the same effect as the two commands mentioned above.\n\nFor more options and help, please run\n\n```cmd\ndepsol --help\n```\n\n`DependencySolver` generates the following two files in the current directory:\n\n- **depsol.log**: An internal log showing the process of traversing and selecting dependencies.\n- **depsol.pabot.txt**: A file for use with [Pabot](https://pabot.org/), detailing how the selected tests can be run in parallel while respecting dependencies.\n\n## Using with Pabot\n\nIf you want to run tests with Pabot, you need at least version 4.1.0 of the \n[robotframework-pabot](https://pypi.org/project/robotframework-pabot/) library.\nThis version introduces the --pabotprerunmodifier feature, which functions \nsimilarly to prerunmodifier, but it is not passed down to subprocesses. \nInstead, it is executed only once in Pabot's main process.\n\nOnce the appropriate version is installed, using Pabot is quite \nstraightforward. The simplest command is:\n\n```cmd\npabot --testlevelsplit --pabotprerunmodifier DependencySolver.depsol:-i:tagC --ordering depsol.pabot.txt <other_commands_to_pabot> <path_to_your_test_folder>\n```\n\nHowever, note that since the example tests A, B, and C depend on each other, \nthey are grouped together using the `--ordering` file so they are executed in \nthe same process. The content of the `depsol.pabot.txt` file looks something \nlike this:\n\n```\n{\n--test Suite.Test A\n--test Suite.Test B #DEPENDS Suite.Test A\n--test Suite.Test C #DEPENDS Suite.Test B\n}\n```\n\n## Contributing\n\nIf you would like to request a new feature or modification to existing functionality, or report a bug, you can open an issue on [GitHub](https://github.com/joonaskuisma/robotframework-dependencysolver/issues). For any issues, please create a bug report and reference the version in question. \n\nIf you want to contribute and participate in the project, please read the [Developer Guide](README.dev.md) file first.\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "A Robot Framework prerunmodifier for interdependent test cases execution.",
"version": "0.3.1",
"project_urls": {
"Download": "https://pypi.org/project/robotframework-dependencysolver/",
"Homepage": "https://github.com/joonaskuisma/robotframework-dependencysolver",
"Issues": "https://github.com/joonaskuisma/robotframework-dependencysolver/issues"
},
"split_keywords": [
"robotframework",
" dependencysolver",
" dependencylibrary",
" prerunmodifier",
" testautomation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "50cb24b99d3216d993eadca386cf6341b3ababc71657a691d4b4125f6dd40b5d",
"md5": "f25c4378c9ac91d1cd64312303db0a5a",
"sha256": "e0246a1b47910ded3252a65fc4670bd5caf315684159af5859c7fd1b7fd9778a"
},
"downloads": -1,
"filename": "robotframework_dependencysolver-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f25c4378c9ac91d1cd64312303db0a5a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 25721,
"upload_time": "2025-02-18T02:23:37",
"upload_time_iso_8601": "2025-02-18T02:23:37.826183Z",
"url": "https://files.pythonhosted.org/packages/50/cb/24b99d3216d993eadca386cf6341b3ababc71657a691d4b4125f6dd40b5d/robotframework_dependencysolver-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "22dc586994742c0c0e0633cd90c1912aefc9ed79489f668f9ade23d271125ea7",
"md5": "fb011556b73506e1e0ed19deeaff5e14",
"sha256": "c2f628d952be4491ecc02fa7602b6f7edfc5d4a42373fdd65a38c37d04ac19e6"
},
"downloads": -1,
"filename": "robotframework_dependencysolver-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "fb011556b73506e1e0ed19deeaff5e14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 30440,
"upload_time": "2025-02-18T02:23:38",
"upload_time_iso_8601": "2025-02-18T02:23:38.979536Z",
"url": "https://files.pythonhosted.org/packages/22/dc/586994742c0c0e0633cd90c1912aefc9ed79489f668f9ade23d271125ea7/robotframework_dependencysolver-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-18 02:23:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joonaskuisma",
"github_project": "robotframework-dependencysolver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robotframework-dependencysolver"
}
