Skip to content
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

[WIP] Subtype setting config val: use as key’s default val #1014

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+196 −0
Open

[WIP] Subtype setting config val: use as key’s default val #1014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions ...ava/org/apache/brooklyn/camp/brooklyn/spi/creation/BrooklynComponentTemplateResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,8 @@ private <T extends Entity> void decorateSpec(EntitySpec<T> spec, Set<String> enc
new BrooklynEntityDecorationResolver.TagsResolver(yamlLoader).decorate(spec, attrs, encounteredRegisteredTypeIds);

configureEntityConfig(spec, encounteredRegisteredTypeIds);

new BrooklynEntityDecorationResolver.SpecParameterResolver(yamlLoader).decorateDefaultVals(spec, attrs, encounteredRegisteredTypeIds);
}

@SuppressWarnings({ "unchecked", "rawtypes" })
Expand Down
31 changes: 31 additions & 0 deletions ...java/org/apache/brooklyn/camp/brooklyn/spi/creation/BrooklynEntityDecorationResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import static com.google.common.base.Preconditions.checkArgument;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
Expand All @@ -35,6 +36,8 @@
import org.apache.brooklyn.api.typereg.RegisteredType;
import org.apache.brooklyn.camp.brooklyn.BrooklynCampReservedKeys;
import org.apache.brooklyn.camp.brooklyn.spi.creation.BrooklynYamlTypeInstantiator.InstantiatorFromKey;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
import org.apache.brooklyn.core.mgmt.BrooklynTags;
import org.apache.brooklyn.core.objs.BasicSpecParameter;
Expand Down Expand Up @@ -221,6 +224,34 @@ public void decorate(EntitySpec<?> entitySpec, ConfigBag attrs, Set<String> enco
BasicSpecParameter.initializeSpecWithExplicitParameters(entitySpec, explicitParams, instantiator.loader);
}

public void decorateDefaultVals(EntitySpec<?> entitySpec, ConfigBag attrs, Set<String> encounteredRegisteredTypeIds) {
// If entitySpec has explicit config values, those override the 'defaults' in the SpecParameter.
// Therefore in our type, we should report these as the 'defaults'.
// This is particularly important for subtypes that set values for inherited config keys.
// e.g. MySuperType declares required config 'maxSize', and MySubType sets a value for that in its
// `brooklyn.config` section. A user of `MySubType` in the UI would be forced to also set a value
// for 'maxSize' (because 'required' and no default) if we didn't do the code below.

List<SpecParameter<?>> params = entitySpec.getParameters();
Map<ConfigKey<?>, Object> configs = entitySpec.getConfig();

List<SpecParameter<?>> decoratedParameters = new ArrayList<>();
for (SpecParameter<?> param : params) {
SpecParameter<?> decoratedParam;
if (configs.containsKey(param.getConfigKey())) {
Object explicitConfigVal = configs.get(param.getConfigKey());
ConfigKey<?> newConfigKey = ConfigKeys.newConfigKeyWithDefault((ConfigKey)param.getConfigKey(), explicitConfigVal);
decoratedParam = new BasicSpecParameter(param.getLabel(), param.isPinned(), newConfigKey, param.getSensor());
} else {
decoratedParam = param;
}
decoratedParameters.add(decoratedParam);

}
// but now we need to filter non-reinheritable, and merge where params are extended/overridden
entitySpec.parametersReplace(decoratedParameters);
}

