Gecko [ tanishkshah.com ]

Name	Size	Permission	Date	Action
test_install_xray_plugin.py	29.14 KB	-rw-r--r--	2026-08-11 11:44
test_upload_reports_destination.py	7.35 KB	-rw-r--r--	2026-08-11 11:44

Rename

"""
Product-behaviour and integration-contract tests for the X-Ray plugin installer.

These tests pin the post-fix contract of ``Base.copy_file_or_dir`` and
``Base.remove_file_or_dir`` in ``plugins/install-xray-plugin.py``: the
installer must still be able to install a regular file, install a directory
tree, replace an existing destination of either kind, and remove files /
trees / non-existent paths idempotently. The patch routes every destination
syscall through a parent dir fd; these tests verify that the legitimate
product behaviour did not regress.

The installer module is loaded under a stubbed import environment because it
imports CloudLinux-specific runtime modules (``cldetectlib``, ``clcommon.*``)
that are not available outside a provisioned CloudLinux OS. Tests cover shared
filesystem primitives plus panel destination, selection, lifecycle, cron, and
UI/agent-state contracts without requiring a provisioned panel.

Run from the repo root with:

python3 -m unittest discover -s plugins/tests -p 'test_*.py'

or directly:

python3 plugins/tests/test_install_xray_plugin.py
"""

import contextlib
import importlib.util
import os
import shutil
import stat
import sys
import tempfile
import types
import unittest
from unittest import mock

def _install_clos_import_stubs():
    """Register no-op stand-ins for CloudLinux-only modules.

The installer module imports ``cldetectlib``, ``clcommon.utils``,
    ``clcommon.lib.cledition`` and ``clcommon.ui_config`` at top level. These
    are present on a CloudLinux OS host but not in a generic Python
    environment. We register minimal stubs so ``importlib`` can load the
    module under test.
    """
    if "cldetectlib" not in sys.modules:
        sys.modules["cldetectlib"] = types.ModuleType("cldetectlib")

if "clcommon" not in sys.modules:
        sys.modules["clcommon"] = types.ModuleType("clcommon")

if "clcommon.utils" not in sys.modules:
        mod = types.ModuleType("clcommon.utils")
        mod.get_rhn_systemid_value = lambda *a, **kw: None
        sys.modules["clcommon.utils"] = mod

if "clcommon.lib" not in sys.modules:
        sys.modules["clcommon.lib"] = types.ModuleType("clcommon.lib")

if "clcommon.lib.cledition" not in sys.modules:
        mod = types.ModuleType("clcommon.lib.cledition")
        mod.is_cl_solo_edition = lambda: False
        sys.modules["clcommon.lib.cledition"] = mod

if "clcommon.ui_config" not in sys.modules:
        mod = types.ModuleType("clcommon.ui_config")

class _UIConfig:
            def __init__(self, *a, **kw):
                pass

mod.UIConfig = _UIConfig
        sys.modules["clcommon.ui_config"] = mod

def _load_installer_module():
    """Load ``install-xray-plugin.py`` from the plugins/ directory.

The file name contains a hyphen so it cannot be imported by the normal
    package mechanism; we use ``importlib`` with an explicit spec.
    """
    _install_clos_import_stubs()
    here = os.path.dirname(os.path.abspath(__file__))
    source_path = os.path.normpath(os.path.join(here, "..", "install-xray-plugin.py"))
    spec = importlib.util.spec_from_file_location("install_xray_plugin", source_path)
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    return module

class CopyFileOrDirContractTests(unittest.TestCase):
    """``Base.copy_file_or_dir`` must install the source at the destination."""

@classmethod
    def setUpClass(cls):
        cls.installer = _load_installer_module()
        cls.Base = cls.installer.Base

def setUp(self):
        self.tmp = tempfile.mkdtemp(prefix="xray-installer-test-")
        self.addCleanup(shutil.rmtree, self.tmp, ignore_errors=True)
        self.base = self.Base()

def _write(self, path, content, mode=0o644):
        with open(path, "wb") as fh:
            fh.write(content)
        os.chmod(path, mode)

def test_copy_regular_file_into_empty_destination(self):
        src = os.path.join(self.tmp, "src.txt")
        dst = os.path.join(self.tmp, "dst.txt")
        self._write(src, b"hello xray installer", mode=0o640)