From 3e4abae7a5f6b8db045f2f36bc967f9b793cfcfb Mon Sep 17 00:00:00 2001
From: Omkar Khatavkar <okhatavkar007@gmail.com>
Date: Fri, 24 Nov 2023 14:07:16 +0530
Subject: [PATCH] recording ui-session-id for report portal logging (#13055)

* recording ui-session-id for report portal logging

* moving the fixture to common location and adding fspath check
---
 pytest_fixtures/core/ui.py            |  3 ++-
 robottelo/hosts.py                    | 28 +++++++++++++++++++--------
 tests/foreman/conftest.py             | 25 ++++++++++++++++++++++++
 tests/foreman/destructive/conftest.py |  3 ++-
 4 files changed, 49 insertions(+), 10 deletions(-)

diff --git a/pytest_fixtures/core/ui.py b/pytest_fixtures/core/ui.py
index 7edbd39b731..f87f4cec0ad 100644
--- a/pytest_fixtures/core/ui.py
+++ b/pytest_fixtures/core/ui.py
@@ -49,7 +49,8 @@ def test_foo(session):
                 session.architecture.create({'name': 'bar'})
 
     """
-    return target_sat.ui_session(test_name, ui_user.login, ui_user.password)
+    with target_sat.ui_session(test_name, ui_user.login, ui_user.password) as session:
+        yield session
 
 
 @pytest.fixture
diff --git a/robottelo/hosts.py b/robottelo/hosts.py
index 4c35dbd41d5..b167d1eba26 100644
--- a/robottelo/hosts.py
+++ b/robottelo/hosts.py
@@ -1729,6 +1729,7 @@ def __init__(self, hostname=None, **kwargs):
         # create dummy classes for later population
         self._api = type('api', (), {'_configured': False})
         self._cli = type('cli', (), {'_configured': False})
+        self.record_property = None
 
     def _swap_nailgun(self, new_version):
         """Install a different version of nailgun from GitHub and invalidate the module cache."""
@@ -1817,6 +1818,7 @@ def omit_credentials(self):
         yield
         self.omitting_credentials = False
 
+    @contextmanager
     def ui_session(self, testname=None, user=None, password=None, url=None, login=True):
         """Initialize an airgun Session object and store it as self.ui_session"""
 
@@ -1829,14 +1831,24 @@ def get_caller():
                 if frame.function.startswith('test_'):
                     return frame.function
 
-        return Session(
-            session_name=testname or get_caller(),
-            user=user or settings.server.admin_username,
-            password=password or settings.server.admin_password,
-            url=url,
-            hostname=self.hostname,
-            login=login,
-        )
+        try:
+            ui_session = Session(
+                session_name=testname or get_caller(),
+                user=user or settings.server.admin_username,
+                password=password or settings.server.admin_password,
+                url=url,
+                hostname=self.hostname,
+                login=login,
+            )
+            yield ui_session
+        except Exception:
+            raise
+        finally:
+            video_url = settings.ui.grid_url.replace(
+                ':4444', f'/videos/{ui_session.ui_session_id}.mp4'
+            )
+            self.record_property('video_url', video_url)
+            self.record_property('session_id', ui_session.ui_session_id)
 
     @property
     def satellite(self):
diff --git a/tests/foreman/conftest.py b/tests/foreman/conftest.py
index 4e3aca8a77c..1e11a276863 100644
--- a/tests/foreman/conftest.py
+++ b/tests/foreman/conftest.py
@@ -1,6 +1,8 @@
 """Configurations for py.test runner"""
+
 import pytest
 
+from robottelo.hosts import Satellite
 from robottelo.logging import collection_logger
 
 
@@ -40,3 +42,26 @@ def pytest_collection_modifyitems(session, items, config):
 
     config.hook.pytest_deselected(items=deselected_items)
     items[:] = [item for item in items if item not in deselected_items]
+
+
+@pytest.fixture(autouse=True)
+def ui_session_record_property(request, record_property):
+    """
+    Autouse fixture to set the record_property attribute for Satellite instances in the test.
+
+    This fixture iterates over all fixtures in the current test node
+    (excluding the current fixture) and sets the record_property attribute
+    for instances of the Satellite class.
+
+    Args:
+        request: The pytest request object.
+        record_property: The value to set for the record_property attribute.
+    """
+    test_directories = ['tests/foreman/destructive', 'tests/foreman/ui']
+    test_file_path = request.node.fspath.strpath
+    if any(directory in test_file_path for directory in test_directories):
+        for fixture in request.node.fixturenames:
+            if request.fixturename != fixture:
+                if isinstance(request.getfixturevalue(fixture), Satellite):
+                    sat = request.getfixturevalue(fixture)
+                    sat.record_property = record_property
diff --git a/tests/foreman/destructive/conftest.py b/tests/foreman/destructive/conftest.py
index f83f6a6313e..190bc2cabe0 100644
--- a/tests/foreman/destructive/conftest.py
+++ b/tests/foreman/destructive/conftest.py
@@ -22,4 +22,5 @@ def test_foo(session):
                 session.architecture.create({'name': 'bar'})
 
     """
-    return module_target_sat.ui_session(test_name, ui_user.login, ui_user.password)
+    with module_target_sat.ui_session(test_name, ui_user.login, ui_user.password) as session:
+        yield session