Package net.officefloor.nosql.firestore.test

Class AbstractFirestoreJunit<T extends AbstractFirestoreJunit<T>>

java.lang.Object

net.officefloor.nosql.firestore.test.AbstractFirestoreConnectJunit

net.officefloor.nosql.firestore.test.AbstractFirestoreJunit<T>

Direct Known Subclasses:

FirestoreExtension, FirestoreRule, MavenFirestore

public abstract class AbstractFirestoreJunit<T extends AbstractFirestoreJunit<T>>
extends AbstractFirestoreConnectJunit

Abstract JUnit Firestore functionality.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.nosql.firestore.test.AbstractFirestoreConnectJunit

AbstractFirestoreConnectJunit.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIRESTORE_IMAGE_NAME	Docker image name for the Firestore emulator.
static final String	FIRESTORE_TAG_NAME	Docker tag name for the Firestore emulator.

Fields inherited from class net.officefloor.nosql.firestore.test.AbstractFirestoreConnectJunit

DEFAULT_EMULATOR_START_TIMEOUT, DEFAULT_LOCAL_FIRESTORE_PORT, DEFAULT_PROJECT_ID

Constructor Summary

Constructors

Constructor	Description
AbstractFirestoreJunit()	Instantiate with default AbstractFirestoreConnectJunit.Configuration.
AbstractFirestoreJunit(AbstractFirestoreConnectJunit.Configuration configuration)	Instantiate.

Method Summary

Modifier and Type	Method	Description
protected void	extendStart()	Extends starting Firestore.
protected void	extendStop()	Extends stopping Firestore.
String	getEmulatorHost()	Obtains the emulator host.
com.google.cloud.firestore.Firestore	getFirestore()	Obtains the Firestore.
T	waitForFirestore(boolean isWaitForFirestore)	Sets up to wait for Firestore to be available.

Methods inherited from class net.officefloor.nosql.firestore.test.AbstractFirestoreConnectJunit

getFirestorePort, startFirestore, stopFirestore

Methods inherited from class java.lang.Object

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

Field Details

FIRESTORE_IMAGE_NAME

public static final String FIRESTORE_IMAGE_NAME

Docker image name for the Firestore emulator.

See Also:

• Constant Field Values

FIRESTORE_TAG_NAME

public static final String FIRESTORE_TAG_NAME

Docker tag name for the Firestore emulator.

See Also:

• Constant Field Values

Constructor Details

AbstractFirestoreJunit

public AbstractFirestoreJunit()

Instantiate with default AbstractFirestoreConnectJunit.Configuration.

AbstractFirestoreJunit

public AbstractFirestoreJunit(AbstractFirestoreConnectJunit.Configuration configuration)

Instantiate.

Parameters:

configuration - AbstractFirestoreConnectJunit.Configuration.

Method Details

waitForFirestore

public T waitForFirestore(boolean isWaitForFirestore)

Sets up to wait for Firestore to be available.

Parameters:

isWaitForFirestore - Indicates if wait for Firestore to be available.

Returns:

this.

getEmulatorHost

public String getEmulatorHost()

Obtains the emulator host.

Returns:

Emulator host.

extendStart

protected void extendStart()
                    throws Exception

Description copied from class: AbstractFirestoreConnectJunit

Extends starting Firestore.

Overrides:

extendStart in class AbstractFirestoreConnectJunit

Throws:

Exception - If fails extending start.

getFirestore

public com.google.cloud.firestore.Firestore getFirestore()

Description copied from class: AbstractFirestoreConnectJunit

Obtains the Firestore.

Overrides:

getFirestore in class AbstractFirestoreConnectJunit

Returns:

Firestore.

extendStop

protected void extendStop()
                   throws Exception

Description copied from class: AbstractFirestoreConnectJunit

Extends stopping Firestore.

Overrides:

extendStop in class AbstractFirestoreConnectJunit

Throws:

Exception - If fails extending stop.