Added build-env.py file and updated Makefile commands to create an env file

Author: akaila-splunk

Makefile

@@ -56,6 +56,17 @@ test_smoke_no_app:
 	@echo "$(ATTN_COLOR)==> test_smoke_no_app $(NO_COLOR)"
 	@tox -e py27,py37 -- -m "smoke and not app"
 
+.PHONY: env
+env:
+	@echo "$(ATTN_COLOR)==> env $(NO_COLOR)"
+	@echo "To make a .env:"
+	@echo "  [SPLUNK_INSTANCE_JSON] | python scripts/build-env.py"
+
+.PHONY: env_default
+env_default:
+	@echo "$(ATTN_COLOR)==> env_default $(NO_COLOR)"
+	@python scripts/build-env.py
+
 .PHONY: up
 up:
 	@echo "$(ATTN_COLOR)==> up $(NO_COLOR)"

README.md

@@ -96,6 +96,24 @@ To connect to Splunk Enterprise, many of the SDK examples and unit tests take co
 
 >**Note**: Storing login credentials in the **.env** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file.
 
+here is an example of .env file:
+
+    # Splunk Enterprise host (default: localhost)
+    host=localhost
+    # Splunk Enterprise admin port (default: 8089)
+    port=8089
+    # Splunk Enterprise username
+    username=admin
+    # Splunk Enterprise password
+    password=changed!
+    # Access scheme (default: https)
+    scheme=https
+    # Your version of Splunk Enterprise
+    version=8.0
+    # Bearer token for authentication
+    #bearerToken=<Bearer-token>
+    # Session key for authentication
+    #sessionKey=<Session-Key>
 
 #### Run the examples
 

scripts/build-env.py

@@ -0,0 +1,112 @@
+# Copyright 2011-2020 Splunk, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+#!/usr/bin/env python
+
+import sys
+import json
+import urllib.parse
+import os
+from pathlib import Path
+from string import Template
+
+DEFAULT_CONFIG = {
+    'host': 'localhost',
+    'port': '8089',
+    'username': 'admin',
+    'password': 'changed!',
+    'scheme': 'https',
+    'version': '8.0'
+}
+
+DEFAULT_ENV_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', '.env')
+
+ENV_TEMPLATE_PATH = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)), 'templates/env.template')
+
+# {
+#     "server_roles": {
+#         "standalone": [
+#             {
+#                 "host": "10.224.106.158",
+#                 "ports": {
+#                     "8089/tcp": "10.224.106.158:55759",
+#                 },
+#                 "splunk": {
+#                     "user_roles": {
+#                         "admin": {
+#                             "password": "Chang3d!",
+#                             "username": "admin"
+#                         }
+#                     },
+#                     "version": "8.1.0",
+#                     "web_url": "http://10.224.106.158:55761"
+#                 }
+#             }
+#         ]
+#     }
+# }
+def build_config(json_string):
+    try:
+        spec_config = json.loads(json_string)
+
+        server_config = spec_config['server_roles']['standalone'][0]
+        splunk_config = server_config['splunk']
+
+        host, port = parse_hostport(server_config['ports']['8089/tcp'])
+
+        return {
+            'host': host,
+            'port': port,
+            'username': splunk_config['user_roles']['admin']['username'],
+            'password': splunk_config['user_roles']['admin']['password'],
+            'version': splunk_config['version'],
+        }
+    except Exception as e:
+        raise ValueError('Invalid configuration JSON string') from e
+
+# Source: https://stackoverflow.com/a/53172593
+def parse_hostport(host_port):
+    # urlparse() and urlsplit() insists on absolute URLs starting with "//"
+    result = urllib.parse.urlsplit('//' + host_port)
+    return result.hostname, result.port
+
+def run(variable, env_path=None):
+    # read JSON from input
+    # parse the JSON
+    input_config = build_config(variable) if variable else DEFAULT_CONFIG
+
+    config = {**DEFAULT_CONFIG, **input_config}
+
+    # build a env file
+    with open(ENV_TEMPLATE_PATH, 'r') as f:
+        template = Template(f.read())
+
+    env_string = template.substitute(config)
+    env_path = DEFAULT_ENV_PATH if env_path is None else env_path
+    # if no env, dry-run
+    if not env_path:
+        print(env_string)
+        return
+
+    # write the .env file
+    with open(env_path, 'w') as f:
+        f.write(env_string)
+
+if sys.stdin.isatty():
+    DATA = None
+else:
+    DATA = sys.stdin.read()
+
+run(DATA, sys.argv[1] if len(sys.argv) > 1 else None)

scripts/templates/env.template

@@ -0,0 +1,16 @@
+# Splunk host (default: localhost)
+host=$host
+# Splunk admin port (default: 8089)
+port=$port
+# Splunk username
+username=$username
+# Splunk password
+password=$password
+# Access scheme (default: https)
+scheme=$scheme
+# Your version of Splunk (default: 6.2)
+version=$version
+# Bearer token for authentication
+#bearerToken=<Bearer-token>
+# Session key for authentication
+#sessionKey=<Session-Key>