python-watcher 15.1.0__tar.gz → 15.1.1__tar.gz

{python_watcher-15.1.0 → python_watcher-15.1.1}/.zuul.yaml

@@ -147,6 +147,9 @@
               block_migration_for_live_migration: true
             optimize:
               run_extended_attributes_tests: true
+              run_continuous_audit_tests: true
+              run_zone_migration_extra_tests: true
+              run_zone_migration_storage_tests: true
       # tempest variables
       tempest_test_regex: watcher_tempest_plugin.tests\.(api|scenario)
       # excluding tests with tag "real_load"

{python_watcher-15.1.0 → python_watcher-15.1.1}/ChangeLog

@@ -1,6 +1,20 @@
 CHANGES
 =======
 
+15.1.1
+------
+
+* Avoid logging messaging transport URLs
+* Enable extra zone migration tests on master branch
+* Handle missing fields building storage model XML or list
+* Test zone migration audit without destination
+* Ensure zone migration creates the correct action
+* Add test for zone migration audit without dst\_type
+* Fix zone migration dst pool and type selection
+* Add tests for get\_dst\_pool\_and\_type method
+* Fix small issues in cinder\_helper unit test
+* Fix check for volume type in cinder helper migrate
+
 15.1.0
 ------
 

{python_watcher-15.1.0 → python_watcher-15.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-watcher
-Version: 15.1.0
+Version: 15.1.1
 Summary: OpenStack Watcher provides a flexible and scalable resource optimization service for multi-tenant OpenStack-based clouds.
 Home-page: https://docs.openstack.org/watcher/latest/
 Author: OpenStack

{python_watcher-15.1.0 → python_watcher-15.1.1}/python_watcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-watcher
-Version: 15.1.0
+Version: 15.1.1
 Summary: OpenStack Watcher provides a flexible and scalable resource optimization service for multi-tenant OpenStack-based clouds.
 Home-page: https://docs.openstack.org/watcher/latest/
 Author: OpenStack

{python_watcher-15.1.0 → python_watcher-15.1.1}/python_watcher.egg-info/SOURCES.txt

@@ -245,6 +245,7 @@ rally-jobs/watcher-watcher.yaml
 releasenotes/notes/.placeholder
 releasenotes/notes/2025.1-prelude-8be97eece4e1d1ff.yaml
 releasenotes/notes/2025.2-prelude-a9f4c7b2e8d15692.yaml
+releasenotes/notes/960265-optional-pool-fields-storage-xml-26701a4ce5e54f2b.yaml
 releasenotes/notes/action-plan-cancel-c54726378019e096.yaml
 releasenotes/notes/action-plan-versioned-notifications-api-e8ca4f5d37aa5b4b.yaml
 releasenotes/notes/action-versioned-notifications-api-ff94fc0f401292d0.yaml
@@ -268,6 +269,7 @@ releasenotes/notes/audit-scoper-for-storage-data-model-cdccc803542d22db.yaml
 releasenotes/notes/audit-tag-vm-metadata-47a3e4468748853c.yaml
 releasenotes/notes/audit-versioned-notifications-api-bca7738e16954bad.yaml
 releasenotes/notes/automatic-triggering-audit-8a9b0540d547db60.yaml
+releasenotes/notes/avoid-transport-url-in-debug-logs.yaml
 releasenotes/notes/background-jobs-ha-9d3cf3fe356f4705.yaml
 releasenotes/notes/blueprint-add-skip-actions-4a5a997dc1133f13.yaml
 releasenotes/notes/bp-audit-scope-exclude-project-511a7720aac00dff.yaml
@@ -283,6 +285,7 @@ releasenotes/notes/bug-2113776-4bd314fb46623fbc.yaml
 releasenotes/notes/bug-2117726-fix-model-list-api-ref-30cc7ed1c85c0d0e.yaml
 releasenotes/notes/bug-2120586-fix-nova-microversion-check-9022a378b75d046f.yaml
 releasenotes/notes/bug-2121601-allow-status-message-updates-in-skipped-state-a8b4c5d7e9f2g3h1.yaml
+releasenotes/notes/bug-2129692-a1f941b8fa5a71be.yaml
 releasenotes/notes/bug-2131663-b486d36f77d13a5d.yaml
 releasenotes/notes/bug-2138857-e3505aa4a20a7831.yaml
 releasenotes/notes/build-baremetal-data-model-in-watcher-3023453a47b61dab.yaml

python_watcher-15.1.1/python_watcher.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "8e27e90a", "is_release": true}

