revise storage passwords tests

Author: Shakeel Mohamed

.gitignore

@@ -18,3 +18,4 @@ examples/*/metadata
 tests/searchcommands_data/log/
 tests/searchcommands_data/output/
 examples/searchcommands_app/searchcommand_app.log
+Test Results*.html

splunklib/client.py

@@ -1708,16 +1708,18 @@ def __init__(self, service):
             raise ValueError("StoragePasswords cannot have wildcards in namespace.")
         super(StoragePasswords, self).__init__(service, PATH_STORAGE_PASSWORDS, item=StoragePassword)
 
-    def create(self, realm, username, password):
+    def create(self, password, username, realm=None):
         """ Creates a storage password.
 
-        # TODO: add some notes about processing that happens before hitting the REST API
+        The identifier can be passed in through the username parameter as
+        <username> or <realm>:<username>, but the preferred way is by
+        passing in the username and realm parameters.
 
-        :param realm: The credential realm.
+        :param password: The password for the credentials - this is the only part of the credentials that will be stored securely.
         :type name: ``string``
-        :param name: The username for the credentials.
+        :param username: The username for the credentials, or <realm>:<username> if the realm parameter is omitted.
         :type name: ``string``
-        :param username: The password for the credentials - this is the only part of the credentials that will be stored securely.
+        :param realm: The credential realm. (optional)
         :type name: ``string``
 
         :return: The :class:`StoragePassword` object created.
@@ -1736,19 +1738,26 @@ def create(self, realm, username, password):
 
         return storage_password
 
-    """# TODO: docs
-        * realm defaults to empty string
-        * username is optional... if realm is the full name
+    """Delete a storage password by username and/or realm.
 
-    """
-    def delete(self, realm, username=None):
-        # TODO: encode each component separately
+        The identifier can be passed in through the username parameter as
+        <username> or <realm>:<username>, but the preferred way is by
+        passing in the username and realm parameters.
 
-        if username is None:
+        :param username: The username for the credentials, or <realm>:<username> if the realm parameter is omitted.
+        :type name: ``string``
+        :param realm: The credential realm. (optional)
+        :type name: ``string``
+
+    """
+    def delete(self, username, realm=None):
+        if realm is None:
             # This case makes the username optional, so
-            # the full name can be passed in as realm
-            name = realm
+            # the full name can be passed in as realm.
+            # Assume it's already encoded.
+            name = username
         else:
+            # Encode each component separately
             name = urllib.quote(realm) + ":" + urllib.quote(username)
 
         # Append the : expected at the end of the name

tests/test_storage_passwords.py

@@ -19,7 +19,7 @@
 
 import splunklib.client as client
 
-class TestCreate(testlib.SDKTestCase):
+class Tests(testlib.SDKTestCase):
     def setUp(self):
         self.service = client.connect(**self.opts.kwargs)
         self.storage_passwords = self.service.storage_passwords
@@ -35,7 +35,7 @@ def test_create(self):
         realm = testlib.tmpname()
         username = testlib.tmpname()
 
-        p = self.storage_passwords.create(realm, username, "changeme")
+        p = self.storage_passwords.create("changeme", username, realm)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, realm)
         self.assertEqual(p.username, username)
@@ -49,7 +49,7 @@ def test_create_norealm(self):
         start_count = len(self.storage_passwords)
         username = testlib.tmpname()
 
-        p = self.storage_passwords.create("", username, "changeme")
+        p = self.storage_passwords.create("changeme", username, "")
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, None)
         self.assertEqual(p.username, username)
@@ -64,7 +64,7 @@ def test_create_with_colons(self):
         username = testlib.tmpname()
         realm = testlib.tmpname()
 
-        p = self.storage_passwords.create(":start" + realm, username + ":end", "changeme")
+        p = self.storage_passwords.create("changeme", username + ":end", ":start" + realm)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, ":start" + realm)
         self.assertEqual(p.username, username + ":end")
@@ -74,25 +74,56 @@ def test_create_with_colons(self):
         p.delete()
         self.assertEqual(start_count, len(self.storage_passwords))
 
-        realm = ":r:e:a:l:m:"
+        prefix = testlib.tmpname()
+        realm = prefix + ":r:e:a:l:m:"
         user = ":u:s:e:r:"
-        p = self.storage_passwords.create(realm, user, "changeme")
+        p = self.storage_passwords.create("changeme", user, realm)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, realm)
         self.assertEqual(p.username, user)
         self.assertEqual(p.clear_password, "changeme")
-        self.assertEqual(p.name, "\\:r\\:e\\:a\\:l\\:m\\::\\:u\\:s\\:e\\:r\\::")
-        
+        self.assertEqual(p.name, prefix + "\\:r\\:e\\:a\\:l\\:m\\::\\:u\\:s\\:e\\:r\\::")
+
+        p.delete()
+        self.assertEqual(start_count, len(self.storage_passwords))
+
+    def test_create_crazy(self):
+        start_count = len(self.storage_passwords)
+        username = testlib.tmpname()
+        realm = testlib.tmpname()
+
+        p = self.storage_passwords.create("changeme", username + ":end!@#$%^&*()_+{}:|<>?", ":start::!@#$%^&*()_+{}:|<>?" + realm)
+        self.assertEqual(start_count + 1, len(self.storage_passwords))
+        self.assertEqual(p.realm, ":start::!@#$%^&*()_+{}:|<>?" + realm)
+        self.assertEqual(p.username, username + ":end!@#$%^&*()_+{}:|<>?")
+        self.assertEqual(p.clear_password, "changeme")
+        self.assertEqual(p.name, "\\:start\\:\\:!@#$%^&*()_+{}\\:|<>?" + realm + ":" + username + "\\:end!@#$%^&*()_+{}\\:|<>?:")
+
         p.delete()
         self.assertEqual(start_count, len(self.storage_passwords))
 
+    def test_read(self):
+        start_count = len(self.storage_passwords)
+        username = testlib.tmpname()
+
+        p = self.storage_passwords.create("changeme", username, "")
+        self.assertEqual(start_count + 1, len(self.storage_passwords))
+
+        for sp in self.storage_passwords:
+            self.assertTrue(p.name in self.storage_passwords)
+            # Name works with or without a trailing colon
+            self.assertTrue((":" + username + ":") in self.storage_passwords)
+            self.assertTrue((":" + username) in self.storage_passwords)
+
+        p.delete()
+        self.assertEqual(start_count, len(self.storage_passwords))
 
     def test_update(self):
         start_count = len(self.storage_passwords)
         realm = testlib.tmpname()
         username = testlib.tmpname()
 
-        p = self.storage_passwords.create(realm, username, "changeme")
+        p = self.storage_passwords.create("changeme", username, realm)
         self.assertEqual(start_count + 1, len(self.storage_passwords))
         self.assertEqual(p.realm, realm)
         self.assertEqual(p.username, username)
@@ -113,29 +144,30 @@ def test_update(self):
         self.assertEqual(start_count, len(self.storage_passwords))
 
     def test_delete(self):
-        # TODO: make a bunch of tests for different ways of deleting
         start_count = len(self.storage_passwords)
+        username = testlib.tmpname()
 
-        p = self.storage_passwords.create("myfoo", "yourbar2", "changeme")
+        # Testing named parameters
+        p = self.storage_passwords.create("changeme", username, "myrealm")
         self.assertEqual(start_count + 1, len(self.storage_passwords))
-        self.assertEqual(p.realm, "myfoo")
-        self.assertEqual(p.username, "yourbar2")
+        self.assertEqual(p.realm, "myrealm")
+        self.assertEqual(p.username, username)
         self.assertEqual(p.clear_password, "changeme")
-        self.assertEqual(p.name, "myfoo:yourbar2:")
+        self.assertEqual(p.name, "myrealm:" + username + ":")
 
-        # TODO: move these tests out
-        for sp in self.storage_passwords:
-            self.assertTrue("myfoo:yourbar2" in self.storage_passwords)
-            # Name works with or without a trailing colon
-            self.assertTrue("myfoo:yourbar2:" in self.storage_passwords)
+        self.storage_passwords.delete(username, "myrealm")
+        self.assertEqual(start_count, len(self.storage_passwords))
+
+        self.storage_passwords.create("changeme", username, "myrealm")
+        self.assertEqual(start_count + 1, len(self.storage_passwords))
 
-        self.storage_passwords.delete("myfoo:yourbar2")
+        self.storage_passwords.delete("myrealm:" + username + ":")
         self.assertEqual(start_count, len(self.storage_passwords))
 
-        self.storage_passwords.create("myfoo", "yourbar2", "changeme")
+        self.storage_passwords.create("changeme", username, realm="myrealm")
         self.assertEqual(start_count + 1, len(self.storage_passwords))
 
-        self.storage_passwords.delete("myfoo:yourbar2:")
+        self.storage_passwords.delete(username, "myrealm")
         self.assertEqual(start_count, len(self.storage_passwords))
 
 if __name__ == "__main__":