Add Label functionality

allure-pytest-bdd/src/attachment_worker.py

@@ -0,0 +1,61 @@
+import os.path
+import os
+
+
+class AttachmentWorker:
+
+    def __init__(self, test_result, item):
+        self.test_result = test_result
+        self.attachments_dir = AttachmentWorker.get_path_to_attachments(item)
+
+    def delete_duplicates(self):
+        if len(self.test_result.attachments) == 0:
+            return
+
+        for step in self.test_result.steps:
+            for attach in step.attachments:
+                to_delete = self._find_duplicate(attach)
+                if to_delete is not None:
+                    self.test_result.attachments.remove(to_delete)
+                    os.remove(os.path.join(self.attachments_dir, to_delete.source))
+
+    @staticmethod
+    def get_path_to_attachments(item):
+        splitted_param = AttachmentWorker._get_allurdir_param(item).split('=')
+
+        project_dir = str(item.config.invocation_params.dir)
+        if len(splitted_param) == 1:
+            return project_dir
+
+        allure_dir = os.path.normpath(splitted_param[1])
+        if not os.path.isabs(allure_dir):
+            allure_dir = os.path.join(project_dir, allure_dir.lstrip("\\"))
+
+        return allure_dir
+
+    def _find_duplicate(self, attachment_from_step):
+        for attachment in self.test_result.attachments:
+            if self._are_attachments_equal(attachment, attachment_from_step):
+                return attachment
+
+        return None
+
+    def _are_attachments_equal(self, first, second):
+        first_file = open(os.path.join(self.attachments_dir, first.source), 'br')
+        first_content = first_file.read()
+        first_file.close()
+
+        second_file = open(os.path.join(self.attachments_dir, second.source), 'br')
+        second_content = second_file.read()
+        second_file.close()
+
+        return \
+            first.name == second.name and \
+            first.type == second.type and \
+            first_content == second_content
+
+    @staticmethod
+    def _get_allurdir_param(item):
+        for param in item.config.invocation_params.args:
+            if param.startswith("--alluredir"):
+                return param

allure-pytest-bdd/src/pytest_bdd_listener.py

@@ -12,10 +12,13 @@
 from .utils import get_step_name
 from .utils import get_status_details
 from .utils import get_pytest_report_status
+from .utils import get_full_name, get_name, get_params
+from .utils import pytest_markers
 from allure_commons.model2 import StatusDetails
 from functools import partial
 from allure_commons.lifecycle import AllureLifecycle
-from .utils import get_full_name, get_name, get_params
+
+from .attachment_worker import AttachmentWorker
 
 
 class PytestBDDListener(object):
@@ -41,6 +44,8 @@ def pytest_bdd_before_scenario(self, request, feature, scenario):
             test_result.fullName = full_name
             test_result.name = name
             test_result.start = now()
+            test_result.labels.extend([Label(name=LabelType.TAG, value=value)
+                                       for value in pytest_markers(request.node)])
             test_result.labels.append(Label(name=LabelType.HOST, value=self.host))
             test_result.labels.append(Label(name=LabelType.THREAD, value=self.thread))
             test_result.labels.append(Label(name=LabelType.FRAMEWORK, value="pytest-bdd"))
@@ -113,6 +118,9 @@ def pytest_runtest_makereport(self, item, call):
                     test_result.status = status
                     test_result.statusDetails = status_details
 
+            if test_result and test_result.status:
+                AttachmentWorker(test_result, item).delete_duplicates()
+
         if report.when == 'teardown':
             self.lifecycle.write_test_case(uuid=uuid)
 

allure-pytest-bdd/src/utils.py

@@ -1,10 +1,11 @@
 import os
 from uuid import UUID
-from allure_commons.utils import md5
 from allure_commons.model2 import StatusDetails
 from allure_commons.model2 import Status
 from allure_commons.model2 import Parameter
+from allure_commons.utils import md5
 from allure_commons.utils import format_exception
+from allure_commons.utils import represent
 
 
 def get_step_name(node, step):
@@ -50,3 +51,31 @@ def get_params(node):
     if hasattr(node, 'callspec'):
         params = node.callspec.params
         return [Parameter(name=name, value=value) for name, value in params.items()]
