syspaths.py warning message

[alan-cugler]

What does this PR do?

• sets missing variable to None
• Created a warning level message:
  • lists missing variables
  • "typo?" prompt
  • shows how & where to explicitly set variables

What issues does this PR fix or reference?

#52230

Previous Behavior

• If variable is missing from _syspaths.py file salt breaks and gives a traceback.

New Behavior

• Default sets variables not explicitly set in the _syspaths.py file
• Prompts user at log warning level about said variables.

Tests written?

• Was manually tested, no automated tests written.

Commits signed with GPG?

Yes

[alan-cugler]

I did not add in salt docs reference or URL since said doc doesn't exist yet, and reviewing other log messages showed no such references or URLs set in the messages.

[alan-cugler]

I don't get the space after comma error in pylint. later in the same file the lists don't have spaces after commas? pylint test is just bullying me... (T_T)

[alan-cugler]

@Ch3LL can you explain the error? I'm confused by it.

[Ch3LL]

you will want to make sure you point your pylint to the testing pylintrc file. For example I run: python2 -m pylint --rcfile /home/ch3ll/git/salt/.testing.pylintrc tests/unit/utils/test_stringutils.py

This should give you similar results as these tests.

But to help point you in the right direction this is how you will need to fix this particular lint error:

diff --git a/salt/syspaths.py b/salt/syspaths.py
index 0e61da7639..46c104e9d3 100644
--- a/salt/syspaths.py
+++ b/salt/syspaths.py
@@ -27,7 +27,7 @@ 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_PARENT_PATH', 'SPM_FORMULA_PATH', 'SPM_PILLAR_PATH',
     'SPM_REACTOR_PATH', 'SHARE_DIR')
 
 try:

notice the space after the SPM_FORMULA_PATH comma

[alan-cugler]

Cool, not sure why it failed before, but now it passes all the tests!

[alan-cugler]

@waynew let me know if anything is still dis-satisfying for the PR. I ended up using %s instead of %r since the %r was printing the unicode with the key variable in the print.

[waynew]

@alan-cugler Looking great! Do you think it would make sense to add a test ensuring that the expected values do get set? I'm not sure if that's a test we could automate very well?

[alan-cugler]

@waynew I am still learning your guy's test suite and how to use the mock library. We can open an issue to add a test in.