Type hints for tests

radicale/tests/test_auth.py

@@ -22,13 +22,12 @@ Radicale tests with simple requests and authentication.
 """
 
 import os
-import shutil
 import sys
-import tempfile
+from typing import Iterable, Tuple, Union
 
 import pytest
 
-from radicale import Application, config, xmlutils
+from radicale import Application, xmlutils
 from radicale.tests import BaseTest
 
 
@@ -38,21 +37,10 @@ class TestBaseAuthRequests(BaseTest):
     We should setup auth for each type before creating the Application object.
 
     """
-    def setup(self):
-        self.configuration = config.load()
-        self.colpath = tempfile.mkdtemp()
-        self.configuration.update({
-            "storage": {"filesystem_folder": self.colpath,
-                        # Disable syncing to disk for better performance
-                        "_filesystem_fsync": "False"},
-            # Set incorrect authentication delay to a very low value
-            "auth": {"delay": "0.002"}}, "test", privileged=True)
 
-    def teardown(self):
-        shutil.rmtree(self.colpath)
-
-    def _test_htpasswd(self, htpasswd_encryption, htpasswd_content,
-                       test_matrix="ascii"):
+    def _test_htpasswd(self, htpasswd_encryption: str, htpasswd_content: str,
+                       test_matrix: Union[str, Iterable[Tuple[str, str, bool]]]
+                       = "ascii") -> None:
         """Test htpasswd authentication with user "tmp" and password "bepo" for
            ``test_matrix`` "ascii" or user "😀" and password "🔑" for
            ``test_matrix`` "unicode"."""
@@ -67,7 +55,7 @@ class TestBaseAuthRequests(BaseTest):
             except MissingBackendError:
                 pytest.skip("bcrypt backend for passlib is not installed")
         htpasswd_file_path = os.path.join(self.colpath, ".htpasswd")
-        encoding = self.configuration.get("encoding", "stock")
+        encoding: str = self.configuration.get("encoding", "stock")
         with open(htpasswd_file_path, "w", encoding=encoding) as f:
             f.write(htpasswd_content)
         self.configuration.update({
@@ -83,54 +71,56 @@ class TestBaseAuthRequests(BaseTest):
             test_matrix = (("😀", "🔑", True), ("😀", "🌹", False),
                            ("😁", "🔑", False), ("😀", "", False),
                            ("", "🔑", False), ("", "", False))
+        elif isinstance(test_matrix, str):
+            raise ValueError("Unknown test matrix %r" % test_matrix)
         for user, password, valid in test_matrix:
             self.propfind("/", check=207 if valid else 401,
                           login="%s:%s" % (user, password))
 
-    def test_htpasswd_plain(self):
+    def test_htpasswd_plain(self) -> None:
         self._test_htpasswd("plain", "tmp:bepo")
 
-    def test_htpasswd_plain_password_split(self):
+    def test_htpasswd_plain_password_split(self) -> None:
         self._test_htpasswd("plain", "tmp:be:po", (
             ("tmp", "be:po", True), ("tmp", "bepo", False)))
 
-    def test_htpasswd_plain_unicode(self):
+    def test_htpasswd_plain_unicode(self) -> None:
         self._test_htpasswd("plain", "😀:🔑", "unicode")
 
-    def test_htpasswd_md5(self):
+    def test_htpasswd_md5(self) -> None:
         self._test_htpasswd("md5", "tmp:$apr1$BI7VKCZh$GKW4vq2hqDINMr8uv7lDY/")
 
     def test_htpasswd_md5_unicode(self):
         self._test_htpasswd(
             "md5", "😀:$apr1$w4ev89r1$29xO8EvJmS2HEAadQ5qy11", "unicode")
 
-    def test_htpasswd_bcrypt(self):
+    def test_htpasswd_bcrypt(self) -> None:
         self._test_htpasswd("bcrypt", "tmp:$2y$05$oD7hbiQFQlvCM7zoalo/T.MssV3V"
                             "NTRI3w5KDnj8NTUKJNWfVpvRq")
 
-    def test_htpasswd_bcrypt_unicode(self):
+    def test_htpasswd_bcrypt_unicode(self) -> None:
         self._test_htpasswd("bcrypt", "😀:$2y$10$Oyz5aHV4MD9eQJbk6GPemOs4T6edK"
                             "6U9Sqlzr.W1mMVCS8wJUftnW", "unicode")
 
-    def test_htpasswd_multi(self):
+    def test_htpasswd_multi(self) -> None:
         self._test_htpasswd("plain", "ign:ign\ntmp:bepo")
 
     @pytest.mark.skipif(sys.platform == "win32", reason="leading and trailing "
                         "whitespaces not allowed in file names")
-    def test_htpasswd_whitespace_user(self):
+    def test_htpasswd_whitespace_user(self) -> None:
         for user in (" tmp", "tmp ", " tmp "):
             self._test_htpasswd("plain", "%s:bepo" % user, (
                 (user, "bepo", True), ("tmp", "bepo", False)))
 
-    def test_htpasswd_whitespace_password(self):
+    def test_htpasswd_whitespace_password(self) -> None:
         for password in (" bepo", "bepo ", " bepo "):
             self._test_htpasswd("plain", "tmp:%s" % password, (
                 ("tmp", password, True), ("tmp", "bepo", False)))
 
-    def test_htpasswd_comment(self):
+    def test_htpasswd_comment(self) -> None:
         self._test_htpasswd("plain", "#comment\n #comment\n \ntmp:bepo\n\n")
 
-    def test_remote_user(self):
+    def test_remote_user(self) -> None:
         self.configuration.update({"auth": {"type": "remote_user"}}, "test")
         self.application = Application(self.configuration)
         _, responses = self.propfind("/", """\
@@ -140,11 +130,15 @@ class TestBaseAuthRequests(BaseTest):
         <current-user-principal />
     </prop>
 </propfind>""", REMOTE_USER="test")
-        status, prop = responses["/"]["D:current-user-principal"]
+        assert responses is not None
+        response = responses["/"]
+        assert not isinstance(response, int)
+        status, prop = response["D:current-user-principal"]
         assert status == 200
-        assert prop.find(xmlutils.make_clark("D:href")).text == "/test/"
+        href_element = prop.find(xmlutils.make_clark("D:href"))
+        assert href_element is not None and href_element.text == "/test/"
 
-    def test_http_x_remote_user(self):
+    def test_http_x_remote_user(self) -> None:
         self.configuration.update(
             {"auth": {"type": "http_x_remote_user"}}, "test")
         self.application = Application(self.configuration)
@@ -155,11 +149,15 @@ class TestBaseAuthRequests(BaseTest):
         <current-user-principal />
     </prop>
 </propfind>""", HTTP_X_REMOTE_USER="test")
-        status, prop = responses["/"]["D:current-user-principal"]
+        assert responses is not None
+        response = responses["/"]
+        assert not isinstance(response, int)
+        status, prop = response["D:current-user-principal"]
         assert status == 200
-        assert prop.find(xmlutils.make_clark("D:href")).text == "/test/"
+        href_element = prop.find(xmlutils.make_clark("D:href"))
+        assert href_element is not None and href_element.text == "/test/"
 
-    def test_custom(self):
+    def test_custom(self) -> None:
         """Custom authentication."""
         self.configuration.update(
             {"auth": {"type": "radicale.tests.custom.auth"}}, "test")