Add normalize_name utility

The normalize_name utility provides consumers of os-resource-classes
with a way of generating a known-good name for a custom resource class.
This is equivalent to the os-traits utility of the same name [1].

[1] 9eab06df2f/os_traits/__init__.py (L113)

Change-Id: Id5557d65f11ed4dee10c8df2a42a4c485bfd65d1
This commit is contained in:
Eric Fried 2019-01-31 09:39:43 -06:00
parent b0c27a7d62
commit 2d4672e5f3
2 changed files with 46 additions and 0 deletions

View File

@ -25,6 +25,7 @@ The OpenStack placement API provides a way to create these. A
custom resource class always begins with a "CUSTOM_" prefix.
"""
import re
import sys
# NOTE(cdent): We don't expect there to be thousands of resource
@ -77,3 +78,28 @@ def is_custom(resource_class):
package = sys.modules[__name__]
for resource_class in STANDARDS:
setattr(package, resource_class, resource_class)
# NOTE(efried): This method was introduced in nova in commit
# c6231539a7d39dccf3e859eda54e9336bc164c9f and copied from nova in its current
# form as of 5a4863aa152f58f6de426b3908a75c2cc1b2efca
def normalize_name(name):
"""Converts an input string to a legal* custom resource class name.
Legal custom resource class names are prefixed with CUSTOM_ and contain
only the characters A-Z, 0-9, and _ (underscore).
.. note:: Does not attempt to detect an existing ``CUSTOM_`` prefix, so
results starting with ``CUSTOM_CUSTOM_`` (etc.) are possible.
*Does not attempt to handle length restrictions.
:param name: A string to be converted.
:return: A legal* custom resource class name.
"""
if name is None:
return None
# Replace non-alphanumeric characters with underscores
norm_name = re.sub('[^0-9A-Za-z]+', '_', name)
# Bug #1762789: Do .upper after replacing non alphanumerics.
return CUSTOM_NAMESPACE + norm_name.upper()

View File

@ -48,3 +48,23 @@ class TestOs_resource_classes(base.TestCase):
expected_length = 15
self.assertEqual(expected_last_class, rc.STANDARDS[-1])
self.assertEqual(expected_length, len(rc.STANDARDS))
def test_normalize_name(self):
values = [
("foo", "CUSTOM_FOO"),
("VCPU", "CUSTOM_VCPU"),
("CUSTOM_BOB", "CUSTOM_CUSTOM_BOB"),
("CUSTM_BOB", "CUSTOM_CUSTM_BOB"),
# Bug #1762789: The upper() builtin treats sharp S (\xdf)
# differently in py2 vs py3. Make sure normalize_name handles it
# properly.
(u"Fu\xdfball", u"CUSTOM_FU_BALL"),
("abc-123", "CUSTOM_ABC_123"),
("Hello, world! This is a test ^_^",
"CUSTOM_HELLO_WORLD_THIS_IS_A_TEST_"),
(" leading and trailing spaces ",
"CUSTOM__LEADING_AND_TRAILING_SPACES_"),
]
for test_value, expected in values:
result = rc.normalize_name(test_value)
self.assertEqual(expected, result)