initial commit

env/lib/python3.10/site-packages/keyring/testing/backend.py

@@ -0,0 +1,200 @@
+"""
+Common test functionality for backends.
+"""
+
+import os
+import string
+
+import pytest
+
+from keyring import errors
+
+from .util import random_string
+
+# unicode only characters
+# Sourced from The Quick Brown Fox... Pangrams
+# http://www.columbia.edu/~fdc/utf8/
+UNICODE_CHARS = (
+    "זהכיףסתםלשמועאיךתנצחקרפדעץטובבגן"
+    "ξεσκεπάζωτηνψυχοφθόραβδελυγμία"
+    "Съешьжеещёэтихмягкихфранцузскихбулокдавыпейчаю"
+    "Жълтатадюлябешещастливачепухъткойтоцъфназамръзнакатогьон"
+)
+
+# ensure no-ascii chars slip by - watch your editor!
+assert min(ord(char) for char in UNICODE_CHARS) > 127
+
+
+def is_ascii_printable(s):
+    return all(32 <= ord(c) < 127 for c in s)
+
+
+class BackendBasicTests:
+    """Test for the keyring's basic functions. password_set and password_get"""
+
+    DIFFICULT_CHARS = string.whitespace + string.punctuation
+
+    @pytest.fixture(autouse=True)
+    def _init_properties(self, request):
+        self.keyring = self.init_keyring()
+        self.credentials_created = set()
+        request.addfinalizer(self.cleanup)
+
+    def cleanup(self):
+        for item in self.credentials_created:
+            self.keyring.delete_password(*item)
+
+    def set_password(self, service, username, password):
+        # set the password and save the result so the test runner can clean
+        #  up after if necessary.
+        self.keyring.set_password(service, username, password)
+        self.credentials_created.add((service, username))
+
+    def check_set_get(self, service, username, password):
+        keyring = self.keyring
+
+        # for the non-existent password
+        assert keyring.get_password(service, username) is None
+
+        # common usage
+        self.set_password(service, username, password)
+        assert keyring.get_password(service, username) == password
+
+        # for the empty password
+        self.set_password(service, username, "")
+        assert keyring.get_password(service, username) == ""
+
+    def test_password_set_get(self):
+        password = random_string(20)
+        username = random_string(20)
+        service = random_string(20)
+        self.check_set_get(service, username, password)
+
+    def test_set_after_set_blank(self):
+        service = random_string(20)
+        username = random_string(20)
+        self.keyring.set_password(service, username, "")
+        self.keyring.set_password(service, username, "non-blank")
+
+    def test_difficult_chars(self):
+        password = random_string(20, self.DIFFICULT_CHARS)
+        username = random_string(20, self.DIFFICULT_CHARS)
+        service = random_string(20, self.DIFFICULT_CHARS)
+        self.check_set_get(service, username, password)
+
+    def test_delete_present(self):
+        password = random_string(20, self.DIFFICULT_CHARS)
+        username = random_string(20, self.DIFFICULT_CHARS)
+        service = random_string(20, self.DIFFICULT_CHARS)
+        self.keyring.set_password(service, username, password)
+        self.keyring.delete_password(service, username)
+        assert self.keyring.get_password(service, username) is None
+
+    def test_delete_not_present(self):
+        username = random_string(20, self.DIFFICULT_CHARS)
+        service = random_string(20, self.DIFFICULT_CHARS)
+        with pytest.raises(errors.PasswordDeleteError):
+            self.keyring.delete_password(service, username)
+
+    def test_delete_one_in_group(self):
+        username1 = random_string(20, self.DIFFICULT_CHARS)
+        username2 = random_string(20, self.DIFFICULT_CHARS)
+        password = random_string(20, self.DIFFICULT_CHARS)
+        service = random_string(20, self.DIFFICULT_CHARS)
+        self.keyring.set_password(service, username1, password)
+        self.set_password(service, username2, password)
+        self.keyring.delete_password(service, username1)
+        assert self.keyring.get_password(service, username2) == password
+
+    def test_name_property(self):
+        assert is_ascii_printable(self.keyring.name)
+
+    def test_unicode_chars(self):
+        password = random_string(20, UNICODE_CHARS)
+        username = random_string(20, UNICODE_CHARS)
+        service = random_string(20, UNICODE_CHARS)
+        self.check_set_get(service, username, password)
+
+    def test_unicode_and_ascii_chars(self):
+        source = (
+            random_string(10, UNICODE_CHARS)
+            + random_string(10)
+            + random_string(10, self.DIFFICULT_CHARS)
+        )
+        password = random_string(20, source)
+        username = random_string(20, source)
+        service = random_string(20, source)
+        self.check_set_get(service, username, password)
+
+    def test_different_user(self):
+        """
+        Issue #47 reports that WinVault isn't storing passwords for
+        multiple users. This test exercises that test for each of the
+        backends.
+        """
+
+        keyring = self.keyring
+        self.set_password('service1', 'user1', 'password1')
+        self.set_password('service1', 'user2', 'password2')
+        assert keyring.get_password('service1', 'user1') == 'password1'
+        assert keyring.get_password('service1', 'user2') == 'password2'
+        self.set_password('service2', 'user3', 'password3')
+        assert keyring.get_password('service1', 'user1') == 'password1'
+
+    def test_credential(self):
+        keyring = self.keyring
+
+        cred = keyring.get_credential('service', None)
+        assert cred is None
+
+        self.set_password('service1', 'user1', 'password1')
+        self.set_password('service1', 'user2', 'password2')
+
+        cred = keyring.get_credential('service1', None)
+        assert cred is None or (cred.username, cred.password) in (
+            ('user1', 'password1'),
+            ('user2', 'password2'),
+        )
+
+        cred = keyring.get_credential('service1', 'user2')
+        assert cred is not None
+        assert (cred.username, cred.password) in (
+            ('user1', 'password1'),
+            ('user2', 'password2'),
+        )
+
+    @pytest.mark.xfail("platform.system() == 'Windows'", reason="#668")
+    def test_empty_username(self):
+        with pytest.deprecated_call():
+            self.set_password('service1', '', 'password1')
+        assert self.keyring.get_password('service1', '') == 'password1'
+
+    def test_set_properties(self, monkeypatch):
+        env = dict(KEYRING_PROPERTY_FOO_BAR='fizz buzz', OTHER_SETTING='ignore me')
+        monkeypatch.setattr(os, 'environ', env)
+        self.keyring.set_properties_from_env()
+        assert self.keyring.foo_bar == 'fizz buzz'
+
+    def test_new_with_properties(self):
+        alt = self.keyring.with_properties(foo='bar')
+        assert alt is not self.keyring
+        assert alt.foo == 'bar'
+        with pytest.raises(AttributeError):
+            self.keyring.foo  # noqa: B018
+
+    def test_wrong_username_returns_none(self):
+        keyring = self.keyring
+        service = 'test_wrong_username_returns_none'
+        cred = keyring.get_credential(service, None)
+        assert cred is None
+
+        password_1 = 'password1'
+        password_2 = 'password2'
+        self.set_password(service, 'user1', password_1)
+        self.set_password(service, 'user2', password_2)
+
+        assert keyring.get_credential(service, "user1").password == password_1
+        assert keyring.get_credential(service, "user2").password == password_2
+
+        # Missing/wrong username should not return a cred
+        assert keyring.get_credential(service, "nobody!") is None

