OAuth 2.0 Password Grant authentication

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- OAuth 2.0 Password Grant authentication, by @HardNorth
 ### Changed
 - Client version updated to [5.6.6](https://github.com/reportportal/client-Python/releases/tag/5.6.6), by @HardNorth
 ### Fixed

pytest_reportportal/config.py

@@ -32,6 +32,7 @@
 class AgentConfig:
     """Storage for the RP agent initialization attributes."""
 
+    rp_enabled: bool
     rp_client_type: Optional[ClientType]
     rp_rerun: Optional[bool]
     pconfig: Config
@@ -61,8 +62,18 @@ class AgentConfig:
     rp_project: str
     rp_rerun_of: Optional[str]
     rp_api_retries: int
-    rp_skip_connection_test: bool
-    rp_api_key: str
+
+    # API key auth parameter
+    rp_api_key: Optional[str]
+
+    # OAuth 2.0 parameters
+    rp_oauth_uri: Optional[str]
+    rp_oauth_username: Optional[str]
+    rp_oauth_password: Optional[str]
+    rp_oauth_client_id: Optional[str]
+    rp_oauth_client_secret: Optional[str]
+    rp_oauth_scope: Optional[str]
+
     rp_verify_ssl: Union[bool, str]
     rp_launch_timeout: int
     rp_launch_uuid_print: bool
@@ -72,6 +83,7 @@ class AgentConfig:
 
     def __init__(self, pytest_config: Config) -> None:
         """Initialize required attributes."""
+        self.rp_enabled = to_bool(self.find_option(pytest_config, "rp_enabled", True))
         self.rp_rerun = pytest_config.option.rp_rerun or pytest_config.getini("rp_rerun")
         self.rp_endpoint = getenv("RP_ENDPOINT") or self.find_option(pytest_config, "rp_endpoint")
         self.rp_hierarchy_code = to_bool(self.find_option(pytest_config, "rp_hierarchy_code"))
@@ -112,7 +124,6 @@ def __init__(self, pytest_config: Config) -> None:
         self.rp_parent_item_id = self.find_option(pytest_config, "rp_parent_item_id")
         self.rp_project = self.find_option(pytest_config, "rp_project")
         self.rp_rerun_of = self.find_option(pytest_config, "rp_rerun_of")
-        self.rp_skip_connection_test = to_bool(self.find_option(pytest_config, "rp_skip_connection_test"))
 
         rp_api_retries_str = self.find_option(pytest_config, "rp_api_retries")
         rp_api_retries = rp_api_retries_str and int(rp_api_retries_str)
@@ -134,6 +145,7 @@ def __init__(self, pytest_config: Config) -> None:
             else:
                 self.rp_api_retries = 0
 
+        # API key auth parameter
         self.rp_api_key = getenv("RP_API_KEY") or self.find_option(pytest_config, "rp_api_key")
         if not self.rp_api_key:
             self.rp_api_key = getenv("RP_UUID") or self.find_option(pytest_config, "rp_uuid")
@@ -146,15 +158,14 @@ def __init__(self, pytest_config: Config) -> None:
                     DeprecationWarning,
                     2,
                 )
-            else:
-                warnings.warn(
-                    "Argument `rp_api_key` is `None` or empty string, "
-                    "that is not supposed to happen because Report "
-                    "Portal is usually requires an authorization key. "
-                    "Please check your configuration.",
-                    RuntimeWarning,
-                    2,
-                )
+
+        # OAuth 2.0 parameters
+        self.rp_oauth_uri = self.find_option(pytest_config, "rp_oauth_uri")
+        self.rp_oauth_username = self.find_option(pytest_config, "rp_oauth_username")
+        self.rp_oauth_password = self.find_option(pytest_config, "rp_oauth_password")
+        self.rp_oauth_client_id = self.find_option(pytest_config, "rp_oauth_client_id")
+        self.rp_oauth_client_secret = self.find_option(pytest_config, "rp_oauth_client_secret")
+        self.rp_oauth_scope = self.find_option(pytest_config, "rp_oauth_scope")
 
         rp_verify_ssl = self.find_option(pytest_config, "rp_verify_ssl", True)
         try:

pytest_reportportal/plugin.py

@@ -24,7 +24,6 @@
 import pytest
 
 # noinspection PyPackageRequirements
-import requests
 from pytest import Item, Session
 from reportportal_client import RP, RPLogHandler
 from reportportal_client.errors import ResponseError
@@ -48,13 +47,6 @@
 
 LOGGER: Logger = logging.getLogger(__name__)
 
