validate integration tests, minor ui changes and log messages

Author: sudo87

results.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><testsuite name="nosetests" tests="6" errors="0" failures="0" skip="0"><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_01_deploy_vm_no_lease_svc_offering" time="55.914"></testcase><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_02_deploy_vm_no_lease_svc_offering_with_lease_params" time="54.334"></testcase><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_03_deploy_vm_lease_svc_offering_with_no_param" time="56.395"></testcase><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_04_deploy_vm_lease_svc_offering_with_param" time="55.661"></testcase><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_05_deploy_vm_lease_svc_offering_with_lease_param_disabled" time="56.097"></testcase><testcase classname="integration.component.test_deploy_vm_lease.TestDeployVMLease" name="test_06_deploy_vm_lease_svc_offering_with_disabled_lease" time="53.064"></testcase></testsuite>

server/src/main/java/com/cloud/api/query/dao/ServiceOfferingJoinDaoImpl.java

@@ -177,7 +177,7 @@ public ServiceOfferingResponse newServiceOfferingResponse(ServiceOfferingJoinVO
             }
         }
 
-        if (VMLeaseManagerImpl.InstanceLeaseEnabled.value() && offering.getLeaseDuration() != null && offering.getLeaseDuration() != -1L) {
+        if (VMLeaseManagerImpl.InstanceLeaseEnabled.value() && offering.getLeaseDuration() != null && offering.getLeaseDuration() >= -1L) {
             offeringResponse.setLeaseDuration(offering.getLeaseDuration());
             offeringResponse.setLeaseExpiryAction(offering.getLeaseExpiryAction());
         }

server/src/main/java/com/cloud/api/query/dao/UserVmJoinDao.java

@@ -47,7 +47,7 @@ UserVmResponse newUserVmResponse(ResponseView view, String objectName, UserVmJoi
     List<UserVmJoinVO> listByAccountServiceOfferingTemplateAndNotInState(long accountId,
              List<VirtualMachine.State> states, List<Long> offeringIds, List<Long> templateIds);
 
-    List<UserVmJoinVO> listExpiredInstancesIds();
+    List<UserVmJoinVO> listLeaseExpiredInstances();
 
-    List<UserVmJoinVO> listExpiringInstancesInDays(int days);
+    List<UserVmJoinVO> listLeaseInstancesExpiringInDays(int days);
 }

server/src/main/java/com/cloud/api/query/dao/UserVmJoinDaoImpl.java

@@ -138,7 +138,9 @@ protected UserVmJoinDaoImpl() {
         leaseOverInstanceSearch.done();
 
         leaseExpiringInstanceSearch = createSearchBuilder();
-        leaseExpiringInstanceSearch.and("leaseExpiringToday", leaseExpiringInstanceSearch.entity().getLeaseExpiryDate(), Op.GTEQ);
+        leaseExpiringInstanceSearch.selectFields(leaseExpiringInstanceSearch.entity().getId(), leaseExpiringInstanceSearch.entity().getUuid(),
+                leaseExpiringInstanceSearch.entity().getPodId(), leaseExpiringInstanceSearch.entity().getDataCenterId());
+        leaseExpiringInstanceSearch.and("leaseCurrentDate", leaseExpiringInstanceSearch.entity().getLeaseExpiryDate(), Op.GTEQ);
         leaseExpiringInstanceSearch.and("leaseExpiresOnDate", leaseExpiringInstanceSearch.entity().getLeaseExpiryDate(), Op.LT);
         leaseExpiringInstanceSearch.done();
 
@@ -751,21 +753,21 @@ public List<UserVmJoinVO> listByAccountServiceOfferingTemplateAndNotInState(long
     }
 
     @Override
-    public List<UserVmJoinVO> listExpiredInstancesIds() {
+    public List<UserVmJoinVO> listLeaseExpiredInstances() {
         SearchCriteria<UserVmJoinVO> sc = leaseOverInstanceSearch.create();
         sc.setParameters("leaseExpired", new Date());
         return listBy(sc);
     }
 
     @Override
-    public List<UserVmJoinVO> listExpiringInstancesInDays(int days) {
+    public List<UserVmJoinVO> listLeaseInstancesExpiringInDays(int days) {
         SearchCriteria<UserVmJoinVO> sc = leaseExpiringInstanceSearch.create();
         Date currentDate = new Date();
         Calendar calendar = Calendar.getInstance();
         calendar.setTime(currentDate);
         calendar.add(Calendar.DAY_OF_MONTH, days);
         Date nextDate = calendar.getTime();
-        sc.setParameters("leaseExpiringToday", currentDate);
+        sc.setParameters("leaseCurrentDate", currentDate);
         sc.setParameters("leaseExpiresOnDate", nextDate);
         return listBy(sc);
     }

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

@@ -3500,7 +3500,7 @@ public static String validateAndGetLeaseExpiryAction(Long leaseDuration, String
             throw new InvalidParameterValueException("Provide values for both: leaseduration and leaseexpiryaction");
         }
 
-        if (leaseDuration < 0L) {
+        if (leaseDuration < 1L) {
             throw new InvalidParameterValueException("Invalid value provided for leaseDuration, accepts only positive number");
         }
 

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

@@ -363,6 +363,7 @@
 import java.net.URLDecoder;
 import java.text.SimpleDateFormat;
 import java.time.LocalDate;
+import java.time.LocalTime;
 import java.time.ZoneId;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -6366,7 +6367,7 @@ protected void applyLeaseOnUpdateInstance(UserVm instance, Long leaseDuration, S
 
     private void addLeaseDetailsForInstance(UserVm vm, Long leaseDuration, String leaseExpiryAction) {
         LocalDate today = LocalDate.now();
-        Date leaseExpiryDate = Date.from(today.plusDays(leaseDuration).atStartOfDay().atZone(ZoneId.systemDefault()).toInstant());
+        Date leaseExpiryDate = Date.from(today.plusDays(leaseDuration).atTime(LocalTime.MAX).atZone(ZoneId.systemDefault()).toInstant());
         SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
         String formattedLeaseExpiryDate = sdf.format(leaseExpiryDate);
         userVmDetailsDao.addDetail(vm.getId(), VmDetailConstants.INSTANCE_LEASE_EXPIRY_DATE, formattedLeaseExpiryDate, false);

server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseManager.java

@@ -36,15 +36,15 @@ enum ExpiryAction {
             true, List.of(ConfigKey.Scope.Account, ConfigKey.Scope.Domain));
 
     ConfigKey<String> InstanceLeaseExpiryAction = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, String.class,
-            "instance.lease.expiryaction", "stop", "Default action to be taken at instance lease expiry",
+            "instance.lease.expiryaction", "STOP", "Default action to be taken at instance lease expiry",
             true, List.of(ConfigKey.Scope.Account, ConfigKey.Scope.Domain));
 
     ConfigKey<Long> InstanceLeaseSchedulerInterval = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Long.class,
-            "instance.lease.scheduler.interval", "60", "VM Lease Scheduler interval in seconds",
+            "instance.lease.scheduler.interval", "86400", "VM Lease Scheduler interval in seconds",
             true, List.of(ConfigKey.Scope.Global));
 
     ConfigKey<Long> InstanceLeaseAlertSchedule = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Long.class,
-            "instance.lease.alertscheduler.interval", "3600", "Lease Alert Scheduler interval in seconds",
+            "instance.lease.alertscheduler.interval", "86400", "Lease Alert Scheduler interval in seconds",
             true, List.of(ConfigKey.Scope.Global));
 
     ConfigKey<Long> InstanceLeaseAlertStartsAt = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Long.class,

server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseManagerImpl.java

@@ -23,7 +23,9 @@
 import com.cloud.api.query.dao.UserVmJoinDao;
 import com.cloud.api.query.vo.UserVmJoinVO;
 import com.cloud.event.ActionEventUtils;
+import com.cloud.user.Account;
 import com.cloud.user.User;
+import com.cloud.utils.DateUtil;
 import com.cloud.utils.StringUtils;
 import com.cloud.utils.component.ComponentContext;
 import com.cloud.utils.component.ManagerBase;
@@ -39,10 +41,12 @@
 import org.apache.cloudstack.framework.jobs.AsyncJobManager;
 import org.apache.cloudstack.framework.jobs.impl.AsyncJobVO;
 import org.apache.cloudstack.managed.context.ManagedContextTimerTask;
+import org.apache.commons.lang3.time.DateUtils;
 
 import javax.inject.Inject;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Calendar;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
@@ -138,17 +142,32 @@ protected void alert() {
             return;
         }
 
-        List<UserVmJoinVO> leaseExpiringForInstances = userVmJoinDao.listExpiringInstancesInDays(InstanceLeaseAlertStartsAt.value().intValue());
-        for (UserVmJoinVO instance : leaseExpiringForInstances) {
-            alertManager.sendAlert(AlertManager.AlertType.ALERT_TYPE_USERVM, instance.getDataCenterId(), instance.getPodId(),
-                    "Lease expiring for instance id: " + instance.getUuid(), "Lease expiring for instance");
+        GlobalLock scanLock = GlobalLock.getInternLock("VMLeaseAlertScheduler");
+        try {
+            if (scanLock.lock(ACQUIRE_GLOBAL_LOCK_TIMEOUT_FOR_COOPERATION)) {
+                try {
+                    List<UserVmJoinVO> leaseExpiringForInstances = userVmJoinDao.listLeaseInstancesExpiringInDays(InstanceLeaseAlertStartsAt.value().intValue());
+                    for (UserVmJoinVO instance : leaseExpiringForInstances) {
+                        alertManager.sendAlert(AlertManager.AlertType.ALERT_TYPE_USERVM, instance.getDataCenterId(), instance.getPodId(),
+                                "Lease expiring for instance id: " + instance.getUuid(), "Lease expiring for instance");
+                    }
+                } finally {
+                    scanLock.unlock();
+                }
+            }
+        } finally {
+            scanLock.releaseRef();
         }
     }
 
     @Override
-    public void poll(Date currentTimestamp) {
-        // as feature is disabled, no action is required
+    public void poll(Date timestamp) {
+        Date currentTimestamp = DateUtils.round(timestamp, Calendar.MINUTE);
+        String displayTime = DateUtil.displayDateInTimezone(DateUtil.GMT_TIMEZONE, currentTimestamp);
+        logger.debug("VMLeaseScheduler.poll is being called at {}", displayTime);
+
         if (!InstanceLeaseEnabled.value()) {
+            logger.debug("Instance lease feature is disabled, no action is required");
             return;
         }
 
@@ -168,16 +187,15 @@ public void poll(Date currentTimestamp) {
 
     protected void reallyRun() {
         // fetch user_instances having leaseDuration configured and has expired
-        List<UserVmJoinVO> leaseExpiredInstances = userVmJoinDao.listExpiredInstancesIds();
+        List<UserVmJoinVO> leaseExpiredInstances = userVmJoinDao.listLeaseExpiredInstances();
         List<Long> actionableInstanceIds = new ArrayList<>();
-        // iterate over them and ignore if delete protection is enabled
+        // iterate over and skip ones with delete protection
         for (UserVmJoinVO userVmVO : leaseExpiredInstances) {
             if (userVmVO.isDeleteProtection() != null && userVmVO.isDeleteProtection()) {
                 logger.debug("Ignoring instance with id: {} as deleteProtection is enabled", userVmVO.getUuid());
                 continue;
             }
             // state check, include instances not yet stopped or destroyed
-            // it can be done in fetch_user_instances as well
             if (!Arrays.asList(Destroyed, Expunging, Unknown, VirtualMachine.State.Error).contains(userVmVO.getState())) {
                 actionableInstanceIds.add(userVmVO.getId());
             }
@@ -208,7 +226,7 @@ protected void reallyRun() {
                 failedToSubmitInstanceIds.add(instanceId);
             }
         }
-        logger.debug("Successfully submitted jobs for ids: {}", submittedJobIds);
+        logger.debug("Successfully submitted lease expiry jobs with ids: {}", submittedJobIds);
         if (!failedToSubmitInstanceIds.isEmpty()) {
             logger.debug("Lease scheduler failed to submit jobs for instance ids: {}", failedToSubmitInstanceIds);
         }
@@ -227,7 +245,7 @@ Long executeExpiryAction(UserVmJoinVO instance, ExpiryAction expiryAction, long
             }
             default: {
                 logger.error("Invalid configuration for instance.lease.expiryaction for vm id: {}, " +
-                        "valid values are: \"stop\" and  \"destroy\"", instance.getUuid());
+                        "valid values are: \"STOP\" and  \"DESTROY\"", instance.getUuid());
             }
         }
         return null;
@@ -236,8 +254,8 @@ Long executeExpiryAction(UserVmJoinVO instance, ExpiryAction expiryAction, long
     long executeStopInstanceJob(UserVmJoinVO vm, boolean isForced, long eventId) {
         final Map<String, String> params = new HashMap<>();
         params.put(ApiConstants.ID, String.valueOf(vm.getId()));
-        params.put("ctxUserId", "1");
-        params.put("ctxAccountId", String.valueOf(vm.getAccountId()));
+        params.put("ctxUserId", String.valueOf(User.UID_SYSTEM));
+        params.put("ctxAccountId", String.valueOf(Account.ACCOUNT_ID_SYSTEM));
         params.put(ApiConstants.CTX_START_EVENT_ID, String.valueOf(eventId));
         params.put(ApiConstants.FORCED, String.valueOf(isForced));
         final StopVMCmd cmd = new StopVMCmd();
@@ -252,8 +270,8 @@ long executeStopInstanceJob(UserVmJoinVO vm, boolean isForced, long eventId) {
     long executeDestroyInstanceJob(UserVmJoinVO vm, boolean isForced, long eventId) {
         final Map<String, String> params = new HashMap<>();
         params.put(ApiConstants.ID, String.valueOf(vm.getId()));
-        params.put("ctxUserId", "1");
-        params.put("ctxAccountId", String.valueOf(vm.getAccountId()));
+        params.put("ctxUserId", String.valueOf(User.UID_SYSTEM));
+        params.put("ctxAccountId", String.valueOf(Account.ACCOUNT_ID_SYSTEM));
         params.put(ApiConstants.CTX_START_EVENT_ID, String.valueOf(eventId));
         params.put(ApiConstants.FORCED, String.valueOf(isForced));
 

server/src/test/java/org/apache/cloudstack/vm/lease/VMLeaseManagerImplTest.java

@@ -110,7 +110,7 @@ public void testStart() {
     public void testAlert() {
         UserVmJoinVO vm = createMockVm(1L, VM_UUID, VM_NAME, VirtualMachine.State.Running, false);
         List<UserVmJoinVO> expiringVms = Arrays.asList(vm);
-        when(userVmJoinDao.listExpiringInstancesInDays(anyInt())).thenReturn(expiringVms);
+        when(userVmJoinDao.listLeaseInstancesExpiringInDays(anyInt())).thenReturn(expiringVms);
         vmLeaseManager.alert();
         verify(alertManager).sendAlert(
                 eq(AlertManager.AlertType.ALERT_TYPE_USERVM),
@@ -123,7 +123,7 @@ public void testAlert() {
 
     @Test
     public void testReallyRunNoExpiredInstances() {
-        when(userVmJoinDao.listExpiredInstancesIds()).thenReturn(new ArrayList<>());
+        when(userVmJoinDao.listLeaseExpiredInstances()).thenReturn(new ArrayList<>());
         vmLeaseManager.reallyRun();
         verify(asyncJobManager, never()).submitAsyncJob(any(AsyncJobVO.class));
     }
@@ -132,7 +132,7 @@ public void testReallyRunNoExpiredInstances() {
     public void testReallyRunWithDeleteProtection() {
         UserVmJoinVO vm = createMockVm(1L, VM_UUID, VM_NAME, VirtualMachine.State.Running, true);
         List<UserVmJoinVO> expiredVms = Arrays.asList(vm);
-        when(userVmJoinDao.listExpiredInstancesIds()).thenReturn(expiredVms);
+        when(userVmJoinDao.listLeaseExpiredInstances()).thenReturn(expiredVms);
         vmLeaseManager.reallyRun();
         // Verify no jobs were submitted because of delete protection
         verify(asyncJobManager, never()).submitAsyncJob(any(AsyncJobVO.class));
@@ -147,7 +147,7 @@ public void testReallyRunIgnoredStates() {
         UserVmJoinVO vmError = createMockVm(4L, "vm-uuid4", "vm-name4", VirtualMachine.State.Error, false);
 
         List<UserVmJoinVO> expiredVms = Arrays.asList(vmDestroyed, vmExpunging, vmUnknown, vmError);
-        when(userVmJoinDao.listExpiredInstancesIds()).thenReturn(expiredVms);
+        when(userVmJoinDao.listLeaseExpiredInstances()).thenReturn(expiredVms);
         vmLeaseManager.reallyRun();
         // Verify no jobs were submitted because all VMs are in ignored states
         verify(asyncJobManager, never()).submitAsyncJob(any(AsyncJobVO.class));
@@ -157,7 +157,7 @@ public void testReallyRunIgnoredStates() {
     public void testReallyRunStopAction() {
         UserVmJoinVO vm = createMockVm(1L, VM_UUID, VM_NAME, VirtualMachine.State.Running, false);
         List<UserVmJoinVO> expiredVms = Arrays.asList(vm);
-        when(userVmJoinDao.listExpiredInstancesIds()).thenReturn(expiredVms);
+        when(userVmJoinDao.listLeaseExpiredInstances()).thenReturn(expiredVms);
         when(userVmJoinDao.findById(1L)).thenReturn(vm);
         doReturn(1L).when(vmLeaseManager).executeStopInstanceJob(eq(vm), eq(true), anyLong());
         try (MockedStatic<ActionEventUtils> utilities = Mockito.mockStatic(ActionEventUtils.class)) {
@@ -173,7 +173,7 @@ public void testReallyRunStopAction() {
     public void testReallyRunDestroyAction() {
         UserVmJoinVO vm = createMockVm(1L, VM_UUID, VM_NAME, VirtualMachine.State.Running, false, DESTORY);
         List<UserVmJoinVO> expiredVms = Arrays.asList(vm);
-        when(userVmJoinDao.listExpiredInstancesIds()).thenReturn(expiredVms);
+        when(userVmJoinDao.listLeaseExpiredInstances()).thenReturn(expiredVms);
         when(userVmJoinDao.findById(1L)).thenReturn(vm);
         doReturn(1L).when(vmLeaseManager).executeDestroyInstanceJob(eq(vm), eq(true), anyLong());
         try (MockedStatic<ActionEventUtils> utilities = Mockito.mockStatic(ActionEventUtils.class)) {