env/lib/python3.10/site-packages/keyring/testing/util.py

@@ -0,0 +1,68 @@
+import contextlib
+import os
+import random
+import string
+import sys
+
+
+class ImportKiller:
+    "Context manager to make an import of a given name or names fail."
+
+    def __init__(self, *names):
+        self.names = names
+
+    def find_module(self, fullname, path=None):
+        if fullname in self.names:
+            return self
+
+    def load_module(self, fullname):
+        assert fullname in self.names
+        raise ImportError(fullname)
+
+    def __enter__(self):
+        self.original = {}
+        for name in self.names:
+            self.original[name] = sys.modules.pop(name, None)
+        sys.meta_path.insert(0, self)
+
+    def __exit__(self, *args):
+        sys.meta_path.remove(self)
+        for key, value in self.original.items():
+            if value is not None:
+                sys.modules[key] = value
+
+
+@contextlib.contextmanager
+def NoNoneDictMutator(destination, **changes):
+    """Helper context manager to make and unmake changes to a dict.
+
+    A None is not a valid value for the destination, and so means that the
+    associated name should be removed."""
+    original = {}
+    for key, value in changes.items():
+        original[key] = destination.get(key)
+        if value is None:
+            if key in destination:
+                del destination[key]
+        else:
+            destination[key] = value
+    yield
+    for key, value in original.items():
+        if value is None:
+            if key in destination:
+                del destination[key]
+        else:
+            destination[key] = value
+
+
+def Environ(**changes):
+    """A context manager to temporarily change the os.environ"""
+    return NoNoneDictMutator(os.environ, **changes)
+
+
+ALPHABET = string.ascii_letters + string.digits
+
+
+def random_string(k, source=ALPHABET):
+    """Generate a random string with length <i>k</i>"""
+    return ''.join(random.choice(source) for _unused in range(k))