Skip to content

feat: variables testing in Java #7

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

Merged
fahad19 merged 1 commit into from
Aug 30, 2026
Merged

feat: variables testing in Java #7

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Add the Featurevisor Java SDK as a dependency with your desired version:
<dependency>
<groupId>com.featurevisor</groupId>
<artifactId>featurevisor-java</artifactId>
<version>4.0.0</version>
<version>4.1.0</version>
</dependency>
</dependencies>
```
Expand Down Expand Up @@ -901,7 +901,7 @@ Add the provider with the same version as the Featurevisor Java SDK:
<dependency>
<groupId>com.featurevisor</groupId>
<artifactId>featurevisor-openfeature</artifactId>
<version>4.0.0</version>
<version>4.1.0</version>
</dependency>
```

Expand Down Expand Up @@ -973,7 +973,7 @@ $ make verify-artifacts
### Releasing

1. Merge the release changes into `main`.
2. Tag the release with a `v` prefix, such as `v4.0.0`, and push the tag.
2. Tag the release with a `v` prefix, such as `v4.1.0`, and push the tag.
3. GitHub Actions verifies and publishes the parent POM, Java SDK, and OpenFeature provider to [GitHub Packages](https://github.com/orgs/featurevisor/packages?repo_name=featurevisor-java).
4. Create the corresponding [GitHub release](https://github.com/featurevisor/featurevisor-java/releases).

Expand Down
175 changes: 122 additions & 53 deletions featurevisor-sdk/src/main/java/com/featurevisor/cli/CLI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
@Command(
name = "featurevisor",
mixinStandardHelpOptions = true,
version = "4.0.0",
version = "4.1.0",
description = "Featurevisor Java Library CLI - Test runner, benchmark, and distribution assessment"
)
public class CLI implements Runnable {
Expand Down Expand Up @@ -209,14 +209,13 @@ String selectDatafileKeyForAssertion(Map<String, Object> assertion, Map<String,
String assertionEnvironment = assertion.get("environment") instanceof String
? (String) assertion.get("environment")
: null;
String baseDatafileKey = getEnvironmentKey(assertionEnvironment);
String target = assertion.get("target") instanceof String ? (String) assertion.get("target") : null;

if (target != null && datafileCache.containsKey(targetDatafileCacheKey(assertionEnvironment, target))) {
if (target != null) {
return targetDatafileCacheKey(assertionEnvironment, target);
}

return baseDatafileKey;
return getEnvironmentKey(assertionEnvironment);
}

private DatafileContent parseDatafileContent(String datafileOutput, String contextForError) throws IOException {
Expand Down Expand Up @@ -523,7 +522,12 @@ private TestResult testFeature(Map<String, Object> assertion, String featureKey,
@SuppressWarnings("unchecked")
Map<String, Object> childContext = (Map<String, Object>) child.getOrDefault("context", new HashMap<>());
com.featurevisor.sdk.ChildInstance childF = spawn(f, childContext);
TestResult childResult = testFeature(child, featureKey, childF, level);
TestResult childResult;
try {
childResult = testFeature(child, featureKey, childF, level);
} finally {
childF.close();
}
duration += childResult.duration;
hasError = hasError || childResult.hasError;

Expand All @@ -538,19 +542,17 @@ private TestResult testFeature(Map<String, Object> assertion, String featureKey,

private TestResult testGlobalVariable(Map<String, Object> assertion, String variableKey, Featurevisor f) {
@SuppressWarnings("unchecked") Map<String, Object> context = (Map<String, Object>) assertion.getOrDefault("context", new HashMap<>());
@SuppressWarnings("unchecked") Map<String, Object> stickyVariables = (Map<String, Object>) assertion.getOrDefault("stickyVariables", new HashMap<>());
f.setContext(context, true);
f.setStickyVariables(stickyVariables, true);
Featurevisor.OverrideOptions options = new Featurevisor.OverrideOptions();
if (assertion.containsKey("defaultVariableValue")) options.setDefaultVariableValue(assertion.get("defaultVariableValue"));
long startTime = System.nanoTime();
Evaluation evaluation = f.evaluateVariable(variableKey, context, options);
Evaluation evaluation = f.evaluateVariable(variableKey, new HashMap<>(), options);
boolean hasError = false;
StringBuilder errors = new StringBuilder();
if (assertion.containsKey("expectedValue") && !Objects.equals(assertion.get("expectedValue"), evaluation.getVariableValue())) {
hasError = true;
errors.append(" ✘ expectedValue: expected ").append(assertion.get("expectedValue"))
.append(" but received ").append(evaluation.getVariableValue()).append("\n");
errors.append(" ✘ expectedValue: expected ").append(formatTestValue(assertion.get("expectedValue")))
.append(" but received ").append(formatTestValue(evaluation.getVariableValue())).append("\n");
}
if (assertion.containsKey("expectedEvaluation")) {
@SuppressWarnings("unchecked") Map<String, Object> expected = (Map<String, Object>) assertion.get("expectedEvaluation");
Expand All @@ -559,13 +561,94 @@ private TestResult testGlobalVariable(Map<String, Object> assertion, String vari
if (!Objects.equals(entry.getValue(), actual)) {
hasError = true;
errors.append(" ✘ expectedEvaluation.").append(entry.getKey()).append(": expected ")
.append(entry.getValue()).append(" but received ").append(actual).append("\n");
.append(formatTestValue(entry.getValue())).append(" but received ").append(formatTestValue(actual)).append("\n");
}
}
}
if (assertion.containsKey("children")) {
@SuppressWarnings("unchecked") List<Map<String, Object>> children = (List<Map<String, Object>>) assertion.get("children");
for (int childIndex = 0; childIndex < children.size(); childIndex++) {
Map<String, Object> childAssertion = children.get(childIndex);
@SuppressWarnings("unchecked") Map<String, Object> childContext = (Map<String, Object>) childAssertion.getOrDefault("context", new HashMap<>());
@SuppressWarnings("unchecked") Map<String, Object> childStickyFeatures = (Map<String, Object>) childAssertion.get("stickyFeatures");
@SuppressWarnings("unchecked") Map<String, Object> childStickyVariables = (Map<String, Object>) childAssertion.get("stickyVariables");
if (childStickyFeatures == null) childStickyFeatures = new HashMap<>();
if (childStickyVariables == null) childStickyVariables = new HashMap<>();
Featurevisor.SpawnOptions spawnOptions = new Featurevisor.SpawnOptions()
.stickyFeatures(childStickyFeatures)
.stickyVariables(childStickyVariables);
com.featurevisor.sdk.ChildInstance child = f.spawn(childContext, spawnOptions);
try {
TestResult childResult = testGlobalVariableChild(childAssertion, variableKey, child, childIndex);
hasError = hasError || childResult.hasError;
errors.append(childResult.errors);
} finally {
child.close();
}
}
}
return new TestResult(hasError, errors.toString(), (System.nanoTime() - startTime) / 1_000_000.0);
}

private TestResult testGlobalVariableChild(Map<String, Object> assertion, String variableKey, com.featurevisor.sdk.ChildInstance child, int childIndex) {
Featurevisor.OverrideOptions options = new Featurevisor.OverrideOptions();
if (assertion.containsKey("defaultVariableValue")) options.setDefaultVariableValue(assertion.get("defaultVariableValue"));
Evaluation evaluation = child.evaluateVariable(variableKey, new HashMap<>(), options);
boolean hasError = false;
StringBuilder errors = new StringBuilder();
String prefix = "children[" + childIndex + "].";
if (assertion.containsKey("expectedValue") && !Objects.equals(assertion.get("expectedValue"), evaluation.getVariableValue())) {
hasError = true;
errors.append(" ✘ ").append(prefix).append("expectedValue: expected ")
.append(formatTestValue(assertion.get("expectedValue"))).append(" but received ")
.append(formatTestValue(evaluation.getVariableValue())).append("\n");
}
if (assertion.containsKey("expectedEvaluation")) {
@SuppressWarnings("unchecked") Map<String, Object> expected = (Map<String, Object>) assertion.get("expectedEvaluation");
for (Map.Entry<String, Object> entry : expected.entrySet()) {
Object actual = getEvaluationValue(evaluation, entry.getKey());
if (!Objects.equals(entry.getValue(), actual)) {
hasError = true;
errors.append(" ✘ ").append(prefix).append("expectedEvaluation.").append(entry.getKey())
.append(": expected ").append(formatTestValue(entry.getValue()))
.append(" but received ").append(formatTestValue(actual)).append("\n");
}
}
}
return new TestResult(hasError, errors.toString(), 0);
}

private String formatTestValue(Object value) {
try {
return objectMapper.writeValueAsString(value);
} catch (Exception ignored) {
return String.valueOf(value);
}
}

@SuppressWarnings("unchecked")
private Featurevisor createInstanceForAssertion(DatafileContent datafile, Map<String, Object> assertion, FeaturevisorLogLevel level) {
Featurevisor.FeaturevisorOptions options = new Featurevisor.FeaturevisorOptions()
.datafile(datafile)
.logLevel(level)
.context((Map<String, Object>) assertion.getOrDefault("context", new HashMap<>()))
.stickyFeatures((Map<String, Object>) assertion.getOrDefault("stickyFeatures", assertion.get("sticky")))
.stickyVariables((Map<String, Object>) assertion.get("stickyVariables"));
if (assertion.get("at") instanceof Number) {
double at = ((Number) assertion.get("at")).doubleValue();
options.modules(Collections.singletonList(
new FeaturevisorModule("test-module").bucketValue(bucket -> (int) (at * 1000))
));
}
return Featurevisor.createFeaturevisor(options);
}

private TestResult missingDatafileResult(Map<String, Object> assertion) {
String environmentName = assertion.get("environment") instanceof String ? assertion.get("environment").toString() : "none";
String targetName = assertion.get("target") instanceof String ? " and target \"" + assertion.get("target") + "\"" : "";
return new TestResult(true, " ✘ datafile not found for environment \"" + environmentName + "\"" + targetName + "\n", 0);
}

/**
* Helper methods to work with both Instance and ChildInstance
*/
Expand Down Expand Up @@ -728,7 +811,7 @@ private void test() {
@SuppressWarnings("unchecked")
List<Map<String, Object>> assertions = (List<Map<String, Object>>) test.get("assertions");

if (test.containsKey("feature") && !targets.isEmpty()) {
if ((test.containsKey("feature") || test.containsKey("variable")) && !targets.isEmpty()) {
assertions = assertions.stream().filter(assertion -> {
Object assertionTarget = assertion.get("target");
return assertionTarget == null || targets.contains(assertionTarget.toString());
Expand All @@ -751,65 +834,51 @@ private void test() {
String assertionEnvironment = assertion.get("environment") instanceof String
? (String) assertion.get("environment")
: null;
String baseDatafileKey = getEnvironmentKey(assertionEnvironment);
String selectedDatafileKey = selectDatafileKeyForAssertion(assertion, datafileCache);

DatafileContent selectedDatafile = datafileCache.get(selectedDatafileKey);
if (selectedDatafile == null) {
selectedDatafile = datafileCache.get(baseDatafileKey);
}

if (selectedDatafile == null) {
throw new IOException("No datafile found for assertion environment: " + assertionEnvironment);
}

@SuppressWarnings("unchecked")
Map<String, Object> effectiveAssertion = objectMapper.convertValue(
assertion,
new TypeReference<Map<String, Object>>() {}
);
testResult = missingDatafileResult(assertion);
} else {
@SuppressWarnings("unchecked")
Map<String, Object> effectiveAssertion = objectMapper.convertValue(
assertion,
new TypeReference<Map<String, Object>>() {}
);

if (Boolean.TRUE.equals(showDatafile)) {
System.out.println();
System.out.println(objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(selectedDatafile));
System.out.println();
}

Featurevisor f = Featurevisor.createFeaturevisor(new Featurevisor.FeaturevisorOptions()
.datafile(selectedDatafile)
.logLevel(level));

// If "at" parameter is provided, create a new SDK instance with the specific module
if (effectiveAssertion.containsKey("at")) {
Object atObj = effectiveAssertion.get("at");
double atValue;

if (atObj instanceof Number) {
atValue = ((Number) atObj).doubleValue();
} else {
atValue = Double.parseDouble(atObj.toString());
Featurevisor f = createInstanceForAssertion(selectedDatafile, effectiveAssertion, level);
try {
testResult = testFeature(effectiveAssertion, (String) test.get("feature"), f, level);
} finally {
f.close();
}

FeaturevisorModule testModule = new FeaturevisorModule("test-module")
.bucketValue((options) -> (int) (atValue * 1000));

f = Featurevisor.createFeaturevisor(new Featurevisor.FeaturevisorOptions()
.datafile(selectedDatafile)
.logLevel(level)
.modules(Collections.singletonList(testModule)));
}

testResult = testFeature(effectiveAssertion, (String) test.get("feature"), f, level);


} else if (test.containsKey("variable")) {
String assertionEnvironment = assertion.get("environment") instanceof String ? (String) assertion.get("environment") : null;
String selectedDatafileKey = selectDatafileKeyForAssertion(assertion, datafileCache);
DatafileContent selectedDatafile = datafileCache.get(selectedDatafileKey);
if (selectedDatafile == null) selectedDatafile = datafileCache.get(getEnvironmentKey(assertionEnvironment));
if (selectedDatafile == null) throw new IOException("No datafile found for assertion environment: " + assertionEnvironment);
Featurevisor f = Featurevisor.createFeaturevisor(new Featurevisor.FeaturevisorOptions().datafile(selectedDatafile).logLevel(level));
testResult = testGlobalVariable(assertion, (String) test.get("variable"), f);
if (selectedDatafile == null) {
testResult = missingDatafileResult(assertion);
} else {
if (Boolean.TRUE.equals(showDatafile)) {
System.out.println();
System.out.println(objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(selectedDatafile));
System.out.println();
}
Featurevisor f = createInstanceForAssertion(selectedDatafile, assertion, level);
try {
testResult = testGlobalVariable(assertion, (String) test.get("variable"), f);
} finally {
f.close();
}
}
} else if (test.containsKey("segment")) {
testResult = testSegment(assertion, segmentsByKey.get(test.get("segment")), level);
} else {
Expand Down
4 changes: 2 additions & 2 deletions featurevisor-sdk/src/test/java/com/featurevisor/cli/CLIOptionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public void testTargetAssertionSelectsTargetDatafile() {
}

@Test
public void testTargetAssertionFallsBackToBaseDatafile() {
public void testTargetAssertionDoesNotFallBackToBaseDatafile() {
CLI cli = new CLI();
Map<String, Object> assertion = new HashMap<>();
assertion.put("environment", "production");
Expand All @@ -73,7 +73,7 @@ public void testTargetAssertionFallsBackToBaseDatafile() {
Map<String, DatafileContent> cache = new HashMap<>();
cache.put("production", new DatafileContent("2", "base"));

assertEquals("production", cli.selectDatafileKeyForAssertion(assertion, cache));
assertEquals("production-target-checkout", cli.selectDatafileKeyForAssertion(assertion, cache));
}

@Test
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</modules>

<properties>
<revision>4.0.0</revision>
<revision>4.1.0</revision>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<maven.compiler.testSource>15</maven.compiler.testSource>
Expand Down