@Override
protected List<SpecParameter<?>> buildListOfTheseDecorationsFromIterable(Iterable<?> value) {
// returns definitions, used only by #decorate method above
Expand Down
58 changes: 58 additions & 0 deletions ...mp-brooklyn/src/test/java/org/apache/brooklyn/camp/brooklyn/ConfigParametersYamlTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.catalog.internal.BasicBrooklynCatalog;
import org.apache.brooklyn.core.config.BasicConfigInheritance;
import org.apache.brooklyn.core.config.ConfigConstraints;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.config.ConfigPredicates;
import org.apache.brooklyn.core.config.ConstraintViolationException;
Expand All @@ -57,6 +58,7 @@
import org.apache.brooklyn.entity.software.base.EmptySoftwareProcess;
import org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess;
import org.apache.brooklyn.entity.stock.BasicApplication;
import org.apache.brooklyn.entity.stock.BasicEntity;
import org.apache.brooklyn.location.ssh.SshMachineLocation;
import org.apache.brooklyn.test.Asserts;
import org.apache.brooklyn.util.collections.MutableList;
Expand Down Expand Up @@ -1275,6 +1277,62 @@ public void testConfigParameterPinnedOrder() throws Exception {
}
}

@Test
public void testRequiredParameterSetInConfigBlockTreatedAsDefault() throws Exception {
String version = TEST_VERSION;
String nameOfItem = "mySuperType";
ConfigKey<String> configKey = ConfigKeys.newStringConfigKey("myconfig");

String valInConfigBlock = "myValInSubType";
String valInDeploy = "myValInDeploy";

addCatalogItems(
"brooklyn.catalog:",
" id: " + nameOfItem,
" version: " + version,
" itemType: entity",
" item:",
" type: " + BasicEntity.class.getName(),
" brooklyn.parameters:",
" - name: " + configKey.getName(),
" type: String",
" constraints:",
" - required",
" brooklyn.config:",
" " + configKey.getName() + ": " + valInConfigBlock);

// Entity has a config value set in catalog item
{
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfItem + ":" + version);
Entity entity = Iterables.getOnlyElement(app.getChildren());
assertEquals(entity.config().get(configKey), valInConfigBlock);
}

// Config value overridden at deploy-time
{
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfItem + ":" + version,
" brooklyn.config:",
" myconfig: " + valInDeploy);
Entity entity = Iterables.getOnlyElement(app.getChildren());
assertEquals(entity.config().get(configKey), valInDeploy);
}

// Catalog item has a value for the config; this should be shown as the default
{
RegisteredType subType = mgmt().getTypeRegistry().get(nameOfItem, version);
EntitySpec<?> spec = mgmt().getTypeRegistry().createSpec(subType, null, EntitySpec.class);
List<SpecParameter<?>> parameters = spec.getParameters();
SpecParameter<?> param = Iterables.find(parameters, (p) -> p.getConfigKey().equals(configKey));

assertEquals(param.getConfigKey().getDefaultValue(), valInConfigBlock);
assertEquals(param.getConfigKey().getConstraint(), new ConfigConstraints.RequiredPredicate<String>());
}
}

