Merge "Improve masking of secrets in configuration show"

Author: Jenkins

openstackclient/common/configuration.py

@@ -13,6 +13,7 @@
 
 """Configuration action implementations"""
 
+from keystoneauth1.loading import base
 from osc_lib.command import command
 import six
 
@@ -44,12 +45,13 @@ def get_parser(self, prog_name):
 
     def take_action(self, parsed_args):
 
+        auth_plg_name = self.app.client_manager.auth_plugin_name
+        secret_opts = [o.dest for o in base.get_plugin_options(auth_plg_name)
+                       if o.secret]
+
         info = self.app.client_manager.get_configuration()
         for key, value in six.iteritems(info.pop('auth', {})):
-            if parsed_args.mask:
-                if 'password' in key.lower():
-                    value = REDACTED
-                if 'token' in key.lower():
+            if parsed_args.mask and key.lower() in secret_opts:
                     value = REDACTED
             info['auth.' + key] = value
         return zip(*sorted(six.iteritems(info)))

openstackclient/tests/common/test_configuration.py

@@ -11,6 +11,8 @@
 #   under the License.
 #
 
+import mock
+
 from openstackclient.common import configuration
 from openstackclient.tests import fakes
 from openstackclient.tests import utils
@@ -33,7 +35,12 @@ class TestConfiguration(utils.TestCommand):
         fakes.REGION_NAME,
     )
 
-    def test_show(self):
+    opts = [mock.Mock(secret=True, dest="password"),
+            mock.Mock(secret=True, dest="token")]
+
+    @mock.patch("keystoneauth1.loading.base.get_plugin_options",
+                return_value=opts)
+    def test_show(self, m_get_plugin_opts):
         arglist = []
         verifylist = [('mask', True)]
         cmd = configuration.ShowConfiguration(self.app, None)
@@ -44,7 +51,9 @@ def test_show(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, data)
 
-    def test_show_unmask(self):
+    @mock.patch("keystoneauth1.loading.base.get_plugin_options",
+                return_value=opts)
+    def test_show_unmask(self, m_get_plugin_opts):
         arglist = ['--unmask']
         verifylist = [('mask', False)]
         cmd = configuration.ShowConfiguration(self.app, None)
@@ -62,7 +71,9 @@ def test_show_unmask(self):
         )
         self.assertEqual(datalist, data)
 
-    def test_show_mask(self):
+    @mock.patch("keystoneauth1.loading.base.get_plugin_options",
+                return_value=opts)
+    def test_show_mask(self, m_get_plugin_opts):
         arglist = ['--mask']
         verifylist = [('mask', True)]
         cmd = configuration.ShowConfiguration(self.app, None)