expose rp_uuid and rp_endpoint to command line

* Added unit tests for .ini and command line arguments

These tests verify the names of the arguments added to each.

* Refactored `pytest_addoption` and `AgentConfig`

This change adds a new helper function `add_shared_option` within
`pytest_addoption` to make it easier to keep both sets of arguments
consistent with each other.

This change also adds a new method, `AgentConfig.find_option`, which
is used to find options given from either the command line or from
the .ini file.

Note: This change does affect the order of the calls to
`parser.addini` and `group.addoption`.

* Expose `rp_uuid` and `rp_endpoint` as command line arguments

Co-authored-by: Ryan Hardin <[email protected]>

Author: rthardin

pytest_reportportal/config.py

@@ -18,31 +18,24 @@ def __init__(self, pytest_config):
         self._rp_rerun = None
         self.pconfig = pytest_config
 
-        self.rp_endpoint = self.pconfig.getini('rp_endpoint')
-        self.rp_ignore_errors = self.pconfig.getini('rp_ignore_errors')
-        self.rp_ignore_attributes = self.pconfig.getini('rp_ignore_attributes')
-        self.rp_is_skipped_an_issue = self.pconfig.getini(
-            'rp_is_skipped_an_issue')
-        self.rp_launch = self.pconfig.option.rp_launch or self.pconfig.getini(
-            'rp_launch')
-        self.rp_launch_id = (self.pconfig.option.rp_launch_id or
-                             self.pconfig.getini('rp_launch_id'))
-        self.rp_launch_attributes = self.pconfig.getini('rp_launch_attributes')
-        self.rp_launch_description = (
-                self.pconfig.option.rp_launch_description or
-                self.pconfig.getini('rp_launch_description')
+        self.rp_endpoint = self.find_option('rp_endpoint')
+        self.rp_ignore_errors = self.find_option('rp_ignore_errors')
+        self.rp_ignore_attributes = self.find_option('rp_ignore_attributes')
+        self.rp_is_skipped_an_issue = self.find_option(
+            'rp_is_skipped_an_issue'
         )
-        self.rp_log_batch_size = int(self.pconfig.getini('rp_log_batch_size'))
+        self.rp_launch = self.find_option('rp_launch')
+        self.rp_launch_id = self.find_option('rp_launch_id')
+        self.rp_launch_attributes = self.find_option('rp_launch_attributes')
+        self.rp_launch_description = self.find_option('rp_launch_description')
+        self.rp_log_batch_size = int(self.find_option('rp_log_batch_size'))
         self.rp_log_level = get_actual_log_level(self.pconfig, 'rp_log_level')
-        self.rp_parent_item_id = (self.pconfig.option.rp_parent_item_id or
-                                  self.pconfig.getini('rp_parent_item_id'))
-        self.rp_project = (self.pconfig.option.rp_project or
-                           self.pconfig.getini('rp_project'))
-        self.rp_rerun_of = (self.pconfig.option.rp_rerun_of or
-                            self.pconfig.getini('rp_rerun_of'))
-        self.rp_retries = int(self.pconfig.getini('retries'))
-        self.rp_uuid = getenv('RP_UUID') or self.pconfig.getini('rp_uuid')
-        self.rp_verify_ssl = self.pconfig.getini('rp_verify_ssl')
+        self.rp_parent_item_id = self.find_option('rp_parent_item_id')
+        self.rp_project = self.find_option('rp_project')
+        self.rp_rerun_of = self.find_option('rp_rerun_of')
+        self.rp_retries = int(self.find_option('retries'))
+        self.rp_uuid = getenv('RP_UUID') or self.find_option('rp_uuid')
+        self.rp_verify_ssl = self.find_option('rp_verify_ssl')
 
     @property
     def rp_rerun(self):
@@ -54,3 +47,22 @@ def rp_rerun(self):
                 self._rp_rerun = (self.pconfig.option.rp_rerun or
                                   self.pconfig.getini('rp_rerun'))
         return self._rp_rerun
+
+    def find_option(self, option_name, default=None):
+        """
+        Find a single configuration setting from multiple places.
+
+        The value is retrieved in the following places in priority order:
+
+        1. From `self.pconfig.option.[option_name]`.
+        2. From `self.pconfig.getini(option_name)`.
+
+        :param option_name: name of the option
+        :param default:     value to be returned if not found
+        :return: option value
+        """
+        value = (
+            getattr(self.pconfig.option, option_name) or
+            self.pconfig.getini(option_name)
+        )
+        return value if value else default

pytest_reportportal/config.pyi

@@ -1,5 +1,5 @@
 from _pytest.config import Config as Config
-from typing import List, Optional, Text
+from typing import List, Optional, Text, Union
 
 class AgentConfig:
     _rp_rerun: Optional[bool] = ...
@@ -23,3 +23,5 @@ class AgentConfig:
     def __init__(self, pytest_config: Config) -> None: ...
     @property
     def rp_rerun(self) -> Optional[bool]: ...
+
+    def find_option(self, param: str) -> Union[str, bool]: ...

pytest_reportportal/plugin.py

@@ -214,83 +214,80 @@ def pytest_addoption(parser):
     :param parser: Object of the Parser class
     """
     group = parser.getgroup('reporting')
-    group.addoption(
-        '--rp-launch',
-        action='store',
-        dest='rp_launch',
-        help='Launch name (overrides rp_launch config option)')
-    group.addoption(
-        '--rp-launch-id',
-        action='store',
-        dest='rp_launch_id',
-        help='Use already existing launch-id. The plugin won\'t control the '
-             'Launch status (overrides rp_launch_id config option)')
-    group.addoption(
-        '--rp-launch-description',
-        action='store',
-        dest='rp_launch_description',
-        help='Launch description (overrides '
-             'rp_launch_description config option)')
-    group.addoption(
-        '--rp-rerun',
-        action='store_true',
-        dest='rp_rerun',
-        help='Marks the launch as the rerun')
-    group.addoption(
-        '--rp-rerun-of',
-        action='store',
-        dest='rp_rerun_of',
-        help='ID of the launch to be marked as a rerun '
-             '(use only with rp_rerun=True)')
-    group.addoption(
-        '--rp-parent-item-id',
-        action='store',
-        dest='rp_parent_item_id',
-        help='Create all test item as child items of the given '
-             '(already existing) item.')
-    group.addoption(
-        '--rp-project',
-        action='store',
-        dest='rp_project',
-        help='Sets rp_project from command line'
-    )
+
+    def add_shared_option(name, help, default=None, action='store'):
+        """
+        Add an option to both the command line and the .ini file.
+
+        This function modifies `parser` and `group` from the outer scope.
+
+        :param name:     name of the option
+        :param help:     help message
+        :param default:  default value
+        :param action:   `group.addoption` action
+        """
+        parser.addini(
+            name=name,
+            default=default,
+            help=help,
+        )
+        group.addoption(
+            '--{0}'.format(name.replace('_', '-')),
+            action=action,
+            dest=name,
+            help='{help} (overrides {name} config option)'.format(
+                help=help,
+                name=name,
+            ),
+        )
+
     group.addoption(
         '--reportportal',
         action='store_true',
         dest='rp_enabled',
         default=False,
         help='Enable ReportPortal plugin'
     )
-    group.addoption(
-        '--rp-log-level',
-        dest='rp_log_level',
-        default=None,
-        help='Logging level for automated log records reporting'
+    add_shared_option(
+        name='rp_launch',
+        help='Launch name',
+        default='Pytest Launch',
     )
-
-    parser.addini(
-        'rp_log_level',
-        default=None,
-        help='Logging level for automated log records reporting'
+    add_shared_option(
+        name='rp_launch_id',
+        help='Use already existing launch-id. The plugin won\'t control the '
+             'Launch status',
     )
-    parser.addini(
-        'rp_uuid',
-        help='UUID')
-    parser.addini(
-        'rp_endpoint',
-        help='Server endpoint')
-    parser.addini(
-        'rp_project',
-        help='Project name')
-    parser.addini(
-        'rp_launch',
-        default='Pytest Launch',
-        help='Launch name')
-    parser.addini(
-        'rp_launch_id',
-        default=None,
-        help='Use already existing launch-id. The plugin won\'t control '
-             'the Launch status')
+    add_shared_option(
+        name='rp_launch_description',
+        help='Launch description',
+        default='',
+    )
+    add_shared_option(name='rp_project', help='Project name')
+    add_shared_option(
+        name='rp_log_level',
+        help='Logging level for automated log records reporting',
+    )
+    add_shared_option(
+        name='rp_rerun',
+        help='Marks the launch as a rerun',
+        default=False,
+        action='store_true',
+    )
+    add_shared_option(
+        name='rp_rerun_of',
+        help='ID of the launch to be marked as a rerun (use only with '
+             'rp_rerun=True)',
+        default='',
+    )
+    add_shared_option(
+        name='rp_parent_item_id',
+        help='Create all test item as child items of the given (already '
+             'existing) item.',
+    )
+    add_shared_option(name='rp_uuid', help='UUID')
+    add_shared_option(name='rp_endpoint', help='Server endpoint')
+
     parser.addini(
         'rp_launch_attributes',
         type='args',
@@ -299,10 +296,6 @@ def pytest_addoption(parser):
         'rp_tests_attributes',
         type='args',
         help='Attributes for all tests items, e.g. Smoke')
-    parser.addini(
-        'rp_launch_description',
-        default='',
-        help='Launch description')
     parser.addini(
         'rp_log_batch_size',
         default='20',
@@ -375,21 +368,7 @@ def pytest_addoption(parser):
         type='bool',
         default=True,
         help='Adding tag with issue id to the test')
-    parser.addini(
-        'rp_parent_item_id',
-        default=None,
-        help="Create all test item as child items of the given "
-             "(already existing) item.")
     parser.addini(
         'retries',
         default='0',
         help='Amount of retries for performing REST calls to RP server')
-    parser.addini(
-        'rp_rerun',
-        default=False,
-        help='Marks the launch as the rerun')
-    parser.addini(
-        'rp_rerun_of',
-        default='',
-        help='ID of the launch to be marked as a rerun '
-             '(use only with rp_rerun=True)')

tests/conftest.py

@@ -42,10 +42,26 @@ def mocked_module(mocked_session):
 def mocked_config():
     """Mock Pytest config for testing."""
     mocked_config = mock.create_autospec(Config)
+
+    mocked_config.getoption_side_effects = {
+        '--collect-only': False,
+        '--setup-plan': False,
+        'rp_log_level': 'debug',
+    }
+
+    def getoption_side_effect(name, default=None):
+        return mocked_config.getoption_side_effects.get(
+            name, default if default else mock.Mock()
+        )
+
+    mocked_config.getoption.side_effect = getoption_side_effect
     mocked_config._reportportal_configured = True
     mocked_config.rootdir = py.path.local('/path/to')
     mocked_config.trace = TagTracer().get('root')
     mocked_config.pluginmanager = mock.Mock()
+    mocked_config.option = mock.Mock()
+    mocked_config.option.rp_log_batch_size = -1
+    mocked_config.option.retries = -1
     return mocked_config