Replace .splunkrc with .env file in test and examples

akaila-splunk · akaila-splunk · commit 09551a86e2e1 · 2022-01-11T19:24:59.000+05:30
- Replace .spluncrc file with .env in examples and test cases
- updated __init__.py and cmdopts classes method to support .env file
diff --git a/.env b/.env
@@ -0,0 +1,16 @@
+# Splunk host (default: localhost)
+host=localhost
+# Splunk admin port (default: 8089)
+port=8089
+# Splunk username
+username=admin
+# Splunk password
+password=changed!
+# Access scheme (default: https)
+scheme=https
+# Your version of Splunk (default: 6.2)
+version=8.0
+# Bearer token for authentication
+#bearerToken="<Bearer-token>"
+# Session key for authentication
+#sessionKey="<Session-Key>"
diff --git a/examples/analytics/input.py b/examples/analytics/input.py
@@ -102,7 +102,7 @@ def main():
 
     argv = sys.argv[1:]
 
-    splunk_opts = utils.parse(argv, {}, ".splunkrc", usage=usage)
+    splunk_opts = utils.parse(argv, {}, ".env", usage=usage)
     tracker = AnalyticsTracker("cli_app", splunk_opts.kwargs)
     
     #tracker.track("test_event", "abc123", foo="bar", bar="foo")
diff --git a/examples/analytics/output.py b/examples/analytics/output.py
@@ -152,7 +152,7 @@ def main():
 
     argv = sys.argv[1:]
 
-    opts = utils.parse(argv, {}, ".splunkrc", usage=usage)
+    opts = utils.parse(argv, {}, ".env", usage=usage)
     retriever = AnalyticsRetriever(opts.args[0], opts.kwargs)    
 
     #events = retriever.events()
diff --git a/examples/analytics/server.py b/examples/analytics/server.py
@@ -146,7 +146,7 @@ def application(name):
 def main():
     argv = sys.argv[1:]
 
-    opts = utils.parse(argv, {}, ".splunkrc")
+    opts = utils.parse(argv, {}, ".env")
     global splunk_opts
     splunk_opts = opts.kwargs
 
diff --git a/examples/async/async.py b/examples/async/async.py
@@ -51,7 +51,7 @@ def main(argv):
     usage = "async.py <sync | async>"
 
     # Parse the command line args.
-    opts = parse(argv, {}, ".splunkrc")
+    opts = parse(argv, {}, ".env")
 
     # We have to see if we got either the "sync" or
     # "async" command line arguments.
diff --git a/examples/binding1.py b/examples/binding1.py
@@ -52,7 +52,7 @@ def search(self, query, **kwargs):
         return self.context.post("search/jobs/export", search=query, **kwargs)
 
 def main(argv):
-    opts = parse(argv, {}, ".splunkrc")
+    opts = parse(argv, {}, ".env")
     context = connect(**opts.kwargs)
     service = Service(context)
     assert service.apps().status == 200
diff --git a/examples/conf.py b/examples/conf.py
@@ -151,7 +151,7 @@ def main():
     commands = ['create', 'delete', 'list']
 
     # parse args, connect and setup 
-    opts = parse(argv, {}, ".splunkrc", usage=usage)
+    opts = parse(argv, {}, ".env", usage=usage)
     service = connect(**opts.kwargs)
     program = Program(service)
 
diff --git a/examples/dashboard/feed.py b/examples/dashboard/feed.py
@@ -171,7 +171,7 @@ def iterate(job):
 
 def main(argv):
     # Parse the command line args.
-    opts = parse(argv, {}, ".splunkrc")
+    opts = parse(argv, {}, ".env")
 
     # Connect to Splunk
     service = client.connect(**opts.kwargs)
diff --git a/examples/event_types.py b/examples/event_types.py
@@ -30,7 +30,7 @@
                     "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     service = connect(**opts.kwargs)
 
     for item in service.event_types:
diff --git a/examples/explorer/README.md b/examples/explorer/README.md
@@ -8,7 +8,7 @@ To run, simply execute:
 
     ./explorer.py
 
-It will pick up all relevant values from your .splunkrc, or you can pass them 
+It will pick up all relevant values from your .env, or you can pass them 
 in on the command line. You can see help by adding `--help` to the exectuion.
 
 The API Explorer will open up a browser window that will show you a drop down
diff --git a/examples/explorer/explorer.py b/examples/explorer/explorer.py
@@ -43,7 +43,7 @@ def main(argv):
         },
     }
 
