Package net.officefloor.nosql.firestore.test

Class AbstractFirestoreConnectJunit

java.lang.Object

net.officefloor.nosql.firestore.test.AbstractFirestoreConnectJunit

Direct Known Subclasses:

AbstractFirestoreJunit, FirestoreConnectExtension, FirestoreConnectRule

public class AbstractFirestoreConnectJunit
extends Object

Abstract JUnit connect Firestore functionality.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractFirestoreConnectJunit.Configuration	Configuration of Firestore.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_EMULATOR_START_TIMEOUT	Default timeout for starting the emulator.
static final int	DEFAULT_LOCAL_FIRESTORE_PORT	Default local Firestore port.
static final String	DEFAULT_PROJECT_ID	Default project id.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	extendStart()	Extends starting Firestore.
protected void	extendStop()	Extends stopping Firestore.
com.google.cloud.firestore.Firestore	getFirestore()	Obtains the Firestore.
protected int	getFirestorePort()	Obtains port Firestore running on.
protected void	startFirestore()	Start Firestore connection.
protected void	stopFirestore()	Stops connection to Firestore.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOCAL_FIRESTORE_PORT

public static final int DEFAULT_LOCAL_FIRESTORE_PORT

Default local Firestore port.

See Also:

• Constant Field Values

DEFAULT_EMULATOR_START_TIMEOUT

public static final int DEFAULT_EMULATOR_START_TIMEOUT

Default timeout for starting the emulator.

See Also:

• Constant Field Values

DEFAULT_PROJECT_ID

public static final String DEFAULT_PROJECT_ID

Default project id.

See Also:

• Constant Field Values

Constructor Details

AbstractFirestoreConnectJunit

public AbstractFirestoreConnectJunit()

Instantiate with default AbstractFirestoreConnectJunit.Configuration.

AbstractFirestoreConnectJunit

public AbstractFirestoreConnectJunit(AbstractFirestoreConnectJunit.Configuration configuration)

Instantiate.

Parameters:

configuration - AbstractFirestoreConnectJunit.Configuration.

Method Details

getFirestorePort

protected int getFirestorePort()

Obtains port Firestore running on.

Returns:

Port Firestore running on.

getFirestore

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

Obtains the Firestore.

Returns:

Firestore.

startFirestore

protected void startFirestore()
                       throws Exception

Start Firestore connection.

Throws:

Exception - If fails to start.

extendStart

protected void extendStart()
                    throws Exception

Extends starting Firestore.

Throws:

Exception - If fails extending start.

stopFirestore

protected void stopFirestore()
                      throws Exception

Stops connection to Firestore.

Throws:

Exception - If fails to stop.

extendStop

protected void extendStop()
                   throws Exception

Extends stopping Firestore.

Throws:

Exception - If fails extending stop.