Fix password module index entry (puzzle#124)

* update module_index entry password so that it matches the structure * updated dict access in order to accept new structure * added fragments
acteru · May 6, 2024 · 1386cf9 · 1386cf9
1 parent 8a0a23b
commit 1386cf9
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 28 deletions.
diff --git a/changelogs/fragments/124-fix-password-module-index-entry.yml b/changelogs/fragments/124-fix-password-module-index-entry.yml
@@ -0,0 +1,4 @@
+---
+bugfixes:
+    - module_index - Password entry now matches configure_function structure.
+    - system_access_users - Updated set_user_password dict calls in order to work with the newly introduced structure
diff --git a/plugins/module_utils/module_index.py b/plugins/module_utils/module_index.py
@@ -107,12 +107,14 @@
                 "/usr/local/etc/inc/auth.inc",
             ],
             "configure_functions": {
-                "name": "echo password_hash",
-                "configure_params": [
-                    "'password'",
-                    "PASSWORD_BCRYPT",
-                    "[ 'cost' => 11 ]",
-                ],
+                "password": {
+                    "name": "echo password_hash",
+                    "configure_params": [
+                        "'password'",
+                        "PASSWORD_BCRYPT",
+                        "[ 'cost' => 11 ]",
+                    ],
+                },
             },
         },
         "firewall_rules": {
@@ -232,12 +234,14 @@
                 "/usr/local/etc/inc/auth.inc",
             ],
             "configure_functions": {
-                "name": "echo password_hash",
-                "configure_params": [
-                    "'password'",
-                    "PASSWORD_BCRYPT",
-                    "[ 'cost' => 11 ]",
-                ],
+                "password": {
+                    "name": "echo password_hash",
+                    "configure_params": [
+                        "'password'",
+                        "PASSWORD_BCRYPT",
+                        "[ 'cost' => 11 ]",
+                    ],
+                },
             },
         },
         "firewall_rules": {
@@ -357,12 +361,14 @@
                 "/usr/local/etc/inc/auth.inc",
             ],
             "configure_functions": {
-                "name": "echo password_hash",
-                "configure_params": [
-                    "'password'",
-                    "PASSWORD_BCRYPT",
-                    "[ 'cost' => 11 ]",
-                ],
+                "password": {
+                    "name": "echo password_hash",
+                    "configure_params": [
+                        "'password'",
+                        "PASSWORD_BCRYPT",
+                        "[ 'cost' => 11 ]",
+                    ],
+                },
             },
         },
         "firewall_rules": {
@@ -483,12 +489,14 @@
                 "/usr/local/etc/inc/auth.inc",
             ],
             "configure_functions": {
-                "name": "echo password_hash",
-                "configure_params": [
-                    "'password'",
-                    "PASSWORD_BCRYPT",
-                    "[ 'cost' => 11 ]",
-                ],
+                "password": {
+                    "name": "echo password_hash",
+                    "configure_params": [
+                        "'password'",
+                        "PASSWORD_BCRYPT",
+                        "[ 'cost' => 11 ]",
+                    ],
+                },
             },
         },
         "firewall_rules": {

diff --git a/plugins/module_utils/system_access_users_utils.py b/plugins/module_utils/system_access_users_utils.py
@@ -775,10 +775,14 @@ def set_user_password(self, user: User) -> None:
 
         # load requirements
         php_requirements = self._config_maps["password"]["php_requirements"]
-        configure_function = self._config_maps["password"]["configure_functions"][
-            "name"
-        ]
-        configure_params = self._config_maps["password"]["configure_functions"][
+
+        # load requirements
+        configure_function_dict = self._config_maps["password"]["configure_functions"]
+        configure_function_key = next(
+            (key for key in configure_function_dict if key != "name"), None
+        )
+        configure_function = configure_function_dict[configure_function_key]["name"]
+        configure_params = configure_function_dict[configure_function_key][
             "configure_params"
         ]