Corrected useLocalAuth setting so that it works as expected

Corrected imports so that post version control method works as well as the cloud version

Author: gjanders

README.md

@@ -260,6 +260,11 @@ To do this you will need to install Version Control For SplunkCloud on your Splu
 [SplunkVersionControlCloud github](https://github.com/gjanders/SplunkVersionControlCloud)
 
 ## Release Notes 
+### 1.1.1
+Corrected useLocalAuth setting so that it works as expected
+
+Corrected imports so that post version control method works as well as the cloud version
+
 ### 1.1.0
 Now tested on Windows and Splunk Cloud (note this version of the app is not installed on SplunkCloud, the VersionControl for SplunkCloud is the app to install on the SplunkCloud instance, this variation of the app includes only what is required to remotely backup/restore a SplunkCloud instance
 

SplunkVersionControl.tgz

@@ -173,6 +173,7 @@ def validate_arguments():
         useLocalAuth = val_data['useLocalAuth'].lower()
         if useLocalAuth == "true" or useLocalAuth == "t":
             useLocalAuth = True
+            logger.debug("useLocalAuth enabled")
             if val_data['srcURL'] != "https://localhost:8089":
                 print_error("Expected srcURL of https://localhost:8089 since useLocalAuth=True")
                 sys.exit(1)
@@ -186,18 +187,18 @@ def validate_arguments():
     if not useLocalAuth and ('srcUsername' not in val_data or 'srcPassword' not in val_data):
         print_error("useLocalAuth is not set to true and srcUsername/srcPassword not set, invalid config")
         sys.exit(3)
-    
+
     appName = "SplunkVersionControl"
     if 'remoteAppName' in val_data:
         appName = val_data['remoteAppName']
 
     if 'git_command' in val_data:
-        git_command = val_data['git_command']
+        git_command = val_data['git_command'].strip()
         logger.debug("Overriding git command to %s" % (git_command))
     else:
         git_command = "git"
     if 'ssh_command' in val_data:
-        ssh_command = val_data['ssh_command']
+        ssh_command = val_data['ssh_command'].strip()
         logger.debug("Overriding ssh command to %s" % (ssh_command))
     else:
         ssh_command = "ssh"

bin/splunkversioncontrol_backup.py

@@ -976,6 +976,7 @@ def run_script(self):
             useLocalAuth = config['useLocalAuth'].lower()
             if useLocalAuth == "true" or useLocalAuth=="t":
                 useLocalAuth = True
+                logger.debug("useLocalAuth enabled")
             else:
                 useLocalAuth = False
 
@@ -994,12 +995,12 @@ def run_script(self):
         self.gitRepoURL = config['gitRepoURL']
 
         if 'git_command' in config:
-            self.git_command = config['git_command']
+            self.git_command = config['git_command'].strip()
             logger.debug("Overriding git command to %s" % (self.git_command))
         else:
             self.git_command = "git"
         if 'ssh_command' in config:
-            self.ssh_command = config['ssh_command']
+            self.ssh_command = config['ssh_command'].strip()
             logger.debug("Overriding ssh command to %s" % (self.ssh_command))
         else:
             self.ssh_command = "ssh"
@@ -1032,7 +1033,7 @@ def run_script(self):
         currentEpochTime = calendar.timegm(time.gmtime())
         self.session_key = config['session_key']
 
-        if self.srcPassword.find("password:") == 0:
+        if not useLocalAuth and self.srcPassword.find("password:") == 0:
             self.srcPassword = get_password(self.srcPassword[9:], self.session_key, logger)
 
         if 'appsList' in config and config['appsList']!="":

bin/splunkversioncontrol_backup_class.py

@@ -8,13 +8,16 @@
 import os
 import time
 import calendar
-from splunkversioncontrol_restore_class import SplunkVersionControlRestore
 import sys
+import splunk.rest
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "lib"))
 
 from splunklib import six
 