-    opts = utils.parse(argv, redirect_port_args, ".splunkrc", usage=usage)
+    opts = utils.parse(argv, redirect_port_args, ".env", usage=usage)
 
     args = [("scheme", opts.kwargs["scheme"]),
             ("host", opts.kwargs["host"]),
diff --git a/examples/export/export.py b/examples/export/export.py
@@ -320,7 +320,7 @@ def export(options, service):
 
 def main():
     """ main entry """
-    options = parse(sys.argv[1:], CLIRULES, ".splunkrc")
+    options = parse(sys.argv[1:], CLIRULES, ".env")
 
     if options.kwargs['omode'] not in OUTPUT_MODES:
         print("output mode must be one of %s, found %s" % (OUTPUT_MODES,
diff --git a/examples/fired_alerts.py b/examples/fired_alerts.py
@@ -30,7 +30,7 @@
                     "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     service = connect(**opts.kwargs)
 
     for group in service.fired_alerts:
diff --git a/examples/follow.py b/examples/follow.py
@@ -48,7 +48,7 @@ def follow(job, count, items):
 
 def main():
     usage = "usage: follow.py <search>"
-    opts = utils.parse(sys.argv[1:], {}, ".splunkrc", usage=usage)
+    opts = utils.parse(sys.argv[1:], {}, ".env", usage=usage)
 
     if len(opts.args) != 1:
         utils.error("Search expression required", 2)
diff --git a/examples/genevents.py b/examples/genevents.py
@@ -113,7 +113,7 @@ def main():
         print("must supply an index name")
         sys.exit(1)
 
-    opts = parse(argv, RULES, ".splunkrc", usage=usage)
+    opts = parse(argv, RULES, ".env", usage=usage)
     service = connect(**opts.kwargs)
 
     if opts.kwargs['ingest'] not in INGEST_TYPE:
diff --git a/examples/get_job.py b/examples/get_job.py
@@ -33,7 +33,7 @@
                     "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main(argv):
-    opts = parse(argv, {}, ".splunkrc")
+    opts = parse(argv, {}, ".env")
     service = client.connect(**opts.kwargs)
 
     # Execute a simple search, and store the sid
diff --git a/examples/handlers/handler_certs.py b/examples/handlers/handler_certs.py
@@ -114,7 +114,7 @@ def request(url, message, **kwargs):
 
     return request
 
-opts = utils.parse(sys.argv[1:], RULES, ".splunkrc")
+opts = utils.parse(sys.argv[1:], RULES, ".env")
 ca_file = opts.kwargs['ca_file']
 service = client.connect(handler=handler(ca_file), **opts.kwargs)
 pprint([app.name for app in service.apps])
diff --git a/examples/handlers/handler_debug.py b/examples/handlers/handler_debug.py
@@ -41,6 +41,6 @@ def request(url, message, **kwargs):
         return response
     return request
 
-opts = utils.parse(sys.argv[1:], {}, ".splunkrc")
+opts = utils.parse(sys.argv[1:], {}, ".env")
 service = client.connect(handler=handler(), **opts.kwargs)
 pprint([app.name for app in service.apps])
diff --git a/examples/handlers/handler_proxy.py b/examples/handlers/handler_proxy.py
@@ -80,7 +80,7 @@ def handler(proxy):
     urllib.request.install_opener(opener)
     return request
 
-opts = utils.parse(sys.argv[1:], RULES, ".splunkrc")
+opts = utils.parse(sys.argv[1:], RULES, ".env")
 proxy = opts.kwargs['proxy']
 try:
     service = client.connect(handler=handler(proxy), **opts.kwargs)
diff --git a/examples/handlers/handler_urllib2.py b/examples/handlers/handler_urllib2.py
@@ -53,7 +53,7 @@ def request(url, message, **kwargs):
         'body': BytesIO(response.read())
     }
 
-opts = utils.parse(sys.argv[1:], {}, ".splunkrc")
+opts = utils.parse(sys.argv[1:], {}, ".env")
 service = client.connect(handler=request, **opts.kwargs)
 pprint([app.name for app in service.apps])
 
diff --git a/examples/index.py b/examples/index.py
@@ -183,7 +183,7 @@ def main():
         options = argv[:index]
         command = argv[index:]
 
-    opts = parse(options, {}, ".splunkrc", usage=usage, epilog=HELP_EPILOG)
+    opts = parse(options, {}, ".env", usage=usage, epilog=HELP_EPILOG)
     service = connect(**opts.kwargs)
     program = Program(service)
     program.run(command)
diff --git a/examples/info.py b/examples/info.py
@@ -30,7 +30,7 @@
                 "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 if __name__ == "__main__":
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     service = client.connect(**opts.kwargs)
 
     content = service.info
diff --git a/examples/inputs.py b/examples/inputs.py
@@ -30,7 +30,7 @@
                     "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     service = connect(**opts.kwargs)
 
     for item in service.inputs:
diff --git a/examples/job.py b/examples/job.py
@@ -267,7 +267,7 @@ def main():
         options = argv[:index]
         command = argv[index:]
 
-    opts = parse(options, {}, ".splunkrc", usage=usage, epilog=HELP_EPILOG)
+    opts = parse(options, {}, ".env", usage=usage, epilog=HELP_EPILOG)
     service = connect(**opts.kwargs)
     program = Program(service)
     program.run(command)
diff --git a/examples/kvstore.py b/examples/kvstore.py
@@ -30,7 +30,7 @@
                     "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     opts.kwargs["owner"] = "nobody"
     opts.kwargs["app"] = "search"
     service = connect(**opts.kwargs)
diff --git a/examples/loggers.py b/examples/loggers.py
@@ -32,7 +32,7 @@
 
 def main(argv):
     usage = "usage: %prog [options]"
-    opts = parse(argv, {}, ".splunkrc", usage=usage)
+    opts = parse(argv, {}, ".env", usage=usage)
     service = client.connect(**opts.kwargs)
 
     for logger in service.loggers:
diff --git a/examples/oneshot.py b/examples/oneshot.py
@@ -39,7 +39,7 @@ def pretty(response):
 
 def main():
     usage = "usage: oneshot.py <search>"
-    opts = utils.parse(sys.argv[1:], {}, ".splunkrc", usage=usage)
+    opts = utils.parse(sys.argv[1:], {}, ".env", usage=usage)
     if len(opts.args) != 1:
         utils.error("Search expression required", 2)
 
diff --git a/examples/saved_search/saved_search.py b/examples/saved_search/saved_search.py
@@ -160,7 +160,7 @@
 def main(argv):
     """ main entry """
     usage = 'usage: %prog --help for options'
-    opts = utils.parse(argv, RULES, ".splunkrc", usage=usage)
+    opts = utils.parse(argv, RULES, ".env", usage=usage)
 
     context = binding.connect(**opts.kwargs)
     operation = None
diff --git a/examples/saved_searches.py b/examples/saved_searches.py
@@ -31,7 +31,7 @@
 
 
 def main():
-    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    opts = parse(sys.argv[1:], {}, ".env")
     service = connect(**opts.kwargs)
 
     for saved_search in service.saved_searches:
diff --git a/examples/search.py b/examples/search.py
@@ -49,7 +49,7 @@ def cmdline(argv, flags, **kwargs):
     """A cmdopts wrapper that takes a list of flags and builds the
        corresponding cmdopts rules to match those flags."""
     rules = dict([(flag, {'flags': ["--%s" % flag]}) for flag in flags])
-    return parse(argv, rules, ".splunkrc", **kwargs)
+    return parse(argv, rules, ".env", **kwargs)
 
 def main(argv):
     usage = 'usage: %prog [options] "search"'
diff --git a/examples/search_modes.py b/examples/search_modes.py
@@ -12,7 +12,7 @@ def cmdline(argv, flags, **kwargs):
     """A cmdopts wrapper that takes a list of flags and builds the
        corresponding cmdopts rules to match those flags."""
     rules = dict([(flag, {'flags': ["--%s" % flag]}) for flag in flags])
-    return parse(argv, rules, ".splunkrc", **kwargs)
+    return parse(argv, rules, ".env", **kwargs)
 
 def modes(argv):
     opts = cmdline(argv, [])
diff --git a/examples/spcmd.py b/examples/spcmd.py
@@ -118,7 +118,7 @@ def actions(opts):
     return len(opts.args) > 0 or 'eval' in opts.kwargs 
 
 def main():
-    opts = utils.parse(sys.argv[1:], RULES, ".splunkrc")
+    opts = utils.parse(sys.argv[1:], RULES, ".env")
 
     # Connect and initialize the command session
     session = Session(**opts.kwargs)
diff --git a/examples/spurl.py b/examples/spurl.py
@@ -47,7 +47,7 @@ def print_response(response):
         print(body)
 
 def main():
-    opts = utils.parse(sys.argv[1:], {}, ".splunkrc")
+    opts = utils.parse(sys.argv[1:], {}, ".env")
     for arg in opts.args: 
         print_response(invoke(arg, **opts.kwargs))
 
diff --git a/examples/stail.py b/examples/stail.py
@@ -35,7 +35,7 @@
 
 def main():
     usage = "usage: %prog <search>"
-    opts = utils.parse(sys.argv[1:], {}, ".splunkrc", usage=usage)
+    opts = utils.parse(sys.argv[1:], {}, ".env", usage=usage)
 
     if len(opts.args) != 1:
         utils.error("Search expression required", 2)
diff --git a/examples/submit.py b/examples/submit.py
@@ -45,7 +45,7 @@
 
 def main(argv):
     usage = 'usage: %prog [options] <index>'
-    opts = parse(argv, RULES, ".splunkrc", usage=usage)
+    opts = parse(argv, RULES, ".env", usage=usage)
 
     if len(opts.args) == 0: error("Index name required", 2)
     index = opts.args[0]
diff --git a/examples/twitted/input.py b/examples/twitted/input.py
@@ -94,7 +94,7 @@ def connect(self):
 }
 
 def cmdline():
-    kwargs = parse(sys.argv[1:], RULES, ".splunkrc").kwargs
+    kwargs = parse(sys.argv[1:], RULES, ".env").kwargs
 
     # Prompt for Twitter username/password if not provided on command line
     if 'tusername' not in kwargs:
diff --git a/examples/upload.py b/examples/upload.py
@@ -58,7 +58,7 @@
 
 def main(argv):
     usage = 'usage: %prog [options] <filename>*'
-    opts = parse(argv, RULES, ".splunkrc", usage=usage)
+    opts = parse(argv, RULES, ".env", usage=usage)
 
     kwargs_splunk = dslice(opts.kwargs, FLAGS_SPLUNK)
     service = client.connect(**kwargs_splunk)
diff --git a/tests/test_binding.py b/tests/test_binding.py
@@ -69,7 +69,7 @@ class BindingTestCase(unittest.TestCase):
     context = None
     def setUp(self):
         logging.info("%s", self.__class__.__name__)
-        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.opts = testlib.parse([], {}, ".env")
         self.context = binding.connect(**self.opts.kwargs)
         logging.debug("Connected to splunkd.")
 
@@ -512,7 +512,7 @@ def test_logout(self):
 
 class TestCookieAuthentication(unittest.TestCase):
     def setUp(self):
-        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.opts = testlib.parse([], {}, ".env")
         self.context = binding.connect(**self.opts.kwargs)
 
         # Skip these tests if running below Splunk 6.2, cookie-auth didn't exist before
@@ -709,7 +709,7 @@ def test_namespace_fails(self):
 @pytest.mark.smoke
 class TestBasicAuthentication(unittest.TestCase):
     def setUp(self):
-        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.opts = testlib.parse([], {}, ".env")
         opts = self.opts.kwargs.copy()
         opts["basic"] = True
         opts["username"] = self.opts.kwargs["username"]
diff --git a/tests/test_service.py b/tests/test_service.py
@@ -180,7 +180,7 @@ def test_hec_event(self):
 
 class TestCookieAuthentication(unittest.TestCase):
     def setUp(self):
-        self.opts = testlib.parse([], {}, ".splunkrc")
+        self.opts = testlib.parse([], {}, ".env")
         self.service = client.Service(**self.opts.kwargs)
 
     if getattr(unittest.TestCase, 'assertIsNotNone', None) is None:
diff --git a/tests/testlib.py b/tests/testlib.py
@@ -232,7 +232,7 @@ def restartSplunk(self, timeout=240):
 
     @classmethod
     def setUpClass(cls):
-        cls.opts = parse([], {}, ".splunkrc")
+        cls.opts = parse([], {}, ".env")
 
         # Before we start, make sure splunk doesn't need a restart.
         service = client.connect(**cls.opts.kwargs)
diff --git a/tox.ini b/tox.ini
@@ -32,6 +32,7 @@ deps = pytest
        xmlrunner
        unittest2
        unittest-xml-reporting
+       python-dotenv
 
 distdir = build
 commands =
diff --git a/utils/__init__.py b/utils/__init__.py
diff --git a/utils/cmdopts.py b/utils/cmdopts.py
