From 8d21df93522c7ef76ae03e6b5be303da68420f69 Mon Sep 17 00:00:00 2001
From: Rob Crittenden <rcritten@redhat.com>
Date: Tue, 27 Apr 2021 18:00:16 -0400
Subject: [PATCH] Add a unit test for the LDAP cache layer

This mostly confirms that when an entry is added, modified or
deleted it is expunged from the cache.

https://pagure.io/freeipa/issue/8798

Signed-off-by: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: Rafael Guterres Jeffman <rjeffman@redhat.com>
---
 ipatests/test_ipapython/test_ldap_cache.py | 137 +++++++++++++++++++++
 1 file changed, 137 insertions(+)
 create mode 100644 ipatests/test_ipapython/test_ldap_cache.py

diff --git a/ipatests/test_ipapython/test_ldap_cache.py b/ipatests/test_ipapython/test_ldap_cache.py
new file mode 100644
index 000000000..fbe21fc3c
--- /dev/null
+++ b/ipatests/test_ipapython/test_ldap_cache.py
@@ -0,0 +1,137 @@
+#
+# Copyright (C) 2021  FreeIPA Contributors see COPYING for license
+#
+
+"""
+Test the LDAPCache class.
+"""
+# pylint: disable=no-member
+
+from ipalib import api, errors
+from ipapython import ipaldap
+from ipapython.dn import DN
+
+import pytest
+
+
+def hits_and_misses(cache, hits, misses):
+    assert cache._cache_hits == hits
+    assert cache._cache_misses == misses
+
+
+@pytest.fixture(scope='class')
+@pytest.mark.tier1
+@pytest.mark.needs_ipaapi
+def class_cache(request):
+    cache = ipaldap.LDAPCache(api.env.ldap_uri)
+    hits_and_misses(cache, 0, 0)
+
+    request.cls.cache = cache
+    request.cls.userdn = DN(
+        'uid=testuser', api.env.container_user, api.env.basedn
+    )
+
+    rpcclient = api.Backend.rpcclient
+    was_connected = rpcclient.isconnected()
+
+    if not was_connected:
+        rpcclient.connect()
+
+    api.Command.user_add('testuser', givenname=u'Test', sn=u'User')
+
+    yield
+
+    try:
+        api.Command.user_del('testuser')
+    except Exception:
+        pass
+
+    try:
+        if not was_connected:
+            rpcclient.disconnect()
+    except Exception:
+        pass
+
+
+@pytest.mark.usefixtures('class_cache')
+@pytest.mark.skip_ipaclient_unittest
+@pytest.mark.needs_ipaapi
+class TestLDAPCache:
+
+    def test_one(self):
+        dn = DN('uid=notfound', api.env.container_user, api.env.basedn)
+        try:
+            self.cache.get_entry(dn)
+        except errors.EmptyResult:
+            pass
+
+        assert dn in self.cache.cache
+        exc = self.cache.cache[dn].exception
+        assert isinstance(exc, errors.EmptyResult)
+
+        hits_and_misses(self.cache, 0, 1)
+
+    def test_retrieve_exception(self):
+        dn = DN('uid=notfound', api.env.container_user, api.env.basedn)
+        try:
+            self.cache.get_entry(dn)
+        except errors.EmptyResult:
+            pass
+        assert dn in self.cache.cache
+        exc = self.cache.cache[dn].exception
+        assert isinstance(exc, errors.EmptyResult)
+        hits_and_misses(self.cache, 1, 1)
+
+    def test_get_testuser(self):
+        assert self.userdn not in self.cache.cache
+        self.cache.get_entry(self.userdn)
+        assert self.userdn in self.cache.cache
+        hits_and_misses(self.cache, 1, 2)
+
+    def test_get_testuser_again(self):
+        assert self.userdn in self.cache.cache
+        self.cache.get_entry(self.userdn)
+        hits_and_misses(self.cache, 2, 2)
+
+    def test_update_testuser(self):
+        entry = self.cache.cache[self.userdn].entry
+        try:
+            self.cache.update_entry(entry)
+        except errors.EmptyModlist:
+            pass
+        assert self.userdn not in self.cache.cache
+        hits_and_misses(self.cache, 2, 2)
+
+    def test_modify_testuser(self):
+        self.cache.get_entry(self.userdn)
+        entry = self.cache.cache[self.userdn].entry
+        try:
+            self.cache.modify_s(entry.dn, [])
+        except errors.EmptyModlist:
+            pass
+        assert self.userdn not in self.cache.cache
+        hits_and_misses(self.cache, 2, 3)
+
+    def test_delete_entry(self):
+        # We don't care if this is successful or not, just that the
+        # cache doesn't retain the deleted entry
+        try:
+            self.cache.delete_entry(self.userdn)
+        except Exception:
+            pass
+        assert self.userdn not in self.cache.cache
+        hits_and_misses(self.cache, 2, 3)
+
+    def test_add_entry(self):
+        # We don't care if this is successful or not, just that the
+        # cache doesn't get the added entry
+        try:
+            self.cache.add_entry(self.userdn)
+        except Exception:
+            pass
+        assert self.userdn not in self.cache.cache
+        hits_and_misses(self.cache, 2, 3)
+
+    def test_clear_cache(self):
+        self.cache.clear_cache()
+        hits_and_misses(self.cache, 0, 0)