Merge pull request #15 from vakulich/rp_launch_config

Add launch name config option and tags for test items

Author: krasoffski

README.rst

@@ -33,7 +33,7 @@ any one using pytest command line option:
 
 The :code:`pytest.ini` file should have next mandatory fields:
 
-- :code:`rp_uuid` - number could be found in the User profile section
+- :code:`rp_uuid` - value could be found in the User Profile section
 - :code:`rp_project` - name of project in Report Potal
 - :code:`rp_endpoint` - address of Report Portal Server
 
@@ -45,17 +45,23 @@ Example of :code:`pytest.ini`:
     rp_uuid = fb586627-32be-47dd-93c1-678873458a5f
     rp_endpoint = http://192.168.1.10:8080
     rp_project = user_personal
+    rp_launch = AnyLaunchName
     rp_launch_tags = 'PyTest' 'Smoke'
+    rp_launch_description = 'Smoke test'
 
-Also launch tags could be added, but this parapmeter is not
-mandatory :code:`rp_launch_tags = 'PyTest' 'Report_Portal'`.
+The following parapmeters are optional:
 
+- :code:`rp_launch = AnyLaunchName` - launch name (could be overriden
+  by pytest --rp-launch option, default value is 'Pytest Launch')
+- :code:`rp_launch_tags = 'PyTest' 'Smoke'` - list of tags
+- :code:`rp_launch_description = 'Smoke test'` - launch description
 
-Logging
-~~~~~~~
+
+Examples
+~~~~~~~~
 
 For logging of the test item flow to Report Portal, please, use the python
-logging handler privided by plugin like bellow:
+logging handler provided by plugin like bellow:
 
 .. code-block:: python
 
@@ -96,11 +102,33 @@ logging handler privided by plugin like bellow:
         # This debug message will not be sent to the Report Portal.
         logger.debug("Case1. Debug message")
 
+Plugin can report doc-strings of tests as :code:`descriptions`:
+
+.. code-block:: python
+
+    def test_one():
+        """
+        Description of the test case which will be sent to Report Portal
+        """
+        pass
+
+Pytest markers will be attached as :code:`tags` to Report Portal items.
+In the following example tags 'linux' and 'win32' will be used:
+
+.. code-block:: python
+
+    import pytest
+
+    @pytest.mark.win32
+    @pytest.mark.linux
+    def test_one():
+        pass
+
 
 Launching
 ~~~~~~~~~
 
-To run test with Report Portal you need to specify neme of :code:`launch`:
+To run test with Report Portal you can specify name of :code:`launch`:
 
 .. code-block:: bash
 

pytest_reportportal/plugin.py

@@ -29,7 +29,6 @@ def pytest_runtest_makereport(self, item, call):
             )
 
         if report.when == "setup":
-
             # when function pytest_setup is called,
             # test item session will be started in RP
             PyTestService.start_pytest_item(item)
@@ -58,45 +57,38 @@ def pytest_runtest_makereport(self, item, call):
 
 
 def pytest_sessionstart(session):
-    config = session.config
-    if config.option.rp_launch:
-        # get config parameters if rp_launch option is set
-        rp_uuid = config.getini("rp_uuid")
-        rp_project = config.getini("rp_project")
-        rp_endpoint = config.getini("rp_endpoint")
-        rp_launch_tags = config.getini("rp_launch_tags")
-        # initialize PyTest
-        PyTestService.init_service(
-                project=rp_project,
-                endpoint=rp_endpoint,
-                uuid=rp_uuid)
-        launch_name = config.getoption("rp_launch")
-
-        PyTestService.start_launch(launch_name, tags=rp_launch_tags)
+    PyTestService.init_service(
+        project=session.config.getini("rp_project"),
+        endpoint=session.config.getini("rp_endpoint"),
+        uuid=session.config.getini("rp_uuid"),
+    )
+
+    PyTestService.start_launch(
+        session.config.option.rp_launch,
+        tags=session.config.getini("rp_launch_tags"),
+        description=session.config.getini("rp_launch_description"),
+    )
 
 
 def pytest_sessionfinish(session):