+sys.path.append(os.path.join(os.path.dirname(__file__), "..", "bin"))
+from splunkversioncontrol_restore_class import SplunkVersionControlRestore
+
 splunkLogsDir = os.environ['SPLUNK_HOME'] + "/var/log/splunk"
 #Setup the logging
 logging_config = dict(
@@ -230,8 +233,8 @@ def handle_POST(self):
                 self.response.write("Restore has completed successfully in app %s, object of type %s, with name %s was restored from tag %s, scope %s with restoreAsUser %s and your username of %s" % (app, type, obj_name, tag, scope, restoreAsUser, username))
                 logger.info("Restore has completed successfully in app=%s, object of type=%s, with name=%s was restored from tag=%s, scope=%s with restoreAsUser=%s and requested by username=%s" % (app, type, obj_name, tag, scope, restoreAsUser, username))
             else:
-                self.response.write("Restore has failed to complete successfully in app %s, object of type %s, with name %s was restored from tag %s, scope %s with restoreAsUser %s and your username of %s" % (app, type, obj_name, tag, scope, restoreAsUser, username))
-                logger.warn("Restore has failed to successfully in app=%s, object of type=%s, with name=%s was restored from tag=%s, scope=%s with restoreAsUser=%s and requested by username=%s" % (app, type, obj_name, tag, scope, restoreAsUser, username))    
+                self.response.write("Restore has failed to complete successfully in app %s, object of type %s, with name %s was not restored from tag %s, scope %s with restoreAsUser %s and your username of %s" % (app, type, obj_name, tag, scope, restoreAsUser, username))
+                logger.warn("Restore has failed to complete successfully in app=%s, object of type=%s, with name=%s was not restored from tag=%s, scope=%s with restoreAsUser=%s and requested by username=%s" % (app, type, obj_name, tag, scope, restoreAsUser, username))    
 
             self.runHttpRequest(url, headers, None, 'delete', 'wiping kvstore splunkversioncontrol_rest_restore_status after completed run')
 

bin/splunkversioncontrol_rest_restore.py

@@ -150,6 +150,7 @@ def validate_arguments():
         useLocalAuth = val_data['useLocalAuth'].lower()
         if useLocalAuth == "true" or useLocalAuth == "t":
             useLocalAuth = True
+            logger.debug("useLocalAuth enabled")
             if val_data['destURL'] != "https://localhost:8089":
                 print_error("Expected destURL of https://localhost:8089 since useLocalAuth=True")
                 sys.exit(1)
@@ -210,12 +211,12 @@ def validate_arguments():
     gitRepoURL = val_data['gitRepoURL']
 
     if 'git_command' in val_data:
-        git_command = val_data['git_command']
+        git_command = val_data['git_command'].strip()
         logger.debug("Overriding git command to %s" % (git_command))
     else:
         git_command = "git"
     if 'ssh_command' in val_data:
-        ssh_command = val_data['ssh_command']
+        ssh_command = val_data['ssh_command'].strip()
         logger.debug("Overriding ssh command to %s" % (ssh_command))
     else:
         ssh_command = "ssh"

bin/splunkversioncontrol_restore.py

@@ -865,6 +865,7 @@ def run_script(self, restlist_override=None, config_override=None):
             useLocalAuth = config['useLocalAuth'].lower()
             if useLocalAuth == "true" or useLocalAuth=="t":
                 useLocalAuth = True
+                logger.debug("useLocalAuth enabled")
             else:
                 useLocalAuth = False
 
@@ -894,20 +895,20 @@ def run_script(self, restlist_override=None, config_override=None):
 
         self.session_key = config['session_key']
 
-        if self.destPassword.find("password:") == 0:
+        if not useLocalAuth and self.destPassword.find("password:") == 0:
             self.destPassword = get_password(self.destPassword[9:], self.session_key, logger)
 
         knownAppList = []
         self.gitTempDir = config['gitTempDir']
         self.gitRootDir = config['gitTempDir']
 
         if 'git_command' in config:
-            self.git_command = config['git_command']
+            self.git_command = config['git_command'].strip()
             logger.debug("Overriding git command to %s" % (self.git_command))
         else:
             self.git_command = "git"
         if 'ssh_command' in config:
-            self.ssh_command = config['ssh_command']
+            self.ssh_command = config['ssh_command'].strip()
             logger.debug("Overriding ssh command to %s" % (self.ssh_command))
         else:
             self.ssh_command = "ssh"
@@ -971,6 +972,7 @@ def run_script(self, restlist_override=None, config_override=None):
         else:
             resList = restlist_override
 
+        result = False
         if len(resList) == 0:
             logger.info("i=\"%s\" No restore required at this point in time" % (self.stanzaName))
         else:
@@ -994,11 +996,12 @@ def run_script(self, restlist_override=None, config_override=None):
                     logger.info("i=\"%s\" Successfully cloned the git URL=%s into directory dir=%s" % (self.stanzaName, self.gitRepoURL, self.gitRootDir))
             else:
                 logger.info("i=\"%s\" Successfully ran the git pull for URL=%s from directory dir=%s" % (self.stanzaName, self.gitRepoURL, self.gitRootDir))
+
             if stderrout.find("error:") != -1 or stderrout.find("fatal:") != -1 or stderrout.find("timeout after") != -1:
                 logger.warn("i=\"%s\" error/fatal messages in git stderroutput please review. stderrout=\"%s\"" % (self.stanzaName, stderrout))
                 gitFailure = True
-            logger.debug("i=\"%s\" The restore list is %s" % (self.stanzaName, resList))
 
+            logger.debug("i=\"%s\" The restore list is %s" % (self.stanzaName, resList))
             #Attempt to determine all users involved in this restore so we can run a single query and determine if they are admins or not
             userList = []
             for aRes in resList:
@@ -1174,3 +1177,5 @@ def run_script(self, restlist_override=None, config_override=None):
             shutil.rmtree(self.gitTempDir)
 
         logger.info("i=\"%s\" Done" % (self.stanzaName))
+
+        return result

bin/splunkversioncontrol_restore_class.py

@@ -33,7 +33,7 @@ def runOSProcess(command, logger, timeout=10, shell=False):
             logger.debug("OS process exited with zero code, for command %s" % (command))
             res = True
 
-    return stdout, stderr, res
+    return str(stdout), str(stderr), res
 
 # use the password endpoint to obtain the clear_password passed in, start with the context of this app and then try all contexts
 def get_password(password, session_key, logger):

bin/splunkversioncontrol_utility.py

@@ -12,7 +12,7 @@ label = SplunkVersionControl
 [launcher]
 author = Gareth Anderson
 description = Version Control software for Splunk instances (backup/restore from git)
-version = 1.1.0
+version = 1.1.1
 
 [package]
 id = SplunkVersionControl