com.hcl.domino.keep.testhelper

Class AbstractDatabaseHandlerTest

java.lang.Object

com.hcl.domino.keep.testhelper.AbstractDatabaseHandlerTest

Direct Known Subclasses:

BaseTestForEverythingList, CancelAgentTest, ExecuteAgentTest, ExecuteAgentWithContextTest, UpdateDelegationTest, UpdateKeepConfigTest

public abstract class AbstractDatabaseHandlerTest
extends java.lang.Object

The bulk of our class implementation are implementations of AsyncDominoJNX and the extension interfaces in the com.hcl.domino.keep.dbrequests package To facilitate testing of those, this base class provides the standard objects we need to mock in order to minimize boilerplate code in our test execution

Field Summary

Fields

Modifier and Type	Field and Description
protected com.hcl.domino.security.Acl	acl
protected com.hcl.domino.security.AclAccess	aclAccess
protected com.hcl.domino.DominoClient	client
protected com.hcl.domino.data.Database	db
protected java.lang.String	eventbusId
protected MockKeepFactory	factory
protected io.vertx.core.json.JsonObject	incoming
protected static org.slf4j.Logger	logger
protected java.lang.AutoCloseable	mockHolder
protected com.hcl.domino.keep.dbrequests.KeepJnxSession	s
protected TestSubscriberJson	subscriber

Constructor Summary

Constructors

Constructor and Description
AbstractDatabaseHandlerTest()

Method Summary

Modifier and Type	Method and Description
protected void	beforeEach(io.vertx.core.Vertx vertx)
protected void	beforeEach2(org.junit.jupiter.api.TestInfo testInfo)
protected void	beforeEachEnd(org.junit.jupiter.api.TestInfo testInfo)
protected void	expectFailure(java.lang.Class<? extends java.lang.Exception> clazz, com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params, java.lang.String errorMessage)
protected void	expectFailure(java.lang.Class<? extends java.lang.Exception> clazz, com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params) Shortcut function to capture failing UnitTest that throw Exceptions
protected void	expectFailure(java.lang.Class<? extends java.lang.Exception> clazz, com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params, java.lang.String errorMessage) Shortcut function to capture failing UnitTest that throw Exceptions
protected void	expectFailureBuffer(java.lang.Class<? extends java.lang.Exception> clazz, com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params) Shortcut function to capture failing UnitTest that throw Exceptions
protected void	expectFailureBuffer(java.lang.Class<? extends java.lang.Exception> clazz, com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params, java.lang.String errorMessage) Shortcut function to capture failing UnitTest that throw Exceptions
protected void	expectSuccess(com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request, com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params) Shortcut function to capture success
protected com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer>	getBufferParams(io.reactivex.Observer<io.vertx.core.buffer.Buffer> bufferSubscriber)
protected com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject>	getJsonParams() Provide all the parameters for a successful call to the process() method all database calls rely on

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

s

@Mock
protected com.hcl.domino.keep.dbrequests.KeepJnxSession s

db

@Mock
protected com.hcl.domino.data.Database db

acl

@Mock
protected com.hcl.domino.security.Acl acl

aclAccess

@Mock
protected com.hcl.domino.security.AclAccess aclAccess

client

@Mock
protected com.hcl.domino.DominoClient client

factory

protected MockKeepFactory factory

subscriber

protected TestSubscriberJson subscriber

incoming

protected io.vertx.core.json.JsonObject incoming

mockHolder

protected java.lang.AutoCloseable mockHolder

eventbusId

protected java.lang.String eventbusId

Constructor Detail

AbstractDatabaseHandlerTest

public AbstractDatabaseHandlerTest()

Method Detail

beforeEach

@BeforeEach
protected void beforeEach(io.vertx.core.Vertx vertx)

Parameters:

vertx -

• Runtime

beforeEach2

@BeforeEach
protected void beforeEach2(org.junit.jupiter.api.TestInfo testInfo)

beforeEachEnd

@AfterEach
protected void beforeEachEnd(org.junit.jupiter.api.TestInfo testInfo)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

expectFailure

protected void expectFailure(java.lang.Class<? extends java.lang.Exception> clazz,
                             com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request,
                             com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params,
                             java.lang.String errorMessage)

expectFailure

protected void expectFailure(java.lang.Class<? extends java.lang.Exception> clazz,
                             com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request,
                             com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params)

Shortcut function to capture failing UnitTest that throw Exceptions

Parameters:

clazz -

• the expected Exception class

request -

• the request to process (Interface)

params -

• the JSON request parameters

expectFailure

protected void expectFailure(java.lang.Class<? extends java.lang.Exception> clazz,
                             com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request,
                             com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params,
                             java.lang.String errorMessage)

Shortcut function to capture failing UnitTest that throw Exceptions

Parameters:

clazz -

• the expected Exception class

request -

• the request to process (Interface)

params -

• the JSON request parameters

errorMessage -

• optional the expected error message

expectFailureBuffer

protected void expectFailureBuffer(java.lang.Class<? extends java.lang.Exception> clazz,
                                   com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request,
                                   com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params)

Shortcut function to capture failing UnitTest that throw Exceptions

Parameters:

clazz -

• the expected Exception class

request -

• the request to process (Interface)

params -

• the Buffer request parameters

expectFailureBuffer

protected void expectFailureBuffer(java.lang.Class<? extends java.lang.Exception> clazz,
                                   com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer request,
                                   com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> params,
                                   java.lang.String errorMessage)

Shortcut function to capture failing UnitTest that throw Exceptions

Parameters:

clazz -

• the expected Exception class

request -

• the request to process (Interface)

params -

• the Buffer request parameters

errorMessage -

• optional the expected error message

expectSuccess

protected void expectSuccess(com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson request,
                             com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> params)
                      throws java.lang.Exception

Shortcut function to capture success

Parameters:

request -

• the request to process (Interface)

params -

• the JSON request parameters

Throws:

java.lang.Exception -

• your test was wrong!

getBufferParams

protected com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.buffer.Buffer> getBufferParams(io.reactivex.Observer<io.vertx.core.buffer.Buffer> bufferSubscriber)
                                                                                                   throws com.hcl.domino.keep.exceptions.KeepExceptionMissingParameters

Throws:

com.hcl.domino.keep.exceptions.KeepExceptionMissingParameters

getJsonParams

protected com.hcl.domino.keep.dbrequests.DbRequestParameters<io.vertx.core.json.JsonObject> getJsonParams()
                                                                                                   throws com.hcl.domino.keep.exceptions.KeepExceptionMissingParameters

Provide all the parameters for a successful call to the process() method all database calls rely on

Returns:

the parameters

Throws:

com.hcl.domino.keep.exceptions.KeepExceptionMissingParameters