Imported Upstream version 4.6.2

ipatests/test_ipalib/test_crud.py

@@ -0,0 +1,244 @@
+# Authors:
+#   Jason Gerard DeRose <jderose@redhat.com>
+#
+# Copyright (C) 2008  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, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+"""
+Test the `ipalib.crud` module.
+"""
+
+from ipatests.util import raises, get_api, ClassChecker
+from ipalib import crud, frontend
+from ipalib.parameters import Str
+
+import pytest
+
+pytestmark = pytest.mark.tier0
+
+class CrudChecker(ClassChecker):
+    """
+    Class for testing base classes in `ipalib.crud`.
+    """
+
+    def get_api(self, args=tuple(), options=tuple()):
+        """
+        Return a finalized `ipalib.plugable.API` instance.
+        """
+        api, _home = get_api()
+        class user(frontend.Object):
+            takes_params = (
+                'givenname',
+                Str('sn', flags='no_update'),
+                Str('uid', primary_key=True),
+                'initials',
+                Str('uidnumber', flags=['no_create', 'no_search'])
+            )
+        class user_verb(self.cls):
+            takes_args = args
+            takes_options = options
+        api.add_plugin(user)
+        api.add_plugin(user_verb)
+        api.finalize()
+        return api
+
+
+class test_Create(CrudChecker):
+    """
+    Test the `ipalib.crud.Create` class.
+    """
+
+    _cls = crud.Create
+
+    def test_get_args(self):
+        """
+        Test the `ipalib.crud.Create.get_args` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.args) == ['uid']
+        assert api.Method.user_verb.args.uid.required is True
+
+    def test_get_options(self):
+        """
+        Test the `ipalib.crud.Create.get_options` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.options) == \
+            ['givenname', 'sn', 'initials', 'all', 'raw', 'version']
+        for param in api.Method.user_verb.options():
+            if param.name != 'version':
+                assert param.required is True
+        api = self.get_api(options=(Str('extra?'),))
+        assert list(api.Method.user_verb.options) == \
+            ['givenname', 'sn', 'initials', 'extra', 'all', 'raw', 'version']
+        assert api.Method.user_verb.options.extra.required is False
+
+
+class test_Update(CrudChecker):
+    """
+    Test the `ipalib.crud.Update` class.
+    """
+
+    _cls = crud.Update
+
+    def test_get_args(self):
+        """
+        Test the `ipalib.crud.Update.get_args` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.args) == ['uid']
+        assert api.Method.user_verb.args.uid.required is True
+
+    def test_get_options(self):
+        """
+        Test the `ipalib.crud.Update.get_options` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.options) == \
+            ['givenname', 'initials', 'uidnumber', 'all', 'raw', 'version']
+        for param in api.Method.user_verb.options():
+            if param.name in ['all', 'raw']:
+                assert param.required is True
+            else:
+                assert param.required is False
+
+
+class test_Retrieve(CrudChecker):
+    """
+    Test the `ipalib.crud.Retrieve` class.
+    """
+
+    _cls = crud.Retrieve
+
+    def test_get_args(self):
+        """
+        Test the `ipalib.crud.Retrieve.get_args` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.args) == ['uid']
+        assert api.Method.user_verb.args.uid.required is True
+
+    def test_get_options(self):
+        """
+        Test the `ipalib.crud.Retrieve.get_options` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.options) == ['all', 'raw', 'version']
+
+
+class test_Delete(CrudChecker):
+    """
+    Test the `ipalib.crud.Delete` class.
+    """
+
+    _cls = crud.Delete
+
+    def test_get_args(self):
+        """
+        Test the `ipalib.crud.Delete.get_args` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.args) == ['uid']
+        assert api.Method.user_verb.args.uid.required is True
+
+    def test_get_options(self):
+        """
+        Test the `ipalib.crud.Delete.get_options` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.options) == ['version']
+        assert len(api.Method.user_verb.options) == 1
+
+
+class test_Search(CrudChecker):
+    """
+    Test the `ipalib.crud.Search` class.
+    """
+
+    _cls = crud.Search
+
+    def test_get_args(self):
+        """
+        Test the `ipalib.crud.Search.get_args` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.args) == ['criteria']
+        assert api.Method.user_verb.args.criteria.required is False
+
+    def test_get_options(self):
+        """
+        Test the `ipalib.crud.Search.get_options` method.
+        """
+        api = self.get_api()
+        assert list(api.Method.user_verb.options) == \
+            ['givenname', 'sn', 'uid', 'initials', 'all', 'raw', 'version']
+        for param in api.Method.user_verb.options():
+            if param.name in ['all', 'raw']:
+                assert param.required is True
+            else:
+                assert param.required is False
+
+
+class test_CrudBackend(ClassChecker):
+    """
+    Test the `ipalib.crud.CrudBackend` class.
+    """
+
+    _cls = crud.CrudBackend
+
+    def get_subcls(self):
+        class ldap(self.cls):
+            pass
+        return ldap
+
+    def check_method(self, name, *args):
+        api = 'the api instance'
+        o = self.cls(api)
+        e = raises(NotImplementedError, getattr(o, name), *args)
+        assert str(e) == 'CrudBackend.%s()' % name
+        sub = self.subcls(api)
+        e = raises(NotImplementedError, getattr(sub, name), *args)
+        assert str(e) == 'ldap.%s()' % name
+
+    def test_create(self):
+        """
+        Test the `ipalib.crud.CrudBackend.create` method.
+        """
+        self.check_method('create')
+
+    def test_retrieve(self):
+        """
+        Test the `ipalib.crud.CrudBackend.retrieve` method.
+        """
+        self.check_method('retrieve', 'primary key', 'attribute')
+
+    def test_update(self):
+        """
+        Test the `ipalib.crud.CrudBackend.update` method.
+        """
+        self.check_method('update', 'primary key')
+
+    def test_delete(self):
+        """
+        Test the `ipalib.crud.CrudBackend.delete` method.
+        """
+        self.check_method('delete', 'primary key')
+
+    def test_search(self):
+        """
+        Test the `ipalib.crud.CrudBackend.search` method.
+        """
+        self.check_method('search')