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

Jump to bottom

Izpack 1182: Evaluation of dynamic variables, which depends on other ones #306

Merged
merged 8 commits into from Jan 30, 2015
Merged

Izpack 1182: Evaluation of dynamic variables, which depends on other ones #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f86cec5
Implement test case for IZPACK-1182
Helpstone Jan 28, 2015
541e170
IZPACK-1182: continue evaluation of dynamic variables, until a stable
Helpstone Jan 28, 2015
5218547
IZPACK-1182: continue evaluation of dynamic variables, until a stable
Helpstone Jan 28, 2015
2b56e8e
reordering: tests above utility methods
Helpstone Jan 29, 2015
a8bd487
new utility method, which provides a new dynamic variable with
Helpstone Jan 29, 2015
fe86bea
Implement a unit test for the example from
Helpstone Jan 29, 2015
140e552
refactoring: think in "changed" instead of "unchanged"
Helpstone Jan 29, 2015
fabd58b
IZPACK-1182: in the case of several <dynamicvariable> with same name but
Helpstone Jan 29, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
118 changes: 68 additions & 50 deletions izpack-core/src/main/java/com/izforge/izpack/core/data/DefaultVariables.java
View file
Open in desktop
Expand Up @@ -310,77 +310,95 @@ public synchronized void add(DynamicVariable variable)
public synchronized void refresh()
{
logger.fine("Refreshing dynamic variables");

Properties setVariables = new Properties();
Set<String> unsetVariables = new HashSet<String>();

for (DynamicVariable variable : dynamicVariables)
{
String name = variable.getName();
if (!isBlockedVariableName(name))
Set<DynamicVariable> checkedVariables = new HashSet<DynamicVariable>();
boolean changed = true;
while (changed) {
changed = false;
Properties setVariables = new Properties();
Set<String> unsetVariables = new HashSet<String>();

for (DynamicVariable variable : dynamicVariables)
{
String conditionId = variable.getConditionid();
if (conditionId == null || rules.isConditionTrue(conditionId))
String name = variable.getName();
if (!isBlockedVariableName(name))
{
if (!(variable.isCheckonce() && variable.isChecked()))
String conditionId = variable.getConditionid();
if (conditionId == null || rules.isConditionTrue(conditionId))
{
String newValue;
try
{
newValue = variable.evaluate(replacer);
}
catch (IzPackException exception)
{
throw exception;
}
catch (Exception exception)
{
throw new IzPackException("Failed to refresh dynamic variable (" + name + ")", exception);
}
if (newValue == null)
if (!(variable.isCheckonce() && variable.isChecked()))
{
// Mark unset if dynamic variable cannot be evaluated and failOnError set
unsetVariables.add(name);
String newValue;
try
{
newValue = variable.evaluate(replacer);
}
catch (IzPackException exception)
{
throw exception;
}
catch (Exception exception)
{
throw new IzPackException("Failed to refresh dynamic variable (" + name + ")", exception);
}
if (newValue == null)
{
// Mark unset if dynamic variable cannot be evaluated and failOnError set
unsetVariables.add(name);
}
else
{
setVariables.put(name, newValue);
}
checkedVariables.add(variable);
}
else
{
setVariables.put(name, newValue);
String oldvalue = properties.getProperty(name);
if (oldvalue != null)
{
setVariables.put(name, oldvalue);
}
}
variable.setChecked();
}
else
{
String oldvalue = properties.getProperty(name);
if (oldvalue != null)
{
setVariables.put(name, oldvalue);
}
// Mark unset if condition is not true
unsetVariables.add(name);
}
}
else
{
// Mark unset if condition is not true
unsetVariables.add(name);
else {
logger.fine("Dynamic variable '" + name + "' blocked from changing due to user input");
}
}
else {
logger.fine("Dynamic variable '" + name + "' blocked from changing due to user input");

for (String key : unsetVariables)
{
// Don't unset dynamic variable from one definition, which
// are set to a value from another one during this refresh
if (!setVariables.containsKey(key))
{
if (get(key)!=null)
{
changed = true;
set(key, null);
}
}
}
}

for (String key : unsetVariables)
{
// Don't unset dynamic variable from one definition, which
// are set to a value from another one during this refresh
if (!setVariables.containsKey(key))
for (String key : setVariables.stringPropertyNames())
{
set(key, null);
String newValue = setVariables.getProperty(key);
String oldValue = get(key);
if (oldValue==null || ! oldValue.equals(newValue))
{
changed = true;
set(key,newValue);
}
}
}

for (String key : setVariables.stringPropertyNames())
for (DynamicVariable variable : checkedVariables)
{
set(key, setVariables.getProperty(key));
variable.setChecked();
}
}

Expand Down
2 changes: 1 addition & 1 deletion izpack-core/src/main/java/com/izforge/izpack/core/data/DynamicVariableImpl.java
View file
Open in desktop
Expand Up @@ -130,7 +130,7 @@ public String evaluate(VariableSubstitutor... substitutors) throws Exception
return null;
}

if (checkonce && currentValue != null)
if (checkonce && checked)
{
return filterValue(currentValue, substitutors);
}
Expand Down
155 changes: 149 additions & 6 deletions izpack-core/src/test/java/com/izforge/izpack/core/data/DefaultVariablesTest.java
View file
Open in desktop
Expand Up @@ -254,12 +254,8 @@ public void testDynamicVariablesUnset()
rules.readConditionMap(conditions);
((DefaultVariables) variables).setRules(rules);

DynamicVariable variable1 = createDynamic("unset1", "a", "cond1+cond2");
variable1.setCheckonce(true);
variables.add(variable1);
DynamicVariable variable2 = createDynamic("unset1", "b", "cond1+!cond2");
variable2.setCheckonce(true);
variables.add(variable2);
variables.add(createDynamicCheckonce("unset1", "a", "cond1+cond2"));
variables.add(createDynamicCheckonce("unset1", "b", "cond1+!cond2"));

// !cond1+!cond2
variables.refresh();
Expand All @@ -284,6 +280,152 @@ public void testDynamicVariablesUnset()
assertEquals("a", variables.get("unset1"));
}

/**
* Tests dynamic variables with a deeper dependency
* @see https://jira.codehaus.org/browse/IZPACK-1182
*/
@Test
public void testDependentDynamicVariables()
{
variables.add(createDynamic("depVar1", "${depVar2}"));
variables.add(createDynamic("depVar2", "${depVar3}"));
variables.set("depVar3", "depValue");

assertNull(variables.get("depVar1")); // not created till variables refreshed
variables.refresh();
assertEquals("check dependent variable","depValue", variables.get("depVar1"));
}

/**
* Tests dynamic variables with a deeper dependency and checkonce==true
* @see https://jira.codehaus.org/browse/IZPACK-1182
*/
@Test
public void testDependentDynamicVariablesWithCheckOnce()
{
variables.add(createDynamic("depVar1", "${depVar2}"));
variables.add(createDynamic("depVar2", "${depVar3}"));
variables.set("depVar3", "depValue");

variables.add(createDynamicCheckonce("checkonceVar", "${depVar1}"));

variables.refresh();
assertEquals("check dependent variable","depValue", variables.get("depVar1"));
assertEquals("check variable with checkonce=true","depValue", variables.get("checkonceVar"));

variables.set("depVar3", "newValue");
variables.refresh();
assertEquals("recheck dependent variable","newValue", variables.get("depVar1")); // should be changed
assertEquals("recheck variable with checkonce=true","depValue", variables.get("checkonceVar")); // should not change any more
}

/**
* Tests dynamic variables with and without conditions
*
* This test is for the definition
* <dynamicvariables>
* <variable name="thechoice" value="fallback value" />
* <variable name="thechoice" value="choice1" condition="cond1" />
* <variable name="thechoice" value="choice2" condition="cond2" />
* </dynamicvariables>
* @see http://docs.codehaus.org/display/IZPACK/Lifecycle+of+dynamic+variables
*/
@Test
public void testMixedDynamicVariables()
{
final String observedVar = "thechoice";

// set up conditions
Map<String, Condition> conditions = new HashMap<String, Condition>();
conditions.put("cond1", new VariableCondition("condvar1", "1"));
conditions.put("cond2", new VariableCondition("condvar2", "1"));

// set up the rules
AutomatedInstallData installData = new AutomatedInstallData(variables, Platforms.LINUX);
RulesEngineImpl rules = new RulesEngineImpl(installData, new ConditionContainer(new DefaultContainer()),
installData.getPlatform());
rules.readConditionMap(conditions);
((DefaultVariables) variables).setRules(rules);

variables.add(createDynamic(observedVar, "fallback value", null));
variables.add(createDynamic(observedVar, "choice1", "cond1"));
variables.add(createDynamic(observedVar, "choice2", "cond2"));

assertNull(variables.get(observedVar));

// !cond1+!cond2
variables.refresh();
assertEquals("fallback value", variables.get(observedVar));

// cond1+!cond2
variables.set("condvar1", "1");
variables.refresh();
assertEquals("choice1", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("choice1", variables.get(observedVar));

// cond1+cond2
variables.set("condvar2", "1");
variables.refresh();
assertEquals("choice2", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("choice2", variables.get(observedVar));

// !cond1+cond2
variables.set("condvar1", "0");
variables.refresh();
assertEquals("choice2", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("choice2", variables.get(observedVar));

// !cond1+!cond2
variables.set("condvar2", "0");
variables.refresh();
assertEquals("fallback value", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("fallback value", variables.get(observedVar));

// !cond1+cond2
variables.set("condvar2", "1");
variables.refresh();
assertEquals("choice2", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("choice2", variables.get(observedVar));

// cond1+cond2
variables.set("condvar1", "1");
variables.refresh(); // cond2 takes precedence because of ordering
assertEquals("choice2", variables.get(observedVar));
variables.refresh(); // Double check whether it is a stable state (for instance on panel change)
assertEquals("choice2", variables.get(observedVar));
}

/**
* Creates a dynamic variable with Checkonce set.
*
* @param name the variable name
* @param value the variable value
* @return a new variable
*/
private DynamicVariable createDynamicCheckonce(String name, String value)
{
return createDynamicCheckonce(name, value, null);
}

/**
* Creates a dynamic variable with a condition and Checkonce set.
*
* @param name the variable name
* @param value the variable value
* @param conditionId the condition identifier. May be {@code null}
* @return a new variable
*/
private DynamicVariable createDynamicCheckonce(String name, String value, String conditionId)
{
DynamicVariable var = createDynamic(name, value, conditionId);
var.setCheckonce(true);
return var;
}

/**
* Creates a dynamic variable.
Expand Down Expand Up @@ -313,5 +455,6 @@ private DynamicVariable createDynamic(String name, String value, String conditio
result.setConditionid(conditionId);
return result;
}

}