Merge branch 'master' into patch-1

Author: Dzmitry Humianiuk

LICENSE

@@ -7,6 +7,14 @@ agent-python-pytest
 
 Pytest plugin for reporting test results of Pytest to the 'Reportal Portal'.
 
+* Usage
+* Configuration
+* Examples
+* Launching
+* Send attachement (screenshots)
+* Troubleshooting
+* Copyright Notice
+
 Usage
 -----
 
@@ -69,8 +77,10 @@ The following parameters are optional:
 - :code:`rp_hierarchy_parametrize = True` - Enables hierarchy parametrized tests, default `False`. Doesn't support 'xdist' plugin.
 - :code:`rp_hierarchy_dirs_level = 0` - Directory starting hierarchy level (from pytest.ini level) (default `0`)
 - :code:`rp_issue_marks = 'xfail' 'issue'` - Pytest marks that could be used to get issue information (id, type, reason)
-- :code:`rp_issue_system_url = https://bugzilla.olympus.f5net.com/show_bug.cgi?id=` - URL to get issue description (issue id from pytest mark will be added to this URL)
+- :code:`rp_issue_system_url = http://bugzilla.some.com/show_bug.cgi?id={%issue_id}` - issue URL (issue_id will be filled by parameter from pytest mark)
 - :code:`rp_verify_ssl = True` - Verify SSL when connecting to the server
+- :code:`rp_display_suite_test_file = True` In case of True, include the suite's relative file path in the launch name as a convention of "<RELATIVE_FILE_PATH>::<SUITE_NAME>". In case of False, set the launch name to be the suite name only - this flag is relevant only when "rp_hierarchy_module" flag is set to False
+
 
 If you like to override the above parameters from command line, or from CI environment based on your build, then pass
 - :code:`-o "rp_launch_tags=Smoke Tests"` during invocation.
@@ -181,6 +191,13 @@ Example:
         assert False
 
 
+Send attachement (screenshots)
+----------------
+
+https://github.com/reportportal/client-Python#send-attachement-screenshots
+
+
+
 Troubleshooting
 ~~~~~~~~~
 
@@ -205,9 +222,12 @@ deactivate :code:`pytest_reportportal` plugin with command like:
     py.test -p no:pytest_reportportal ./tests
 
 
+
 Copyright Notice
 ----------------
+..  Copyright Notice:  https://github.com/reportportal/agent-python-pytest#copyright-notice
 
 Licensed under the GPLv3_ license (see the LICENSE file).
 
 .. _GPLv3:  https://www.gnu.org/licenses/quick-guide-gplv3.html
+

README.rst

@@ -1,6 +1,9 @@
-import cgi
 import pytest
 import logging
+try:
+    from html import escape   # python3
+except ImportError:
+    from cgi import escape    # python2
 
 
 try:
@@ -46,8 +49,7 @@ def pytest_runtest_makereport(self, item):
 
         if report.longrepr:
             self.PyTestService.post_log(
-                # Used for support python 2.7
-                cgi.escape(report.longreprtext),
+                escape(report.longreprtext),
                 loglevel='ERROR',
             )
 
@@ -101,17 +103,17 @@ def _add_issue_info(self, item, report):
                         issue_ids = [issue_ids]
                     comment += "\n" if comment else ""
                     comment += "Issues:"
-
                     for issue_id in issue_ids:
-                        comment += " [{}]({}{})".format(issue_id, url, issue_id) if url else " {}".format(issue_id)
+                        template = (" [{issue_id}]" + "({})".format(url)) if url else " {issue_id}"
+                        comment += template.format(issue_id=issue_id)
 
                 if "issue_type" in mark.kwargs:
                     issue_type = mark.kwargs["issue_type"]
 
-        if comment:
-            self.issue['comment'] = comment
-
-        if issue_type and self.PyTestService.issue_types and (issue_type in self.PyTestService.issue_types):
+        if issue_type and self.PyTestService.issue_types \
+                and (issue_type in self.PyTestService.issue_types):
+            if comment:
+                self.issue['comment'] = comment
             self.issue['issue_type'] = self.PyTestService.issue_types[issue_type]
             # self.issue['ignoreAnalyzer'] = True ???
         elif (report.when == 'setup') and report.skipped:

pytest_reportportal/listener.py

@@ -297,3 +297,11 @@ def pytest_addoption(parser):
         default=True,
         type='bool',
         help='Verify HTTPS calls')
+
+    parser.addini(
+        'rp_display_suite_test_file',
+        default=True,
+        type='bool',
+        help="In case of True, include the suite's relative file path in the launch name as a convention of "
+             "'<RELATIVE_FILE_PATH>::<SUITE_NAME>'. In case of False, set the launch name to be the suite name "
+             "only - this flag is relevant only when 'rp_hierarchy_module' flag is set to False")

pytest_reportportal/plugin.py