+
+
+def pytest_markers(item):
+    for keyword in item.keywords.keys():
+        if any([
+            keyword.startswith('allure_'),
+            keyword == 'parametrize',
+            keyword == "usefixtures"
+        ]):
+            continue
+        marker = item.get_closest_marker(keyword)
+        if marker is None:
+            continue
+
+        yield mark_to_str(marker)
+
+
+def mark_to_str(marker):
+    args = [represent(arg) for arg in marker.args]
+    kwargs = ['{name}={value}'.format(name=key, value=represent(marker.kwargs[key])) for key in marker.kwargs]
+    if marker.name in ('filterwarnings', 'skip', 'skipif', 'xfail', 'tryfirst', 'trylast'):
+        markstr = '@pytest.mark.{name}'.format(name=marker.name)
+    else:
+        markstr = '{name}'.format(name=marker.name)
+    if args or kwargs:
+        parameters = ', '.join(args + kwargs)
+        markstr = '{}({})'.format(markstr, parameters)
+    return markstr

allure-pytest-bdd/test/acceptance.feature

@@ -0,0 +1,16 @@
+# Created by denis at 11.01.2021
+Feature: test
+  # Enter feature description here
+
+  Scenario: scenario
+    Given py file with name: example
+    And with imports: pytest, pytest_bdd, allure
+    And with func:
+      """
+      @pytest_bdd.given("given_step")
+      def my_func():
+          allure.attach("blah", ...)
+          raise Exception("message")
+      """
+    And test for scenario_name from file.feature
+    And py file saved

allure-pytest-bdd/test/attachments_tests/attachment_test.py

@@ -0,0 +1,42 @@
+from pytest_bdd import scenario
+
+
+@scenario("attachments_features\\attachment_in_step.feature", "Attachment in Given")
+def test_given_with_attachments():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_step.feature", "Attachment in When")
+def test_when_with_attachments():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_step.feature", "Attachment in Then")
+def test_then_with_attachments():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_exception_step.feature", "Attachment and exception in step")
+def test_step_with_attachments_and_exception():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_many_steps.feature", "Attachment in many steps")
+def test_attachment_in_many_steps():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_failed_step.feature", "Attachment in failed step")
+def test_failed_step_with_attachment():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_called_fixture.feature", "Attachment in called fixture")
+def test_attachment_in_called_fixture():
+    pass
+
+
+@scenario("attachments_features\\attachment_in_step-fixture.feature",
+          "attachment in a step, that is also a fixture")
+def test_attachment_in_step_fixture():
+    pass

allure-pytest-bdd/test/attachments_tests/attachments_features/attachment_in_called_fixture.feature

@@ -0,0 +1,37 @@
+Feature: Attachments
+
+  Scenario: Attachment in called fixture
+    Given example.feature with content:
+      """
+      Feature: Feature Test
+        Scenario: My Scenario Test
+          Given passed step
+          When when-step use fixture, that have attachment
+          Then passed step
+      """
+    And py file with name: example_test
+    And with imports: pytest, pytest_bdd, allure
+    And with passed steps
+    And with func:
+      """
+      @pytest.fixture()
+      def fixture_with_attachment():
+          allure.attach('Attachment content', 'allure attachment', allure.attachment_type.TEXT)
+      """
+    And with func:
+      """
+      @pytest_bdd.when("when-step use fixture, that have attachment")
+      def step_with_attachment(fixture_with_attachment):
+          pass
+      """
+    And test for My Scenario Test from example.feature
+    And py file saved
+
+    When run pytest-bdd with allure
+
+    Then attachment allure attachment must be in attachments
+    And this attachment with content:
+      """
+      Attachment content
+      """
+    And attachments must not be in When when-step use fixture, that have attachment

allure-pytest-bdd/test/attachments_tests/attachments_features/attachment_in_exception_step.feature

@@ -0,0 +1,31 @@
+Feature: Attachments
+
+  Scenario: Attachment and exception in step
+    Given example.feature with content:
+      """
+      Feature: Feature Test
+        Scenario: My Scenario Test
+          Given step with attach and exception
+          When passed step
+          Then passed step
+      """
+    And py file with name: example_test
+    And with imports: pytest_bdd, allure
+    And with passed steps
+    And with func:
+      """
+      @pytest_bdd.given("step with attach and exception")
+      def step_with_attachment():
+          allure.attach('Attachment content', 'allure attachment', allure.attachment_type.TEXT)
+          raise Exception("Exception message")
+      """
+    And test for My Scenario Test from example.feature
+    And py file saved
+
+    When run pytest-bdd with allure
+
+    Then attachment allure attachment must be in Given step with attach and exception
+    And this attachment with content:
+      """
+      Attachment content
+      """

