Refactored CredentialProvider class

Author: barshaul

docs/examples/connection_examples.ipynb

@@ -100,7 +100,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "## Connecting to a redis instance with static credential provider"
+    "## Connecting to a redis instance with username and password credential provider"
    ],
    "metadata": {}
   },
@@ -111,7 +111,7 @@
    "source": [
     "import redis\n",
     "\n",
-    "creds_provider = redis.StaticCredentialProvider(\"username\", \"password\")\n",
+    "creds_provider = redis.UsernamePasswordCredentialProvider(\"username\", \"password\")\n",
     "user_connection = redis.Redis(host=\"localhost\", port=6379, credential_provider=creds_provider)\n",
     "user_connection.ping()"
    ],
@@ -131,11 +131,19 @@
    "execution_count": null,
    "outputs": [],
    "source": [
+    "from typing import Tuple\n",
     "import redis\n",
     "\n",
     "creds_map = {\"user_1\": \"pass_1\",\n",
     "             \"user_2\": \"pass_2\"}\n",
     "\n",
+    "class UserMapCredentialProvider(redis.CredentialProvider):\n",
+    "    def __init__(self, username: str):\n",
+    "        self.username = username\n",
+    "\n",
+    "    def get_credentials(self) -> Tuple[str, str]:\n",
+    "        return self.username, creds_map.get(self.username)\n",
+    "\n",
     "# Create a default connection to set the ACL user\n",
     "default_connection = redis.Redis(host=\"localhost\", port=6379)\n",
     "default_connection.acl_setuser(\n",
@@ -146,11 +154,8 @@
     "    commands=[\"+ping\", \"+command\", \"+info\", \"+select\", \"+flushdb\"],\n",
     ")\n",
     "\n",
-    "def creds_provider(self):\n",
-    "    return self.username, creds_map.get(self.username)\n",
-    "\n",
-    "# Create a CredentialProvider instance for user_1\n",
-    "creds_provider = redis.CredentialProvider(username=\"user_1\", supplier=creds_provider)\n",
+    "# Create a UserMapCredentialProvider instance for user_1\n",
+    "creds_provider = UserMapCredentialProvider(\"user_1\")\n",
     "# Initiate user connection with the credential provider\n",
     "user_connection = redis.Redis(host=\"localhost\", port=6379,\n",
     "                              credential_provider=creds_provider)\n",
@@ -172,24 +177,27 @@
    "execution_count": null,
    "outputs": [],
    "source": [
+    "from typing import Union\n",
     "import redis\n",
     "\n",
-    "def call_external_supplier():\n",
-    "    # Call to an external credential supplier\n",
-    "    raise NotImplementedError\n",
+    "class InitCredsSetCredentialProvider(redis.CredentialProvider):\n",
+    "    def __init__(self, username, password):\n",
+    "        self.username = username\n",
+    "        self.password = password\n",
+    "        self.call_supplier = False\n",
+    "\n",
+    "    def call_external_supplier(self) -> Union[Tuple[str], Tuple[str, str]]:\n",
+    "        # Call to an external credential supplier\n",
+    "        raise NotImplementedError\n",
     "\n",
-    "def creds_supplier(self):\n",
-    "    call_supplier =  self.supplier_kwargs.get(\"call_supplier\", True)\n",
-    "    if call_supplier:\n",
-    "        return call_external_supplier()\n",
-    "    # Use the init set only for the first time\n",
-    "    self.kwargs.update({\"call_supplier\": True})\n",
-    "    return self.username, self.password\n",
+    "    def get_credentials(self) -> Union[Tuple[str], Tuple[str, str]]:\n",
+    "        if self.call_supplier:\n",
+    "            return self.call_external_supplier()\n",
+    "        # Use the init set only for the first time\n",
+    "        self.call_supplier = True\n",
+    "        return self.username, self.password\n",
     "\n",
-    "cred_provider = redis.CredentialProvider(username=\"init_user\",\n",
-    "                                         password=\"init_pass\",\n",
-    "                                         call_supplier=False,\n",
-    "                                         supplier=creds_supplier)"
+    "cred_provider = InitCredsSetCredentialProvider(username=\"init_user\", password=\"init_pass\")"
    ],
    "metadata": {}
    }

redis/__init__.py

@@ -9,7 +9,7 @@
     SSLConnection,
     UnixDomainSocketConnection,
 )
