Code reference support

Author: HardNorth

.gitignore

@@ -36,3 +36,4 @@ coverage.xml
 # Environments
 .env
 .venv
+/venv

.travis.yml

@@ -9,8 +9,13 @@ python:
   - "3.6"
   - "3.7"
   - "3.8"
+install:
+  - pip install pycodestyle pydocstyle pytest delayed-assert requests reportportal-client dill
+before_script:
+  - pycodestyle .
+  - pydocstyle .
 script:
-  - python setup.py test
+  - pytest tests/ -s -vv
   - python setup.py -q install
 
 jobs:

pytest_reportportal/__init__.py

@@ -1,3 +1,5 @@
+"""This package contains Pytest agent's code for the Report Portal."""
+
 from .rp_logging import RPLogger, RPLogHandler
 
 __all__ = ['RPLogger', 'RPLogHandler']

pytest_reportportal/errors.py

@@ -8,4 +8,3 @@ class PytestWarning(UserWarning):
     up to 3.8.0. Get rid of this code once we drop support for Pytest versions
     below 3.8.0.
     """
-    pass

pytest_reportportal/listener.py

@@ -1,37 +1,56 @@
+"""RPReportListener implements Pytest hooks required for item reporting."""
+
 import pytest
 import logging
 try:
-    from html import escape   # python3
+    from html import escape  # python3
 except ImportError:
-    from cgi import escape    # python2
+    from cgi import escape  # python2
 
 
 try:
     # This try/except can go away once we support pytest >= 3.3
     import _pytest.logging
+
     PYTEST_HAS_LOGGING_PLUGIN = True
     from .rp_logging import RPLogHandler, patching_logger_class
 except ImportError:
     PYTEST_HAS_LOGGING_PLUGIN = False
 
 
 class RPReportListener(object):
+    """RPReportListener class."""
+
     def __init__(self, py_test_service,
                  log_level=logging.NOTSET,
                  endpoint=None):
+        """Initialize RPReport Listener instance.
+
+        :param py_test_service: PyTestServiceClass instance
+        :param log_level:       One of the 'CRITICAL', 'ERROR',
+                                'WARNING','INFO','DEBUG', 'NOTSET'
+        :param endpoint:        Report Portal API endpoint
+        """
         # Test Item result
         self.PyTestService = py_test_service
         self.result = None
         self.issue = {}
         self._log_level = log_level
         if PYTEST_HAS_LOGGING_PLUGIN:
-            self._log_handler = RPLogHandler(py_test_service=py_test_service,
-                                             level=log_level,
-                                             filter_reportportal_client_logs=True,
-                                             endpoint=endpoint)
+            self._log_handler = \
+                RPLogHandler(py_test_service=py_test_service,
+                             level=log_level,
+                             filter_client_logs=True,
+                             endpoint=endpoint)
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_protocol(self, item):
+        """
+        Adding issues id marks to the test item.
+
+        :param item:  Pytest.Item
+        :return: generator object
+        """
         self._add_issue_id_marks(item)
         item_id = self.PyTestService.start_pytest_item(item)
         if PYTEST_HAS_LOGGING_PLUGIN:
@@ -48,6 +67,12 @@ def pytest_runtest_protocol(self, item):
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_makereport(self, item):
+        """
+         Change runtest_makereport function.
+
+        :param item: pytest.Item
+        :return: None
+        """
         report = (yield).get_result()
 
         if report.longrepr:
@@ -89,8 +114,10 @@ def _add_issue_id_marks(self, item):
                         for issue_id in issue_ids:
                             mark_issue = "{}:{}".format(mark.name, issue_id)
                             try:
-                                pytest.mark._markers.add(mark_issue)  # register mark in pytest,
-                            except AttributeError:               # for pytest >= 4.5.0
+                                # register mark in pytest
+                                pytest.mark._markers.add(mark_issue),
+                                # for pytest >= 4.5.0
+                            except AttributeError:
                                 pass
                             item.add_marker(mark_issue)
 
@@ -120,11 +147,14 @@ def _add_issue_info(self, item, report):
                     mark_comment = mark.kwargs.get("reason", mark.name)
                     mark_comment += ":"
                     for issue_id in issue_ids:
-                        issue_url = mark_url.format(issue_id=issue_id) if mark_url else None
-                        template = " [{issue_id}]({url})" if issue_url else " {issue_id}"
-                        mark_comment += template.format(issue_id=issue_id, url=issue_url)
+                        issue_url = mark_url.format(issue_id=issue_id) if \
+                            mark_url else None
+                        template = " [{issue_id}]({url})" if issue_url \
+                            else " {issue_id}"
+                        mark_comment += template.format(issue_id=issue_id,
+                                                        url=issue_url)
                 elif "reason" in mark.kwargs:
-                     mark_comment = mark.kwargs["reason"]
+                    mark_comment = mark.kwargs["reason"]
 
                 if mark_comment:
                     comment += ("\n* " if comment else "* ") + mark_comment
@@ -140,7 +170,8 @@ def _add_issue_info(self, item, report):
                 (issue_type in getattr(self.PyTestService, 'issue_types', ())):
             if comment:
                 self.issue['comment'] = comment
-            self.issue['issueType'] = self.PyTestService.issue_types[issue_type]
+            self.issue['issueType'] = \
+                self.PyTestService.issue_types[issue_type]
             # self.issue['ignoreAnalyzer'] = True ???
         elif (report.when == 'setup') and report.skipped:
             self.issue['issueType'] = 'NOT_ISSUE'

pytest_reportportal/plugin.py

@@ -1,3 +1,5 @@
+"""This module contains changed pytest for report-portal."""
+
 # This program is free software: you can redistribute it
 # and/or modify it under the terms of the GPL licence
 
@@ -30,21 +32,36 @@
 
 def is_master(config):
     """
