Package com.google.appengine.tools.development.testing

Class LocalDatastoreServiceTestConfig

java.lang.Object

com.google.appengine.tools.development.testing.LocalDatastoreServiceTestConfig

All Implemented Interfaces:

LocalServiceTestConfig

public final class LocalDatastoreServiceTestConfig
extends Object
implements LocalServiceTestConfig

Config for accessing the local datastore service in tests. Default behavior is to configure the local datastore to only store data in-memory, to not write anything to disk, and for all jobs to apply on the first attempt. tearDown() wipes out all in-memory state so that the datastore is empty at the end of every test.

Constructor Summary

Constructors

Constructor	Description
LocalDatastoreServiceTestConfig()

Method Summary

Modifier and Type	Method	Description
Class<? extends HighRepJobPolicy>	getAlternateHighRepJobPolicyClass()
LocalDatastoreService.AutoIdAllocationPolicy	getAutoIdAllocationPolicy()
String	getBackingStoreLocation()
Long	getDefaultHighRepJobPolicyRandomSeed()
Float	getDefaultHighRepJobPolicyUnappliedJobPercentage()
static LocalDatastoreV3Service	getLocalDatastoreService()
Integer	getMaxQueryLifetimeMs()
Integer	getMaxTxnLifetimeMs()
Integer	getStoreDelayMs()
boolean	isNoIndexAutoGen()
boolean	isNoStorage()
LocalDatastoreServiceTestConfig	setAlternateHighRepJobPolicyClass(Class<? extends HighRepJobPolicy> alternateHighRepJobPolicyClass)	An alternate HighRepJobPolicy implementation.
LocalDatastoreServiceTestConfig	setApplyAllHighRepJobPolicy()	Make the datastore a high-replication datastore, but with all jobs applying immediately (simplifies tests that use eventually-consistent queries).
LocalDatastoreServiceTestConfig	setAutoIdAllocationPolicy(LocalDatastoreService.AutoIdAllocationPolicy autoIdAllocationPolicy)	Dictate how Put() assigns auto IDs.
LocalDatastoreServiceTestConfig	setBackingStoreLocation(String backingStoreLocation)	Where to read/store the datastore from/to.
LocalDatastoreServiceTestConfig	setDefaultHighRepJobPolicyRandomSeed(long defaultHighRepJobPolicyRandomSeed)	A seed for a Random used by DefaultHighRepJobPolicy to determine whether or not a job application attempt fails.
LocalDatastoreServiceTestConfig	setDefaultHighRepJobPolicyUnappliedJobPercentage(float defaultHighRepJobPolicyUnappliedJobPercentage)	The percentage of job application attempts that will fail.
LocalDatastoreServiceTestConfig	setMaxQueryLifetimeMs(int maxQueryLifetimeMs)	Sets how long a query can stay "live" before we expire it.
LocalDatastoreServiceTestConfig	setMaxTxnLifetimeMs(int maxTxnLifetimeMs)	Sets how long a txn can stay "live" before we expire it.
LocalDatastoreServiceTestConfig	setNoIndexAutoGen(boolean noIndexAutoGen)	True to prevent the datastore from writing the auto-generated index file.
LocalDatastoreServiceTestConfig	setNoStorage(boolean noStorage)	True to put the datastore into "memory-only" mode.
LocalDatastoreServiceTestConfig	setStoreDelayMs(int storeDelayMs)	Sets how long to wait before updating the persistent store.
void	setUp()	Set up the local service.
void	tearDown()	Tear down the local service.

Methods inherited from class java.lang.Object

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

Constructor Details

LocalDatastoreServiceTestConfig

public LocalDatastoreServiceTestConfig()

Method Details

isNoStorage

public boolean isNoStorage()

setNoStorage

public LocalDatastoreServiceTestConfig setNoStorage(boolean noStorage)

True to put the datastore into "memory-only" mode.

Parameters:

noStorage -

Returns:

this (for chaining)

getAutoIdAllocationPolicy

public LocalDatastoreService.AutoIdAllocationPolicy getAutoIdAllocationPolicy()

setAutoIdAllocationPolicy

public LocalDatastoreServiceTestConfig setAutoIdAllocationPolicy(LocalDatastoreService.AutoIdAllocationPolicy autoIdAllocationPolicy)

Dictate how Put() assigns auto IDs.

Parameters:

autoIdAllocationPolicy -

Returns:

this (for chaining)

getMaxQueryLifetimeMs

public Integer getMaxQueryLifetimeMs()

setMaxQueryLifetimeMs

public LocalDatastoreServiceTestConfig setMaxQueryLifetimeMs(int maxQueryLifetimeMs)

Sets how long a query can stay "live" before we expire it.

Parameters:

maxQueryLifetimeMs -

Returns:

