udm_user: sanity (#5559) (#5593)

* fix parameter email

* fix parameter groups

* fix parameters home_telephone_number, mail_alternative_address, mobile_telephone_number, pager_telephonenumber

* fix parameter phone

* fix parameter samba_privileges

* fix parameter samba_user_workstations

* fix parameter secretary

* fix parameter serviceprovider

* remove lines from ignore files

* add changelog fragment

(cherry picked from commit 79929830c4)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

changelogs/fragments/5559-udm-user-sanity.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - udm_user - add ``elements`` attribute when missing in ``list`` parameters (https://github.com/ansible-collections/community.general/pull/5559).

plugins/modules/udm_user.py

@@ -78,6 +78,7 @@ options:
         description:
             - A list of e-mail addresses.
         type: list
+        elements: str
     employee_number:
         description:
             - Employee number
@@ -99,6 +100,7 @@ options:
                LDAP filter for each group as $GROUP:
                C((&(objectClass=posixGroup)(cn=$GROUP)))."
         type: list
+        elements: str
     home_share:
         description:
             - "Home NFS share. Must be a LDAP DN, e.g.
@@ -116,6 +118,7 @@ options:
             - List of private telephone numbers.
         aliases: [ homeTelephoneNumber ]
         type: list
+        elements: str
     homedrive:
         description:
             - Windows home drive, e.g. C("H:").
@@ -126,6 +129,7 @@ options:
             - List of alternative e-mail addresses.
         aliases: [ mailAlternativeAddress ]
         type: list
+        elements: str
     mail_home_server:
         description:
             - FQDN of mail server
@@ -142,6 +146,7 @@ options:
             - Mobile phone number
         aliases: [ mobileTelephoneNumber ]
         type: list
+        elements: str
     organisation:
         description:
             - Organisation
@@ -165,10 +170,12 @@ options:
             - List of pager telephone numbers.
         aliases: [ pagerTelephonenumber ]
         type: list
+        elements: str
     phone:
         description:
             - List of telephone numbers.
         type: list
+        elements: str
         default: []
     postcode:
         description:
@@ -201,12 +208,14 @@ options:
                join."
         aliases: [ sambaPrivileges ]
         type: list
+        elements: str
         default: []
     samba_user_workstations:
         description:
             - Allow the authentication only on this Microsoft Windows host.
         aliases: [ sambaUserWorkstations ]
         type: list
+        elements: str
         default: []
     sambahome:
         description:
@@ -221,11 +230,13 @@ options:
         description:
             - A list of superiors as LDAP DNs.
         type: list
+        elements: str
     serviceprovider:
         default: ['']
         description:
             - Enable user for the following service providers.
         type: list
+        elements: str
     shell:
         default: '/bin/bash'
         description:
@@ -333,7 +344,8 @@ def main():
             display_name=dict(type='str',
                               aliases=['displayName']),
             email=dict(default=[''],
-                       type='list'),
+                       type='list',
+                       elements='str'),
             employee_number=dict(type='str',
                                  aliases=['employeeNumber']),
             employee_type=dict(type='str',
@@ -341,18 +353,21 @@ def main():
             firstname=dict(type='str'),
             gecos=dict(type='str'),
             groups=dict(default=[],
-                        type='list'),
+                        type='list',
+                        elements='str'),
             home_share=dict(type='str',
                             aliases=['homeShare']),
             home_share_path=dict(type='str',
                                  aliases=['homeSharePath']),
             home_telephone_number=dict(default=[],
                                        type='list',
+                                       elements='str',
                                        aliases=['homeTelephoneNumber']),
             homedrive=dict(type='str'),
             lastname=dict(type='str'),
             mail_alternative_address=dict(default=[],
                                           type='list',
+                                          elements='str',
                                           aliases=['mailAlternativeAddress']),
             mail_home_server=dict(type='str',
                                   aliases=['mailHomeServer']),
@@ -360,6 +375,7 @@ def main():
                                       aliases=['mailPrimaryAddress']),
             mobile_telephone_number=dict(default=[],
                                          type='list',
+                                         elements='str',
                                          aliases=['mobileTelephoneNumber']),
             organisation=dict(type='str',
                               aliases=['organization']),
@@ -371,11 +387,13 @@ def main():
                                   aliases=['override_pw_length']),
             pager_telephonenumber=dict(default=[],
                                        type='list',
+                                       elements='str',
                                        aliases=['pagerTelephonenumber']),
             password=dict(type='str',
                           no_log=True),
             phone=dict(default=[],
-                       type='list'),
+                       type='list',
+                       elements='str'),
             postcode=dict(type='str'),
             primary_group=dict(type='str',
                                aliases=['primaryGroup']),
@@ -387,16 +405,20 @@ def main():
                              aliases=['roomNumber']),
             samba_privileges=dict(default=[],
                                   type='list',
+                                  elements='str',
                                   aliases=['sambaPrivileges']),
             samba_user_workstations=dict(default=[],
                                          type='list',
+                                         elements='str',
                                          aliases=['sambaUserWorkstations']),
             sambahome=dict(type='str'),
             scriptpath=dict(type='str'),
             secretary=dict(default=[],
-                           type='list'),
+                           type='list',
+                           elements='str'),
             serviceprovider=dict(default=[''],
-                                 type='list'),
+                                 type='list',
+                                 elements='str'),
             shell=dict(default='/bin/bash',
                        type='str'),
             street=dict(type='str'),

tests/sanity/ignore-2.11.txt

@@ -26,7 +26,6 @@ plugins/modules/rax.py use-argspec-type-path # fix needed
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
 plugins/modules/udm_share.py validate-modules:parameter-list-no-elements
-plugins/modules/udm_user.py validate-modules:parameter-list-no-elements
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path
 tests/integration/targets/django_manage/files/base_test/simple_project/p1/manage.py compile-2.6   # django generated code

tests/sanity/ignore-2.12.txt

@@ -21,6 +21,5 @@ plugins/modules/rax.py use-argspec-type-path # fix needed
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
 plugins/modules/udm_share.py validate-modules:parameter-list-no-elements
-plugins/modules/udm_user.py validate-modules:parameter-list-no-elements
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.13.txt

@@ -21,6 +21,5 @@ plugins/modules/rax.py use-argspec-type-path # fix needed
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
 plugins/modules/udm_share.py validate-modules:parameter-list-no-elements
-plugins/modules/udm_user.py validate-modules:parameter-list-no-elements
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.14.txt

@@ -23,6 +23,5 @@ plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
 plugins/modules/udm_share.py validate-modules:parameter-list-no-elements
 plugins/modules/udm_user.py import-3.11  # Uses deprecated stdlib library 'crypt'
-plugins/modules/udm_user.py validate-modules:parameter-list-no-elements
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.15.txt

@@ -23,6 +23,5 @@ plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
 plugins/modules/udm_share.py validate-modules:parameter-list-no-elements
 plugins/modules/udm_user.py import-3.11  # Uses deprecated stdlib library 'crypt'
-plugins/modules/udm_user.py validate-modules:parameter-list-no-elements
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path