From f8e167ad936c274e5ac424bcba8c7e136cda3791 Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Wed, 27 Mar 2019 11:49:01 -0500 Subject: [PATCH 1/9] syspaths.py file modified to take missing variables from _syspaths.py and default them to "None" This will cause variables typoed or missing to be defaulted and allow salt to execute. --- salt/syspaths.py | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 7c35bff53a56..403503062e35 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -23,7 +23,12 @@ import os.path __PLATFORM = sys.platform.lower() - +svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', + 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', + 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', + 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', + 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH','SPM_PILLAR_PATH', + 'SPM_REACTOR_PATH', 'SHARE_DIR') try: # Let's try loading the system paths from the generated module at @@ -32,14 +37,14 @@ except ImportError: import types __generated_syspaths = types.ModuleType(str('salt._syspaths')) # future lint: blacklisted-function - for key in ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', - 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', - 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', - 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', - 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH', - 'SPM_PILLAR_PATH', 'SPM_REACTOR_PATH', 'SHARE_DIR'): + for key in svl: setattr(__generated_syspaths, key, None) - +else: + for key in svl: + if hasattr(__generated_syspaths, key): + continue + else: + setattr(__generated_syspaths, key, None) # Let's find out the path of this module if 'SETUP_DIRNAME' in globals(): From ff4dc7a17f79867cd4145c1343da7b91b7f97dd4 Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Wed, 27 Mar 2019 12:10:35 -0500 Subject: [PATCH 2/9] just added a comment for variable name --- salt/syspaths.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 403503062e35..31ea11575b8f 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -23,7 +23,7 @@ import os.path __PLATFORM = sys.platform.lower() -svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', +svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # svl = salt variable list 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', From de5426548e344af6ebcd22640fa80a52c7882a87 Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Wed, 27 Mar 2019 16:45:48 -0500 Subject: [PATCH 3/9] Warning log still not working added in elements from observing other salt .py files with log related code. --- salt/syspaths.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 31ea11575b8f..02d7ba62e2b4 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -1,8 +1,5 @@ # -*- coding: utf-8 -*- ''' - :codeauthor: Pedro Algarvio (pedro@algarvio.me) - - salt.syspaths ~~~~~~~~~~~~~ @@ -21,8 +18,10 @@ from __future__ import absolute_import, print_function, unicode_literals import sys import os.path +import logging __PLATFORM = sys.platform.lower() +log = logging.getLogger(__name__) svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # svl = salt variable list 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', @@ -44,7 +43,8 @@ if hasattr(__generated_syspaths, key): continue else: - setattr(__generated_syspaths, key, None) + log.warning('variable ' + key + ' was missing from _syspaths.py file, value defaulted to "None"') + setattr(__generated_syspaths, key, None) # missing variables defaulted to None # Let's find out the path of this module if 'SETUP_DIRNAME' in globals(): From f10f737e49be91ac7583aea1591793781f56cf3a Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Thu, 28 Mar 2019 19:32:06 -0500 Subject: [PATCH 4/9] Finished flushing out the warning log message. Added in typo question. Added in example line to fix the issue. --- salt/syspaths.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 02d7ba62e2b4..fb13217cd8d9 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -21,8 +21,9 @@ import logging __PLATFORM = sys.platform.lower() +typo_warning = False log = logging.getLogger(__name__) -svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # svl = salt variable list +svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # salt variable list 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', @@ -43,9 +44,13 @@ if hasattr(__generated_syspaths, key): continue else: - log.warning('variable ' + key + ' was missing from _syspaths.py file, value defaulted to "None"') + if not typo_warning: + log.warning('Possible Typo?') + log.warning('To dissolve this warning add `[variable] = None` to _syspaths.py') + typo_warning = True + log.warning('Variable "' + key + '" is missing, value set to None') setattr(__generated_syspaths, key, None) # missing variables defaulted to None - + # Let's find out the path of this module if 'SETUP_DIRNAME' in globals(): # This is from the exec() call in Salt's setup.py From d18c25451b54baef864289552c46bc48ae24b83b Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Fri, 29 Mar 2019 11:07:05 -0500 Subject: [PATCH 5/9] fixed tab/space mixing and removed trailing white space --- salt/syspaths.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index fb13217cd8d9..0bb1ae3a4d0f 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -24,11 +24,11 @@ typo_warning = False log = logging.getLogger(__name__) svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # salt variable list - 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', - 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', - 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', - 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH','SPM_PILLAR_PATH', - 'SPM_REACTOR_PATH', 'SHARE_DIR') + 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', + 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', + 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', + 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH','SPM_PILLAR_PATH', + 'SPM_REACTOR_PATH', 'SHARE_DIR') try: # Let's try loading the system paths from the generated module at @@ -41,16 +41,16 @@ setattr(__generated_syspaths, key, None) else: for key in svl: - if hasattr(__generated_syspaths, key): - continue - else: + if hasattr(__generated_syspaths, key): + continue + else: if not typo_warning: log.warning('Possible Typo?') log.warning('To dissolve this warning add `[variable] = None` to _syspaths.py') typo_warning = True - log.warning('Variable "' + key + '" is missing, value set to None') - setattr(__generated_syspaths, key, None) # missing variables defaulted to None - + log.warning('Variable "' + key + '" is missing, value set to None') + setattr(__generated_syspaths, key, None) # missing variables defaulted to None + # Let's find out the path of this module if 'SETUP_DIRNAME' in globals(): # This is from the exec() call in Salt's setup.py From 228483b3abdad5a19b2f3d981a645e2452f00fbe Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Fri, 29 Mar 2019 11:10:59 -0500 Subject: [PATCH 6/9] indentation fix --- salt/syspaths.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 0bb1ae3a4d0f..9e9f979dd5e0 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -42,7 +42,7 @@ else: for key in svl: if hasattr(__generated_syspaths, key): - continue + continue else: if not typo_warning: log.warning('Possible Typo?') From 7351cef255ad03943e0d61b9f309170fb32ca033 Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Fri, 29 Mar 2019 11:15:23 -0500 Subject: [PATCH 7/9] comment white space pylint test requirement --- salt/syspaths.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 9e9f979dd5e0..0e61da763980 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -23,7 +23,7 @@ __PLATFORM = sys.platform.lower() typo_warning = False log = logging.getLogger(__name__) -svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # salt variable list +svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # salt variable list 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', @@ -43,13 +43,13 @@ for key in svl: if hasattr(__generated_syspaths, key): continue - else: + else: if not typo_warning: log.warning('Possible Typo?') log.warning('To dissolve this warning add `[variable] = None` to _syspaths.py') typo_warning = True log.warning('Variable "' + key + '" is missing, value set to None') - setattr(__generated_syspaths, key, None) # missing variables defaulted to None + setattr(__generated_syspaths, key, None) # missing variables defaulted to None # Let's find out the path of this module if 'SETUP_DIRNAME' in globals(): From 432ea419a8114e8e436e07ba1a6f5d8975baefa3 Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Thu, 4 Apr 2019 15:57:08 -0500 Subject: [PATCH 8/9] space added to list --- salt/syspaths.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 0e61da763980..46c104e9d31e 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -27,7 +27,7 @@ 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', - 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH','SPM_PILLAR_PATH', + 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH', 'SPM_PILLAR_PATH', 'SPM_REACTOR_PATH', 'SHARE_DIR') try: From 8a79909af55b2103cd5a4da6b748e67d9afd198c Mon Sep 17 00:00:00 2001 From: Alan Cugler Date: Wed, 24 Apr 2019 16:49:43 -0500 Subject: [PATCH 9/9] 1) replace the svl variable, 2) reversed single print for loop mechanic, 3) changed print structure based off of a suggestion by @waynew Signed-off-by: Alan Cugler --- salt/syspaths.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/salt/syspaths.py b/salt/syspaths.py index 46c104e9d31e..ff60b73f4e12 100644 --- a/salt/syspaths.py +++ b/salt/syspaths.py @@ -21,14 +21,14 @@ import logging __PLATFORM = sys.platform.lower() -typo_warning = False +typo_warning = True log = logging.getLogger(__name__) -svl = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', # salt variable list - 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', - 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', - 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', - 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH', 'SPM_PILLAR_PATH', - 'SPM_REACTOR_PATH', 'SHARE_DIR') +EXPECTED_VARIABLES = ('ROOT_DIR', 'CONFIG_DIR', 'CACHE_DIR', 'SOCK_DIR', + 'SRV_ROOT_DIR', 'BASE_FILE_ROOTS_DIR', 'HOME_DIR', + 'BASE_PILLAR_ROOTS_DIR', 'BASE_THORIUM_ROOTS_DIR', + 'BASE_MASTER_ROOTS_DIR', 'LOGS_DIR', 'PIDFILE_DIR', + 'SPM_PARENT_PATH', 'SPM_FORMULA_PATH', 'SPM_PILLAR_PATH', + 'SPM_REACTOR_PATH', 'SHARE_DIR') try: # Let's try loading the system paths from the generated module at @@ -37,18 +37,18 @@ except ImportError: import types __generated_syspaths = types.ModuleType(str('salt._syspaths')) # future lint: blacklisted-function - for key in svl: + for key in EXPECTED_VARIABLES: setattr(__generated_syspaths, key, None) else: - for key in svl: + for key in EXPECTED_VARIABLES: if hasattr(__generated_syspaths, key): continue else: - if not typo_warning: + if typo_warning: log.warning('Possible Typo?') log.warning('To dissolve this warning add `[variable] = None` to _syspaths.py') - typo_warning = True - log.warning('Variable "' + key + '" is missing, value set to None') + typo_warning = False + log.warning('Variable %s is missing, value set to None', key) setattr(__generated_syspaths, key, None) # missing variables defaulted to None # Let's find out the path of this module