Do not require description in UI.

Description attribute is not required in LDAP schema so there is no reason to require it in UI. Modified tests to reflect this change. https://fedorahosted.org/freeipa/ticket/4387 Reviewed-By: Martin Kosek <mkosek@redhat.com>
2025-02-25 18:55:28 -06:00 · 2014-09-26 02:54:28 -04:00
parent 947c7398ed
commit cd9a4cca1f
10 changed files with 17 additions and 17 deletions
--- a/API.txt
+++ b/API.txt
@@ -1296,7 +1296,7 @@ args: 1,10,3
 arg: Str('cn', attribute=True, cli_name='group_name', maxlength=255, multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('external', autofill=True, cli_name='external', default=False)
 option: Int('gidnumber', attribute=True, cli_name='gid', minvalue=1, multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
@@ -1681,7 +1681,7 @@ args: 1,7,3
 arg: Str('cn', attribute=True, cli_name='name', multivalue=False, primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
 option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui')
 option: Str('setattr*', cli_name='setattr', exclude='webui')
@@ -1931,7 +1931,7 @@ args: 1,7,3
 arg: Str('cn', attribute=True, cli_name='hostgroup_name', multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*$', primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
 option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui')
 option: Str('setattr*', cli_name='setattr', exclude='webui')
@@ -2180,7 +2180,7 @@ args: 1,11,3
 arg: Str('cn', attribute=True, cli_name='name', multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*$', primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Str('externalhost', attribute=True, cli_name='externalhost', multivalue=True, required=False)
 option: StrEnum('hostcategory', attribute=True, cli_name='hostcat', multivalue=False, required=False, values=(u'all',))
 option: Str('nisdomainname', attribute=True, cli_name='nisdomain', multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*$', required=False)
@@ -2608,7 +2608,7 @@ args: 1,7,3
 arg: Str('cn', attribute=True, cli_name='name', multivalue=False, primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
 option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui')
 option: Str('setattr*', cli_name='setattr', exclude='webui')
@@ -2900,7 +2900,7 @@ args: 1,7,3
 arg: Str('cn', attribute=True, cli_name='name', multivalue=False, primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
 option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui')
 option: Str('setattr*', cli_name='setattr', exclude='webui')
@@ -3377,7 +3377,7 @@ args: 1,7,3
 arg: Str('cn', attribute=True, cli_name='sudocmdgroup_name', multivalue=False, primary_key=True, required=True)
 option: Str('addattr*', cli_name='addattr', exclude='webui')
 option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui')
-option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=True)
+option: Str('description', attribute=True, cli_name='desc', multivalue=False, required=False)
 option: Flag('no_members', autofill=True, default=False, exclude='webui')
 option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui')
 option: Str('setattr*', cli_name='setattr', exclude='webui')
--- a/ipalib/plugins/group.py
+++ b/ipalib/plugins/group.py
@@ -227,7 +227,7 @@ class group(LDAPObject):
            primary_key=True,
            normalizer=lambda value: value.lower(),
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('Group description'),
--- a/ipalib/plugins/hbacsvcgroup.py
+++ b/ipalib/plugins/hbacsvcgroup.py
@@ -107,7 +107,7 @@ class hbacsvcgroup(LDAPObject):
            primary_key=True,
            normalizer=lambda value: value.lower(),
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('HBAC service group description'),
--- a/ipalib/plugins/hostgroup.py
+++ b/ipalib/plugins/hostgroup.py
@@ -139,7 +139,7 @@ class hostgroup(LDAPObject):
            primary_key=True,
            normalizer=lambda value: value.lower(),
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('A description of this host-group'),
--- a/ipalib/plugins/netgroup.py
+++ b/ipalib/plugins/netgroup.py
@@ -184,7 +184,7 @@ class netgroup(LDAPObject):
            primary_key=True,
            normalizer=lambda value: value.lower(),
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('Netgroup description'),
--- a/ipalib/plugins/privilege.py
+++ b/ipalib/plugins/privilege.py
@@ -102,7 +102,7 @@ class privilege(LDAPObject):
            label=_('Privilege name'),
            primary_key=True,
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('Privilege description'),
--- a/ipalib/plugins/role.py
+++ b/ipalib/plugins/role.py
@@ -134,7 +134,7 @@ class role(LDAPObject):
            label=_('Role name'),
            primary_key=True,
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('A description of this role-group'),
--- a/ipalib/plugins/sudocmdgroup.py
+++ b/ipalib/plugins/sudocmdgroup.py
@@ -117,7 +117,7 @@ class sudocmdgroup(LDAPObject):
            primary_key=True,
            normalizer=lambda value: value.lower(),
        ),
-        Str('description',
+        Str('description?',
            cli_name='desc',
            label=_('Description'),
            doc=_('Group description'),
--- a/ipatests/test_cmdline/test_cli.py
+++ b/ipatests/test_cmdline/test_cli.py
@@ -117,7 +117,6 @@ class TestCLIParsing(object):
        with self.fake_stdin('Test group\n'):
            self.check_command('group-add tgroup1', 'group_add',
                cn=u'tgroup1',
-                description=u'Test group',
                nonposix=False,
                external=False,
                no_members=False,
--- a/ipatests/test_xmlrpc/test_batch_plugin.py
+++ b/ipatests/test_xmlrpc/test_batch_plugin.py
@@ -28,6 +28,7 @@ from xmlrpc_test import Declarative, fuzzy_digits, fuzzy_uuid
 from ipapython.dn import DN

 group1 = u'testgroup1'
+first1 = u'John'


 def deepequal_list(*expected):
@@ -182,7 +183,7 @@ class test_batch(Declarative):
                # missing required argument
                dict(method='user_add', params=([], dict())),
                # missing required option
-                dict(method='group_add', params=([group1], dict())),
+                dict(method='user_add', params=([], dict(givenname=first1))),
                # bad type
                dict(method='group_add', params=([group1], dict(
                        description=u't', gidnumber=u'bad'))),
@@ -216,7 +217,7 @@ class test_batch(Declarative):
                        error_code=3007,
                    ),
                    dict(
-                        error=u"'description' is required",
+                        error=u"'sn' is required",
                        error_name=u'RequirementError',
                        error_code=3007,
                    ),