Skip to content

Accept case insensitive values in boolean settings #10663

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.

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,10 @@
@Override
@DB
public String updateConfiguration(final long userId, final String name, final String category, String value, final String scope, final Long resourceId) {
if (Boolean.class == getConfigurationTypeWrapperClass(name)) {
value = value.toLowerCase();

Check warning on line 707 in server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

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

Added line #L707 was not covered by tests
}

final String validationMsg = validateConfigurationValue(name, value, scope);
if (validationMsg != null) {
logger.error("Invalid value [{}] for configuration [{}] due to [{}].", value, name, validationMsg);
Expand Down Expand Up @@ -1241,18 +1245,9 @@
return "Invalid scope id provided for the parameter " + name;
}
}
Class<?> type;
Config configuration = Config.getConfig(name);
if (configuration == null) {
logger.warn("Did not find configuration " + name + " in Config.java. Perhaps moved to ConfigDepot");
ConfigKey<?> configKey = _configDepot.get(name);
if(configKey == null) {
logger.warn("Did not find configuration " + name + " in ConfigDepot too.");
return null;
}
type = configKey.type();
} else {
type = configuration.getType();
Class<?> type = getConfigurationTypeWrapperClass(name);
if (type == null) {
return null;

Check warning on line 1250 in server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

View check run for this annotation

Codecov / codecov/patch

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

Added line #L1250 was not covered by tests
}

validateSpecificConfigurationValues(name, value, type);
Expand All @@ -1262,7 +1257,28 @@
return String.format("Value [%s] is not a valid [%s].", value, type);
}

return validateValueRange(name, value, type, configuration);
return validateValueRange(name, value, type, Config.getConfig(name));
}

/**
* Returns the configuration type's wrapper class.
* @param name name of the configuration.
* @return if the configuration exists, returns its type's wrapper class; if not, returns null.
*/
protected Class<?> getConfigurationTypeWrapperClass(String name) {
Config configuration = Config.getConfig(name);
if (configuration != null) {
return configuration.getType();
}

logger.warn("Did not find configuration [{}] in Config.java. Perhaps moved to ConfigDepot.", name);
ConfigKey<?> configKey = _configDepot.get(name);
if (configKey == null) {
logger.warn("Did not find configuration [{}] in ConfigDepot too.", name);
return null;
}

return configKey.type();
}

protected void validateConfigurationAllowedOnlyForDefaultAdmin(String configName, String value) {
Expand Down Expand Up @@ -1299,7 +1315,7 @@
* <ul>
* <li>String: any value, including null;</li>
* <li>Character: any value, including null;</li>
* <li>Boolean: strings that equal "true" or "false" (case-sensitive);</li>
* <li>Boolean: strings that equal "true" or "false" (case-insensitive);</li>
* <li>Integer, Short, Long: strings that contain a valid int/short/long;</li>
* <li>Float, Double: strings that contain a valid float/double, except infinity.</li>
* </ul>
Expand Down Expand Up @@ -8176,36 +8192,32 @@
};
}


/**
* Returns a string representing the specified configuration's type.
* @param configName name of the configuration.
* @return if the configuration exists, returns its type; if not, returns {@link Configuration.ValueType#String}.
*/
@Override
public String getConfigurationType(final String configName) {
final ConfigurationVO cfg = _configDao.findByName(configName);
if (cfg == null) {
logger.warn("Configuration " + configName + " not found");
logger.warn("Configuration [{}] not found", configName);
return Configuration.ValueType.String.name();
}

if (weightBasedParametersForValidation.contains(configName)) {
return Configuration.ValueType.Range.name();
}

Class<?> type = null;
final Config c = Config.getConfig(configName);
if (c == null) {
logger.warn("Configuration " + configName + " no found. Perhaps moved to ConfigDepot");
final ConfigKey<?> configKey = _configDepot.get(configName);
if (configKey == null) {
logger.warn("Couldn't find configuration " + configName + " in ConfigDepot too.");
return Configuration.ValueType.String.name();
}
type = configKey.type();
} else {
type = c.getType();
}

return getInputType(type, cfg);
Class<?> type = getConfigurationTypeWrapperClass(configName);
return parseConfigurationTypeIntoString(type, cfg);
}

