Tests: Tracker class for services

Provides basic service tracker, so far for purposes of [1].
Tracker is not complete, some methods will need to be added in case of service test refactoring.

[1] https://fedorahosted.org/freeipa/ticket/433

Reviewed-By: Milan Kubik <mkubik@redhat.com>

1 files changed, 152 insertions, 0 deletions

diff --git a/ipatests/test_xmlrpc/tracker/service_plugin.py b/ipatests/test_xmlrpc/tracker/service_plugin.py
new file mode 100644
index 000000000..89c27e821
--- /dev/null
+++ b/ipatests/test_xmlrpc/tracker/service_plugin.py
@@ -0,0 +1,152 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016  FreeIPA Contributors see COPYING for license
+#
+
+import six
+
+from ipalib import api
+from ipatests.test_xmlrpc.tracker.base import Tracker
+from ipatests.test_xmlrpc.xmlrpc_test import fuzzy_uuid
+from ipatests.test_xmlrpc import objectclasses
+from ipatests.util import assert_deepequal
+from ipapython.dn import DN
+
+if six.PY3:
+    unicode = str
+
+
+class ServiceTracker(Tracker):
+    """
+    Tracker class for service plugin
+
+    So far does not include methods for these commands:
+        service-add-host
+        service-remove-host
+        service-allow-retrieve-keytab
+        service-disallow-retrieve-keytab
+        service-allow-create-keytab
+        service-disallow-create-keytab
+        service-disable
+        service-add-cert
+        service-remove-cert
+    """
+
+    retrieve_keys = {
+        u'dn', u'krbprincipalname', u'usercertificate', u'has_keytab',
+        u'ipakrbauthzdata', u'ipaallowedtoperform', u'subject',
+        u'managedby', u'serial_number', u'serial_number_hex', u'issuer',
+        u'valid_not_before', u'valid_not_after', u'md5_fingerprint',
+        u'sha1_fingerprint', u'krbprincipalauthind', u'managedby_host',
+        u'krbcanonicalname'}
+    retrieve_all_keys = retrieve_keys | {
+        u'ipaKrbPrincipalAlias', u'ipaUniqueID', u'krbExtraData',
+        u'krbLastPwdChange', u'krbLoginFailedCount', u'memberof',
+        u'objectClass', u'ipakrbrequirespreauth',
+        u'ipakrbokasdelegate'}
+
+    create_keys = (retrieve_keys | {u'objectclass', u'ipauniqueid'}) - {
+        u'usercertificate', u'has_keytab'}
+    update_keys = retrieve_keys - {u'dn'}
+
+    def __init__(self, name, host_fqdn, options):
+        super(ServiceTracker, self).__init__(default_version=None)
+        self._name = "{0}/{1}@{2}".format(name, host_fqdn, api.env.realm)
+        self.dn = DN(
+            ('krbprincipalname', self.name), api.env.container_service,
+            api.env.basedn)
+        self.host_fqdn = host_fqdn
+        self.options = options
+
+    @property
+    def name(self):
+        return self._name
+
+    def make_create_command(self, force=True):
+        """ Make function that creates a service """
+        return self.make_command('service_add', self.name,
+                                 force=force, **self.options)
+
+    def make_delete_command(self):
+        """ Make function that deletes a service """
+        return self.make_command('service_del', self.name)
+
+    def make_retrieve_command(self, all=False, raw=False):
+        """ Make function that retrieves a service """
+        return self.make_command('service_show', self.name, all=all)
+
+    def make_find_command(self, *args, **kwargs):
+        """ Make function that searches for a service"""
+        return self.make_command('service_find', *args, **kwargs)
+
+    def make_update_command(self, updates):
+        """ Make function that updates a service """
+
+        return self.make_command('service_mod', self.name, **updates)
+
+    def track_create(self, **options):
+        """ Update expected state for service creation """
+        self.attrs = {
+            u'dn': self.dn,
+            u'krbprincipalname': [u'{0}'.format(self.name)],
+            u'objectclass': objectclasses.service,
+            u'ipauniqueid': [fuzzy_uuid],
+            u'managedby_host': [self.host_fqdn],
+            u'krbcanonicalname': [u'{0}'.format(self.name)]
+        }
+
+        for key in self.options:
+            self.attrs[key] = [self.options[key]]
+
+        self.exists = True
+
+    def check_create(self, result):
+        """ Check service-add command result """
+        assert_deepequal({
+            u'value': u'{0}'.format(self.name),
+            u'summary': u'Added service "{0}"'.format(self.name),
+            u'result': self.filter_attrs(self.create_keys)
+            }, result)
+
+    def check_delete(self, result):
+        """ Check service-del command result """
+        assert_deepequal({
+            u'value': [u'{0}'.format(self.name)],
+            u'summary': u'Deleted service "{0}"'.format(self.name),
+            u'result': {u'failed': []}
+            }, result)
+
+    def check_retrieve(self, result, all=False, raw=False):
+        """ Check service-show command result """
+        if all:
+            expected = self.filter_attrs(self.retrieve_all_keys)
+        else:
+            expected = self.filter_attrs(self.retrieve_keys)
+
+        assert_deepequal({
+            u'value': u'{0}'.format(self.name),
+            u'summary': None,
+            u'result': expected,
+        }, result)
+
+    def check_find(self, result, all=False, raw=False):
+        """ Check service-find command result """
+        if all:
+            expected = self.filter_attrs(self.retrieve_all_keys)
+        else:
+            expected = self.filter_attrs(self.retrieve_keys)
+
+        assert_deepequal({
+            u'count': 1,
+            u'truncated': False,
+            u'summary': u'1 service matched',
+            u'result': [expected]
+            }, result)
+
+    def check_update(self, result, extra_keys=()):
+        """ Check service-mod command result """
+        assert_deepequal({
+            u'value': u'{0}'.format(self.name),
+            u'summary': u'Modified service "{0}"'.format(self.name),
+            u'result': self.filter_attrs(self.update_keys | set(extra_keys))
+            }, result)