-    config = session.config
-    if config.option.rp_launch:
-        # FixMe: currently method of RP api takes the string parameter
-        # so it is hardcoded
-        PyTestService.finish_launch(status="RP_Launch")
+    # FixMe: currently method of RP api takes the string parameter
+    # so it is hardcoded
+    PyTestService.finish_launch(status="RP_Launch")
 
 
 def pytest_configure(config):
-    rp_launch = config.getoption("rp_launch")
-    if rp_launch:
-        # set Pytest_Reporter and configure it
-        config._reporter = RP_Report_Listener()
+    if not config.option.rp_launch:
+        config.option.rp_launch = config.getini("rp_launch")
 
-        if hasattr(config, "_reporter"):
-            config.pluginmanager.register(config._reporter)
+    # set Pytest_Reporter and configure it
+    config._reporter = RP_Report_Listener()
+
+    if hasattr(config, "_reporter"):
+        config.pluginmanager.register(config._reporter)
 
 
 def pytest_unconfigure(config):
-    rp_launch = config.getoption("rp_launch")
-    if rp_launch:
-        PyTestService.terminate_service()
+    PyTestService.terminate_service()
 
     if hasattr(config, "_reporter"):
         reporter = config._reporter
@@ -111,21 +103,31 @@ def pytest_addoption(parser):
         "--rp-launch",
         action="store",
         dest="rp_launch",
-        help="The Launch name for RP")
+        help="Launch name (overrides rp_launch config option)")
 
     parser.addini(
         "rp_uuid",
-        help="Uid of RP user")
+        help="UUID")
 
     parser.addini(
         "rp_endpoint",
-        help="RP server")
+        help="Server endpoint")
 
     parser.addini(
         "rp_project",
-        help="RP Project")
+        help="Project name")
+
+    parser.addini(
+        "rp_launch",
+        default="Pytest Launch",
+        help="Launch name")
 
     parser.addini(
         "rp_launch_tags",
         type="args",
-        help="Tags for of RP Launch, i.e Perfomance Regression")
+        help="Launch tags, i.e Performance Regression")
+
+    parser.addini(
+        "rp_launch_description",
+        default="",
+        help="Launch description")

pytest_reportportal/service.py

@@ -3,6 +3,7 @@
 from time import time
 
 from six import with_metaclass
+from _pytest.mark import MarkMapping
 
 from reportportal_client import ReportPortalServiceAsync
 
@@ -53,13 +54,13 @@ def terminate_service(self):
             self.RP.terminate()
 
     def start_launch(
-            self, launch_name, mode=None, tags=None):
+            self, launch_name, mode=None, tags=None, description=None):
         # In next versions launch object(suite, testcase)
         # could be set as parameter
         sl_pt = {
             "name": launch_name,
             "start_time": timestamp(),
-            "description": 'Pytest Launch',
+            "description": description,
             "mode": mode,
             "tags": tags
         }
@@ -76,10 +77,14 @@ def start_pytest_item(self, test_item=None):
         except AttributeError:
             # doctest has no `function` attribute
             item_description = test_item.reportinfo()[2]
+
+        # extract names of @pytest.mark.* decorators used for test item
+        item_tags = list(MarkMapping(test_item.keywords)._mymarks)
+
         start_rq = {
             "name": test_item.name,
             "description": item_description,
-            "tags": ['PyTest Item Tag'],
+            "tags": item_tags,
             "start_time": timestamp(),
             "item_type": "TEST"
         }

setup.py

@@ -15,7 +15,7 @@ def read_file(fname):
 setup(
     name="pytest-reportportal",
     version=version,
-    description="Agent for Reproting results of tests to the Report Portal server",
+    description="Agent for Reporting results of tests to the Report Portal server",
     long_description=read_file("README.rst") + "\n\n",
     author="Pavel Papou",
     author_email="[email protected]",