-MANDATORY_PARAMETER_MISSED_PATTERN: str = (
-    "One of the following mandatory parameters is unset: "
-    + "rp_project: {}, "
-    + "rp_endpoint: {}, "
-    + "rp_api_key: {}"
-)
-
 FAILED_LAUNCH_WAIT: str = (
     "Failed to initialize reportportal-client service. "
     + "Waiting for Launch start timed out. "
@@ -182,25 +174,6 @@ def register_markers(config) -> None:
     config.addinivalue_line("markers", "name(name): report the test case with a custom Name.")
 
 
-def check_connection(agent_config: AgentConfig):
-    """Check connection to RP using provided options.
-
-    If connection is successful returns True either False.
-    :param agent_config: Instance of the AgentConfig class
-    :return True on successful connection check, either False
-    """
-    url = "{0}/api/v1/project/{1}".format(agent_config.rp_endpoint, agent_config.rp_project)
-    headers = {"Authorization": "bearer {0}".format(agent_config.rp_api_key)}
-    try:
-        resp = requests.get(url, headers=headers, verify=agent_config.rp_verify_ssl)
-        resp.raise_for_status()
-        return True
-    except requests.exceptions.RequestException as exc:
-        LOGGER.exception(exc)
-        LOGGER.error("Unable to connect to Report Portal, the launch won't be reported")
-        return False
-
-
 # no 'config' type for backward compatibility for older pytest versions
 # noinspection PyProtectedMember
 def pytest_configure(config) -> None:
@@ -210,30 +183,17 @@ def pytest_configure(config) -> None:
     """
     register_markers(config)
 
+    agent_config = AgentConfig(config)
+
     config._rp_enabled = not (
         config.getoption("--collect-only", default=False)
         or config.getoption("--setup-plan", default=False)
-        or not config.option.rp_enabled
+        or not agent_config.rp_enabled
     )
     if not config._rp_enabled:
-        return
-
-    agent_config = AgentConfig(config)
-
-    cond = (agent_config.rp_project, agent_config.rp_endpoint, agent_config.rp_api_key)
-    config._rp_enabled = all(cond)
-    if not config._rp_enabled:
-        LOGGER.debug(MANDATORY_PARAMETER_MISSED_PATTERN.format(*cond))
         LOGGER.debug("Disabling reporting to RP.")
         return
 
-    if not agent_config.rp_skip_connection_test:
-        config._rp_enabled = check_connection(agent_config)
-
-    if not config._rp_enabled:
-        LOGGER.debug("Failed to establish connection with RP. " "Disabling reporting.")
-        return
-
     config._reporter_config = agent_config
 
     if is_control(config):
@@ -612,6 +572,19 @@ def add_shared_option(name, help_str, default=None, action="store"):
         name="rp_launch_uuid_print_output",
         help_str="Launch UUID print output. Default `stdout`. Possible values: [stderr, stdout]",
     )
+    add_shared_option(
+        name="rp_enabled",
+        help_str="Enable reportportal plugin",
+        default=True,
+    )
+
+    # OAuth 2.0 parameters
+    parser.addini("rp_oauth_uri", type="args", help="OAuth 2.0 token endpoint URL for password grant authentication")
+    parser.addini("rp_oauth_username", type="args", help="OAuth 2.0 username for password grant authentication")
+    parser.addini("rp_oauth_password", type="args", help="OAuth 2.0 password for password grant authentication")
+    parser.addini("rp_oauth_client_id", type="args", help="OAuth 2.0 client identifier")
+    parser.addini("rp_oauth_client_secret", type="args", help="OAuth 2.0 client secret")
+    parser.addini("rp_oauth_scope", type="args", help="OAuth 2.0 access token scope")
 
     parser.addini("rp_launch_attributes", type="args", help="Launch attributes, i.e Performance Regression")
     parser.addini("rp_tests_attributes", type="args", help="Attributes for all tests items, e.g. Smoke")
@@ -669,7 +642,6 @@ def add_shared_option(name, help_str, default=None, action="store"):
     parser.addini("rp_issue_id_marks", type="bool", default=True, help="Add tag with issue id to the test")
     parser.addini("retries", default="0", help="Deprecated: use `rp_api_retries` instead")
     parser.addini("rp_api_retries", default="0", help="Amount of retries for performing REST calls to RP server")
-    parser.addini("rp_skip_connection_test", default=False, type="bool", help="Skip Report Portal connection test")
     parser.addini(
         "rp_launch_timeout",
         default=86400,

pytest_reportportal/service.py

@@ -1398,6 +1398,13 @@ def start(self) -> None:
             print_output=self._config.rp_launch_uuid_print_output,
             http_timeout=self._config.rp_http_timeout,
             mode=self._config.rp_mode,
+            # OAuth 2.0 parameters
+            oauth_uri=self._config.rp_oauth_uri,
+            oauth_username=self._config.rp_oauth_username,
+            oauth_password=self._config.rp_oauth_password,
+            oauth_client_id=self._config.rp_oauth_client_id,
+            oauth_client_secret=self._config.rp_oauth_client_secret,
+            oauth_scope=self._config.rp_oauth_scope,
         )
         if hasattr(self.rp, "get_project_settings"):
             self.project_settings = self.rp.get_project_settings()