Merge pull request #38585 from rallytime/follow-up-38527

Follow up to PR #38527

salt/config/__init__.py

@@ -3307,18 +3307,23 @@ def api_config(path):
     Read in the Salt Master config file and add additional configs that
     need to be stubbed out for salt-api
     '''
-    # Let's grab a copy of salt's master opts
-    opts = client_config(path, defaults=DEFAULT_MASTER_OPTS)
-    # Let's override them with salt-api's required defaults
-    api_opts = DEFAULT_API_OPTS
-    api_opts.update({
+    # Let's grab a copy of salt-api's required defaults
+    opts = DEFAULT_API_OPTS
+
+    # Let's override them with salt's master opts
+    opts.update(client_config(path, defaults=DEFAULT_MASTER_OPTS))
+
+    # Let's set the pidfile and log_file values in opts to api settings
+    opts.update({
         'pidfile': opts.get('api_pidfile', DEFAULT_API_OPTS['api_pidfile']),
         'log_file': opts.get('api_logfile', DEFAULT_API_OPTS['api_logfile']),
     })
-    opts.update(api_opts)
+
     prepend_root_dir(opts, [
         'api_pidfile',
         'api_logfile',
+        'log_file',
+        'pidfile'
     ])
     return opts
 

tests/unit/config/api_test.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+'''
+tests.unit.api_config_test
+'''
+
+# Import Python libs
+from __future__ import absolute_import
+
+# Import Salt Testing libs
+from salttesting import skipIf, TestCase
+from salttesting.helpers import destructiveTest, ensure_in_syspath
+from salttesting.mock import (
+    MagicMock,
+    NO_MOCK,
+    NO_MOCK_REASON,
+    patch
+)
+
+ensure_in_syspath('../../')
+
+# Import Salt libs
+import salt.config
+
+MOCK_MASTER_DEFAULT_OPTS = {
+    'log_file': '/var/log/salt/master',
+    'pidfile': '/var/run/salt-master.pid',
+    'root_dir': '/'
+}
+
+
+@skipIf(NO_MOCK, NO_MOCK_REASON)
+class APIConfigTestCase(TestCase):
+    '''
+    TestCase for the api_config function in salt.config.__init__.py
+    '''
+
+    @patch('salt.config.client_config', MagicMock(return_value=MOCK_MASTER_DEFAULT_OPTS))
+    def test_api_config_log_file_values(self):
+        '''
+        Tests the opts value of the 'log_file' after running through the
+        various default dict updates. 'log_file' should be updated to match
+        the DEFAULT_API_OPTS 'api_logfile' value.
+        '''
+        ret = salt.config.api_config('/some/fake/path')
+        self.assertEqual(ret['log_file'], '/var/log/salt/api')
+
+    @patch('salt.config.client_config', MagicMock(return_value=MOCK_MASTER_DEFAULT_OPTS))
+    def test_api_config_pidfile_values(self):
+        '''
+        Tests the opts value of the 'pidfile' after running through the
+        various default dict updates. 'pidfile' should be updated to match
+        the DEFAULT_API_OPTS 'api_pidfile' value.
+        '''
+        ret = salt.config.api_config('/some/fake/path')
+        self.assertEqual(ret['pidfile'], '/var/run/salt-api.pid')
+
+    @destructiveTest
+    def test_master_config_file_overrides_defaults(self):
+        '''
+        Tests the opts value of the api config values after running through the
+        various default dict updates that should be overridden by settings in
+        the user's master config file.
+        '''
+        # Copy DEFAULT_API_OPTS to restore after the test
+        default_api_opts = salt.config.DEFAULT_API_OPTS.copy()
+
+        foo_dir = '/foo/bar/baz'
+        hello_dir = '/hello/world'
+        mock_master_config = {
+            'api_pidfile': foo_dir,
+            'api_logfile': hello_dir,
+            'rest_timeout': 5
+        }
+        mock_master_config.update(MOCK_MASTER_DEFAULT_OPTS.copy())
+
+        with patch('salt.config.client_config',
+                   MagicMock(return_value=mock_master_config)):
+            ret = salt.config.api_config('/some/fake/path')
+            self.assertEqual(ret['rest_timeout'], 5)
+            self.assertEqual(ret['api_pidfile'], foo_dir)
+            self.assertEqual(ret['pidfile'], foo_dir)
+            self.assertEqual(ret['api_logfile'], hello_dir)
+            self.assertEqual(ret['log_file'], hello_dir)
+
+        # Reset DEFAULT_API_OPTS settings as to not interfere with other unit tests
+        salt.config.DEFAULT_API_OPTS = default_api_opts
+
+    @destructiveTest
+    def test_api_config_prepend_root_dirs_return(self):
+        '''
+        Tests the opts value of the api_logfile, log_file, api_pidfile, and pidfile
+        when a custom root directory is used. This ensures that each of these
+        values is present in the list of opts keys that should have the root_dir
+        prepended when the api_config function returns the opts dictionary.
+        '''
+        # Copy DEFAULT_API_OPTS to restore after the test
+        default_api_opts = salt.config.DEFAULT_API_OPTS.copy()
+
+        mock_log = '/mock/root/var/log/salt/api'
+        mock_pid = '/mock/root/var/run/salt-api.pid'
+
+        mock_master_config = MOCK_MASTER_DEFAULT_OPTS.copy()
+        mock_master_config['root_dir'] = '/mock/root/'
+
+        with patch('salt.config.client_config',
+                   MagicMock(return_value=mock_master_config)):
+            ret = salt.config.api_config('/some/fake/path')
+            self.assertEqual(ret['api_logfile'], mock_log)
+            self.assertEqual(ret['log_file'], mock_log)
+            self.assertEqual(ret['api_pidfile'], mock_pid)
+            self.assertEqual(ret['pidfile'], mock_pid)
+
+        # Reset DEFAULT_API_OPTS settings as to not interfere with other unit tests
+        salt.config.DEFAULT_API_OPTS = default_api_opts
+
+
+if __name__ == '__main__':
+    from integration import run_tests
+    run_tests(APIConfigTestCase, needs_daemon=False)