python_watcher-15.1.1/releasenotes/notes/960265-optional-pool-fields-storage-xml-26701a4ce5e54f2b.yaml

@@ -0,0 +1,11 @@
+---
+fixes:
+  - |
+    Fixed the errors showing in the decision engine logs when generating the
+    xml representation of the storage model when using some storage backends
+    other than lvms (like ceph or nfs). Those drivers do not report pool
+    fields like total_volumes or free_capacity_gb that the lvm driver does,
+    so assuming those fields are always reported by the cinder api calls is
+    wrong.
+
+    See: https://bugs.launchpad.net/watcher/+bug/2121147 for more details.

python_watcher-15.1.1/releasenotes/notes/avoid-transport-url-in-debug-logs.yaml

@@ -0,0 +1,8 @@
+---
+security:
+  - |
+    Hardened service debug logging so service start and stop messages no
+    longer include the configured messaging transport URL. This avoids writing
+    credentials embedded in the transport URL to service logs when debug
+    logging is enabled. This is a security hardening enhancement and not a
+    security vulnerability fix.

python_watcher-15.1.1/releasenotes/notes/bug-2129692-a1f941b8fa5a71be.yaml

@@ -0,0 +1,15 @@
+---
+fixes:
+  - |
+    Fixed zone migration strategy destination pool and type selection.
+    Previously, the get_dst_pool_and_type method was always selecting the
+    first matching storage pool based only on src_pool, ignoring the
+    src_type parameter. This caused incorrect volume migrations when
+    users supplied multiple values for storage_pools with the same
+    source pool but different source types.
+
+    The method now implements a two-pass matching approach:
+    first attempting to match both src_pool and src_type for exact matches,
+    then falling back to matching just src_pool if no exact match is found.
+
+    For more info see: https://bugs.launchpad.net/watcher/+bug/2129692

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/common/cinder_helper.py

@@ -94,18 +94,6 @@ class CinderHelper(object):
         except cinder_exception.NotFound:
             return self.cinder.volumes.find(name=volume)
 
-    def backendname_from_poolname(self, poolname):
-        """Get backendname from poolname"""
-        # pooolname formatted as host@backend#pool since ocata
-        # as of ocata, may as only host
-        backend = poolname.split('#')[0]
-        backendname = ""
-        try:
-            backendname = backend.split('@')[1]
-        except IndexError:
-            pass
-        return backendname
-
     def _has_snapshot(self, volume):
         """Judge volume has a snapshot"""
         volume = self.get_volume(volume)
@@ -132,6 +120,51 @@ class CinderHelper(object):
         else:
             return True
 
+    def _check_backend_matches_type(self, pool, volume_type):
+        """Check if a storage pool matches volume type requirements.
+
+        Verifies that all extra_specs properties defined in the volume
+        type are present in the pool's capabilities with matching values.
+
+        :param pool: Storage pool dictionary with capabilities
+        :param volume_type: Volume type object with extra_specs
+        :returns: True if pool matches all volume type requirements,
+                  False otherwise
+        """
+        for field_name, field_value in volume_type.extra_specs.items():
+            pool_value = pool.get("capabilities", {}).get(field_name)
+            if pool_value is not None and field_value != pool_value:
+                # the property associated with the volume type is
+                # not defined in the pool, so the type can't be used in the
+                # pool
+                LOG.debug(
+                    f"property {field_name} with value {field_value} "
+                    f"does not match value {pool_value} from pool "
+                    f"{pool['name']}"
+                )
+                return False
+        return True
+
+    def get_volume_types_for_pool(self, pool):
+        """Return a list of volume types that can be associated with a pool.
+
+        :param pool: Storage pool dictionary with capabilities
+        :returns: List of volume types than can be scheduled in the input pool
+        """
+        volume_type_list = self.get_volume_type_list()
+
+        pool_volume_types = []
+        for volume_type in volume_type_list:
+            if not volume_type.extra_specs:
+                # if there are no properties associated with the volume type
+                # it can be used in any pool
+                pool_volume_types.append(volume_type.name)
+                continue
+            if self._check_backend_matches_type(pool, volume_type):
+                pool_volume_types.append(volume_type.name)
+
+        return pool_volume_types
+
     def check_volume_deleted(self, volume, retry=120, retry_interval=10):
         """Check volume has been deleted"""
         volume = self.get_volume(volume)
@@ -224,11 +257,20 @@ class CinderHelper(object):
     def migrate(self, volume, dest_node):
         """Migrate volume to dest_node"""
         volume = self.get_volume(volume)