@ImplementedBy(TestEntityWithPinnedConfigImpl.class)
public static interface TestEntityWithPinnedConfig extends Entity {

Expand Down
105 changes: 105 additions & 0 deletions ...ooklyn/src/test/java/org/apache/brooklyn/camp/brooklyn/catalog/CatalogYamlEntityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,18 @@
import org.apache.brooklyn.api.entity.EntitySpec;
import org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec;
import org.apache.brooklyn.api.objs.Identifiable;
import org.apache.brooklyn.api.objs.SpecParameter;
import org.apache.brooklyn.api.typereg.BrooklynTypeRegistry;
import org.apache.brooklyn.api.typereg.BrooklynTypeRegistry.RegisteredTypeKind;
import org.apache.brooklyn.api.typereg.RegisteredType;
import org.apache.brooklyn.camp.brooklyn.AbstractYamlTest;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.catalog.internal.BasicBrooklynCatalog;
import org.apache.brooklyn.core.catalog.internal.CatalogUtils;
import org.apache.brooklyn.core.config.ConfigConstraints;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.config.ConstraintViolationException;
import org.apache.brooklyn.core.entity.Dumper;
import org.apache.brooklyn.core.test.entity.TestEntity;
import org.apache.brooklyn.core.test.entity.TestEntityImpl;
import org.apache.brooklyn.core.typereg.RegisteredTypes;
Expand Down Expand Up @@ -760,6 +764,107 @@ protected void doTestReplacementFailureLeavesPreviousIntact(boolean includeBundl
Assert.assertNull(item3, "Type should have been deleted");
}

@Test
public void testRequiredParameterSetInSubTypeNoLongerRequired() throws Exception {
String version = TEST_VERSION;
String nameOfSuperType = "mySuperType";
String nameOfSubType = "mySubType";
ConfigKey<String> configKey = ConfigKeys.newStringConfigKey("myconfig");

String valInSubType = "myValInSubType";
String valInDeploy = "myValInDeploy";

addCatalogItems(
"brooklyn.catalog:",
" id: " + nameOfSuperType,
" version: " + version,
" itemType: entity",
" item:",
" type: " + BasicEntity.class.getName(),
" brooklyn.parameters:",
" - name: " + configKey.getName(),
" type: String",
" constraints:",
" - required");

addCatalogItems(
"brooklyn.catalog:",
" id: " + nameOfSubType,
" version: " + version,
" itemType: entity",
" item:",
" type: " + nameOfSuperType + ":" + version,
" brooklyn.config:",
" " + configKey.getName() + ": " + valInSubType);

// No value for 'required' config; should fail
try {
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfSuperType + ":" + version);
Dumper.dumpInfo(app);
Asserts.shouldHaveFailedPreviously();
} catch (ConstraintViolationException e) {
// success - config has no value
}

// If explicitly set config, then deploy should work
{
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfSuperType + ":" + version,
" brooklyn.config:",
" myconfig: " + valInDeploy);
Entity entity = Iterables.getOnlyElement(app.getChildren());
assertEquals(entity.config().get(configKey), valInDeploy);
}

// Subtype has a config value set, but that should be overridden if explicitly value is passed
{
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfSubType + ":" + version,
" brooklyn.config:",
" myconfig: " + valInDeploy);
Entity entity = Iterables.getOnlyElement(app.getChildren());
assertEquals(entity.config().get(configKey), valInDeploy);
}

// Subtype has a config value set, so 'required' constraint is satisfied
{
Entity app = createAndStartApplication(
"services:",
"- type: " + nameOfSubType + ":" + version);
Entity entity = Iterables.getOnlyElement(app.getChildren());
assertEquals(entity.config().get(configKey), valInSubType);
}

// UI uses spec-parameter's metadata to validate inputs.
// Check that reports constraints / defaults correctly.

// Supertype has no default value, and constraint is 'required'
{
RegisteredType superType = mgmt().getTypeRegistry().get(nameOfSuperType, version);
EntitySpec<?> spec = mgmt().getTypeRegistry().createSpec(superType, null, EntitySpec.class);
List<SpecParameter<?>> parameters = spec.getParameters();
SpecParameter<?> param = Iterables.find(parameters, (p) -> p.getConfigKey().equals(configKey));

assertEquals(param.getConfigKey().getDefaultValue(), null);
assertEquals(param.getConfigKey().getConstraint(), new ConfigConstraints.RequiredPredicate<String>());
}

// Subtype has a value; this should be shown as the default
{
RegisteredType subType = mgmt().getTypeRegistry().get(nameOfSubType, version);
EntitySpec<?> spec = mgmt().getTypeRegistry().createSpec(subType, null, EntitySpec.class);
List<SpecParameter<?>> parameters = spec.getParameters();
SpecParameter<?> param = Iterables.find(parameters, (p) -> p.getConfigKey().equals(configKey));

assertEquals(param.getConfigKey().getDefaultValue(), valInSubType);
assertEquals(param.getConfigKey().getConstraint(), new ConfigConstraints.RequiredPredicate<String>());
}
}

private void registerAndLaunchAndAssertSimpleEntity(String symbolicName, String serviceType) throws Exception {
registerAndLaunchAndAssertSimpleEntity(symbolicName, serviceType, serviceType);
}
Expand Down