rft allure-pytest self testing (fixes #292 via #354)

Author: sseliverstov

allure-pytest/examples/attachment/attachment.rst

@@ -0,0 +1,34 @@
+Attachments
+-----------
+
+Reports can display many different types of provided attachments that can complement a test, step or fixture result.
+Attachments can be created either with invocation of ``allure.attach(body, name, attachment_type, extension):``
+
+``body`` - raw content to be written into the file.
+``name`` - a string with name of the file
+``attachment_type`` - one of the allure.attachment_type values
+``extension`` - is provided will be used as an extension for the created file.
+
+    >>> import allure
+
+    >>> def test_attach_body_with_default_kwargs():
+    ...     allure.attach("Some content in plain text")
+
+    >>> def test_attach_body():
+    ...     xml_content = """<?xml version="1.0" encoding="UTF-8"?>
+    ...     <tag>
+    ...         <inside>...</inside>
+    ...     </tag>
+    ...     """
+    ...     allure.attach(xml_content, name='some attachment name', attachment_type=allure.attachment_type.XML)
+    ...
+    ...     allure.attach("Some content in plain text")
+
+
+or ``allure.attach.file(source, name, attachment_type, extension)``:
+``source`` - a string containing path to the file.
+(other arguments are the same)
+
+    >>> def test_attach_file():
+    ...
+    ...     allure.attach.file(__file__)  # this file path

allure-pytest/examples/attachment/attachment_fixture.rst

@@ -0,0 +1,31 @@
+Attachment in fixtures
+----------------------
+
+Attachments are shown in the context of a test entity they belong to.
+
+You can attach some context from fixture:
+
+    >>> import pytest
+    >>> import allure
+
+    >>> @pytest.fixture
+    ... def fixture_with_attachment():
+    ...     allure.attach("Fixture context")
+
+    >>> def test_fixture_attachment(fixture_with_attachment):
+    ...     pass
+
+
+or fixture finalizer:
+
+    >>> import pytest
+    >>> import allure
+
+    >>> @pytest.fixture
+    ... def fixture_with_attachment_in_finalizer(request):
+    ...     def finalizer():
+    ...         allure.attach(__file__)
+    ...     request.addfinalizer(finalizer)
+
+    >>> def test_fixture_finalizer_attachment(fixture_with_attachment_in_finalizer):
+    ...     pass

allure-pytest/examples/attachment/attachment_step.rst

@@ -0,0 +1,14 @@
+Attachment in step
+------------------
+
+Attachment usage for steps make your test more clear.
+
+    >>> import pytest
+    >>> import allure
+
+    >>> @allure.step
+    ... def step_with_attachment():
+    ...     allure.attach("hello there")
+
+    >>> def test_step_with_attachment():
+    ...     step_with_attachment()

allure-pytest/examples/description/description.rst

@@ -0,0 +1,27 @@
+Description
+-----------
+
+You can add a detailed description for tests to provide as much context to the report reader as you want. This can be
+done in several ways: you can add a @allure.description decorator providing a description string or you can use
+``@allure.description_html`` to provide some HTML to be rendered in the 'Description' section of a test case.
+
+    >>> import allure
+
+    >>> @allure.description("""Test description""")
+    ... def test_description():
+    ...     pass
+
+
+    >>> @allure.description_html("""<h1>Html test description</h1>""")
+    ... def test_description_html():
+    ...     pass
+
+
+Alternatively description will be simply picked up from the docstring of a test method.
+
+    >>> def test_docstring_description():
+    ...     """ Docstring """
+
+
+    >>> def test_unicode_docstring_description():
+    ...     """ Докстринг в юникоде """

allure-pytest/examples/description/dynamic_description.rst

@@ -0,0 +1,15 @@
+Dynamic description
+-------------------
+
+Also descriptions can be dynamically updated from within test body using allure.dynamic.description.
+
+
+    >>> import allure
+
+    >>> @allure.description("Initial description")
+    ... def test_dynamic_description():
+    ...     allure.dynamic.description("Actual description")
+
+    >>> @allure.description_html("<h1>Initial HTML description</h1>")
+    ... def test_dynamic_description_html():
+    ...     allure.dynamic.description_html("<p>Actual HTML description</p>")

allure-pytest/examples/display_name/display_name.rst

@@ -0,0 +1,19 @@
+Test title
+----------
+
+Test titles can be made more readable with special @allure.title decorator.
+Titles support placeholders for arguments.
+
+    >>> import pytest
+    >>> import allure
+
+
+    >>> @allure.title("A some test title")
+    ... def test_display_name():
+    ...     pass
+
+
+    >>> @allure.title("A some test title with param {param}")
+    ... @pytest.mark.parametrize('param', [False])
+    ... def test_display_name_template(param):
+    ...     assert param

allure-pytest/examples/display_name/dynamic_display_name.rst

@@ -0,0 +1,9 @@
+Dynamic test title
+------------------
+
+    >>> import allure
+
+
+    >>> @allure.title("A some test tile")
+    >>> def test_dynamic_display_name():
+    >>>     allure.dynamic.title("It is renamed test")

allure-pytest/examples/label/bdd/bdd_label.rst

@@ -0,0 +1,21 @@
+BDD labels
+----------
+
+There are two decorators: @allure.feature and @allure.story to mark your tests according to Feature/Story breakdown
+specific to your project
+
+    >>> import allure
+
+
+    >>> @allure.epic("My epic")
+    ... @allure.feature("My feature")
+    ... @allure.story("My story")
+    ... def test_single_bdd_label():
+    ...     pass
+
+
+    >>> @allure.epic("My epic", "Another epic")
+    ... @allure.feature("My feature", "Another feature", "One more feature")
+    ... @allure.story("My story", "Alternative story")
+    ... def test_multiple_bdd_label():
+    ...     pass

allure-pytest/examples/label/bdd/dynamic_bdd_label.rst

@@ -0,0 +1,13 @@
+Dynamic BDD labels
+------------------
+
+    >>> import allure
+    >>> import pytest
+
+    >>> @allure.feature('first feature')
+    ... def test_dynamic_feature():
+    ...     allure.dynamic.feature('second feature')
+
+    >>> @pytest.mark.parametrize('feature', ['first feature', 'second feature'])
+    ... def test_parametrized_dynamic_feature(feature):
+    ...     allure.dynamic.feature(feature)

allure-pytest/examples/label/bdd/select_tests_by_bdd.rst

@@ -0,0 +1,43 @@
+Selecting tests by BDD label
+----------------------------
+
+You can use following commandline options to specify different sets of tests to execute passing a list of
+comma-separated values:
+
+--allure-epics
+--allure-features
+--allure-stories
+
+There are some tests marked with BDD labels:
+
+    >>> import allure
+
+    >>> @allure.epic("My Epic")
+    ... @allure.feature("My Feature")
+    ... @allure.story("My Story")
+    ... def test_with_epic_feature_story():
+    ...     pass
+
+
+    >>> @allure.epic("My Epic")
+    ... @allure.feature("My Feature")
+    ... def test_with_epic_feature():
+    ...     pass
+
+
+    >>> @allure.epic("My Epic")
+    ... def test_with_epic():
+    ...     pass
+
+
+    >>> @allure.epic("Another Epic")
+    ... @allure.feature("Another Feature")
+    ... @allure.story("Another Story")
+    ... def test_with_another_epic_feature_story():
+    ...     pass
+
+If you run ``pytest`` with following options: ``$ pytest tests.py --allure-epics=My Epic --alluredir=./report`` first
+three tests will be runned.
+
+And with next options: ``$ pytest tests.py --allure-stories=My Story, Another Story --alluredir=./report`` it will
+run just are first and last test.