-        dest_backend = self.backendname_from_poolname(dest_node)
-        dest_type = self.get_volume_type_by_backendname(dest_backend)
-        if volume.volume_type not in dest_type:
+        pool_dict = self.get_storage_pool_by_name(dest_node).to_dict()
+        dest_types = self.get_volume_types_for_pool(pool_dict)
+        if volume.volume_type not in dest_types:
             raise exception.Invalid(
-                message=(_("Volume type must be same for migrating")))
+                message=(
+                    _(
+                        "Volume type '%(volume_type)s' is not compatible with "
+                        "destination pool '%(pool_name)s'"
+                    ) % {
+                        'volume_type': volume.volume_type,
+                        'pool_name': dest_node
+                        }
+                )
+            )
 
         source_node = getattr(volume, 'os-vol-host-attr:host')
         LOG.debug("Volume %(volume)s found on host '%(host)s'.",

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/common/service.py

@@ -241,7 +241,7 @@ class Service(service.ServiceBase):
         )
 
     def start(self):
-        LOG.debug("Connecting to '%s'", CONF.transport_url)
+        LOG.debug("Connecting to messaging transport")
         if self.conductor_topic_handler:
             self.conductor_topic_handler.start()
         if self.notification_handler:
@@ -250,7 +250,7 @@ class Service(service.ServiceBase):
             self.heartbeat.start()
 
     def stop(self):
-        LOG.debug("Disconnecting from '%s'", CONF.transport_url)
+        LOG.debug("Disconnecting from messaging transport")
         if self.conductor_topic_handler:
             self.conductor_topic_handler.stop()
         if self.notification_handler:

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/conf/grafana_client.py

