Adds admin_password as key to be sanitized when logging

The Nova V3 API is moving to use admin_password instead of
admin_pass (both are currently in use). So adding admin_password
as a key that the value should be sanitized for when
logging.

Change-Id: I0eb66c948516624db8b770498ae541025545d981
Partial-Bug: #1247217

openstack/common/log.py

@@ -51,7 +51,7 @@
 
 _DEFAULT_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
 
-_SANITIZE_KEYS = ['adminPass', 'admin_pass', 'password']
+_SANITIZE_KEYS = ['adminPass', 'admin_pass', 'password', 'admin_password']
 
 # NOTE(ldbragst): Let's build a list of regex objects using the list of
 # _SANITIZE_KEYS we already have. This way, we only have to add the new key

tests/unit/test_log.py

@@ -546,6 +546,14 @@ def test_json(self):
         payload = """{ 'admin_pass' : 'mypassword' }"""
         expected = """{ 'admin_pass' : '***' }"""
         self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' w/o spaces
+        payload = """{'admin_password':'mypassword'}"""
+        expected = """{'admin_password':'***'}"""
+        self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' with spaces
+        payload = """{ 'admin_password' : 'mypassword' }"""
+        expected = """{ 'admin_password' : '***' }"""
+        self.assertEqual(expected, log.mask_password(payload))
         # Test 'password' w/o spaces
         payload = """{'password':'mypassword'}"""
         expected = """{'password':'***'}"""
@@ -576,6 +584,16 @@ def test_xml(self):
                      </admin_pass>"""
         expected = """<admin_pass>***</admin_pass>"""
         self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' w/o spaces
+        payload = """<admin_password>mypassword</admin_password>"""
+        expected = """<admin_password>***</admin_password>"""
+        self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' with spaces
+        payload = """<admin_password>
+                        mypassword
+                     </admin_password>"""
+        expected = """<admin_password>***</admin_password>"""
+        self.assertEqual(expected, log.mask_password(payload))
         # Test 'password' w/o spaces
         payload = """<password>mypassword</password>"""
         expected = """<password>***</password>"""
@@ -612,6 +630,18 @@ def test_xml_attribute(self):
         payload = """admin_pass = "mypassword\""""
         expected = """admin_pass = "***\""""
         self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' w/o spaces
+        payload = """admin_password='mypassword'"""
+        expected = """admin_password='***'"""
+        self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' with spaces
+        payload = """admin_password = 'mypassword'"""
+        expected = """admin_password = '***'"""
+        self.assertEqual(expected, log.mask_password(payload))
+        # Test 'admin_password' with double quotes
+        payload = """admin_password = "mypassword\""""
+        expected = """admin_password = "***\""""
+        self.assertEqual(expected, log.mask_password(payload))
         # Test 'password' w/o spaces
         payload = """password='mypassword'"""
         expected = """password='***'"""
@@ -632,6 +662,9 @@ def test_json_message(self):
         payload = """body: {"rescue": {"admin_pass": "1234567"}}"""
         expected = """body: {"rescue": {"admin_pass": "***"}}"""
         self.assertEqual(expected, log.mask_password(payload))
+        payload = """body: {"rescue": {"admin_password": "1234567"}}"""
+        expected = """body: {"rescue": {"admin_password": "***"}}"""
+        self.assertEqual(expected, log.mask_password(payload))
         payload = """body: {"rescue": {"password": "1234567"}}"""
         expected = """body: {"rescue": {"password": "***"}}"""
         self.assertEqual(expected, log.mask_password(payload))
@@ -670,6 +703,13 @@ def test_xml_message(self):
     admin_pass="***"/>"""
         self.assertEqual(expected, log.mask_password(payload))
         payload = """<?xml version="1.0" encoding="UTF-8"?>
+<rescue xmlns="http://docs.openstack.org/compute/api/v1.1"
+    admin_password="MySecretPass"/>"""
+        expected = """<?xml version="1.0" encoding="UTF-8"?>
+<rescue xmlns="http://docs.openstack.org/compute/api/v1.1"
+    admin_password="***"/>"""
+        self.assertEqual(expected, log.mask_password(payload))
+        payload = """<?xml version="1.0" encoding="UTF-8"?>
 <rescue xmlns="http://docs.openstack.org/compute/api/v1.1"
     password="MySecretPass"/>"""
         expected = """<?xml version="1.0" encoding="UTF-8"?>