Add cookie-auth tests for both service and binding

Author: Shakeel Mohamed

tests/test_binding.py

@@ -15,7 +15,7 @@
 # under the License.
 
 
-import uuid
+import time
 import urllib2
 from StringIO import StringIO
 from xml.etree.ElementTree import XML
@@ -486,6 +486,54 @@ def test_logout(self):
         response = self.context.get("/services")
         self.assertEqual(response.status, 200)
 
+class TestCookieAuthentication(unittest.TestCase):
+    def setUp(self):
+        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.context = binding.connect(**self.opts.kwargs)
+
+        # Skip these tests if running below Splunk 6.2, cookie-auth didn't exist before
+        import splunklib.client as client
+        service = client.Service(**self.opts.kwargs)
+        splver = service.splunk_version
+        if splver[:2] < (6, 2):
+            self.skipTest("Skipping cookie-auth tests, running in %d.%d.%d, this feature was added in 6.2+" % splver)
+
+    def test_cookie_in_auth_headers(self):
+        self.assertIsNotNone(self.context._auth_headers)
+        self.assertNotEqual(self.context._auth_headers, [])
+        self.assertEqual(len(self.context._auth_headers), 1)
+        self.assertEqual(len(self.context._auth_headers), 1)
+        self.assertEqual(self.context._auth_headers[0][0], "cookie")
+        self.assertEqual(self.context._auth_headers[0][1][:8], "splunkd_")
+
+    def test_got_cookie_on_connect(self):
+        self.assertIsNotNone(self.context.cookie)
+        self.assertNotEqual(self.context.cookie, binding._NoAuthenticationToken)
+        self.assertEqual(self.context.cookie[:8], "splunkd_")
+
+    def test_got_updated_cookie_with_get(self):
+        old_cookie = self.context.cookie
+        resp = self.context.get("apps/local")
+        found = False
+        for key, value in resp.headers:
+            if key.lower() == "set-cookie":
+                found = True
+                self.assertEqual(value[:8], "splunkd_")
+                # It's unlikely that the cookie will change during this short test
+                self.assertEqual(value, old_cookie)
+        self.assertTrue(found)
+
+    def test_login_fails_without_cookie_or_token(self):
+        opts = {
+            'host': self.opts.kwargs['host'],
+            'port': self.opts.kwargs['port']
+        }
+        try:
+            binding.connect(**opts)
+            self.fail()
+        except AuthenticationError as ae:
+            self.assertEqual(ae.message, "Login failed.")
+
 class TestNamespace(unittest.TestCase):
     def test_namespace(self):
         tests = [

tests/test_service.py

@@ -15,16 +15,12 @@
 # under the License.
 
 import testlib
-import logging
-
 import unittest
 
-import splunklib.data as data
-
 import splunklib.client as client
 from splunklib.client import AuthenticationError
 from splunklib.client import Service
-from splunklib.binding import HTTPError
+from splunklib.binding import HTTPError, _NoAuthenticationToken
 
 
 class ServiceTestCase(testlib.SDKTestCase):
@@ -145,6 +141,34 @@ def _create_unauthenticated_service(self):
             'scheme': self.opts.kwargs['scheme']
         })
 
+class TestCookieAuthentication(unittest.TestCase):
+    def setUp(self):
+        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.service = client.Service(**self.opts.kwargs)
+
+        # Skip these tests if running below Splunk 6.2, cookie-auth didn't exist before
+        splver = self.service.splunk_version
+        if splver[:2] < (6, 2):
+            self.skipTest("Skipping cookie-auth tests, running in %d.%d.%d, this feature was added in 6.2+" % splver)
+
+    def test_login_and_store_cookie(self):
+        self.assertIsNotNone(self.service.cookie)
+        self.assertEquals(self.service.cookie, _NoAuthenticationToken)
+        self.service.login()
+        self.assertIsNotNone(self.service.cookie)
+        self.assertNotEquals(self.service.cookie, _NoAuthenticationToken)
+
+    def test_login_with_cookie(self):
+        self.service.login()
+        self.assertIsNotNone(self.service.cookie)
+        self.assertNotEqual(self.service.cookie, _NoAuthenticationToken)
+        # Use the cookie from the other service as the only auth param (don't need user/password)
+        service2 = client.Service(**{"cookie": self.service.cookie})
+        service2.login()
+        self.assertEqual(service2.cookie, self.service.cookie)
+        self.assertEqual(service2.cookie[:8], "splunkd_")
+
+
 class TestSettings(testlib.SDKTestCase):
     def test_read_settings(self):
         settings = self.service.settings