Merge "Add migration_get_by_uuid in db api."

nova/db/api.py

@@ -534,6 +534,11 @@ def migration_get(context, migration_id):
     return IMPL.migration_get(context, migration_id)
 
 
+def migration_get_by_uuid(context, migration_uuid):
+    """Finds a migration by the migration uuid."""
+    return IMPL.migration_get_by_uuid(context, migration_uuid)
+
+
 def migration_get_by_id_and_instance(context, migration_id, instance_uuid):
     """Finds a migration by the migration id and the instance uuid."""
     return IMPL.migration_get_by_id_and_instance(context,

nova/db/sqlalchemy/api.py

@@ -4807,6 +4807,18 @@ def migration_get(context, id):
     return result
 
 
+@pick_context_manager_reader
+def migration_get_by_uuid(context, migration_uuid):
+    result = model_query(context, models.Migration, read_deleted="yes").\
+                     filter_by(uuid=migration_uuid).\
+                     first()
+
+    if not result:
+        raise exception.MigrationNotFound(migration_id=migration_uuid)
+
+    return result
+
+
 @pick_context_manager_reader
 def migration_get_by_id_and_instance(context, id, instance_uuid):
     result = model_query(context, models.Migration).\

nova/tests/unit/db/test_db_api.py

@@ -1478,7 +1478,7 @@ def setUp(self):
 
     def _create(self, status='migrating', source_compute='host1',
                 source_node='a', dest_compute='host2', dest_node='b',
-                system_metadata=None, migration_type=None):
+                system_metadata=None, migration_type=None, uuid=None):
 
         values = {'host': source_compute}
         instance = db.instance_create(self.ctxt, values)
@@ -1489,7 +1489,7 @@ def _create(self, status='migrating', source_compute='host1',
         values = {'status': status, 'source_compute': source_compute,
                   'source_node': source_node, 'dest_compute': dest_compute,
                   'dest_node': dest_node, 'instance_uuid': instance['uuid'],
-                  'migration_type': migration_type}
+                  'migration_type': migration_type, 'uuid': uuid}
         db.migration_create(self.ctxt, values)
         return values
 
@@ -1538,6 +1538,48 @@ def test_instance_join(self):
             instance = migration['instance']
             self.assertEqual(migration['instance_uuid'], instance['uuid'])
 
+    def test_migration_get_by_uuid(self):
+        migration1 = self._create(uuid=uuidsentinel.migration1_uuid)
+        self._create(uuid=uuidsentinel.other_uuid)
+        real_migration1 = db.migration_get_by_uuid(
+            self.ctxt, uuidsentinel.migration1_uuid)
+        for key in migration1:
+            self.assertEqual(migration1[key], real_migration1[key])
+
+    def test_migration_get_by_uuid_soft_deleted_and_deleted(self):
+        migration1 = self._create(uuid=uuidsentinel.migration1_uuid)
+
+        @sqlalchemy_api.pick_context_manager_writer
+        def soft_delete_it(context):
+            sqlalchemy_api.model_query(context, models.Migration).\
+                filter_by(uuid=uuidsentinel.migration1_uuid).\
+                soft_delete()
+
+        @sqlalchemy_api.pick_context_manager_writer
+        def delete_it(context):
+            sqlalchemy_api.model_query(context, models.Migration,
+                                       read_deleted="yes").\
+                filter_by(uuid=uuidsentinel.migration1_uuid).\
+                delete()
+
+        soft_delete_it(self.ctxt)
+        soft_deletd_migration1 = db.migration_get_by_uuid(
+            self.ctxt, uuidsentinel.migration1_uuid)
+        for key in migration1:
+            self.assertEqual(migration1[key], soft_deletd_migration1[key])
+        delete_it(self.ctxt)
+        self.assertRaises(exception.MigrationNotFound,
+                          db.migration_get_by_uuid, self.ctxt,
+                          uuidsentinel.migration1_uuid)
+
+    def test_migration_get_by_uuid_not_found(self):
+        """Asserts that MigrationNotFound is raised if a migration is not
+        found by a given uuid.
+        """
+        self.assertRaises(exception.MigrationNotFound,
+                          db.migration_get_by_uuid, self.ctxt,
+                          uuidsentinel.migration_not_found)
+
     def test_get_migrations_by_filters(self):
         filters = {"status": "migrating", "host": "host3",
                    "migration_type": None, "hidden": False}