-    True if the code running the given pytest.config object is running in a xdist master
-    node or not running xdist at all.
+    Validate slaveinput attribute.
+
+    True if the code running the given pytest.config object
+    is running in a xdist master node or not running xdist at all.
     """
     return not hasattr(config, 'slaveinput')
 
 
 @pytest.mark.optionalhook
 def pytest_configure_node(node):
+    """
+    Configure node of tests.
+
+    :param node: _pytest.nodes.Node
+    :return: pickle of RPService
+    """
     if node.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
-    node.slaveinput['py_test_service'] = pickle.dumps(node.config.py_test_service)
+    node.slaveinput['py_test_service'] = pickle.dumps(node.config.
+                                                      py_test_service)
 
 
 def pytest_sessionstart(session):
+    """
+    Start test session.
+
+    :param session: Session
+    :return: None
+    """
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
@@ -73,6 +90,12 @@ def pytest_sessionstart(session):
 
 
 def pytest_collection_finish(session):
+    """
+    Collect tests if session is configured.
+
+    :param session: pytest.Session
+    :return: None
+    """
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
@@ -81,6 +104,12 @@ def pytest_collection_finish(session):
 
 
 def wait_launch(rp_client):
+    """
+    Wait for initialize RP_Service.
+
+    :param rp_client: RP_Service
+    :return: None
+    """
     timeout = time.time() + LAUNCH_WAIT_TIMEOUT
     while not rp_client.launch_id:
         if time.time() > timeout:
@@ -89,6 +118,12 @@ def wait_launch(rp_client):
 
 
 def pytest_sessionfinish(session):
+    """
+    Finish session if has attr  'slaveinput'.
+
+    :param session: pytest.Session
+    :return: None
+    """
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
@@ -98,7 +133,12 @@ def pytest_sessionfinish(session):
 
 
 def pytest_configure(config):
+    """
+    Configure RPReportListener for send logs.
 
+    :param config: Config file
+    :return:  None
+    """
     if config.getoption('--collect-only', default=False) or \
             config.getoption('--setup-plan', default=False) or \
             not config.option.rp_enabled:
@@ -132,12 +172,14 @@ def pytest_configure(config):
     if not config.option.rp_launch:
         config.option.rp_launch = config.getini('rp_launch')
     if not config.option.rp_launch_description:
-        config.option.rp_launch_description = config.getini('rp_launch_description')
+        config.option.rp_launch_description = config.\
+            getini('rp_launch_description')
 
     if is_master(config):
         config.py_test_service = PyTestServiceClass()
     else:
-        config.py_test_service = pickle.loads(config.slaveinput['py_test_service'])
+        config.py_test_service = pickle.loads(config.
+                                              slaveinput['py_test_service'])
 
     # set Pytest_Reporter and configure it
     if PYTEST_HAS_LOGGING_PLUGIN:
@@ -157,6 +199,12 @@ def pytest_configure(config):
 
 
 def pytest_unconfigure(config):
+    """
+    Clear config from reporter.
+
+    :param config: Config file
+    :return: None
+    """
     if config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
@@ -169,6 +217,12 @@ def pytest_unconfigure(config):
 
 
 def pytest_addoption(parser):
+    """
+    Add parameter in config of reporter.
+
+    :param parser: Config
+    :return:  None
+    """
     group = parser.getgroup('reporting')
     group.addoption(
         '--rp-launch',
@@ -179,7 +233,8 @@ def pytest_addoption(parser):
         '--rp-launch-description',
         action='store',
         dest='rp_launch_description',
-        help='Launch description (overrides rp_launch_description config option)')
+        help='Launch description (overrides '
+             'rp_launch_description config option)')
 
     group.addoption(
         '--reportportal',
@@ -288,7 +343,8 @@ def pytest_addoption(parser):
     parser.addini(
         'rp_issue_system_url',
         default='',
-        help='URL to get issue description. Issue id from pytest mark will be added to this URL')
+        help='URL to get issue description. Issue id '
+             'from pytest mark will be added to this URL')
 
     parser.addini(
         'rp_verify_ssl',
@@ -300,9 +356,12 @@ def pytest_addoption(parser):
         '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")
+        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")
 
     parser.addini(
         'rp_issue_id_marks',