com.google.cloud.datastore.testing

Class LocalDatastoreHelper

java.lang.Object

com.google.cloud.testing.BaseEmulatorHelper<DatastoreOptions>

com.google.cloud.datastore.testing.LocalDatastoreHelper

public class LocalDatastoreHelper
extends BaseEmulatorHelper<DatastoreOptions>

Utility to start and stop local Google Cloud Datastore process.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.testing.BaseEmulatorHelper

BaseEmulatorHelper.DownloadableEmulatorRunner, BaseEmulatorHelper.EmulatorRunner, BaseEmulatorHelper.GcloudEmulatorRunner

Field Summary

Fields inherited from class com.google.cloud.testing.BaseEmulatorHelper

DEFAULT_HOST, DEFAULT_PORT, PROJECT_ID_PREFIX

Method Summary

Modifier and Type	Method and Description
static LocalDatastoreHelper	create() Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9.
static LocalDatastoreHelper	create(double consistency) Creates a local Datastore helper with the specified settings for project ID and consistency.
double	getConsistency() Returns the consistency setting for the local Datastore emulator.
protected List<BaseEmulatorHelper.EmulatorRunner>	getEmulatorRunners()
protected Logger	getLogger()
DatastoreOptions	getOptions() Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
DatastoreOptions	getOptions(String namespace) Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
void	reset() Reset the internal state of the Datastore emulator.
void	start() Starts the local Datastore emulator through gcloud, downloads and caches the zip file if user does not have gcloud or a compatible emulator version installed.
void	stop(org.joda.time.Duration timeout) Stops the Datastore emulator.

Methods inherited from class com.google.cloud.testing.BaseEmulatorHelper

findAvailablePort, getPort, getProjectId, isWindows, sendPostRequest, startProcess, waitForProcess

Methods inherited from class java.lang.Object

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

Method Detail

getEmulatorRunners

protected List<BaseEmulatorHelper.EmulatorRunner> getEmulatorRunners()

Specified by:

getEmulatorRunners in class BaseEmulatorHelper<DatastoreOptions>

getLogger

protected Logger getLogger()

Specified by:

getLogger in class BaseEmulatorHelper<DatastoreOptions>

getOptions

public DatastoreOptions getOptions()

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.

Specified by:

getOptions in class BaseEmulatorHelper<DatastoreOptions>

getOptions

public DatastoreOptions getOptions(String namespace)

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost. The default namespace is set to namespace.

getConsistency

public double getConsistency()

Returns the consistency setting for the local Datastore emulator.

create

public static LocalDatastoreHelper create(double consistency)

Creates a local Datastore helper with the specified settings for project ID and consistency.

Parameters:

consistency - the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible. Note that setting this to 1.0 may mask incorrect assumptions about the consistency of non-ancestor queries; non-ancestor queries are eventually consistent.

create

public static LocalDatastoreHelper create()

Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9. Consistency refers to the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible.

start

public void start()
           throws IOException,
                  InterruptedException

Starts the local Datastore emulator through gcloud, downloads and caches the zip file if user does not have gcloud or a compatible emulator version installed.

Specified by:

start in class BaseEmulatorHelper<DatastoreOptions>

Throws:

IOException

InterruptedException

reset

public void reset()
           throws IOException

Reset the internal state of the Datastore emulator.

Specified by:

reset in class BaseEmulatorHelper<DatastoreOptions>

Throws:

IOException

stop

public void stop(org.joda.time.Duration timeout)
          throws IOException,
                 InterruptedException,
                 TimeoutException

Stops the Datastore emulator.

Specified by:

stop in class BaseEmulatorHelper<DatastoreOptions>

Throws:

IOException

InterruptedException

TimeoutException