adding integration tests for flagd and inmemory provider

Author: sideshowcoder

README.md

@@ -48,7 +48,7 @@ Your Dropwizard application configuration class must implement `OpenFeatureBundl
 
 ## Configuring dropwizard-openfeature in the dropwizard config file
 
-For a full overview see `OpenFeatureBundleFactory`, `OpenFeatureHealthCheckConfiguration`, and `FlagdConfiguration` a 
+For a full overview see `OpenFeatureConfiguration`, `OpenFeatureHealthCheckConfiguration`, and `FlagdConfiguration` a 
 minimal configuration for flagd runnining locally on the port 8013 would look as follows.
 
 ```yaml
@@ -63,15 +63,17 @@ For the bundle to have access to the configuration, your application configurati
 `OpenFeatureBundleConfiguration`.
 
 ```java
+import io.github.sideshowcoder.dropwizard_openfeature.OpenFeatureConfiguration;
+
 public class ApplicationConfiguration implements OpenFeatureBundleConfiguration {
 
     @Valid
     @NotNull
     @JsonProperty
-    private OpenFeatureBundleFactory openfeature;
+    private OpenFeatureConfiguration openfeature;
 
     @Override
-    public OpenFeatureBundleFactory getOpenFeatureBundleFactory() {
+    public OpenFeatureConfiguration getOpenFeatureConfiguration() {
         return openfeature;
     }
 }

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.sideshowcoder</groupId>
     <artifactId>dropwizard-openfeature</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
+    <version>0.0.2-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>dropwizard-openfeature</name>
@@ -28,6 +28,8 @@
         <maven-resources-plugin.version>3.3.1</maven-resources-plugin.version>
         <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
         <maven-surefire-plugin.version>3.5.3</maven-surefire-plugin.version>
+        <maven-failsafe-plugin.version>3.5.3</maven-failsafe-plugin.version>
+        <mockito.version>5.17.0</mockito.version>
     </properties>
 
     <developers>
@@ -61,11 +63,11 @@
                 <scope>import</scope>
             </dependency>
             <dependency>
-                <groupId>org.testcontainers</groupId>
-                <artifactId>testcontainers-bom</artifactId>
-                <version>1.21.0</version>
+                <groupId>org.mockito</groupId>
+                <artifactId>mockito-bom</artifactId>
+                <version>${mockito.version}</version>
                 <type>pom</type>
-                <scope>import</scope>
+                <scope>test</scope>
             </dependency>
         </dependencies>
     </dependencyManagement>
@@ -102,6 +104,16 @@
             <artifactId>dropwizard-testing</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -113,10 +125,16 @@
             <plugin>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>${maven-surefire-plugin.version}</version>
+                <configuration>
+                    <argLine>
+                        -javaagent:${settings.localRepository}/org/mockito/mockito-core/${mockito.version}/mockito-core-${mockito.version}.jar
+                        -Xshare:off
+                    </argLine>
+                </configuration>
             </plugin>
             <plugin>
                 <artifactId>maven-failsafe-plugin</artifactId>
-                <version>${maven-surefire-plugin.version}</version>
+                <version>${maven-failsafe-plugin.version}</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

src/main/java/io/github/sideshowcoder/dropwizard_openfeature/OpenFeatureAPIManager.java

@@ -3,8 +3,11 @@
 import dev.openfeature.sdk.FeatureProvider;
 import dev.openfeature.sdk.OpenFeatureAPI;
 import io.dropwizard.lifecycle.Managed;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class OpenFeatureAPIManager implements Managed {
+    private static final Logger log = LoggerFactory.getLogger(OpenFeatureAPIManager.class);
     private final FeatureProvider featureProvider;
 
     public OpenFeatureAPIManager(FeatureProvider featureProvider) {
@@ -14,10 +17,12 @@ public OpenFeatureAPIManager(FeatureProvider featureProvider) {
     @Override
     public void start() throws Exception {
         OpenFeatureAPI.getInstance().setProviderAndWait(featureProvider);
+        log.info("Started {}", this.getClass().getSimpleName());
     }
 
     @Override
     public void stop() throws Exception {
         OpenFeatureAPI.getInstance().shutdown();
+        log.info("Stopped {}", this.getClass().getSimpleName());
     }
 }

src/main/java/io/github/sideshowcoder/dropwizard_openfeature/OpenFeatureBundle.java

@@ -1,8 +1,12 @@
 package io.github.sideshowcoder.dropwizard_openfeature;
 
-import dev.openfeature.sdk.providers.memory.Flag;
+import dev.openfeature.contrib.providers.flagd.FlagdProvider;
+import dev.openfeature.sdk.FeatureProvider;
+import dev.openfeature.sdk.OpenFeatureAPI;
+import dev.openfeature.sdk.providers.memory.InMemoryProvider;
 import io.dropwizard.core.ConfiguredBundle;
 import io.dropwizard.core.setup.Environment;
+import io.github.sideshowcoder.dropwizard_openfeature.health.OpenFeatureHealthCheck;
 
 import java.util.Map;
 
@@ -18,20 +22,33 @@
  */
 public class OpenFeatureBundle implements ConfiguredBundle<OpenFeatureBundleConfiguration> {
 
-    private final Map<String, Flag<?>> inMemoryFlags;
+    private FeatureProvider featureProvider;
 
-    public OpenFeatureBundle() {
-        this(Map.of());
+    @Override
+    public void run(OpenFeatureBundleConfiguration configuration, Environment environment) {
+        var config = configuration.getOpenFeatureConfiguration();
+        initializeFeatureProvider(config);
+        var manager = new OpenFeatureAPIManager(getFeatureProvider());
+        environment.lifecycle().manage(manager);
+
+        if (config.getHealthcheck().isEnabled()) {
+            var client = OpenFeatureAPI.getInstance().getClient(config.getHealthcheck().getClientDomain());
+            var healthcheck = new OpenFeatureHealthCheck(client);
+            environment.healthChecks().register(config.getHealthcheck().getName(), healthcheck);
+        }
     }
 
-    public OpenFeatureBundle(Map<String, Flag<?>> inMemoryFlags) {
-        this.inMemoryFlags = inMemoryFlags;
+    public FeatureProvider getFeatureProvider() {
+        if (featureProvider == null) {
+            throw new IllegalStateException("FeatureProvider has not been initialized");
+        }
+        return featureProvider;
     }
 
-    @Override
-    public void run(OpenFeatureBundleConfiguration configuration, Environment environment) {
-        configuration.getOpenFeatureBundleFactory().setFlags(inMemoryFlags);
-        configuration.getOpenFeatureBundleFactory().startOpenFeatureAPIManager(environment);
-        configuration.getOpenFeatureBundleFactory().registerOpenFeatureHealthCheck(environment);
+    private synchronized void initializeFeatureProvider(OpenFeatureConfiguration config) {
+        featureProvider = switch (config.getProviderType()) {
+            case FLAGD -> new FlagdProvider(config.getFlagd().getFlagdOptions());
+            case INMEMORY -> new InMemoryProvider(Map.of());
+        };
     }
 }

src/main/java/io/github/sideshowcoder/dropwizard_openfeature/OpenFeatureBundleConfiguration.java

@@ -1,5 +1,5 @@
 package io.github.sideshowcoder.dropwizard_openfeature;
 
 public interface OpenFeatureBundleConfiguration {
-    OpenFeatureBundleFactory getOpenFeatureBundleFactory();
+    OpenFeatureConfiguration getOpenFeatureConfiguration();
 }

src/main/java/io/github/sideshowcoder/dropwizard_openfeature/OpenFeatureBundleFactory.java

@@ -0,0 +1,50 @@
+package io.github.sideshowcoder.dropwizard_openfeature;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.github.sideshowcoder.dropwizard_openfeature.validation.ValidEnum;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+
+public class OpenFeatureConfiguration {
+
+    @Valid
+    @JsonProperty
+    private FlagdConfiguration flagd = new FlagdConfiguration();
+
+    @Valid
+    @JsonProperty
+    private OpenFeatureHealthCheckConfiguration healthcheck = new OpenFeatureHealthCheckConfiguration();
+
+    @JsonProperty
+    @ValidEnum(enumClass = ProviderType.class)
+    @NotNull
+    private String provider;
+
+    public FlagdConfiguration getFlagd() {
+        return flagd;
+    }
+
+    public void setFlagd(FlagdConfiguration flagd) {
+        this.flagd = flagd;
+    }
+
+    public OpenFeatureHealthCheckConfiguration getHealthcheck() {
+        return healthcheck;
+    }
+
+    public void setHealthcheck(OpenFeatureHealthCheckConfiguration healthcheck) {
+        this.healthcheck = healthcheck;
+    }
+
+    public String getProvider() {
+        return provider;
+    }
+
+    public void setProvider(String provider) {
+        this.provider = provider;
+    }
+
+    public ProviderType getProviderType() {
+        return ProviderType.valueOf(provider.toUpperCase());
+    }
+}

src/main/java/io/github/sideshowcoder/dropwizard_openfeature/OpenFeatureConfiguration.java

@@ -0,0 +1,35 @@
+package io.github.sideshowcoder.dropwizard_openfeature;
+
+import dev.openfeature.sdk.OpenFeatureAPI;
+import io.dropwizard.testing.ResourceHelpers;
+import io.dropwizard.testing.junit5.DropwizardAppExtension;
+import io.dropwizard.testing.junit5.DropwizardExtensionsSupport;
+import io.github.sideshowcoder.dropwizard_openfeature.helpers.App;
+import io.github.sideshowcoder.dropwizard_openfeature.helpers.Config;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@ExtendWith(DropwizardExtensionsSupport.class)
+public class OpenFeatureBundleFlagdProviderTest {
+
+    private static final DropwizardAppExtension<Config> APP = new DropwizardAppExtension<>(
+            App.class,
+            ResourceHelpers.resourceFilePath("flagd-provider-config.yml"));
+
+    @Test
+    public void initializesHealthCheck() throws Exception {
+        var healthcheckResult = APP.getEnvironment().healthChecks().runHealthCheck("openfeature-health-check");
+        assertTrue(healthcheckResult.isHealthy());
+    }
+
+    @Test
+    public void providesFeatureFlagsViaInMemoryProvider() throws Exception {
+        // See flagd-test-flags.json for flag definitions used!
+        var client = OpenFeatureAPI.getInstance().getClient("flagd-client");
+        assertEquals("red", client.getStringValue("static-string-flag", "not-expected-value"));
+    }
+
+}