From 90943a56ec4695c9190d098d500bf940a8045cd0 Mon Sep 17 00:00:00 2001
From: Fabio Bertagna <33524186+DonGiovanni83@users.noreply.github.com>
Date: Fri, 26 Apr 2024 09:28:36 +0200
Subject: [PATCH] Remove user shell attribute as enum (#117)

* Remove user shell attribute as enum

* Add changelog fragment for #117
---
 ...17-remove-user-shell-attribute-as-enum.yml |  3 ++
 .../module_utils/system_access_users_utils.py | 30 ++-----------------
 .../test_system_access_users_utils.py         | 11 ++++---
 3 files changed, 10 insertions(+), 34 deletions(-)
 create mode 100644 changelogs/fragments/117-remove-user-shell-attribute-as-enum.yml

diff --git a/changelogs/fragments/117-remove-user-shell-attribute-as-enum.yml b/changelogs/fragments/117-remove-user-shell-attribute-as-enum.yml
new file mode 100644
index 00000000..5623066f
--- /dev/null
+++ b/changelogs/fragments/117-remove-user-shell-attribute-as-enum.yml
@@ -0,0 +1,3 @@
+---
+bugfixes:
+    - system_access_users - Remove the UserLoginEnum type to prevent strict validation.
diff --git a/plugins/module_utils/system_access_users_utils.py b/plugins/module_utils/system_access_users_utils.py
index 0c1e851d..33e0de1e 100644
--- a/plugins/module_utils/system_access_users_utils.py
+++ b/plugins/module_utils/system_access_users_utils.py
@@ -63,16 +63,6 @@ class OPNSenseCryptReturnError(Exception):
     """
 
 
-# pylint: disable=too-few-public-methods
-class UserLoginShell(ListEnum):
-    """Represents the user login shell."""
-
-    NOLOGIN = "/sbin/nologin"
-    CSH = "/bin/csh"
-    SH = "/bin/sh"
-    TCSH = "/bin/tcsh"
-
-
 @dataclass
 class Group:
     """
@@ -190,7 +180,7 @@ class User:
         descr (Optional[str]): A description of the user, if available.
         ipsecpsk (Optional[str]): IPsec pre-shared key, if applicable.
         otp_seed (Optional[str]): OTP seed for two-factor authentication, if used.
-        shell (Optional[UserLoginShell]): The user's login shell, if specified.
+        shell (Optional[str]): The user's login shell, if specified.
         uid (Optional[str]): The user's unique identifier.
         disabled (bool): Whether the user is disabled (default is False).
         full_name (Optional[str]): The user's full name, if available.
@@ -225,7 +215,7 @@ class User:
     descr: Optional[str] = None
     ipsecpsk: Optional[str] = None
     otp_seed: Optional[str] = None
-    shell: Optional[UserLoginShell] = UserLoginShell.NOLOGIN
+    shell: str = "/sbin/nologin"
     uid: Optional[str] = None
     disabled: bool = False
     full_name: Optional[str] = None
@@ -245,8 +235,6 @@ def __init__(self, **kwargs):
         _extra_attrs: dict = {}
         for key, value in kwargs.items():
             if key in _attr_names:
-                if key == "shell":
-                    value = UserLoginShell.from_string(value)
                 setattr(self, key, value)
                 continue
 
@@ -264,20 +252,6 @@ def __eq__(self, other) -> bool:
 
         return True
 
-    def __post_init__(self) -> None:
-        # Manually define the fields and their expected types
-        enum_fields = {
-            "shell": UserLoginShell,
-        }
-
-        for field_name, field_type in enum_fields.items():
-            value = getattr(self, field_name)
-
-            # Check if the value is a string and the field_type is a subclass of ListEnum
-            if isinstance(value, str) and issubclass(field_type, ListEnum):
-                # Convert string to ListEnum
-                setattr(self, field_name, field_type.from_string(value))
-
     def set_otp_seed(self, otp_seed: str = None) -> str:
         """
         Generates and returns a base32-encoded OTP seed.
diff --git a/tests/unit/plugins/module_utils/test_system_access_users_utils.py b/tests/unit/plugins/module_utils/test_system_access_users_utils.py
index 1561208a..eb363210 100644
--- a/tests/unit/plugins/module_utils/test_system_access_users_utils.py
+++ b/tests/unit/plugins/module_utils/test_system_access_users_utils.py
@@ -15,7 +15,6 @@
     Group,
     User,
     UserSet,
-    UserLoginShell,
     OPNSenseGroupNotFoundError,
     OPNSenseCryptReturnError,
 )
@@ -157,7 +156,7 @@ def test_user_from_xml():
     assert test_user.authorizedkeys is None
     assert test_user.ipsecpsk is None
     assert test_user.otp_seed is None
-    assert test_user.shell == UserLoginShell.SH
+    assert test_user.shell == "/bin/sh"
     assert test_user.uid == "1000"
 
 
@@ -204,7 +203,7 @@ def test_user_with_api_key_from_xml():
     assert test_user.authorizedkeys is None
     assert test_user.ipsecpsk is None
     assert test_user.otp_seed is None
-    assert test_user.shell == UserLoginShell.SH
+    assert test_user.shell == "/bin/sh"
     assert test_user.uid == "1001"
 
 
@@ -227,7 +226,7 @@ def test_user_from_ansible_module_params_simple(sample_config_path):
     assert new_test_user.expires is None
     assert new_test_user.authorizedkeys is None
     assert new_test_user.ipsecpsk is None
-    assert new_test_user.shell == UserLoginShell.SH
+    assert new_test_user.shell == "/bin/sh"
     assert new_test_user.uid == "1000"
 
 
@@ -316,7 +315,7 @@ def test_user_from_ansible_module_params_with_group(sample_config_path):
     assert new_test_user.expires is None
     assert new_test_user.authorizedkeys is None
     assert new_test_user.ipsecpsk is None
-    assert new_test_user.shell == UserLoginShell.SH
+    assert new_test_user.shell == "/bin/sh"
     assert new_test_user.uid == "1000"
     assert new_test_user.groupname == ["admins"]
 
@@ -504,7 +503,7 @@ def test_user_from_ansible_module_params_with_authorizedkeys(
     assert new_test_user.expires is None
     assert new_test_user.authorizedkeys == "3J35EY37QTNXFFEECJGZ32WVYQC5W4GZ"
     assert new_test_user.ipsecpsk is None
-    assert new_test_user.shell == UserLoginShell.SH
+    assert new_test_user.shell == "/bin/sh"
     assert new_test_user.uid == "1000"