com.launchdarkly.sdk.server.integrations

Class TestData

java.lang.Object

com.launchdarkly.sdk.server.integrations.TestData

All Implemented Interfaces:

ComponentConfigurer<DataSource>

public final class TestData
extends java.lang.Object
implements ComponentConfigurer<DataSource>

A mechanism for providing dynamically updatable feature flag state in a simplified form to an SDK client in test scenarios.

Unlike FileData, this mechanism does not use any external resources. It provides only the data that the application has put into it using the update(FlagBuilder) method.

     TestData td = TestData.dataSource();
     td.update(testData.flag("flag-key-1").booleanFlag().variationForAllUsers(true));
     
     LDConfig config = new LDConfig.Builder()
         .dataSource(td)
         .build();
     LDClient client = new LDClient(sdkKey, config);
     
     // flags can be updated at any time:
     td.update(testData.flag("flag-key-2")
         .variationForUser("some-user-key", true)
         .fallthroughVariation(false));
 

The above example uses a simple boolean flag, but more complex configurations are possible using the methods of the TestData.FlagBuilder that is returned by flag(String). TestData.FlagBuilder supports many of the ways a flag can be configured on the LaunchDarkly dashboard, but does not currently support 1. rule operators other than "in" and "not in", or 2. percentage rollouts.

If the same TestData instance is used to configure multiple LDClient instances, any changes made to the data will propagate to all of the LDClients.

Since:

5.1.0

See Also:

FileData

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestData.FlagBuilder A builder for feature flag configurations to be used with TestData.

Method Summary

Modifier and Type	Method and Description
DataSource	build(ClientContext context) Called internally by the SDK to create an implementation instance.
static TestData	dataSource() Creates a new instance of the test data source.
TestData	delete(java.lang.String key) Deletes a specific flag from the test data by create a versioned tombstone.
TestData.FlagBuilder	flag(java.lang.String key) Creates or copies a TestData.FlagBuilder for building a test flag configuration.
TestData	update(TestData.FlagBuilder flagBuilder) Updates the test data with the specified flag configuration.
TestData	updateStatus(DataSourceStatusProvider.State newState, DataSourceStatusProvider.ErrorInfo newError) Simulates a change in the data source status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

dataSource

public static TestData dataSource()

Creates a new instance of the test data source.

See TestData for details.

Returns:

a new configurable test data source

flag

public TestData.FlagBuilder flag(java.lang.String key)

Creates or copies a TestData.FlagBuilder for building a test flag configuration.

If this flag key has already been defined in this TestData instance, then the builder starts with the same configuration that was last provided for this flag.

Otherwise, it starts with a new default configuration in which the flag has true and false variations, is true for all users when targeting is turned on and false otherwise, and currently has targeting turned on. You can change any of those properties, and provide more complex behavior, using the TestData.FlagBuilder methods.

Once you have set the desired configuration, pass the builder to update(FlagBuilder).

Parameters:

key - the flag key

Returns:

a flag configuration builder

See Also:

update(FlagBuilder)

delete

public TestData delete(java.lang.String key)

Deletes a specific flag from the test data by create a versioned tombstone.

This has the same effect as if a flag were removed on the LaunchDarkly dashboard. It immediately propagates the flag change to any LDClient instance(s) that you have already configured to use this TestData. If no LDClient has been started yet, it simply adds tombstone to the test data which will be provided to any LDClient that you subsequently configure.

Parameters:

key - the flag key

Returns:

a flag configuration builder

update

public TestData update(TestData.FlagBuilder flagBuilder)

Updates the test data with the specified flag configuration.

This has the same effect as if a flag were added or modified on the LaunchDarkly dashboard. It immediately propagates the flag change to any LDClient instance(s) that you have already configured to use this TestData. If no LDClient has been started yet, it simply adds this flag to the test data which will be provided to any LDClient that you subsequently configure.

Any subsequent changes to this TestData.FlagBuilder instance do not affect the test data, unless you call update(FlagBuilder) again.

Parameters:

flagBuilder - a flag configuration builder

Returns:

the same TestData instance

See Also:

flag(String)

updateStatus

public TestData updateStatus(DataSourceStatusProvider.State newState,
                             DataSourceStatusProvider.ErrorInfo newError)

Simulates a change in the data source status.

Use this if you want to test the behavior of application code that uses LDClient.getDataSourceStatusProvider() to track whether the data source is having problems (for example, a network failure interruptsingthe streaming connection). It does not actually stop the TestData data source from working, so even if you have simulated an outage, calling update(FlagBuilder) will still send updates.

Parameters:

newState - one of the constants defined by DataSourceStatusProvider.State

newError - an DataSourceStatusProvider.ErrorInfo instance, or null

Returns:

the same TestData instance

build

public DataSource build(ClientContext context)

Description copied from interface: ComponentConfigurer

Called internally by the SDK to create an implementation instance. Applications should not need to call this method.

Specified by:

build in interface ComponentConfigurer<DataSource>

Parameters:

context - provides configuration properties and other components from the current SDK client instance

Returns:

a instance of the component type