From 1d416a5a5ceaaf3fff9df423cea9114f1918aad2 Mon Sep 17 00:00:00 2001
From: Sergey Orlov <sorlov@redhat.com>
Date: Mar 13 2020 10:22:26 +0000
Subject: ipatests: provide docstrings instead of imporperly placed comments


Related to: https://bugzilla.redhat.com/show_bug.cgi?id=1685581

Reviewed-By: Florence Blanc-Renaud <flo@redhat.com>

---

diff --git a/ipatests/test_integration/test_sssd.py b/ipatests/test_integration/test_sssd.py
index 747ced0..a41ccf0 100644
--- a/ipatests/test_integration/test_sssd.py
+++ b/ipatests/test_integration/test_sssd.py
@@ -56,9 +56,6 @@ class TestSSSDWithAdTrust(IntegrationTest):
 
         cls.users['ad']['name'] = cls.users['ad']['name_tmpl'].format(
             domain=cls.ad.domain.name)
-
-        # Regression tests for cached_auth_timeout option
-        # https://bugzilla.redhat.com/show_bug.cgi?id=1685581
         tasks.user_add(cls.master, cls.intermed_user)
         tasks.create_active_user(cls.master, cls.ipa_user,
                                  cls.ipa_user_password)
@@ -85,18 +82,34 @@ class TestSSSDWithAdTrust(IntegrationTest):
 
     @pytest.mark.parametrize('user', ['ipa', 'ad'])
     def test_auth_cache_disabled_by_default(self, user):
+        """Check credentials not cached with default sssd config.
+
+        Regression test for cached_auth_timeout option
+        https://bugzilla.redhat.com/show_bug.cgi?id=1685581
+        """
         with self.config_sssd_cache_auth(cached_auth_timeout=None):
             assert not self.is_auth_cached(self.users[user])
             assert not self.is_auth_cached(self.users[user])
 
     @pytest.mark.parametrize('user', ['ipa', 'ad'])
     def test_auth_cache_disabled_with_value_0(self, user):
+        """Check credentials not cached with cached_auth_timeout=0 in sssd.conf
+
+        Regression test for cached_auth_timeout option
+        https://bugzilla.redhat.com/show_bug.cgi?id=1685581
+        """
         with self.config_sssd_cache_auth(cached_auth_timeout=0):
             assert not self.is_auth_cached(self.users[user])
             assert not self.is_auth_cached(self.users[user])
 
     @pytest.mark.parametrize('user', ['ipa', 'ad'])
     def test_auth_cache_enabled_when_configured(self, user):
+        """Check credentials are cached with cached_auth_timeout=30
+
+        Regression test for cached_auth_timeout option
+        https://bugzilla.redhat.com/show_bug.cgi?id=1685581
+        """
+
         timeout = 30
         with self.config_sssd_cache_auth(cached_auth_timeout=timeout):
             start = time.time()