freeipa/tests/test_xmlrpc/test_host_plugin.py

# Authors:
#   Rob Crittenden <rcritten@redhat.com>
#   Pavel Zuna <pzuna@redhat.com>
#
# Copyright (C) 2008, 2009  Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 only
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
Test the `ipalib.plugins.host` module.
"""

from ipalib import api, errors
from tests.test_xmlrpc.xmlrpc_test import Declarative
from tests.test_xmlrpc import objectclasses


fqdn1 = u'testhost1.%s' % api.env.domain


class test_host(Declarative):

    cleanup_commands = [
        ('host_del', [fqdn1], {}),
    ]

    tests = [

        dict(
            desc='Try to retrieve non-existent %r' % fqdn1,
            command=('host_show', [fqdn1], {}),
            expected=errors.NotFound(reason='no such entry'),
        ),


        dict(
            desc='Try to update non-existent %r' % fqdn1,
            command=('host_mod', [fqdn1], dict(description=u'Nope')),
            expected=errors.NotFound(reason='no such entry'),
        ),


        dict(
            desc='Try to delete non-existent %r' % fqdn1,
            command=('host_del', [fqdn1], {}),
            expected=errors.NotFound(reason='no such entry'),
        ),


        dict(
            desc='Create %r' % fqdn1,
            command=('host_add', [fqdn1],
                dict(
                    description=u'Test host 1',
                    localityname=u'Undisclosed location 1',
                ),
            ),
            expected=dict(
                value=fqdn1,
                summary=u'Added host "%s"' % fqdn1,
                result=dict(
                    cn=(fqdn1,),  # FIXME: we should only return fqdn
                    fqdn=(fqdn1,),
                    description=(u'Test host 1',),
                    localityname=(u'Undisclosed location 1',),
                    krbprincipalname=(u'host/%s@%s' % (fqdn1, api.env.realm),),
                    serverhostname=(u'testhost1',),
                    objectclass=objectclasses.host,
                ),
            ),
            ignore_values=['ipauniqueid', 'dn'],
        ),


        dict(
            desc='Try to create duplicate %r' % fqdn1,
            command=('host_add', [fqdn1],
                dict(
                    description=u'Test host 1',
                    localityname=u'Undisclosed location 1',
                ),
            ),
            expected=errors.DuplicateEntry(),
        ),


        dict(
            desc='Retrieve %r' % fqdn1,
            command=('host_show', [fqdn1], {}),
            expected=dict(
                value=fqdn1,
                summary=None,
                result=dict(
                    fqdn=(fqdn1,),
                    description=(u'Test host 1',),
                    localityname=(u'Undisclosed location 1',),
                ),
            ),
            ignore_values=['dn'],
        ),


        dict(
            desc='Retrieve %r with all=True' % fqdn1,
            command=('host_show', [fqdn1], dict(all=True)),
            expected=dict(
                value=fqdn1,
                summary=None,
                result=dict(
                    cn=(fqdn1,),
                    fqdn=(fqdn1,),
                    description=(u'Test host 1',),
                    # FIXME: Why is 'localalityname' returned as 'l' with --all?
                    # It is intuitive for --all to return additional attributes,
                    # but not to return existing attributes under different
                    # names.
                    l=(u'Undisclosed location 1',),
                    krbprincipalname=(u'host/%s@%s' % (fqdn1, api.env.realm),),
                    serverhostname=(u'testhost1',),
                    objectclass=objectclasses.host,
                ),
            ),
            ignore_values=['dn', 'ipauniqueid'],
        ),


        dict(
            desc='Search for %r' % fqdn1,
            command=('host_find', [fqdn1], {}),
            expected=dict(
                count=1,
                truncated=False,
                summary=u'1 host matched',
                result=(
                    dict(
                        fqdn=(fqdn1,),
                        description=(u'Test host 1',),
                        localityname=(u'Undisclosed location 1',),
                    ),
                ),
            ),
        ),


        dict(
            desc='Search for %r with all=True' % fqdn1,
            command=('host_find', [fqdn1], dict(all=True)),
            expected=dict(
                count=1,
                truncated=False,
                summary=u'1 host matched',
                result=(
                    dict(
                        cn=(fqdn1,),
                        fqdn=(fqdn1,),
                        description=(u'Test host 1',),
                        # FIXME: Why is 'localalityname' returned as 'l' with --all?
                        # It is intuitive for --all to return additional attributes,
                        # but not to return existing attributes under different
                        # names.
                        l=(u'Undisclosed location 1',),
                        krbprincipalname=(u'host/%s@%s' % (fqdn1, api.env.realm),),
                        serverhostname=(u'testhost1',),
                        objectclass=objectclasses.host,
                    ),
                ),
            ),
            # FIXME: With --all, host_show() returns the 'dn', but host_find()
            # doesn't.
            ignore_values=['ipauniqueid'],
        ),


        dict(
            desc='Update %r' % fqdn1,
            command=('host_mod', [fqdn1], dict(description=u'Updated host 1')),
            expected=dict(
                value=fqdn1,
                summary=u'Modified host "%s"' % fqdn1,
                result=dict(
                    description=(u'Updated host 1',),
                ),
            ),
        ),


        dict(
            desc='Retrieve %r to verify update' % fqdn1,
            command=('host_show', [fqdn1], {}),
            expected=dict(
                value=fqdn1,
                summary=None,
                result=dict(
                    fqdn=(fqdn1,),
                    description=(u'Updated host 1',),
                    localityname=(u'Undisclosed location 1',),
                ),
            ),
            ignore_values=['dn'],
        ),


        dict(
            desc='Delete %r' % fqdn1,
            command=('host_del', [fqdn1], {}),
            expected=dict(
                value=fqdn1,
                summary=u'Deleted host "%s"' % fqdn1,
                result=True,
            ),
        ),


        dict(
            desc='Try to retrieve non-existent %r' % fqdn1,
            command=('host_show', [fqdn1], {}),
            expected=errors.NotFound(reason='no such entry'),
        ),


        dict(
            desc='Try to update non-existent %r' % fqdn1,
            command=('host_mod', [fqdn1], dict(description=u'Nope')),
            expected=errors.NotFound(reason='no such entry'),
        ),


        dict(
            desc='Try to delete non-existent %r' % fqdn1,
            command=('host_del', [fqdn1], {}),
            expected=errors.NotFound(reason='no such entry'),
        ),

    ]