omd rm: Report terminated processes

`omd stop` will already report some processes, which could not be
killed. However, the actual condition of `omd rm` to fail is different,
since it cares for all site user processes. `omd` will now report the
processes causing the removal to fail.

CMK-31410

Change-Id: I73a7fb6d2d27049ed46ee0656c8bf2d159b38079
(cherry picked from commit d3fcdfd)

Author: SoloJacobs

omd/packages/omd/omdlib/main.py

@@ -111,7 +111,12 @@
 from omdlib.type_defs import Config, Replacements, Skeleton
 from omdlib.update import get_conflict_mode_update, get_edition, ManageUpdate, PreFlight
 from omdlib.update_check import check_update_possible, prepare_conflict_resolution
-from omdlib.user_processes import kill_site_user_processes, terminate_site_user_processes
+from omdlib.user_processes import (
+    descriptions_of_processes,
+    kill_site_user_processes,
+    site_user_processes,
+    terminate_site_user_processes,
+)
 from omdlib.users_and_groups import (
     find_processes_of_user,
     group_exists,
@@ -120,7 +125,6 @@
     popen_as_site_user,
     run_as_site_user,
     user_id,
-    user_logged_in,
     user_verify,
     useradd,
     userdel,
@@ -2001,9 +2005,19 @@ def _main_rm(
     reuse = "reuse" in options
     kill = "kill" in options
 
-    if user_logged_in(site_name):
+    if remaining_processes := site_user_processes(site_name):
         if not kill:
-            sys.exit("User '%s' still logged in or running processes." % site_name)
+            if descriptions := list(descriptions_of_processes(remaining_processes)):
+                sys.exit(
+                    "\n".join(
+                        [
+                            f"User '{site_name}' still logged in or running processes.",
+                            *descriptions,
+                        ]
+                    )
+                )
+            # The process vanished in the meantime. Technically, still an error but without the
+            # description we might as well do what the user asked for.
         else:
             kill_site_user_processes(site_name, global_opts.verbose)
 

omd/packages/omd/omdlib/user_processes.py

@@ -23,7 +23,7 @@ def terminate_site_user_processes(username: str, verbose: bool) -> None:
     the current OMD call terminate.
     """
 
-    processes = _site_user_processes(username)
+    processes = site_user_processes(username) - set(_get_current_and_parent_processes())
     if not processes:
         return
 
@@ -32,7 +32,7 @@ def terminate_site_user_processes(username: str, verbose: bool) -> None:
     timeout_at = time.time() + 5
     sent_terminate = False
     while processes and time.time() < timeout_at:
-        for process in processes[:]:
+        for process in list(processes):
             try:
                 if not sent_terminate:
                     if verbose:
@@ -49,7 +49,7 @@ def terminate_site_user_processes(username: str, verbose: bool) -> None:
         sent_terminate = True
         time.sleep(0.1)
 
-    if remaining_processes_descriptions := list(_descriptions_of_remaining_processes(processes)):
+    if remaining_processes_descriptions := list(descriptions_of_processes(processes)):
         sys.exit(
             "\n".join(
                 [
@@ -63,10 +63,10 @@ def terminate_site_user_processes(username: str, verbose: bool) -> None:
 
 
 def kill_site_user_processes(username: str, verbose: bool) -> None:
-    processes = _site_user_processes(username)
+    processes = site_user_processes(username) - set(_get_current_and_parent_processes())
     tries = 5
     while tries > 0 and processes:
-        for process in processes[:]:
+        for process in list(processes):
             try:
                 if verbose:
                     sys.stdout.write(f"Killing process {process.pid}...")
@@ -79,7 +79,7 @@ def kill_site_user_processes(username: str, verbose: bool) -> None:
         time.sleep(1)
         tries -= 1
 
-    if remaining_processes_descriptions := list(_descriptions_of_remaining_processes(processes)):
+    if remaining_processes_descriptions := list(descriptions_of_processes(processes)):
         sys.exit(
             "\n".join(
                 [
@@ -90,7 +90,7 @@ def kill_site_user_processes(username: str, verbose: bool) -> None:
         )
 
 
-def _descriptions_of_remaining_processes(
+def descriptions_of_processes(
     remaining_processes: Iterable[psutil.Process],
 ) -> Generator[str]:
     for process in remaining_processes:
@@ -108,9 +108,8 @@ def _get_current_and_parent_processes() -> list[psutil.Process]:
     return processes
 
 
-def _site_user_processes(username: str) -> list[psutil.Process]:
-    """Return list of all running site user processes (that are not excluded)"""
-    exclude = set(_get_current_and_parent_processes())
+def site_user_processes(username: str) -> set[psutil.Process]:
+    """Return list of all running site user processes"""
     processes_of_site_user = set()
     for process in psutil.process_iter():
         try:
@@ -119,4 +118,4 @@ def _site_user_processes(username: str) -> list[psutil.Process]:
             continue
         if process_owner == username:
             processes_of_site_user.add(process)
-    return list(processes_of_site_user - exclude)
+    return processes_of_site_user

omd/packages/omd/omdlib/users_and_groups.py

@@ -11,8 +11,6 @@
 from collections.abc import Sequence
 from typing import IO, Literal, overload, TYPE_CHECKING
 
-import psutil
-
 if TYPE_CHECKING:
     from omdlib.contexts import SiteContext
     from omdlib.version_info import VersionInfo
@@ -171,11 +169,6 @@ def group_id(name: str) -> int:
     return grp.getgrnam(name).gr_gid
 
 
-def user_logged_in(name: str) -> bool:
-    """Check if processes of named user are existing"""
-    return any(p for p in psutil.process_iter() if p.username() == name)
-
-
 def user_verify(
     version_info: "VersionInfo", site: "SiteContext", allow_populated: bool = False
 ) -> bool: