robotframework-dependencylibrary


Namerobotframework-dependencylibrary JSON
Version 4.0.0 PyPI version JSON
download
home_pagehttps://github.com/mentalisttraceur/robotframework-dependencylibrary
SummaryDeclare dependencies between Robot Framework tests
upload_time2022-11-05 04:24:52
maintainer
docs_urlNone
authorAlexander Kozhevnikov
requires_python
license0BSD (BSD Zero Clause License)
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Robot Framework Dependency Library
==================================

Declare dependencies between tests.

Ideally tests are independent, but when tests depend
on earlier tests, DependencyLibrary makes it easy to
explicitly declare these dependencies and have tests
that depend on each other do the right thing.


Versioning
----------

This library's version numbers follow the `SemVer 2.0.0
specification <https://semver.org/spec/v2.0.0.html>`_.


Installation
------------

::

    pip install robotframework-dependencylibrary


Usage
-----

First, include the library in your tests:

.. code:: robotframework

    *** Settings ***
    Library  DependencyLibrary

Typical usage:

.. code:: 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.

When you need to declare multiple dependencies, just repeat the keyword:

.. code:: robotframework

    *** Test cases ***
    Another Passing Test
        No operation

    A Test that Depends on Both "Passing Test" and "Another Passing Test"
        Depends on test  Passing Test
        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:

.. code:: robotframework

    *** Test cases ***
    A Test that Depends on an Entire Test Suite Passing
        Depends on suite  Some Test Suite Name
        Log  The rest of the keywords will run if that whole suite passed.


Skipped Dependencies
--------------------

If a dependency was skipped, the depending test is also skipped:

.. code:: robotframework

    *** Test cases ***
    Skipped Test
        Skip  This test is skipped for some reason.

    A Test that Depends on "Skipped Test"
        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:

.. code:: robotframework

    *** Test cases ***
    Failing Test
        Fail  This test failed for some reason.

    A Test that Depends on "Failing Test"
        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,

.. code:: 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,

.. code:: 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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mentalisttraceur/robotframework-dependencylibrary",
    "name": "robotframework-dependencylibrary",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Alexander Kozhevnikov",
    "author_email": "mentalisttraceur@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ee/6c/8c406d0f7dc01d048f0665eb21260521810b749b4e902d41ed83dd7be57c/robotframework-dependencylibrary-4.0.0.tar.gz",
    "platform": null,
    "description": "Robot Framework Dependency Library\n==================================\n\nDeclare dependencies between tests.\n\nIdeally tests are independent, but when tests depend\non earlier tests, DependencyLibrary makes it easy to\nexplicitly declare these dependencies and have tests\nthat depend on each other do the right thing.\n\n\nVersioning\n----------\n\nThis library's version numbers follow the `SemVer 2.0.0\nspecification <https://semver.org/spec/v2.0.0.html>`_.\n\n\nInstallation\n------------\n\n::\n\n    pip install robotframework-dependencylibrary\n\n\nUsage\n-----\n\nFirst, include the library in your tests:\n\n.. code:: robotframework\n\n    *** Settings ***\n    Library  DependencyLibrary\n\nTypical usage:\n\n.. code:: robotframework\n\n    *** Test cases ***\n    Passing Test\n        No operation\n\n    A 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\nWhen you need to declare multiple dependencies, just repeat the keyword:\n\n.. code:: robotframework\n\n    *** Test cases ***\n    Another Passing Test\n        No operation\n\n    A Test that Depends on Both \"Passing Test\" and \"Another Passing Test\"\n        Depends on test  Passing Test\n        Depends on test  Another Passing Test\n        Log  The rest of the keywords in this test will run as normal.\n\nYou can also depend on the statuses of entire test suites:\n\n.. code:: robotframework\n\n    *** Test cases ***\n    A Test that Depends on an Entire Test Suite Passing\n        Depends on suite  Some Test Suite Name\n        Log  The rest of the keywords will run if that whole suite passed.\n\n\nSkipped Dependencies\n--------------------\n\nIf a dependency was skipped, the depending test is also skipped:\n\n.. code:: robotframework\n\n    *** Test cases ***\n    Skipped Test\n        Skip  This test is skipped for some reason.\n\n    A Test that Depends on \"Skipped Test\"\n        Depends on test  Skipped Test\n        Log  The rest of the keywords (including this log) will NOT run!\n\nThe skip message follows this format::\n\n    Dependency not met: test case 'Skipped Test' was skipped.\n\n\nFailing Dependencies\n--------------------\n\nIf a dependency failed, the depending test is skipped instead of\nredundantly failing as well:\n\n.. code:: robotframework\n\n    *** Test cases ***\n    Failing Test\n        Fail  This test failed for some reason.\n\n    A Test that Depends on \"Failing Test\"\n        Depends on test  Failing Test\n        Log  The rest of the keywords (including this log) will NOT run!\n\nThe skip message follows this format::\n\n    Dependency not met: test case 'Failing Test' failed.\n\n\nMistake Warnings\n----------------\n\nIf you depend on a test or suite that does not exist or has not run yet,\n\n.. code:: robotframework\n\n    *** Test cases ***\n    A Test that Depends on \"Missing Test\"\n        Depends on test  Missing Test\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.. code:: robotframework\n\n    *** Test cases ***\n    Depends on Self\n        Depends on test  Depends on Self\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\n",
    "bugtrack_url": null,
    "license": "0BSD (BSD Zero Clause License)",
    "summary": "Declare dependencies between Robot Framework tests",
    "version": "4.0.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "608a6bee55b2973a77d69aa97685ec2ea928d7acbde392aa7102d6b80c0eb804",
                "md5": "c9140cc0a3986f0f53cda2bc124c7ff1",
                "sha256": "2bf2e6608bd0d21f79078de3dc8ffad94e0cdbefeeb64c72a913290d6e25ac5b"
            },
            "downloads": -1,
            "filename": "robotframework_dependencylibrary-4.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c9140cc0a3986f0f53cda2bc124c7ff1",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 3805,
            "upload_time": "2022-11-05T04:24:50",
            "upload_time_iso_8601": "2022-11-05T04:24:50.646941Z",
            "url": "https://files.pythonhosted.org/packages/60/8a/6bee55b2973a77d69aa97685ec2ea928d7acbde392aa7102d6b80c0eb804/robotframework_dependencylibrary-4.0.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ee6c8c406d0f7dc01d048f0665eb21260521810b749b4e902d41ed83dd7be57c",
                "md5": "790f4ef0eac83bf6aaf16e43c0932e26",
                "sha256": "3213cc3d0d6c54c705c00819d6e2339d12a2cf5170a0247d3dc4cdd7825a2d8f"
            },
            "downloads": -1,
            "filename": "robotframework-dependencylibrary-4.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "790f4ef0eac83bf6aaf16e43c0932e26",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3465,
            "upload_time": "2022-11-05T04:24:52",
            "upload_time_iso_8601": "2022-11-05T04:24:52.330242Z",
            "url": "https://files.pythonhosted.org/packages/ee/6c/8c406d0f7dc01d048f0665eb21260521810b749b4e902d41ed83dd7be57c/robotframework-dependencylibrary-4.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-11-05 04:24:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "mentalisttraceur",
    "github_project": "robotframework-dependencylibrary",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "robotframework-dependencylibrary"
}
        
Elapsed time: 0.08503s