@@ -142,10 +142,10 @@ def makeRecord(self, name, level, fn, lno, msg, args, exc_info,
                 return record
             return makeRecord
 
-        if not logger_class == RPLogger:
+        if not logger_class == RPLogger and not hasattr(logger_class, "_patched"):
             logger_class._log = wrap_log(logger_class._log)
             logger_class.makeRecord = wrap_makeRecord(logger_class.makeRecord)
-
+            logger_class._patched = True
         yield
 
     finally:

pytest_reportportal/rp_logging.py

@@ -1,19 +1,18 @@
 import logging
 import sys
 import traceback
-import pytest
-import pkg_resources
-
 from time import time
-from six import with_metaclass
-from six.moves import queue
 
-from _pytest.main import Session
-from _pytest.python import Class, Function, Instance, Module
+import pkg_resources
+import pytest
 from _pytest.doctest import DoctestItem
+from _pytest.main import Session
 from _pytest.nodes import File, Item
+from _pytest.python import Class, Function, Instance, Module
 from _pytest.unittest import TestCaseFunction, UnitTestCase
 from reportportal_client import ReportPortalServiceAsync
+from six import with_metaclass
+from six.moves import queue
 
 log = logging.getLogger(__name__)
 
@@ -92,10 +91,13 @@ def init_service(self, endpoint, project, uuid, log_batch_size,
                 project=project,
                 token=uuid,
                 error_handler=self.async_error_handler,
-                log_batch_size=log_batch_size,
-                verify_ssl=verify_ssl
+                log_batch_size=log_batch_size  # ,
+                # verify_ssl=verify_ssl
             )
-            self.project_settiings = self.RP.rp_client.get_project_settings() if self.RP else None
+            if self.RP and hasattr(self.RP.rp_client, "get_project_settings"):
+                self.project_settiings = self.RP.rp_client.get_project_settings()
+            else:
+                self.project_settiings = None
             self.issue_types = self.get_issue_types()
         else:
             log.debug('The pytest is already initialized')
@@ -130,7 +132,6 @@ def start_launch(self, launch_name,
         req_data = self.RP.start_launch(**sl_pt)
         log.debug('ReportPortal - Launch started: response_body=%s', req_data)
 
-
     def collect_tests(self, session):
         self._stop_if_necessary()
         if self.RP is None:
@@ -140,12 +141,14 @@ def collect_tests(self, session):
         hier_module = False
         hier_class = False
         hier_param = False
+        display_suite_file_name = True
 
         if not hasattr(session.config, 'slaveinput'):
             hier_dirs = session.config.getini('rp_hierarchy_dirs')
             hier_module = session.config.getini('rp_hierarchy_module')
             hier_class = session.config.getini('rp_hierarchy_class')
             hier_param = session.config.getini('rp_hierarchy_parametrize')
+            display_suite_file_name = session.config.getini('rp_display_suite_test_file')
 
         try:
             hier_dirs_level = int(session.config.getini('rp_hierarchy_dirs_level'))
@@ -181,6 +184,8 @@ def collect_tests(self, session):
 
             self._item_parts[item] = parts
             for part in parts:
+                if '_pytest.python.Class' in str(type(part)) and not display_suite_file_name and not hier_module:
+                    part._rp_name = part._rp_name.split("::")[-1]
                 if part not in self._hier_parts:
                     self._hier_parts[part] = {"finish_counter": 1, "start_flag": False}
                 else:
@@ -249,7 +254,6 @@ def finish_pytest_item(self, test_item, status, issue=None):
             log.debug('ReportPortal - End TestSuite: request_body=%s', payload)
             self.RP.finish_test_item(**payload)
 
-
     def finish_launch(self, launch=None, status='rp_launch'):
         self._stop_if_necessary()
         if self.RP is None:
@@ -347,7 +351,8 @@ def _add_item_hier_parts_parametrize(item, report_parts, tests_parts, rp_name=""
                 if test_fullname in tests_parts:
                     item_test = tests_parts[test_fullname]
                 else:
-                    item_test = Item(test_fullname, nodeid=test_fullname, session=item.session, config=item.session.config)
+                    item_test = Item(test_fullname, nodeid=test_fullname, session=item.session,
+                                     config=item.session.config)
                     item_test._rp_name = rp_name
                     item_test.obj = item.obj
                     item_test.keywords = item.keywords

pytest_reportportal/service.py

@@ -8,7 +8,7 @@ def read_file(fname):
         return f.read()
 
 
-version = '1.0.4'
+version = '1.0.5'
 tar_url = 'https://github.com/reportportal/agent-python-pytest/tarball/1.0.3'
 
 
@@ -25,13 +25,14 @@ def read_file(fname):
     version=version,
     description='Agent for Reporting results of tests to the Report Portal',
     long_description=read_file('README.rst'),
+    long_description_content_type='text/markdown',
     author='Pavel Papou',
     author_email='[email protected]',
     url='https://github.com/reportportal/agent-python-pytest',
     download_url=tar_url,
     packages=['pytest_reportportal'],
     install_requires=requirements,
-    license='GNU General Public License v3',
+    license='Apache 2.0',
     keywords=['testing', 'reporting', 'reportportal', 'pytest'],
     classifiers=[
         'Framework :: Pytest',