Finalize the enum migration

Change-Id: Id8ab12441a490d49b30c21c4ab6853787631d4c7

doc/source/reference/usage.rst

@@ -206,7 +206,7 @@ Creating and using a sushy manager object
   print(mgr_inst.get_allowed_reset_manager_values())
 
   # Reset the manager
-  mgr_inst.reset_manager(sushy.RESET_MANAGER_FORCE_RESTART)
+  mgr_inst.reset_manager(sushy.ResetType.FORCE_RESTART)
 
   # Refresh the manager object (with all its sub-resources)
   mgr_inst.refresh(force=True)
@@ -345,7 +345,7 @@ Manager resource.
              % (manager_oem.get_extension(), manager.identity))
 
       # set boot device to a virtual media device image
-      manager_oem.set_virtual_boot_device(sushy.VIRTUAL_MEDIA_CD,
+      manager_oem.set_virtual_boot_device(sushy.VirtualMediaType.CD,
                                           manager=manager)
 
 

releasenotes/notes/enums-3aff03d940012f33.yaml

@@ -0,0 +1,21 @@
+---
+prelude: |
+    Sushy now exposes Python enums instead of simple string constants. Please
+    check the upgrade notes before updating to this version.
+upgrade:
+  - |
+    Python `enumerations <https://docs.python.org/3/library/enum.html>`_ are
+    now used instead of strings for all Sushy constants. The old names are
+    kept but now point to enumerated values, so e.g. ``sushy.POWER_STATE_ON``
+    is an alias for ``sushy.PowerState.ON``. Consumers of the library may see
+    breakages in two cases:
+
+    * Relying on literal values of the old constants. Use constants instead.
+    * Relying on the fact that Sushy constants are strings (e.g. storing them
+      in a database). You can either use the ``value`` attribute to get the
+      underlying string or create your own mapping.
+deprecations:
+  - |
+    The old constant names (not based on enumerations) are now deprecated.
+    For example, use ``sushy.PowerState.ON`` instead of
+    ``sushy.POWER_STATE_ON``.

sushy/tests/unit/resources/chassis/test_chassis.py

@@ -57,8 +57,7 @@ class ChassisTestCase(base.TestCase):
                          self.chassis.uuid)
         self.assertEqual(sushy.IndicatorLED.OFF,
                          self.chassis.indicator_led)
-        self.assertEqual(sushy.POWER_STATE_ON,
-                         self.chassis.power_state)
+        self.assertEqual(sushy.PowerState.ON, self.chassis.power_state)
         self.assertEqual(sushy.State.ENABLED, self.chassis.status.state)
         self.assertEqual(44.45, self.chassis.height_mm)
         self.assertEqual(431.8, self.chassis.width_mm)
@@ -81,7 +80,7 @@ class ChassisTestCase(base.TestCase):
         self.assertEqual('Blade', attributes.get('name'))
         self.assertEqual(sushy.IndicatorLED.OFF,
                          attributes.get('indicator_led'))
-        self.assertEqual(sushy.POWER_STATE_ON, attributes.get('power_state'))
+        self.assertEqual(sushy.PowerState.ON, attributes.get('power_state'))
         self.assertEqual({'intrusion_sensor': sushy.IntrusionSensor.NORMAL,
                           'intrusion_sensor_number': 123,
                           'intrusion_sensor_re_arm':

sushy/tests/unit/resources/system/storage/test_drive.py

@@ -46,7 +46,7 @@ class DriveTestCase(base.TestCase):
         self.assertIsInstance(identifiers, list)
         self.assertEqual(1, len(identifiers))
         identifier = identifiers[0]
-        self.assertEqual(sushy.DURABLE_NAME_FORMAT_NAA,
+        self.assertEqual(sushy.DurableNameFormat.NAA,
                          identifier.durable_name_format)
         self.assertEqual('32ADF365C6C1B7BD', identifier.durable_name)
         self.assertEqual('Contoso', self.stor_drive.manufacturer)

sushy/tests/unit/resources/system/storage/test_storage.py

@@ -125,7 +125,7 @@ class StorageTestCase(base.TestCase):
         self.assertIsInstance(identifiers, list)
         self.assertEqual(1, len(identifiers))
         identifier = identifiers[0]
-        self.assertEqual(sushy.DURABLE_NAME_FORMAT_NAA,
+        self.assertEqual(sushy.DurableNameFormat.NAA,
                          identifier.durable_name_format)
         self.assertEqual('345C59DBD970859C', identifier.durable_name)
         self.assertEqual(12, controller.speed_gbps)

sushy/tests/unit/resources/system/storage/test_volume.py

@@ -50,7 +50,7 @@ class VolumeTestCase(base.TestCase):
         self.assertIsInstance(identifiers, list)
         self.assertEqual(1, len(identifiers))
         identifier = identifiers[0]
-        self.assertEqual(sushy.DURABLE_NAME_FORMAT_UUID,
+        self.assertEqual(sushy.DurableNameFormat.UUID,
                          identifier.durable_name_format)
         self.assertEqual('38f1818b-111e-463a-aa19-fa54f792e468',
                          identifier.durable_name)

sushy/tests/unit/resources/system/test_system.py

@@ -68,8 +68,7 @@ class SystemTestCase(base.TestCase):
         self.assertEqual(res_cons.Health.OK, self.sys_inst.status.health)
         self.assertEqual(res_cons.Health.OK,
                          self.sys_inst.status.health_rollup)
-        self.assertEqual(sushy.SYSTEM_POWER_STATE_ON,
-                         self.sys_inst.power_state)
+        self.assertEqual(sushy.PowerState.ON, self.sys_inst.power_state)
         self.assertEqual(96, self.sys_inst.memory_summary.size_gib)
         self.assertEqual("OK", self.sys_inst.memory_summary.health)
         self.assertIsNotNone(self.sys_inst.maintenance_window)