allure-pytest-bdd/test/attachments_tests/attachments_features/attachment_in_failed_step.feature

@@ -0,0 +1,31 @@
+Feature: Attachments
+
+  Scenario: Attachment in failed step
+    Given example.feature with content:
+      """
+      Feature: Feature Test
+        Scenario: My Scenario Test
+          Given failed step with attach
+          When passed step
+          Then passed step
+      """
+    And py file with name: example_test
+    And with imports: pytest_bdd, allure
+    And with passed steps
+    And with func:
+      """
+      @pytest_bdd.given("failed step with attach")
+      def step_with_attachment():
+          allure.attach('Attachment content', 'allure attachment', allure.attachment_type.TEXT)
+          assert False
+      """
+    And test for My Scenario Test from example.feature
+    And py file saved
+
+    When run pytest-bdd with allure
+
+    Then attachment allure attachment must be in Given failed step with attach
+    And this attachment with content:
+      """
+      Attachment content
+      """

allure-pytest-bdd/test/attachments_tests/attachments_features/attachment_in_many_steps.feature

@@ -0,0 +1,52 @@
+Feature: Attachments
+
+  Scenario: Attachment in many steps
+    Given example.feature with content:
+      """
+      Feature: Feature Test
+        Scenario: My Scenario Test
+          Given given step with attach
+          When when step with attach
+          Then then step with attach
+      """
+    And py file with name: example_test
+    And with imports: pytest_bdd, allure
+    And with passed steps
+    And with func:
+      """
+      @pytest_bdd.given("given step with attach")
+      def given_step_with_attachment():
+          allure.attach('Given Attachment content', 'given allure attachment', allure.attachment_type.TEXT)
+      """
+    And with func:
+      """
+      @pytest_bdd.when("when step with attach")
+      def when_step_with_attachment():
+          allure.attach('When Attachment content', 'when allure attachment', allure.attachment_type.TEXT)
+      """
+    And with func:
+      """
+      @pytest_bdd.then("then step with attach")
+      def then_step_with_attachment():
+          allure.attach('Then Attachment content', 'then allure attachment', allure.attachment_type.TEXT)
+      """
+    And test for My Scenario Test from example.feature
+    And py file saved
+
+    When run pytest-bdd with allure
+
+    Then attachment given allure attachment must be in Given given step with attach
+    And this attachment with content:
+      """
+      Given Attachment content
+      """
+    And attachment when allure attachment must be in When when step with attach
+    And this attachment with content:
+      """
+      When Attachment content
+      """
+    And attachment then allure attachment must be in Then then step with attach
+    And this attachment with content:
+      """
+      Then Attachment content
+      """

allure-pytest-bdd/test/attachments_tests/attachments_features/attachment_in_step-fixture.feature

@@ -0,0 +1,38 @@
+Feature: Attachment
+
+  Scenario: attachment in a step, that is also a fixture
+    Given example.feature with content:
+      """
+      Feature: Feature Test
+        Scenario: My Scenario Test
+          Given passed step
+          When when-step is fixture with attachment
+          Then passed step using fixture
+      """
+    And py file with name: example_test
+    And with imports: pytest, pytest_bdd, allure
+    And with passed steps
+    And with func:
+      """
+      @pytest.fixture()
+      @pytest_bdd.when("when-step is fixture with attachment")
+      def step_with_attachment():
+          allure.attach('Attachment content', 'allure attachment', allure.attachment_type.TEXT)
+      """
+    And with func:
+      """
+      @pytest_bdd.then("passed step using fixture")
+      def then_step(step_with_attachment):
+          pass
+      """
+    And test for My Scenario Test from example.feature
+    And py file saved
+
+    When run pytest-bdd with allure
+
+    Then attachment allure attachment must be in When when-step is fixture with attachment
+    And this attachment with content:
+      """
+      Attachment content
+      """
+    And attachments must not be in attachments