pytest-test-tracer-for-pytest-bdd


Namepytest-test-tracer-for-pytest-bdd JSON
Version 0.3.5 PyPI version JSON
download
home_pageNone
SummaryA plugin that allows coll test data for use on Test Tracer
upload_time2024-08-20 11:25:22
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
license The MIT License (MIT) Copyright (c) 2024 Gavin Clark Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================================
Test Tracer for Pytest BDD
=================================

.. image:: https://img.shields.io/pypi/v/pytest-test-tracer-for-pytest.svg
    :target: https://pypi.org/project/pytest-test-tracer-for-pytest
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pytest-test-tracer-for-pytest.svg
    :target: https://pypi.org/project/pytest-test-tracer-for-pytest
    :alt: Python versions

.. image:: https://github.com/testreporter/test-tracer-for-pytest/actions/workflows/main.yml/badge.svg
    :target: https://github.com/testreporter/test-tracer-for-pytest/actions/workflows/main.yml
    :alt: See Build Status on GitHub Actions

A plugin that allows collecting test data for use on Test Tracer. It is designed to be used with 
the `Pytest BDD`_ tool


Requirements
------------

* `Pytest BDD`_
* A free `Test Tracer`_ account
* An API token that allows uploading the test result



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

You can install "pytest-test-tracer-for-pytest" via `pip`_ from `PyPI`_::

    $ pip install pytest-test-tracer-for-pytest-bdd


Usage
-----

Install the Plugin then activate it using the following Pytest parameters

.. list-table:: parameters
   :widths: 25 8 57 10
   :header-rows: 1

   * - Parameter Name
     - Required
     - Description
     - Default Value
   * - test-tracer-run-reference
     - No
     - By default, Test Tracer Runs are grouped one per Pytest run. If you want multiple Pytest runs to be visible in the same Test Tracer Run, you can specify your own unique run reference. Useful if you split up your test runs into several parallel runs
     - A GUID
   * - use-test-tracer
     - No
     - Provide this argument to enable the Test Tracer plugin
     - False
   * - build-version
     - No
     - If your application under test has a build version. You can enter it here.
     - None
   * - build-revision
     - Yes
     - A unique revision for your application under test. Typically this is a git commit hash, an SVN revision, or any other string that identifies the current code base
     - None
   * - test-tracer-project-name
     - Yes
     - The name of the Project that this test is for. You can give it the name of your application, a single microservice, or any other way that you choose to describe the thing being tested.
     - None
   * - branch-name
     - Yes
     - The name of the branch that is being tested
     - None
   * - test-tracer-no-upload
     - No
     - If you provide this argument, Test Tracer will still generate test result data, but it won't attempt to upload it to Test Tracer
     - False
   * - test-tracer-upload-token
     - No
     - If you want to upload results to Test Tracer, you need to specify the API token used to secure the upload
     - None
   * - test-tracer-environment-name
     - True
     - What environment are you running on? eg: Dev, Production, Staging, etc...
     - None     
   * - test-tracer-run-alias
     - No
     - If you want to you can provide an alias for this run. For example a run called "API Authentication Tests" will allow you to view, group and report on all tests that were part of that run
     - None

Here is an example of using the Test Tracer for Pytest plugin with Git as the source control::

$ pytest --branch-name=$(git rev-parse --abbrev-ref HEAD) --build-revision=$(git rev-parse --short HEAD) --test-tracer-project-name="Your Project Name" --test-tracer-upload-token="Your Test Tracer Upload Token"

License
-------

Distributed under the terms of the `MIT`_ license, "pytest-test-tracer-for-pytest" is free and open source software


Issues
------

If you encounter any problems, please `file an issue`_ along with a detailed description.

