mysql_user: deprecate alias user for name argument (#670)

* mysql_user: deprecate alias user for name argument * Fix module and tests
ansible-collections · Sep 2, 2024 · 59c2621 · 59c2621
1 parent 0de9685
commit 59c2621
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/changelogs/fragments/0-mysql_user.yml b/changelogs/fragments/0-mysql_user.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated and will be removed in collection version 5.0.0. Use the ``name`` argument instead.
diff --git a/plugins/modules/mysql_user.py b/plugins/modules/mysql_user.py
@@ -439,7 +439,13 @@
 def main():
     argument_spec = mysql_common_argument_spec()
     argument_spec.update(
-        user=dict(type='str', required=True, aliases=['name']),
+        name=dict(type='str', required=True, aliases=['user'], deprecated_aliases=[
+            {
+                'name': 'user',
+                'version': '5.0.0',
+                'collection_name': 'community.mysql',
+            }],
+        ),
         password=dict(type='str', no_log=True),
         encrypted=dict(type='bool', default=False),
         host=dict(type='str', default='localhost'),
@@ -471,7 +477,7 @@ def main():
     )
     login_user = module.params["login_user"]
     login_password = module.params["login_password"]
-    user = module.params["user"]
+    user = module.params["name"]
     password = module.params["password"]
     encrypted = module.boolean(module.params["encrypted"])
     host = module.params["host"].lower()

diff --git a/tests/integration/targets/test_mysql_user/tasks/issue-265.yml b/tests/integration/targets/test_mysql_user/tasks/issue-265.yml
@@ -64,7 +64,7 @@
     - name: Issue-265 | Remove blank mysql user with hosts=all (expect changed)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         state: absent
         force_context: yes
@@ -78,7 +78,7 @@
     - name: Issue-265 | Remove blank mysql user with hosts=all (expect ok)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         force_context: yes
         state: absent
@@ -151,7 +151,7 @@
     - name: Issue-265 | Remove blank mysql user with hosts=all (expect changed)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         state: absent
         force_context: no
@@ -165,7 +165,7 @@
     - name: Issue-265 | Remove blank mysql user with hosts=all (expect ok)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         force_context: no
         state: absent

diff --git a/tests/integration/targets/test_mysql_user/tasks/test_idempotency.yml b/tests/integration/targets/test_mysql_user/tasks/test_idempotency.yml
@@ -66,7 +66,7 @@
     - name: Idempotency | Remove blank  user with hosts=all (expect changed)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         state: absent
       register: result
@@ -79,7 +79,7 @@
     - name: Idempotency | Remove blank user with hosts=all (expect ok)
       mysql_user:
         <<: *mysql_params
-        user: ""
+        name: ""
         host_all: true
         state: absent
       register: result
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		breaking_changes:
		- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated and will be removed in collection version 5.0.0. Use the ``name`` argument instead.