Skip to content

Consider Quota settings during processing #10892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
julien-vaz wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Consider Quota settings during processing #10892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf29695
Use account Quota settings
Apr 2, 2025
a6993ef
Remove unused imports
Apr 23, 2025
2dc5715
Apply suggestions from code review
julien-vaz Jun 4, 2025
617d232
Move DB access to end of method
Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...stack/core/spring-engine-schema-core-common-daos-between-management-and-usage-context.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
>

<bean id="accountGuestVlanMapDaoImpl" class="com.cloud.network.dao.AccountGuestVlanMapDaoImpl" />
<bean id="accountDetailsDaoImpl" class="com.cloud.user.AccountDetailsDaoImpl" />
<bean id="domainDaoImpl" class="com.cloud.domain.dao.DomainDaoImpl" />
<bean id="domainDetailsDaoImpl" class="com.cloud.domain.dao.DomainDetailsDaoImpl" />
<bean id="clusterDaoImpl" class="com.cloud.dc.dao.ClusterDaoImpl" />
<bean id="clusterDetailsDaoImpl" class="com.cloud.dc.ClusterDetailsDaoImpl" />
<bean id="dataCenterDaoImpl" class="com.cloud.dc.dao.DataCenterDaoImpl" />
Expand Down
2 changes: 1 addition & 1 deletion framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaAlertManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ public boolean stop() {
*/
@Override
public boolean isQuotaEmailTypeEnabledForAccount(AccountVO account, QuotaEmailTemplateTypes quotaEmailTemplateType) {
boolean quotaEmailsEnabled = QuotaConfig.QuotaEnableEmails.valueIn(account.getAccountId());
boolean quotaEmailsEnabled = _quotaManager.findConfigurationValue(account, QuotaConfig.QuotaEnableEmails);
if (!quotaEmailsEnabled) {
logger.debug("Configuration [{}] is disabled for account [{}]. Therefore, the account will not receive Quota email of type [{}].", QuotaConfig.QuotaEnableEmails.key(), account, quotaEmailTemplateType);
return false;
Expand Down
3 changes: 3 additions & 0 deletions framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@

import com.cloud.user.AccountVO;
import com.cloud.utils.component.Manager;
import org.apache.cloudstack.framework.config.ConfigKey;

public interface QuotaManager extends Manager {

boolean calculateQuotaUsage();

boolean isLockable(AccountVO account);

boolean findConfigurationValue(AccountVO accountVO, ConfigKey<Boolean> key);

}
42 changes: 40 additions & 2 deletions framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@
import javax.inject.Inject;
import javax.naming.ConfigurationException;

import com.cloud.domain.DomainDetailVO;
import com.cloud.domain.dao.DomainDetailsDao;
import com.cloud.user.Account;
import com.cloud.user.AccountDetailVO;
import com.cloud.user.AccountDetailsDao;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
import org.apache.cloudstack.quota.activationrule.presetvariables.Configuration;
import org.apache.cloudstack.quota.activationrule.presetvariables.GenericPresetVariable;
Expand Down Expand Up @@ -89,6 +94,10 @@

@Inject
protected PresetVariableHelper presetVariableHelper;
@Inject
protected AccountDetailsDao accountDetailsDao;
@Inject
protected DomainDetailsDao domainDetailsDao;

private static TimeZone usageAggregationTimeZone = TimeZone.getTimeZone("GMT");
static final BigDecimal GiB_DECIMAL = BigDecimal.valueOf(ByteScaleUtils.GiB);
Expand Down Expand Up @@ -340,12 +349,41 @@
}

protected boolean shouldCalculateUsageRecord(AccountVO accountVO, UsageVO usageRecord) {
if (Boolean.FALSE.equals(QuotaConfig.QuotaAccountEnabled.valueIn(accountVO.getAccountId()))) {
boolean calculateUsageRecord = findConfigurationValue(accountVO, QuotaConfig.QuotaAccountEnabled);

Check warning on line 352 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L352 

Added line #L352 was not covered by tests
if (!calculateUsageRecord && usageRecord != null) {
logger.debug("Considering usage record [{}] as calculated and skipping it because account [{}] has the quota plugin disabled.",
usageRecord.toString(usageAggregationTimeZone), accountVO.reflectionToString());
return false;
}
return true;
return calculateUsageRecord;
}

Check warning on line 359 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L358-L359 

Added lines #L358 - L359 were not covered by tests

@Override
public boolean findConfigurationValue(AccountVO accountVO, ConfigKey<Boolean> key) {
logger.trace("Searching configuration [{}] of account [{}] in its settings.", key.key(), accountVO);
AccountDetailVO accountDetail = accountDetailsDao.findDetail(accountVO.getAccountId(), key.key());

Check warning on line 364 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L362-L364 

Added lines #L362 - L364 were not covered by tests
if (accountDetail != null) {
boolean result = Boolean.parseBoolean(accountDetail.getValue());
logger.trace("Using value [{}] found in account [{}] settings to configuration [{}].", result, accountVO, key.key());
return result;

Check warning on line 368 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L366-L368 

Added lines #L366 - L368 were not covered by tests
}

if (Boolean.parseBoolean(_configDao.getValue("enable.account.settings.for.domain"))) {
logger.trace("Searching for configuration [{}] of account [{}] in its domain [{}] settings.", key.key(), accountVO, accountVO.getDomainId());
DomainDetailVO domainDetail = domainDetailsDao.findDetail(accountVO.getDomainId(), key.key());

Check warning on line 373 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L372-L373 

Added lines #L372 - L373 were not covered by tests
if (domainDetail != null) {
boolean result = Boolean.parseBoolean(domainDetail.getValue());
logger.trace("Using value [{}] found in domain [{}] settings to configuration [{}].", result, accountVO.getDomainId(), key.key());
return result;

Check warning on line 377 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L375-L377 

Added lines #L375 - L377 were not covered by tests
}
}
boolean result = Boolean.parseBoolean(getConfigValueOrDefaultValue(key));
Copy link
Contributor

@shwstppr shwstppr Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

key.value()

What is the difference?

logger.trace("Using default value [{}] to configuration [{}].", result, key.key());
return result;
}

Check warning on line 383 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L380-L383 

Added lines #L380 - L383 were not covered by tests

protected String getConfigValueOrDefaultValue(ConfigKey<?> key) {
return ObjectUtils.defaultIfNull(_configDao.getValue(key.key()), key.defaultValue());

Check warning on line 386 in framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaManagerImpl.java#L385-L386 

Added lines #L385 - L386 were not covered by tests
}

protected List<QuotaUsageVO> persistUsagesAndQuotaUsagesAndRetrievePersistedQuotaUsages(List<Pair<UsageVO, QuotaUsageVO>> pairsUsageAndQuotaUsage) {
Expand Down
6 changes: 2 additions & 4 deletions framework/quota/src/test/java/org/apache/cloudstack/quota/QuotaAlertManagerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import org.apache.cloudstack.quota.dao.QuotaEmailConfigurationDaoImpl;
import org.apache.cloudstack.quota.dao.QuotaEmailTemplatesDao;
import org.apache.cloudstack.quota.vo.QuotaAccountVO;
import org.apache.cloudstack.quota.vo.QuotaEmailConfigurationVO;
import org.apache.cloudstack.quota.vo.QuotaEmailTemplatesVO;
import org.junit.Assert;
import org.junit.Before;
Expand Down Expand Up @@ -116,9 +115,6 @@ public void setup() throws IllegalAccessException, NoSuchFieldException, Configu
@Test
public void isQuotaEmailTypeEnabledForAccountTestConfigurationIsEnabledAndEmailIsConfiguredReturnConfiguredValue() {
boolean expectedValue = !QuotaConfig.QuotaEnableEmails.value();
QuotaEmailConfigurationVO quotaEmailConfigurationVoMock = Mockito.mock(QuotaEmailConfigurationVO.class);
Mockito.when(quotaEmailConfigurationVoMock.isEnabled()).thenReturn(expectedValue);
Mockito.doReturn(quotaEmailConfigurationVoMock).when(quotaEmailConfigurationDaoMock).findByAccountIdAndEmailTemplateType(Mockito.anyLong(), Mockito.any(QuotaConfig.QuotaEmailTemplateTypes.class));

boolean result = quotaAlertManager.isQuotaEmailTypeEnabledForAccount(accountMock, QuotaConfig.QuotaEmailTemplateTypes.QUOTA_EMPTY);

Expand All @@ -129,6 +125,8 @@ public void isQuotaEmailTypeEnabledForAccountTestConfigurationIsEnabledAndEmailI
public void isQuotaEmailTypeEnabledForAccountTestConfigurationIsEnabledAndEmailIsNotConfiguredReturnDefaultValue() {
boolean defaultValue = QuotaConfig.QuotaEnableEmails.value();

Mockito.when(quotaManagerMock.findConfigurationValue(accountMock, QuotaConfig.QuotaEnableEmails)).thenReturn(true);

boolean result = quotaAlertManager.isQuotaEmailTypeEnabledForAccount(accountMock, QuotaConfig.QuotaEmailTemplateTypes.QUOTA_EMPTY);

Assert.assertEquals(defaultValue, result);
Expand Down
Loading