private String getInputType(Class<?> type, ConfigurationVO cfg) {
/**
* Parses a configuration type's wrapper class into its string representation.
*/
protected String parseConfigurationTypeIntoString(Class<?> type, ConfigurationVO cfg) {
if (type == null) {
return Configuration.ValueType.String.name();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// under the License.
package com.cloud.configuration;

import com.cloud.alert.AlertManager;
import com.cloud.capacity.dao.CapacityDao;
import com.cloud.dc.DataCenterVO;
import com.cloud.dc.VlanVO;
Expand Down Expand Up @@ -52,6 +53,7 @@
import com.cloud.utils.exception.CloudRuntimeException;
import com.cloud.utils.net.NetUtils;
import com.cloud.vm.dao.VMInstanceDao;
import org.apache.cloudstack.acl.RoleService;
import org.apache.cloudstack.annotation.dao.AnnotationDao;
import org.apache.cloudstack.api.command.admin.network.CreateNetworkOfferingCmd;
import org.apache.cloudstack.api.command.admin.offering.UpdateDiskOfferingCmd;
Expand All @@ -65,6 +67,7 @@
import org.apache.cloudstack.storage.datastore.db.ImageStoreDao;
import org.apache.cloudstack.resourcedetail.DiskOfferingDetailVO;
import org.apache.cloudstack.vm.UnmanagedVMsManager;
import org.apache.cloudstack.config.Configuration;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
Expand Down Expand Up @@ -897,4 +900,113 @@ public void testValidateConfigurationAllowedOnlyForDefaultAdmin_withValidConfigN
configurationManagerImplSpy.validateConfigurationAllowedOnlyForDefaultAdmin(AccountManagerImpl.listOfRoleTypesAllowedForOperationsOfSameRoleType.key(), invalidValue);
}
}


@Test
public void getConfigurationTypeWrapperClassTestReturnsConfigType() {
Config configuration = Config.AlertEmailAddresses;

Assert.assertEquals(configuration.getType(), configurationManagerImplSpy.getConfigurationTypeWrapperClass(configuration.key()));
}

@Test
public void getConfigurationTypeWrapperClassTestReturnsConfigKeyType() {
String configurationName = "configuration.name";

Mockito.when(configDepot.get(configurationName)).thenReturn(configKeyMock);
Mockito.when(configKeyMock.type()).thenReturn(Integer.class);

Assert.assertEquals(Integer.class, configurationManagerImplSpy.getConfigurationTypeWrapperClass(configurationName));
}

@Test
public void getConfigurationTypeWrapperClassTestReturnsNullWhenConfigurationDoesNotExist() {
String configurationName = "configuration.name";

Mockito.when(configDepot.get(configurationName)).thenReturn(null);
Assert.assertNull(configurationManagerImplSpy.getConfigurationTypeWrapperClass(configurationName));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsStringWhenTypeIsNull() {
Assert.assertEquals(Configuration.ValueType.String.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(null, null));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsStringWhenTypeIsStringAndConfigurationKindIsNull() {
Mockito.when(configurationVOMock.getKind()).thenReturn(null);
Assert.assertEquals(Configuration.ValueType.String.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(String.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsKindWhenTypeIsStringAndKindIsNotNull() {
Mockito.when(configurationVOMock.getKind()).thenReturn(ConfigKey.Kind.CSV.name());
Assert.assertEquals(ConfigKey.Kind.CSV.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(String.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsKindWhenTypeIsCharacterAndKindIsNotNull() {
Mockito.when(configurationVOMock.getKind()).thenReturn(ConfigKey.Kind.CSV.name());
Assert.assertEquals(ConfigKey.Kind.CSV.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Character.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsNumberWhenTypeIsInteger() {
Assert.assertEquals(Configuration.ValueType.Number.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Integer.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsNumberWhenTypeIsLong() {
Assert.assertEquals(Configuration.ValueType.Number.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Long.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsNumberWhenTypeIsShort() {
Assert.assertEquals(Configuration.ValueType.Number.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Short.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsDecimalWhenTypeIsFloat() {
Assert.assertEquals(Configuration.ValueType.Decimal.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Float.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsDecimalWhenTypeIsDouble() {
Assert.assertEquals(Configuration.ValueType.Decimal.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Double.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsBooleanWhenTypeIsBoolean() {
Assert.assertEquals(Configuration.ValueType.Boolean.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Boolean.class, configurationVOMock));
}

@Test
public void parseConfigurationTypeIntoStringTestReturnsStringWhenTypeDoesNotMatchAnyAvailableType() {
Assert.assertEquals(Configuration.ValueType.String.name(), configurationManagerImplSpy.parseConfigurationTypeIntoString(Object.class, configurationVOMock));
}

@Test
public void getConfigurationTypeTestReturnsStringWhenConfigurationDoesNotExist() {
Mockito.when(configDao.findByName(Mockito.anyString())).thenReturn(null);
Assert.assertEquals(Configuration.ValueType.String.name(), configurationManagerImplSpy.getConfigurationType(Mockito.anyString()));
}

@Test
public void getConfigurationTypeTestReturnsRangeForConfigurationsThatAcceptIntervals() {
String configurationName = AlertManager.CPUCapacityThreshold.key();

Mockito.when(configDao.findByName(configurationName)).thenReturn(configurationVOMock);
Assert.assertEquals(Configuration.ValueType.Range.name(), configurationManagerImplSpy.getConfigurationType(configurationName));
}

@Test
public void getConfigurationTypeTestReturnsStringRepresentingConfigurationType() {
ConfigKey<Boolean> configuration = RoleService.EnableDynamicApiChecker;

Mockito.when(configDao.findByName(configuration.key())).thenReturn(configurationVOMock);
Mockito.doReturn(configuration.type()).when(configurationManagerImplSpy).getConfigurationTypeWrapperClass(configuration.key());

configurationManagerImplSpy.getConfigurationType(configuration.key());
Mockito.verify(configurationManagerImplSpy).parseConfigurationTypeIntoString(configuration.type(), configurationVOMock);
}
}
Loading