.. _`MIT`: https://opensource.org/licenses/MIT
.. _`BSD-3`: https://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: https://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/testreporter/test-tracer-for-pytest/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`PyPI`: https://pypi.org/project
.. _`Test Tracer`: https://testtracer.io
.. _`Pytest BDD`: https://pypi.org/project/pytest-bdd/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pytest-test-tracer-for-pytest-bdd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Gavin Clark <testtracer.io@gmail.com>",
    "keywords": null,
    "author": null,
    "author_email": "Gavin Clark <testtracer.io@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/99/ba/57de9de343e964e712b0837fbd9967e256cc65c43fb4f88ff3142818e7d7/pytest_test_tracer_for_pytest_bdd-0.3.5.tar.gz",
    "platform": null,
    "description": "=================================\nTest Tracer for Pytest BDD\n=================================\n\n.. image:: https://img.shields.io/pypi/v/pytest-test-tracer-for-pytest.svg\n    :target: https://pypi.org/project/pytest-test-tracer-for-pytest\n    :alt: PyPI version\n\n.. image:: https://img.shields.io/pypi/pyversions/pytest-test-tracer-for-pytest.svg\n    :target: https://pypi.org/project/pytest-test-tracer-for-pytest\n    :alt: Python versions\n\n.. image:: https://github.com/testreporter/test-tracer-for-pytest/actions/workflows/main.yml/badge.svg\n    :target: https://github.com/testreporter/test-tracer-for-pytest/actions/workflows/main.yml\n    :alt: See Build Status on GitHub Actions\n\nA plugin that allows collecting test data for use on Test Tracer. It is designed to be used with \nthe `Pytest BDD`_ tool\n\n\nRequirements\n------------\n\n* `Pytest BDD`_\n* A free `Test Tracer`_ account\n* An API token that allows uploading the test result\n\n\n\nInstallation\n------------\n\nYou can install \"pytest-test-tracer-for-pytest\" via `pip`_ from `PyPI`_::\n\n    $ pip install pytest-test-tracer-for-pytest-bdd\n\n\nUsage\n-----\n\nInstall the Plugin then activate it using the following Pytest parameters\n\n.. list-table:: parameters\n   :widths: 25 8 57 10\n   :header-rows: 1\n\n   * - Parameter Name\n     - Required\n     - Description\n     - Default Value\n   * - test-tracer-run-reference\n     - No\n     - By default, Test Tracer Runs are grouped one per Pytest run. If you want multiple Pytest runs to be visible in the same Test Tracer Run, you can specify your own unique run reference. Useful if you split up your test runs into several parallel runs\n     - A GUID\n   * - use-test-tracer\n     - No\n     - Provide this argument to enable the Test Tracer plugin\n     - False\n   * - build-version\n     - No\n     - If your application under test has a build version. You can enter it here.\n     - None\n   * - build-revision\n     - Yes\n     - A unique revision for your application under test. Typically this is a git commit hash, an SVN revision, or any other string that identifies the current code base\n     - None\n   * - test-tracer-project-name\n     - Yes\n     - The name of the Project that this test is for. You can give it the name of your application, a single microservice, or any other way that you choose to describe the thing being tested.\n     - None\n   * - branch-name\n     - Yes\n     - The name of the branch that is being tested\n     - None\n   * - test-tracer-no-upload\n     - No\n     - If you provide this argument, Test Tracer will still generate test result data, but it won't attempt to upload it to Test Tracer\n     - False\n   * - test-tracer-upload-token\n     - No\n     - If you want to upload results to Test Tracer, you need to specify the API token used to secure the upload\n     - None\n   * - test-tracer-environment-name\n     - True\n     - What environment are you running on? eg: Dev, Production, Staging, etc...\n     - None     \n   * - test-tracer-run-alias\n     - No\n     - If you want to you can provide an alias for this run. For example a run called \"API Authentication Tests\" will allow you to view, group and report on all tests that were part of that run\n     - None\n\nHere is an example of using the Test Tracer for Pytest plugin with Git as the source control::\n\n$ pytest --branch-name=$(git rev-parse --abbrev-ref HEAD) --build-revision=$(git rev-parse --short HEAD) --test-tracer-project-name=\"Your Project Name\" --test-tracer-upload-token=\"Your Test Tracer Upload Token\"\n\nLicense\n-------\n\nDistributed under the terms of the `MIT`_ license, \"pytest-test-tracer-for-pytest\" is free and open source software\n\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`MIT`: https://opensource.org/licenses/MIT\n.. _`BSD-3`: https://opensource.org/licenses/BSD-3-Clause\n.. _`GNU GPL v3.0`: https://www.gnu.org/licenses/gpl-3.0.txt\n.. _`Apache Software License 2.0`: https://www.apache.org/licenses/LICENSE-2.0\n.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin\n.. _`file an issue`: https://github.com/testreporter/test-tracer-for-pytest/issues\n.. _`pytest`: https://github.com/pytest-dev/pytest\n.. _`tox`: https://tox.readthedocs.io/en/latest/\n.. _`pip`: https://pypi.org/project/pip/\n.. _`PyPI`: https://pypi.org/project\n.. _`Test Tracer`: https://testtracer.io\n.. _`Pytest BDD`: https://pypi.org/project/pytest-bdd/\n",
    "bugtrack_url": null,
    "license": " The MIT License (MIT)  Copyright (c) 2024 Gavin Clark  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A plugin that allows coll test data for use on Test Tracer",
    "version": "0.3.5",
    "project_urls": {
        "Repository": "https://github.com/testreporter/test-tracer-for-pytest"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2f0235c5b7922e84dfe36bc6591c8b30a026292a4d2df6807a7edaa12a24c6cb",
                "md5": "58672e01583740c1ce90609b0130b4b2",
                "sha256": "e064259dc11eba2ed7fe40ffb82971cb97c02611e323fc571c3effd64e2f4005"
            },
            "downloads": -1,
            "filename": "pytest_test_tracer_for_pytest_bdd-0.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "58672e01583740c1ce90609b0130b4b2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9499,
            "upload_time": "2024-08-20T11:25:21",
            "upload_time_iso_8601": "2024-08-20T11:25:21.288753Z",
            "url": "https://files.pythonhosted.org/packages/2f/02/35c5b7922e84dfe36bc6591c8b30a026292a4d2df6807a7edaa12a24c6cb/pytest_test_tracer_for_pytest_bdd-0.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "99ba57de9de343e964e712b0837fbd9967e256cc65c43fb4f88ff3142818e7d7",
                "md5": "13f7a2a26bbaa02bb980315231eb212a",
                "sha256": "e621f0ab63be30aab9ebf3160089e7f92ed8f6bdb3c6cd60ad7bafb5c1ea5054"
            },
            "downloads": -1,
            "filename": "pytest_test_tracer_for_pytest_bdd-0.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "13f7a2a26bbaa02bb980315231eb212a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10427,
            "upload_time": "2024-08-20T11:25:22",
            "upload_time_iso_8601": "2024-08-20T11:25:22.286797Z",
            "url": "https://files.pythonhosted.org/packages/99/ba/57de9de343e964e712b0837fbd9967e256cc65c43fb4f88ff3142818e7d7/pytest_test_tracer_for_pytest_bdd-0.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-20 11:25:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "testreporter",
    "github_project": "test-tracer-for-pytest",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pytest-test-tracer-for-pytest-bdd"
}
        
Elapsed time: 0.30012s