-from redis.credentials import CredentialProvider, StaticCredentialProvider
+from redis.credentials import CredentialProvider, UsernamePasswordCredentialProvider
 from redis.exceptions import (
     AuthenticationError,
     AuthenticationWrongNumberOfArgsError,
@@ -78,7 +78,7 @@ def int_or_str(value):
     "SentinelManagedConnection",
     "SentinelManagedSSLConnection",
     "SSLConnection",
-    "StaticCredentialProvider",
+    "UsernamePasswordCredentialProvider",
     "StrictRedis",
     "TimeoutError",
     "UnixDomainSocketConnection",

redis/connection.py

@@ -11,7 +11,7 @@
 from urllib.parse import parse_qs, unquote, urlparse
 
 from redis.backoff import NoBackoff
-from redis.credentials import CredentialProvider, StaticCredentialProvider
+from redis.credentials import CredentialProvider, UsernamePasswordCredentialProvider
 from redis.exceptions import (
     AuthenticationError,
     AuthenticationWrongNumberOfArgsError,
@@ -690,8 +690,7 @@ def on_connect(self):
         if self.credential_provider or (self.username or self.password):
             cred_provider = (
                 self.credential_provider
-                if self.credential_provider
-                else StaticCredentialProvider(self.username, self.password)
+                or UsernamePasswordCredentialProvider(self.username, self.password)
             )
             auth_args = cred_provider.get_credentials()
             # avoid checking health here -- PING will fail if we try
@@ -705,11 +704,7 @@ def on_connect(self):
                 # server seems to be < 6.0.0 which expects a single password
                 # arg. retry auth with just the password.
                 # https://github.com/andymccurdy/redis-py/issues/1274
-                self.send_command(
-                    "AUTH",
-                    auth_args[-1],
-                    check_health=False,
-                )
+                self.send_command("AUTH", auth_args[-1], check_health=False)
                 auth_response = self.read_response()
 
             if str_if_bytes(auth_response) != "OK":

redis/credentials.py

@@ -1,73 +1,26 @@
-from typing import Callable, Optional, Union
+from typing import Optional, Tuple, Union
 
 
 class CredentialProvider:
-    def __init__(
-        self,
-        username: Union[str, None] = "",
-        password: Union[str, None] = "",
-        supplier: Optional[Callable] = None,
-        *supplier_args,
-        **supplier_kwargs,
-    ):
-        """
-        Initialize a new Credentials Provider.
-        :param supplier: a supplier function that returns the username and password.
-                         def supplier(self, arg1, arg2, ...) -> (username, password)
-                         See examples/connection_examples.ipynb
-        :param supplier_args: arguments to pass to the supplier function
-        :param supplier_kwargs: keyword arguments to pass to the supplier function
-        """
-        self._username_ = username if username is not None else ""
-        self._password_ = password if password is not None else ""
-        self.supplier = supplier
-        self.supplier_args = supplier_args
-        self.supplier_kwargs = supplier_kwargs
-
-    def get_credentials(self):
-        if self.supplier is not None:
-            self.username, self.password = self.supplier(
-                self, *self.supplier_args, **self.supplier_kwargs
-            )
-
-        return (
-            (self._username_, self._password_)
-            if self._username_
-            else (self._password_,)
-        )
-
-    @property
-    def password(self):
-        if self.supplier is not None and not self._password_:
-            self.username, self.password = self.supplier(
-                self, *self.supplier_args, **self.supplier_kwargs
-            )
-        return self._password_
-
-    @password.setter
-    def password(self, value):
-        self._password_ = value if value is not None else ""
-
-    @property
-    def username(self):
-        if self.supplier is not None and not self._username_:
-            self.username, self.password = self.supplier(
-                self, *self.supplier_args, **self.supplier_kwargs
-            )
-        return self._username_
+    """
+    Credentials Provider.
+    """
 
-    @username.setter
-    def username(self, value):
-        self._username_ = value if value is not None else ""
+    def get_credentials(self) -> Union[Tuple[str], Tuple[str, str]]:
+        raise NotImplementedError("get_credentials must be implemented")
 
 
-class StaticCredentialProvider(CredentialProvider):
+class UsernamePasswordCredentialProvider(CredentialProvider):
     """
     Simple implementation of CredentialProvider that just wraps static
     username and password.
     """
 
-    def __init__(
-        self, username: Union[str, None] = "", password: Union[str, None] = ""
-    ):
-        super().__init__(username=username, password=password)
+    def __init__(self, username: Optional[str] = None, password: Optional[str] = None):
+        self.username = username
+        self.password = password
+
+    def get_credentials(self):
+        if self.username:
+            return self.username, self.password
+        return (self.password,)

tests/test_commands.py

@@ -10,7 +10,6 @@
 import redis
 from redis import exceptions
 from redis.client import parse_info
-from redis.credentials import StaticCredentialProvider
 
 from .conftest import (
     _get_client,
@@ -96,9 +95,7 @@ def teardown():
                 # error when switching to the db 9 because we're not authenticated yet
                 # setting the password on the connection itself triggers the
                 # authentication in the connection's `on_connect` method
-                r.connection.credential_provider = StaticCredentialProvider(
-                    password=temp_pass
-                )
+                r.connection.password = temp_pass
             except AttributeError:
                 # connection field is not set in Redis Cluster, but that's ok
                 # because the problem discussed above does not apply to Redis Cluster