Merge pull request #2743 from nuagenetworks/bugfix/marvin_config_drive

CLOUDSTACK-10380: Fix startvm giving another pw after pw reset

Author: Paul Angus

engine/orchestration/src/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java

@@ -1336,7 +1336,7 @@ public boolean canUpdateInSequence(Network network, boolean forced){
 
         //check if the there are no service provider other than virtualrouter.
         for(Provider provider : providers) {
-            if (provider!=Provider.VirtualRouter)
+            if (provider != Provider.VirtualRouter)
                 throw new UnsupportedOperationException("Cannot update the network resources in sequence when providers other than virtualrouter are used");
         }
         //check if routers are in correct state before proceeding with the update

engine/schema/src/com/cloud/vm/dao/UserVmDaoImpl.java

@@ -29,11 +29,11 @@
 import javax.annotation.PostConstruct;
 import javax.inject.Inject;
 
+import org.apache.log4j.Logger;
+
 import com.cloud.network.Network;
 import com.cloud.network.dao.NetworkDao;
 import com.cloud.network.dao.NetworkVO;
-import org.apache.log4j.Logger;
-
 import com.cloud.server.ResourceTag.ResourceObjectType;
 import com.cloud.tags.dao.ResourceTagDao;
 import com.cloud.user.Account;
@@ -368,9 +368,13 @@ public void saveDetails(UserVmVO vm) {
         if (detailsStr == null) {
             return;
         }
+
+        final Map<String, Boolean> visibilityMap = _detailsDao.listDetailsVisibility(vm.getId());
+
         List<UserVmDetailVO> details = new ArrayList<UserVmDetailVO>();
-        for (String key : detailsStr.keySet()) {
-            details.add(new UserVmDetailVO(vm.getId(), key, detailsStr.get(key), true));
+        for (Map.Entry<String, String> entry : detailsStr.entrySet()) {
+            boolean display = visibilityMap.getOrDefault(entry.getKey(), true);
+            details.add(new UserVmDetailVO(vm.getId(), entry.getKey(), entry.getValue(), display));
         }
 
         _detailsDao.saveDetails(details);

engine/schema/src/org/apache/cloudstack/resourcedetail/ResourceDetailsDao.java

@@ -73,6 +73,8 @@ public interface ResourceDetailsDao<R extends ResourceDetail> extends GenericDao
 
     public Map<String, String> listDetailsKeyPairs(long resourceId, boolean forDisplay);
 
+    Map<String, Boolean> listDetailsVisibility(long resourceId);
+
     public void saveDetails(List<R> details);
 
     public void addDetail(long resourceId, String key, String value, boolean display);

engine/schema/src/org/apache/cloudstack/resourcedetail/ResourceDetailsDaoBase.java

@@ -27,7 +27,7 @@
 import com.cloud.utils.db.SearchCriteria;
 import com.cloud.utils.db.TransactionLegacy;
 
-public abstract class ResourceDetailsDaoBase<R extends ResourceDetail> extends GenericDaoBase<R, Long> {
+public abstract class ResourceDetailsDaoBase<R extends ResourceDetail> extends GenericDaoBase<R, Long> implements ResourceDetailsDao<R> {
     private SearchBuilder<R> AllFieldsSearch;
 
     public ResourceDetailsDaoBase() {
@@ -81,6 +81,18 @@ public Map<String, String> listDetailsKeyPairs(long resourceId) {
         return details;
     }
 
+    public Map<String, Boolean> listDetailsVisibility(long resourceId) {
+        SearchCriteria<R> sc = AllFieldsSearch.create();
+        sc.setParameters("resourceId", resourceId);
+
+        List<R> results = search(sc, null);
+        Map<String, Boolean> details = new HashMap<>(results.size());
+        for (R result : results) {
+            details.put(result.getName(), result.isDisplay());
+        }
+        return details;
+    }
+
     public List<R> listDetails(long resourceId) {
         SearchCriteria<R> sc = AllFieldsSearch.create();
         sc.setParameters("resourceId", resourceId);

server/src/com/cloud/network/element/VirtualRouterElement.java

@@ -24,14 +24,12 @@
 
 import javax.inject.Inject;
 
-import com.cloud.utils.net.NetUtils;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
-import com.cloud.network.router.NetworkHelper;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.log4j.Logger;
 import org.cloud.network.router.deployment.RouterDeploymentDefinition;
 import org.cloud.network.router.deployment.RouterDeploymentDefinitionBuilder;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 
 import com.google.gson.Gson;
 
@@ -83,6 +81,7 @@
 import com.cloud.network.dao.VirtualRouterProviderDao;
 import com.cloud.network.lb.LoadBalancingRule;
 import com.cloud.network.lb.LoadBalancingRulesManager;
+import com.cloud.network.router.NetworkHelper;
 import com.cloud.network.router.VirtualRouter;
 import com.cloud.network.router.VirtualRouter.Role;
 import com.cloud.network.router.VpcVirtualNetworkApplianceManager;
@@ -103,6 +102,7 @@
 import com.cloud.utils.db.QueryBuilder;
 import com.cloud.utils.db.SearchCriteria.Op;
 import com.cloud.utils.exception.CloudRuntimeException;
+import com.cloud.utils.net.NetUtils;
 import com.cloud.vm.DomainRouterVO;
 import com.cloud.vm.NicProfile;
 import com.cloud.vm.ReservationContext;
@@ -703,7 +703,14 @@ public boolean savePassword(final Network network, final NicProfile nic, final V
         // save the password in DB
         for (final VirtualRouter router : routers) {
             if (router.getState() == State.Running) {
-                return networkTopology.savePasswordToRouter(network, nic, uservm, router);
+                final boolean result = networkTopology.savePasswordToRouter(network, nic, uservm, router);
+                if (result) {
+                    // Explicit password reset, while VM hasn't generated a password yet.
+                    final UserVmVO userVmVO = _userVmDao.findById(vm.getId());
+                    userVmVO.setUpdateParameters(false);
+                    _userVmDao.update(userVmVO.getId(), userVmVO);
+                }
+                return result;
             }
         }
         final String password = (String) uservm.getParameter(VirtualMachineProfile.Param.VmPassword);

server/src/com/cloud/vm/UserVmManagerImpl.java

@@ -39,6 +39,11 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
+import org.apache.commons.codec.binary.Base64;
+import org.apache.commons.collections.MapUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.log4j.Logger;
+
 import org.apache.cloudstack.acl.ControlledEntity.ACLType;
 import org.apache.cloudstack.acl.SecurityChecker.AccessType;
 import org.apache.cloudstack.affinity.AffinityGroupService;
@@ -91,10 +96,6 @@
 import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;
 import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreDao;
 import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreVO;
-import org.apache.commons.codec.binary.Base64;
-import org.apache.commons.collections.MapUtils;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.log4j.Logger;
 
 import com.cloud.agent.AgentManager;
 import com.cloud.agent.api.Answer;
@@ -688,10 +689,6 @@ public UserVm resetVMPassword(ResetVMPasswordCmd cmd, String password) throws Re
 
         if (result) {
             userVm.setPassword(password);
-            // update the password in vm_details table too
-            // Check if an SSH key pair was selected for the instance and if so
-            // use it to encrypt & save the vm password
-            encryptAndStorePassword(userVm, password);
         } else {
             throw new CloudRuntimeException("Failed to reset password for the virtual machine ");
         }
@@ -736,7 +733,6 @@ private boolean resetVMPasswordInternal(Long vmId, String password) throws Resou
             } else {
                 final UserVmVO userVm = _vmDao.findById(vmId);
                 _vmDao.loadDetails(userVm);
-                userVm.setPassword(password);
                 // update the password in vm_details table too
                 // Check if an SSH key pair was selected for the instance and if so
                 // use it to encrypt & save the vm password
@@ -850,8 +846,9 @@ private boolean resetVMSSHKeyInternal(Long vmId, String sshPublicKey, String pas
                 userVm.setPassword(password);
                 //update the encrypted password in vm_details table too
                 encryptAndStorePassword(userVm, password);
+            } else {
+                _vmDao.saveDetails(userVm);
             }
-            _vmDao.saveDetails(userVm);
 
             if (vmInstance.getState() == State.Stopped) {
                 s_logger.debug("Vm " + vmInstance + " is stopped, not rebooting it as a part of SSH Key reset");
@@ -4461,6 +4458,7 @@ public Pair<UserVmVO, Map<VirtualMachineProfile.Param, Object>> startVirtualMach
                     password = DBEncryptionUtil.decrypt(vm.getDetail("password"));
                 } else {
                     password = _mgr.generateRandomPassword();
+                    vm.setPassword(password);
                 }
             }
 
@@ -4499,11 +4497,10 @@ public Pair<UserVmVO, Map<VirtualMachineProfile.Param, Object>> startVirtualMach
             // this value is not being sent to the backend; need only for api
             // display purposes
             if (template.getEnablePassword()) {
-                vm.setPassword((String)vmParamPair.second().get(VirtualMachineProfile.Param.VmPassword));
-                vm.setUpdateParameters(false);
                 if (vm.getDetail("password") != null) {
-                    _vmDetailsDao.remove(_vmDetailsDao.findDetail(vm.getId(), "password").getId());
+                    _vmDetailsDao.removeDetail(vm.getId(), "password");
                 }
+                vm.setUpdateParameters(false);
                 _vmDao.update(vm.getId(), vm);
             }
         }
@@ -6180,7 +6177,7 @@ public UserVm restoreVMInternal(Account caller, UserVmVO vm, Long newTemplateId)
                             vm.setUpdateParameters(false);
                             _vmDao.loadDetails(vm);
                             if (vm.getDetail("password") != null) {
-                                _vmDetailsDao.remove(_vmDetailsDao.findDetail(vm.getId(), "password").getId());
+                                _vmDetailsDao.removeDetail(vm.getId(), "password");
                             }
                             _vmDao.update(vm.getId(), vm);
                         }