* Fix few comment typos

* Refactor debug messages to use String.format() when debug log level is enabled.

Author: Dingane Hlaluku

api/src/main/java/com/cloud/hypervisor/HypervisorGuru.java

@@ -33,7 +33,7 @@
 import com.cloud.vm.VirtualMachineProfile;
 
 public interface HypervisorGuru extends Adapter {
-    static final ConfigKey<Boolean> VmwareFullClone = new ConfigKey<Boolean>("Advanced", Boolean.class, "vmware.create.full.clone", "true",
+    ConfigKey<Boolean> VmwareFullClone = new ConfigKey<Boolean>("Advanced", Boolean.class, "vmware.create.full.clone", "true",
             "If set to true, creates guest VMs as full clones on ESX", false);
     HypervisorType getHypervisorType();
 
@@ -87,7 +87,7 @@ public interface HypervisorGuru extends Adapter {
     Map<String, String> getClusterSettings(long vmId);
 
     /**
-     * will generate commands to migrate a vm to a pool. For now this will ony work for stopped VMs on Vmware.
+     * Will generate commands to migrate a vm to a pool. For now this will only work for stopped VMs on Vmware.
      *
      * @param vm the stopped vm to migrate
      * @param destination the primary storage pool to migrate to

core/src/main/java/com/cloud/agent/api/UnregisterVMCommand.java

@@ -22,7 +22,7 @@
 public class UnregisterVMCommand extends Command {
     String vmName;
     boolean cleanupVmFiles = false;
-    boolean executeInSequence = false;
+    boolean executeInSequence;
 
     public UnregisterVMCommand(String vmName) {
         this(vmName, false);

engine/api/src/main/java/org/apache/cloudstack/engine/subsystem/api/storage/DataMotionStrategy.java

@@ -26,11 +26,11 @@
 import com.cloud.host.Host;
 
 /**
- * interface to query how to move data around and to commision the moving
+ * Interface to query how to move data around and to commision the moving
  */
 public interface DataMotionStrategy {
     /**
-     * reports whether this instance can do a move from source to destination
+     * Reports whether this instance can do a move from source to destination
      * @param srcData object to move
      * @param destData location to move it to
      * @return the expertise level with which this instance knows how to handle the move
@@ -40,7 +40,7 @@ public interface DataMotionStrategy {
     StrategyPriority canHandle(Map<VolumeInfo, DataStore> volumeMap, Host srcHost, Host destHost);
 
     /**
-     * copy the source volume to its destination (on a host if not null)
+     * Copy the source volume to its destination (on a host if not null)
      *
      * @param srcData volume to move
      * @param destData volume description as intended after the move

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

@@ -1981,8 +1981,7 @@ private void orchestrateStorageMigration(final String vmUuid, final StoragePool
 
         try {
             if(s_logger.isDebugEnabled()) {
-                s_logger.debug(
-                        String.format("Offline migration of %s vm %s with volumes",
+                s_logger.debug(String.format("Offline migration of %s vm %s with volumes",
                                 vm.getHypervisorType().toString(),
                                 vm.getInstanceName()));
             }
@@ -1992,20 +1991,21 @@ private void orchestrateStorageMigration(final String vmUuid, final StoragePool
         } catch (ConcurrentOperationException
                 | InsufficientCapacityException // possibly InsufficientVirtualNetworkCapacityException or InsufficientAddressCapacityException
                 | StorageUnavailableException e) {
-            s_logger.debug("Failed to migration: " + e.toString());
-            throw new CloudRuntimeException("Failed to migration: " + e.toString());
+            String msg = String.format("Failed to migrate VM: %s", vmUuid);
+            s_logger.debug(msg);
+            throw new CloudRuntimeException(msg, e);
         } finally {
             try {
                 stateTransitTo(vm, Event.AgentReportStopped, null);
             } catch (final NoTransitionException e) {
-                s_logger.debug("Failed to change vm state: " + e.toString());
-                throw new CloudRuntimeException("Failed to change vm state: " + e.toString());
+                String anotherMEssage = String.format("failed to change vm state of VM: %s", vmUuid);
+                s_logger.debug(anotherMEssage);
+                throw new CloudRuntimeException(anotherMEssage, e);
             }
         }
     }
 
     private Answer[] attemptHypervisorMigration(StoragePool destPool, VMInstanceVO vm) {
-        boolean migrationResult = false;
         final HypervisorGuru hvGuru = _hvGuruMgr.getGuru(vm.getHypervisorType());
         // OfflineVmwareMigration: in case of vmware call vcenter to do it for us.
         // OfflineVmwareMigration: should we check the proximity of source and destination
@@ -2014,7 +2014,7 @@ private Answer[] attemptHypervisorMigration(StoragePool destPool, VMInstanceVO v
         List<Command> commandsToSend = hvGuru.finalizeMigrate(vm, destPool);
 
         Long hostId = vm.getHostId();
-        // OfflineVmwareMigration: probaby this is null when vm is stopped
+        // OfflineVmwareMigration: probably this is null when vm is stopped
         if(hostId == null) {
             hostId = vm.getLastHostId();
             if (s_logger.isDebugEnabled()) {
@@ -2027,17 +2027,17 @@ private Answer[] attemptHypervisorMigration(StoragePool destPool, VMInstanceVO v
             try {
                 // OfflineVmwareMigration: change to the call back variety?
                 // OfflineVmwareMigration: getting a Long seq to be filled with _agentMgr.send(hostId, commandsContainer, this)
-                Answer[] answers = _agentMgr.send(hostId, commandsContainer);
-                return answers;
+                return  _agentMgr.send(hostId, commandsContainer);
             } catch (AgentUnavailableException | OperationTimedoutException e) {
-                throw new CloudRuntimeException("Failed to migration: " + e.toString());
+                throw new CloudRuntimeException(String.format("Failed to migrate VM: %s", vm.getUuid()),e);
             }
         }
         return null;
     }
 
     private void afterHypervisorMigrationCleanup(StoragePool destPool, VMInstanceVO vm, HostVO srcHost, Long srcClusterId, Answer[] hypervisorMigrationResults) throws InsufficientCapacityException {
-        if(s_logger.isDebugEnabled()) {
+        boolean isDebugEnabled = s_logger.isDebugEnabled();
+        if(isDebugEnabled) {
             String msg = String.format("cleaning up after hypervisor pool migration volumes for VM %s(%s) to pool %s(%s)", vm.getInstanceName(), vm.getUuid(), destPool.getName(), destPool.getUuid());
             s_logger.debug(msg);
         }
@@ -2046,7 +2046,7 @@ private void afterHypervisorMigrationCleanup(StoragePool destPool, VMInstanceVO
         Long destPodId = destPool.getPodId();
         Long vmPodId = vm.getPodIdToDeployIn();
         if (destPodId == null || ! destPodId.equals(vmPodId)) {
-            if(s_logger.isDebugEnabled()) {
+            if(isDebugEnabled) {
                 String msg = String.format("resetting lasHost for VM %s(%s) as pod (%s) is no good.", vm.getInstanceName(), vm.getUuid(), destPodId);
                 s_logger.debug(msg);
             }
@@ -2064,7 +2064,7 @@ private void markVolumesInPool(VMInstanceVO vm, StoragePool destPool, Answer[] h
         MigrateVmToPoolAnswer relevantAnswer = null;
         for (Answer answer : hypervisorMigrationResults) {
             if (s_logger.isTraceEnabled()) {
-                s_logger.trace(String.format("recieved an %s: %s", answer.getClass().getSimpleName(), answer));
+                s_logger.trace(String.format("received an %s: %s", answer.getClass().getSimpleName(), answer));
             }
             if (answer instanceof MigrateVmToPoolAnswer) {
                 relevantAnswer = (MigrateVmToPoolAnswer) answer;
@@ -2118,14 +2118,15 @@ private void preStorageMigrationStateCheck(StoragePool destPool, VMInstanceVO vm
         try {
             stateTransitTo(vm, Event.StorageMigrationRequested, null);
         } catch (final NoTransitionException e) {
-            s_logger.debug("Unable to migrate vm: " + e.toString());
-            throw new CloudRuntimeException("Unable to migrate vm: " + e.toString());
+            String msg = String.format("Unable to migrate vm: %s", vm.getUuid());
+            s_logger.debug(msg);
+            throw new CloudRuntimeException(msg, e);
         }
     }
 
     private void checkDestinationForTags(StoragePool destPool, VMInstanceVO vm) {
         List<VolumeVO> vols = _volsDao.findUsableVolumesForInstance(vm.getId());
-        // OfflineVmwareMigration: itterate over volumes
+        // OfflineVmwareMigration: iterate over volumes
         // OfflineVmwareMigration: get disk offering
         List<String> storageTags = storageMgr.getStoragePoolTagList(destPool.getId());
         for(Volume vol : vols) {

test/integration/smoke/test_vm_life_cycle.py

@@ -238,7 +238,7 @@ def test_deploy_vm_multiple(self):
         list_vms = VirtualMachine.list(self.apiclient, ids=[virtual_machine1.id, virtual_machine2.id], listAll=True)
         self.debug(
             "Verify listVirtualMachines response for virtual machines: %s, %s" % (
-            virtual_machine1.id, virtual_machine2.id)
+                virtual_machine1.id, virtual_machine2.id)
         )
         self.assertEqual(
             isinstance(list_vms, list),
@@ -606,7 +606,7 @@ def test_08_migrate_vm(self):
         migrate_host = suitable_hosts[1]
 
         # deploy VM on target host
-        self.vm_to_migrate = VirtualMachine.create(
+        vm_to_migrate = VirtualMachine.create(
             self.apiclient,
             self.services["small"],
             accountid=self.account.name,
@@ -616,23 +616,23 @@ def test_08_migrate_vm(self):
             hostid=target_host.id
         )
         self.debug("Migrating VM-ID: %s to Host: %s" % (
-            self.vm_to_migrate.id,
+            vm_to_migrate.id,
             migrate_host.id
         ))
 
-        self.vm_to_migrate.migrate(self.apiclient, migrate_host.id)
+        vm_to_migrate.migrate(self.apiclient, migrate_host.id)
 
         retries_cnt = 3
         while retries_cnt >= 0:
             list_vm_response = VirtualMachine.list(self.apiclient,
-                                                   id=self.vm_to_migrate.id)
+                                                   id=vm_to_migrate.id)
             self.assertNotEqual(
                 list_vm_response,
                 None,
                 "Check virtual machine is listed"
             )
             vm_response = list_vm_response[0]
-            self.assertEqual(vm_response.id, self.vm_to_migrate.id, "Check virtual machine ID of migrated VM")
+            self.assertEqual(vm_response.id, vm_to_migrate.id, "Check virtual machine ID of migrated VM")
             self.assertEqual(vm_response.hostid, migrate_host.id, "Check destination hostID of migrated VM")
             retries_cnt = retries_cnt - 1
         return