Merge pull request #54640 from garethgreenaway/2019_2_1_port_52352

[master] Porting #52352 to master
saltstack · Jan 11, 2020 · cd69763 · cd69763
2 parents 8d52ccd + 44760eb
commit cd69763
Showing 1 changed file with 21 additions and 11 deletions.
diff --git a/salt/syspaths.py b/salt/syspaths.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
 '''
-    :codeauthor: Pedro Algarvio (pedro@algarvio.me)
-
-
     salt.syspaths
     ~~~~~~~~~~~~~
 
@@ -21,9 +18,17 @@
 from __future__ import absolute_import, print_function, unicode_literals
 import sys
 import os.path
+import logging
 
 __PLATFORM = sys.platform.lower()
-
+typo_warning = True
+log = logging.getLogger(__name__)
+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
@@ -32,14 +37,19 @@
 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 EXPECTED_VARIABLES:
         setattr(__generated_syspaths, key, None)
-
+else:
+    for key in EXPECTED_VARIABLES:
+        if hasattr(__generated_syspaths, key):
+            continue
+        else:
+            if typo_warning:
+                log.warning('Possible Typo?')
+                log.warning('To dissolve this warning add `[variable] = None` to _syspaths.py')
+            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
 if 'SETUP_DIRNAME' in globals():