@@ -29,6 +29,7 @@ GRAFANA_CLIENT_OPTS = [
     # A similar structure to the database_map would solve this.
     cfg.StrOpt('token',
                default=None,
+               secret=True,
                help="Authentication token to gain access"),
     # TODO(Dantali0n) each individual metric could have its own base url.
     # A similar structure to the database_map would solve this.

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/conf/maas_client.py

@@ -23,6 +23,7 @@ MAAS_CLIENT_OPTS = [
     cfg.StrOpt('url',
                help='MaaS URL, example: http://1.2.3.4:5240/MAAS'),
     cfg.StrOpt('api_key',
+               secret=True,
                help='MaaS API authentication key.'),
     cfg.IntOpt('timeout',
                default=60,

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/decision_engine/model/element/base.py

@@ -51,16 +51,19 @@ class Element(base.WatcherObject, base.WatcherObjectDictCompat,
 
     def as_xml_element(self):
         sorted_fieldmap = []
+        element_name = self.__class__.__name__
         for field in self.fields:
             try:
                 value = str(self[field])
                 sorted_fieldmap.append((field, value))
+            except NotImplementedError:
+                LOG.debug("Attribute %s for object %s: %s is not provided",
+                          field, element_name, self)
             except Exception as exc:
                 LOG.exception(exc)
 
         attrib = collections.OrderedDict(sorted_fieldmap)
 
-        element_name = self.__class__.__name__
         instance_el = etree.Element(element_name, attrib=attrib)
 
         return instance_el

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/decision_engine/model/model_root.py

@@ -269,7 +269,14 @@ class ModelRoot(nx.DiGraph, base.Model):
             in_dict = {}
             for field in cn.fields:
                 new_name = "node_"+str(field)
-                in_dict[new_name] = cn[field]
+                try:
+                    in_dict[new_name] = cn[field]
+                # NotImplementedError means field not assigned
+                # which is really not an issue as it can be an
+                # optional field
+                except NotImplementedError:
+                    LOG.debug("Attribute %s for Compute: %s is not provided",
+                              field, cn.hostname)
             node_instances = self.get_node_instances(cn)
             if not node_instances:
                 deep_in_dict = in_dict.copy()
@@ -278,7 +285,11 @@ class ModelRoot(nx.DiGraph, base.Model):
             for instance in sorted(node_instances, key=lambda x: x.uuid):
                 for field in instance.fields:
                     new_name = "server_"+str(field)
-                    in_dict[new_name] = instance[field]
+                    try:
+                        in_dict[new_name] = instance[field]
+                    except NotImplementedError:
+                        LOG.debug("Attribute %s for Instance: %s is not "
+                                  "provided", field, instance.uuid)
                 if in_dict != {}:
                     deep_in_dict = in_dict.copy()
                     ret_list.append(deep_in_dict)

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/decision_engine/strategy/strategies/zone_migration.py

@@ -381,16 +381,36 @@ class ZoneMigration(base.ZoneMigrationBaseStrategy):
             if node.get("src_node") == src_node:
                 return node.get("dst_node")
 
-    def get_dst_pool_and_type(self, src_pool):
+    def get_dst_pool_and_type(self, src_pool, src_type):
         """Get destination pool and type from self.migration_storage_pools
 
         :param src_pool: storage pool name
-        :returns: set of storage pool name and volume type name
+        :param src_type: storage volume type
+        :returns: set of storage dst pool name and dst volume type name, any
+        of those values can be None if no match for it is found in the
+        input_parameters
         """
+        src_pool_type_inputs = []
+        src_pool_inputs = []
         for pool in self.migrate_storage_pools:
+            if pool.get("src_type") is None:
+                src_pool_inputs.append(pool)
+            else:
+                src_pool_type_inputs.append(pool)
+
+        pool_to_check = (src_pool, src_type)
+        # First pass: prefer exact match (both src_pool and src_type)
+        for pool in src_pool_type_inputs:
+            user_pool = (pool.get("src_pool"), pool.get("src_type"))
+            if pool_to_check == user_pool:
+                return (pool.get("dst_pool"), pool.get("dst_type"))
+
+        # Second pass: fall back to matching just src_pool
+        for pool in src_pool_inputs:
             if pool.get("src_pool") == src_pool:
-                return (pool.get("dst_pool", None),
-                        pool.get("dst_type"))
+                return (pool.get("dst_pool"), pool.get("dst_type"))
+
+        return (None, None)
 
     def volumes_migration(self, volumes, action_counter, instance_targets=[]):
         instance_target_ids = {instance.id for instance in instance_targets}
@@ -406,17 +426,20 @@ class ZoneMigration(base.ZoneMigrationBaseStrategy):
                 continue
 
             src_type = volume.volume_type
-            dst_pool, dst_type = self.get_dst_pool_and_type(pool)
+            dst_pool, dst_type = self.get_dst_pool_and_type(pool, src_type)
             LOG.debug(src_type)
             LOG.debug("%s %s", dst_pool, dst_type)
 
-            if src_type == dst_type:
+            if dst_type is None or src_type == dst_type:
                 if dst_pool is None:
-                    LOG.warning("volume %s will not be migrated because "
-                                "it already has type %s and 'dst_pool'"
-                                " was not specified for src_pool %s",
-                                volume.name, dst_type,
-                                pool)
+                    type_msg = (
+                        "" if dst_type is None else
+                        f"it already has type {dst_type} and ")
+                    LOG.info(
+                        "volume %s will not be migrated because %s'dst_pool' "
+                        "was not specified for src_pool %s",
+                        volume.name, type_msg, pool
+                    )
                     continue
                 self._volume_migrate(volume, dst_pool)
             else:

{python_watcher-15.1.0 → python_watcher-15.1.1}/watcher/tests/api/v1/test_audits.py

@@ -1394,6 +1394,39 @@ class TestAuditZoneMigration(TestPostBase):
             self.assertIn(expected_error_msg, response.json['error_message'])
         mock_trigger_audit.assert_not_called()
 
+    @mock.patch.object(deapi.DecisionEngineAPI, 'trigger_audit')
+    def test_create_audit_zone_migration_no_dst_pool_dst_type(
+        self, mock_trigger_audit
+    ):
+        """Verify zone migration rejects no destination parameters.
+
+        Tests that an audit creation fails with BAD_REQUEST when neither
+        dst_type nor dst_pool are passed in the input parameters. This
+        validates the schema correctly enforces that the at least one
+        destination parameters is present.
+        """
+        mock_trigger_audit.return_value = mock.ANY
+        zm_params = {
+            'storage_pools': [
+                    {"src_type": "src_type_name",
+                     "src_pool": "src_pool_name"}
+                ]
+            }
+
+        audit_input_dict = self._prepare_audit_params(zm_params)
+
+        response = self.post_json('/audits', audit_input_dict,
+                                  expect_errors=True)
+        self.assertEqual("application/json", response.content_type)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
+        expected_error_msgs = (
+            "is not valid under any of the given schemas",
+            "Failed validating 'oneOf' in schema"
+        )
+        for expected_error_msg in expected_error_msgs:
+            self.assertIn(expected_error_msg, response.json['error_message'])
+        mock_trigger_audit.assert_not_called()
+
     @mock.patch.object(deapi.DecisionEngineAPI, 'trigger_audit')
     def test_create_audit_zone_migration_with_multiple_valid_inputs(
         self, mock_trigger_audit