Test description from docstring (fixes #106 via #113)

* test description from docstring

* files

Author: sseliverstov

allure-pytest/src/listener.py

@@ -67,6 +67,9 @@ def pytest_runtest_protocol(self, item, nextitem):
         test_case = TestResult(name=item.name, uuid=uuid)
         self.allure_logger.schedule_test(uuid, test_case)
 
+        if hasattr(item, 'function'):
+            test_case.description = item.function.__doc__
+
         yield
 
         test_case.labels += [Label(name, value) for name, value in allure_labels(item)]

allure-pytest/test/description/__init__.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+"""
+>>> allure_report = getfixture('allure_report')
+"""
+
+
+def test_text_description():
+    """
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_text_description',
+    ...                           has_description(
+    ...                                           starts_with('\\n    >>> allure_report = ')
+    ...                           )
+    ...             )
+    ... )
+    """
+    pass
+
+
+def test_utf8_text_description():
+    u"""
+    >>> #  рекурсия
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_utf8_text_description',
+    ...                           has_description(
+    ...                                           starts_with(u'\\n    >>> #  рекурсия')
+    ...                           )
+    ...             )
+    ... )
+    """
+    pass

allure-pytest/test/description/text_description_test.py

@@ -134,3 +134,7 @@ def with_status_message(message):
 
 def has_history_id():
     return has_entry('historyId', anything())
+
+
+def has_description(*matchers):
+    return has_entry('description', all_of(*matchers))