this (for chaining)

getMaxTxnLifetimeMs

public Integer getMaxTxnLifetimeMs()

setMaxTxnLifetimeMs

public LocalDatastoreServiceTestConfig setMaxTxnLifetimeMs(int maxTxnLifetimeMs)

Sets how long a txn can stay "live" before we expire it.

Parameters:

maxTxnLifetimeMs -

Returns:

this (for chaining)

getStoreDelayMs

public Integer getStoreDelayMs()

setStoreDelayMs

public LocalDatastoreServiceTestConfig setStoreDelayMs(int storeDelayMs)

Sets how long to wait before updating the persistent store. Only useful if isNoStorage() returns false.

Parameters:

storeDelayMs -

Returns:

this (for chaining)

getBackingStoreLocation

public String getBackingStoreLocation()

setBackingStoreLocation

public LocalDatastoreServiceTestConfig setBackingStoreLocation(String backingStoreLocation)

Where to read/store the datastore from/to.

Parameters:

backingStoreLocation -

Returns:

this (for chaining)

isNoIndexAutoGen

public boolean isNoIndexAutoGen()

setNoIndexAutoGen

public LocalDatastoreServiceTestConfig setNoIndexAutoGen(boolean noIndexAutoGen)

True to prevent the datastore from writing the auto-generated index file.

Parameters:

noIndexAutoGen -

Returns:

this (for chaining)

getDefaultHighRepJobPolicyRandomSeed

public Long getDefaultHighRepJobPolicyRandomSeed()

setDefaultHighRepJobPolicyRandomSeed

public LocalDatastoreServiceTestConfig setDefaultHighRepJobPolicyRandomSeed(long defaultHighRepJobPolicyRandomSeed)

A seed for a Random used by DefaultHighRepJobPolicy to determine whether or not a job application attempt fails. This method cannot be used in combination with setAlternateHighRepJobPolicyClass(Class).

Parameters:

defaultHighRepJobPolicyRandomSeed - The random seed.

Returns:

this (for chaining)

Throws:

IllegalArgumentException - If setAlternateHighRepJobPolicyClass(Class) has been called.

getDefaultHighRepJobPolicyUnappliedJobPercentage

public Float getDefaultHighRepJobPolicyUnappliedJobPercentage()

setDefaultHighRepJobPolicyUnappliedJobPercentage

public LocalDatastoreServiceTestConfig setDefaultHighRepJobPolicyUnappliedJobPercentage(float defaultHighRepJobPolicyUnappliedJobPercentage)

The percentage of job application attempts that will fail. Must be >= 0 and invalid input: '<'= 100. This validation is performed during the initialization of LocalDatastoreService, not in the setter, so it will not fail fast. In addition, any portion of the value beyond two decimal places will be truncated. This method cannot be used in combination with setAlternateHighRepJobPolicyClass(Class).

Parameters:

defaultHighRepJobPolicyUnappliedJobPercentage - The percentage of job application attempts that should fail.

Returns:

this (for chaining)

Throws:

IllegalArgumentException - If setAlternateHighRepJobPolicyClass(Class) has been called.

getAlternateHighRepJobPolicyClass

public Class<? extends HighRepJobPolicy> getAlternateHighRepJobPolicyClass()

setAlternateHighRepJobPolicyClass

public LocalDatastoreServiceTestConfig setAlternateHighRepJobPolicyClass(Class<? extends HighRepJobPolicy> alternateHighRepJobPolicyClass)

An alternate HighRepJobPolicy implementation. The class must have a no-arg constructor, but this validation is performed during the iniitialization of LocalDatastoreService, not in the setter, so it will not fail fast. This method cannot be used in combination with setDefaultHighRepJobPolicyRandomSeed(long) or setDefaultHighRepJobPolicyUnappliedJobPercentage(float).

Parameters:

alternateHighRepJobPolicyClass - The HighRepJobPolicy implementation.

Returns:

this (for chaining)

Throws:

IllegalArgumentException - If setDefaultHighRepJobPolicyRandomSeed(long) or setDefaultHighRepJobPolicyUnappliedJobPercentage(float) has been called.

setApplyAllHighRepJobPolicy

public LocalDatastoreServiceTestConfig setApplyAllHighRepJobPolicy()

Make the datastore a high-replication datastore, but with all jobs applying immediately (simplifies tests that use eventually-consistent queries).

setUp

public void setUp()

Description copied from interface: LocalServiceTestConfig

Set up the local service.

Specified by:

setUp in interface LocalServiceTestConfig

tearDown

public void tearDown()

Description copied from interface: LocalServiceTestConfig

Tear down the local service.

Specified by:

tearDown in interface LocalServiceTestConfig

getLocalDatastoreService

public static LocalDatastoreV3Service getLocalDatastoreService()