Fix table data to csv conversion in allure-behave (allure-framework#718)

delatrie · web-flow · commit d667b5e3ed43 · 2022-12-10T23:45:13.000+05:00
diff --git a/allure-behave/features/step.feature b/allure-behave/features/step.feature
@@ -82,3 +82,20 @@ Feature: Step
       And scenario contains step "Given passed step with attachment"
       And this step has attachment
       And this step has "passed" status
+
+  Scenario: Step with table data containing comma
+    Given feature definition
+        """
+        Feature: Step with data
+
+          Scenario: Step with a table data containing comma
+            Given step with a table data
+              |Items A|Items B|
+              |Item 1, Item 2|Item 3, Item 4|
+        """
+    When I run behave with allure formatter
+    Then allure report has a scenario with name "Step with a table data containing comma"
+    And scenario contains step "Given step with a table data"
+    And this step has attachment ".table" with the following data
+      |Items A|Items B|
+      |Item 1, Item 2|Item 3, Item 4|
diff --git a/allure-behave/features/steps/report_steps.py b/allure-behave/features/steps/report_steps.py
@@ -1,17 +1,21 @@
 from functools import partial
 from hamcrest import assert_that, contains_string
 from hamcrest import not_
+from hamcrest import equal_to
+from allure_commons.types import AttachmentType
 from allure_commons_test.report import has_test_case
 from allure_commons_test.result import with_status
 from allure_commons_test.result import has_step
 from allure_commons_test.result import has_attachment
+from allure_commons_test.result import has_attachment_with_content
 from allure_commons_test.result import has_parameter
 from allure_commons_test.result import has_status_details
 from allure_commons_test.result import with_message_contains
 from allure_commons_test.result import has_link
 from allure_commons_test.result import has_description
 from allure_commons_test.container import has_container
 from allure_commons_test.container import has_before, has_after
+from allure_commons_test.content import csv_equivalent
 from allure_commons_test.label import has_severity
 from allure_commons_test.label import has_tag
 from allure_commons_test.label import has_label
@@ -152,8 +156,38 @@ def step_attachment(context, item):
     assert_that(context.allure_report, matcher())
 
 
+@then('this {item} has attachment "{name}" with the following data')
+def step_attachment_data(context, item, name):
+    context_matcher = getattr(context, item)
+    attachment_type, content_matcher = _get_attachment_type_and_matcher(context)
+    matcher = partial(
+        context_matcher,
+        partial(
+            has_attachment_with_content,
+            context.allure_report.attachments,
+            content_matcher,
+            attachment_type.mime_type,
+            name
+        )
+    )
+    assert_that(context.allure_report, matcher())
+
+
 @then('scenario has description "{description}"')
 def step_description(context, description):
     context_matcher = context.scenario
     matcher = partial(context_matcher, has_description, contains_string(description))
     assert_that(context.allure_report, matcher())
+
+def _get_attachment_type_and_matcher(context):
+    return (
+        AttachmentType.CSV,
+        csv_equivalent(
+            [context.table.headings] + [
+                r.cells for r in context.table.rows
+            ]
+        )
+    ) if context.table is not None else (
+        AttachmentType.TEXT,
+        equal_to(context.text)
+    )
diff --git a/allure-behave/pyproject.toml b/allure-behave/pyproject.toml
@@ -1,4 +1,4 @@
 [tool.poe.tasks]
-linter = "flake8 ./src"
+linter = "flake8 --extend-ignore=A003 ./src"
 tests = """behave -f allure_behave.formatter:AllureFormatter -o allure-results
               -f pretty ./features"""
diff --git a/allure-behave/requirements.txt b/allure-behave/requirements.txt
@@ -1,3 +1,3 @@
 poethepoet
 # linters
-flake8==5.*
+flake8
diff --git a/allure-behave/src/utils.py b/allure-behave/src/utils.py
@@ -1,3 +1,5 @@
+import csv
+import io
 from enum import Enum
 from behave.runner_util import make_undefined_step_snippet
 from allure_commons.types import Severity, LabelType
@@ -124,10 +126,11 @@ def step_status_details(result):
 
 
 def step_table(step):
-    table = [','.join(step.table.headings)]
-    for row in step.table.rows:
-        table.append(','.join(list(row)))
-    return '\n'.join(table)
+    with io.StringIO() as buffer:
+        writer = csv.writer(buffer)
+        writer.writerow(step.table.headings)
+        writer.writerows(r.cells for r in step.table.rows)
+        return buffer.getvalue()
 
 
 def is_planned_scenario(scenario, test_plan):
diff --git a/allure-nose2/requirements.txt b/allure-nose2/requirements.txt
@@ -1,4 +1,4 @@
 poethepoet
 # linters
-flake8==4.*
+flake8
 flake8-builtins
diff --git a/allure-pytest-bdd/requirements.txt b/allure-pytest-bdd/requirements.txt
@@ -1,5 +1,5 @@
 mock
 poethepoet
 # linters
-flake8==4.*
+flake8
 flake8-builtins
diff --git a/allure-pytest/requirements.txt b/allure-pytest/requirements.txt
@@ -8,5 +8,5 @@ pytest-xdist
 pytest-lazy-fixture
 poethepoet
 # linters
-flake8==5.*
+flake8
 flake8-builtins
diff --git a/allure-python-commons-test/requirements.txt b/allure-python-commons-test/requirements.txt
@@ -2,5 +2,5 @@
 pyhamcrest
 poethepoet
 # linters
-flake8==5.*
+flake8
 flake8-builtins
diff --git a/allure-python-commons-test/src/container.py b/allure-python-commons-test/src/container.py
@@ -21,8 +21,8 @@ def _matches(self, item):
     def describe_to(self, description):
         description.append_text('describe me later').append_list('[', ', ', ']', self.matchers)
 
-    def describe_mismatch(self, item, mismatch_descaription):
-        self.matches(item, mismatch_descaription)
+    def describe_mismatch(self, item, mismatch_description):
+        self.matches(item, mismatch_description)
 
 
 def has_container(report, *matchers):
diff --git a/allure-python-commons-test/src/content.py b/allure-python-commons-test/src/content.py
@@ -0,0 +1,24 @@
+import csv
+import io
+
+from hamcrest.core.base_matcher import BaseMatcher
+
+
+class CsvEquivalent(BaseMatcher):
+    def __init__(self, rows, **csv_kwargs):
+        self.__rows = rows
+        self.__csv_kwargs = csv_kwargs
+
+    def _matches(self, item):
+        with io.StringIO(item, newline="") as stream:
+            reader = csv.reader(stream, **self.__csv_kwargs)
+            return list(reader) == self.__rows
+
+    def describe_to(self, description):
+        description.append_text(
+            f"csv document equivalent to {self.__rows!r}"
+        )
+
+
+def csv_equivalent(rows, **csv_kwargs):
+    return CsvEquivalent(rows, **csv_kwargs)
diff --git a/allure-python-commons-test/src/lookup.py b/allure-python-commons-test/src/lookup.py
@@ -0,0 +1,26 @@
+from hamcrest.core.base_matcher import BaseMatcher
+from hamcrest import all_of
+
+
+class MapsTo(BaseMatcher):
+    def __init__(self, mapping, *value_matchers):
+        self.__mapping = mapping
+        self.__value_matcher = all_of(*value_matchers)
+
+    def _matches(self, item):
+        if item not in self.__mapping:
+            return False
+        return self.__value_matcher.matches(
+            self.__mapping[item]
+        )
+
+    def describe_to(self, description):
+        keys = list(self.__mapping)
+        description.append_text(
+            f"one of keys {keys!r} mapping to "
+        )
+        self.__value_matcher.describe_to(description)
+
+
+def maps_to(mapping, *value_matchers):
+    return MapsTo(mapping, *value_matchers)
diff --git a/allure-python-commons-test/src/report.py b/allure-python-commons-test/src/report.py
@@ -81,30 +81,47 @@
 class AllureReport:
     def __init__(self, result):
         self.result_dir = result
-        self.test_cases = [json.load(item) for item in self._report_items(result, '*result.json')]
-        self.test_containers = [json.load(item) for item in self._report_items(result, '*container.json')]
-        self.attachments = [item.read() for item in self._report_items(result, '*attachment.*')]
+        self.test_cases = [
+            json.load(file) for _, file in self._report_items(
+                result,
+                '*result.json'
+            )
+        ]
+        self.test_containers = [
+            json.load(file) for _, file in self._report_items(
+                result,
+                '*container.json'
+            )
+        ]
+        self.attachments = {
+            name: file.read() for name, file in self._report_items(
+                result,
+                '*attachment.*'
+            )
+        }
 
     @staticmethod
     def _report_items(report_dir, glob):
         for _file in os.listdir(report_dir):
             if fnmatch.fnmatch(_file, glob):
-                with open(os.path.join(report_dir, _file), encoding="utf-8") as report_file:
-                    yield report_file
+                full_path = os.path.join(report_dir, _file)
+                with open(full_path, encoding="utf-8") as report_file:
+                    yield _file, report_file
 
 
 def has_test_case(name, *matchers):
-    return has_property('test_cases',
-                        has_item(
-                            all_of(
-                                any_of(
-                                    has_entry('fullName', ends_with(name)),
-                                    has_entry('name', starts_with(name))
-                                ),
-                                *matchers
-                            )
-                        )
-                        )
+    return has_property(
+        'test_cases',
+        has_item(
+            all_of(
+                any_of(
+                    has_entry('fullName', ends_with(name)),
+                    has_entry('name', starts_with(name))
+                ),
+                *matchers
+            )
+        )
+    )
 
 
 class HasOnlyTetcases(BaseMatcher):
@@ -142,18 +159,22 @@ def _matches(self, item):
             return False
 
     def describe_to(self, description):
-        description.append_text(f'exactly {self.num} item(s) matching ').append_text(self.matcher)
+        description.append_text(
+            f'exactly {self.num} item(s) matching '
+        ).append_text(self.matcher)
 
 
 def has_only_n_test_cases(name, num, *matchers):
-    return has_property('test_cases',
-                        ContainsExactly(num,
-                                        all_of(
-                                            any_of(
-                                                has_entry('fullName', ends_with(name)),
-                                                has_entry('name', ends_with(name))
-                                            ),
-                                            *matchers
-                                        )
-                                        )
-                        )
+    return has_property(
+        'test_cases',
+        ContainsExactly(
+            num,
+            all_of(
+                any_of(
+                    has_entry('fullName', ends_with(name)),
+                    has_entry('name', ends_with(name))
+                ),
+                *matchers
+            )
+        )
+    )
diff --git a/allure-python-commons-test/src/result.py b/allure-python-commons-test/src/result.py
@@ -66,6 +66,7 @@
 from hamcrest import equal_to, not_none
 from hamcrest import has_entry, has_item
 from hamcrest import contains_string
+from allure_commons_test.lookup import maps_to
 
 
 def has_title(title):
@@ -139,6 +140,19 @@ def has_attachment(attach_type=None, name=None):
                      ))
 
 
+def has_attachment_with_content(attachments, content_matcher, attach_type=None, name=None):
+    return has_entry(
+        'attachments',
+        has_item(
+            all_of(
+                has_entry('name', name) if name else anything(),
+                has_entry('type', attach_type) if attach_type else anything(),
+                has_entry('source', maps_to(attachments, content_matcher))
+            )
+        )
+    )
+
+
 def with_id():
     return has_entry('uuid', not_none())
 
diff --git a/allure-python-commons/pyproject.toml b/allure-python-commons/pyproject.toml
@@ -1,3 +1,3 @@
 [tool.poe.tasks]
-linter = "flake8 ./src"
+linter = "flake8 --extend-ignore=A001,A002,A003 ./src"
 tests = "python -m doctest ./src/*.py"
diff --git a/allure-python-commons/requirements.txt b/allure-python-commons/requirements.txt
@@ -4,4 +4,4 @@ pyhamcrest
 pluggy
 poethepoet
 # linters
-flake8==5.*
+flake8
diff --git a/allure-robotframework/requirements.txt b/allure-robotframework/requirements.txt
@@ -4,5 +4,5 @@ docutils
 pyhamcrest
 poethepoet
 # linters
-flake8==5.*
+flake8
 flake8-builtins
