From 90f01c160fb885aa6450c1d8cb2be01c2c3891d5 Mon Sep 17 00:00:00 2001
From: jyejare <jyejare@redhat.com>
Date: Wed, 18 Oct 2023 19:15:57 +0530
Subject: [PATCH] Capsule N-Minus testing

---
 conf/capsule.yaml.template              |  2 ++
 conftest.py                             |  1 +
 pytest_fixtures/core/sat_cap_factory.py | 21 ++++++++----
 pytest_plugins/capsule_n-minus.py       | 43 +++++++++++++++++++++++++
 4 files changed, 61 insertions(+), 6 deletions(-)
 create mode 100644 pytest_plugins/capsule_n-minus.py

diff --git a/conf/capsule.yaml.template b/conf/capsule.yaml.template
index e6747faa5eb..bc686c327b2 100644
--- a/conf/capsule.yaml.template
+++ b/conf/capsule.yaml.template
@@ -1,4 +1,6 @@
 CAPSULE:
+  # Capsule hostname for N-minus testing
+  HOSTNAME:
   VERSION:
     # The full release version (6.9.2)
     RELEASE:  # populate with capsule version
diff --git a/conftest.py b/conftest.py
index 632f6e2a0e4..c8273388153 100644
--- a/conftest.py
+++ b/conftest.py
@@ -21,6 +21,7 @@
     'pytest_plugins.factory_collection',
     'pytest_plugins.requirements.update_requirements',
     'pytest_plugins.sanity_plugin',
+    'pytest_plugins.capsule_n-minus',
     # Fixtures
     'pytest_fixtures.core.broker',
     'pytest_fixtures.core.sat_cap_factory',
diff --git a/pytest_fixtures/core/sat_cap_factory.py b/pytest_fixtures/core/sat_cap_factory.py
index f08e722cbbf..26e284860a6 100644
--- a/pytest_fixtures/core/sat_cap_factory.py
+++ b/pytest_fixtures/core/sat_cap_factory.py
@@ -43,6 +43,12 @@ def _target_capsule_host(request, capsule_factory):
         yield new_cap
         new_cap.teardown()
         Broker(hosts=[new_cap]).checkin()
+    elif request.config.option.n_minus:
+        if not settings.capsule.hostname:
+            hosts = Capsule.get_hosts_from_inventory(filter="'cap' in @inv.name")
+            settings.capsule.hostname = hosts[0].hostname
+        caps = Capsule(hostname=settings.capsule.hostname)
+        yield caps
     else:
         yield
 
@@ -147,9 +153,10 @@ def session_capsule_host(request, capsule_factory):
 
 
 @pytest.fixture
-def capsule_configured(capsule_host, target_sat):
+def capsule_configured(request, capsule_host, target_sat):
     """Configure the capsule instance with the satellite from settings.server.hostname"""
-    capsule_host.capsule_setup(sat_host=target_sat)
+    if not request.config.option.n_minus:
+        capsule_host.capsule_setup(sat_host=target_sat)
     yield capsule_host
 
 
@@ -161,16 +168,18 @@ def large_capsule_configured(large_capsule_host, target_sat):
 
 
 @pytest.fixture(scope='module')
-def module_capsule_configured(module_capsule_host, module_target_sat):
+def module_capsule_configured(request, module_capsule_host, module_target_sat):
     """Configure the capsule instance with the satellite from settings.server.hostname"""
-    module_capsule_host.capsule_setup(sat_host=module_target_sat)
+    if not request.config.option.n_minus:
+        module_capsule_host.capsule_setup(sat_host=module_target_sat)
     yield module_capsule_host
 
 
 @pytest.fixture(scope='session')
-def session_capsule_configured(session_capsule_host, session_target_sat):
+def session_capsule_configured(request, session_capsule_host, session_target_sat):
     """Configure the capsule instance with the satellite from settings.server.hostname"""
-    session_capsule_host.capsule_setup(sat_host=session_target_sat)
+    if not request.config.option.n_minus:
+        session_capsule_host.capsule_setup(sat_host=session_target_sat)
     yield session_capsule_host
 
 
diff --git a/pytest_plugins/capsule_n-minus.py b/pytest_plugins/capsule_n-minus.py
new file mode 100644
index 00000000000..8c7ae97a6c9
--- /dev/null
+++ b/pytest_plugins/capsule_n-minus.py
@@ -0,0 +1,43 @@
+# Collection of Capsule Factory fixture tests
+# No destructive tests
+# Adjust capsule host and capsule_configured host behavior for n_minus testing
+# Calculate capsule hostname from inventory just as we do in xDist.py
+
+def pytest_addoption(parser):
+    """Add options for pytest to collect tests based on fixtures its using"""
+    help_text = '''
+        Collects tests based on capsule fixtures used by tests and uncollect destructive tests
+
+        Usage: --n-minus
+
+        example: pytest --n-minus tests/foreman
+    '''
+    parser.addoption(
+        "--n-minus", action='store_true', default=False,
+        help=help_text)
+
+
+def pytest_collection_modifyitems(items, config):
+
+    if not config.getoption('n_minus', False):
+        return
+
+    selected = []
+    deselected = []
+
+    for item in items:
+        is_destructive = item.get_closest_marker('destructive')
+        # Deselect Destructive tests and tests without capsule_factory fixture
+        if 'capsule_factory' not in item.fixturenames or is_destructive:
+            deselected.append(item)
+            continue
+        if 'session_puppet_enabled_sat' in item.fixturenames:
+            deselected.append(item)
+            continue
+        if 'sat_maintain' in item.fixturenames and 'satellite' in item.callspec.params.values():
+            deselected.append(item)
+            continue
+        selected.append(item)
+
+    config.hook.pytest_deselected(items=deselected)
+    items[:] = selected