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.

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

feat: add empty constructors to data classes #491

Merged
merged 1 commit into from
Jun 28, 2023
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
10 changes: 7 additions & 3 deletions src/main/java/dev/openfeature/sdk/FlagEvaluationDetails.java
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
package dev.openfeature.sdk;

import javax.annotation.Nullable;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;

import javax.annotation.Nullable;
import lombok.NoArgsConstructor;

/**
* Contains information about how the evaluation happened, including any resolved values.
* Contains information about how the provider resolved a flag, including the resolved value.
*
* @param <T> the type of the flag being evaluated.
*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class FlagEvaluationDetails<T> implements BaseEvaluation<T> {

private String flagKey;
Expand Down
17 changes: 13 additions & 4 deletions src/main/java/dev/openfeature/sdk/ProviderEvaluation.java
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
package dev.openfeature.sdk;

import javax.annotation.Nullable;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.annotation.Nullable;

@SuppressWarnings("checkstyle:MissingJavadocType")
@Data @Builder
/**
* Contains information about how the a flag was evaluated, including the resolved value.
*
* @param <T> the type of the flag being evaluated.
*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ProviderEvaluation<T> implements BaseEvaluation<T> {
T value;
@Nullable String variant;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package dev.openfeature.sdk;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

class FlagEvaluationDetailsTest {

@Test
@DisplayName("Should have empty constructor")
public void empty() {
FlagEvaluationDetails<Integer> details = new FlagEvaluationDetails<Integer>();
assertNotNull(details);
}

@Test
@DisplayName("Should have flagKey, value, variant, reason, errorCode, errorMessage, metadata constructor")
// removeing this constructor is a breaking change!
public void sevenArgConstructor() {

String flagKey = "my-flag";
Integer value = 100;
String variant = "1-hundred";
Reason reason = Reason.DEFAULT;
ErrorCode errorCode = ErrorCode.GENERAL;
String errorMessage = "message";
ImmutableMetadata metadata = ImmutableMetadata.builder().build();

FlagEvaluationDetails<Integer> details = new FlagEvaluationDetails<>(
flagKey,
value,
variant,
reason.toString(),
errorCode,
errorMessage,
metadata);

assertEquals(flagKey, details.getFlagKey());
assertEquals(value, details.getValue());
assertEquals(variant, details.getVariant());
assertEquals(reason.toString(), details.getReason());
assertEquals(errorCode, details.getErrorCode());
assertEquals(errorMessage, details.getErrorMessage());
assertEquals(metadata, details.getFlagMetadata());
}
}
45 changes: 45 additions & 0 deletions src/test/java/dev/openfeature/sdk/ProviderEvaluationTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package dev.openfeature.sdk;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

class ProviderEvaluationTest {

@Test
@DisplayName("Should have empty constructor")
public void empty() {
ProviderEvaluation<Integer> details = new ProviderEvaluation<Integer>();
assertNotNull(details);
}

@Test
@DisplayName("Should have value, variant, reason, errorCode, errorMessage, metadata constructor")
// removeing this constructor is a breaking change!
public void sixArgConstructor() {

Integer value = 100;
String variant = "1-hundred";
Reason reason = Reason.DEFAULT;
ErrorCode errorCode = ErrorCode.GENERAL;
String errorMessage = "message";
ImmutableMetadata metadata = ImmutableMetadata.builder().build();

ProviderEvaluation<Integer> details = new ProviderEvaluation<>(
value,
variant,
reason.toString(),
errorCode,
errorMessage,
metadata);

assertEquals(value, details.getValue());
assertEquals(variant, details.getVariant());
assertEquals(reason.toString(), details.getReason());
assertEquals(errorCode, details.getErrorCode());
assertEquals(errorMessage, details.getErrorMessage());
assertEquals(metadata, details.getFlagMetadata());
}
}