java.lang.Object | |
↳ | com.atlassian.jira.mock.component.MockComponentWorker |
This component worker can be used with the ComponentAccessor
to return mock
instances of components for unit testing.
getComponentOfType(Class)
to resolve the dependency, instead. The drawback is that ComponentAccessor
uses a global, static reference to a ComponentAccessor.Worker
implementation
to accomplish this, and if nothing has initialised that reference, then an
IllegalStateException
is thrown.
Unit tests must be responsible for ensuring that everything they require, directly or
indirectly, is arranged during the test's setup, so a unit test that encounters this
problem should explicitly initialise the component accessor. In most cases, all they
need to do is create and install an instance of this class. For example:
@Before
public void setUp()
{
new MockComponentWorker()
.init()
;
}
The MockComponentWorker
comes with a few mocks by default, including
implementations for common problem areas, such as the UserKeyService
and
the UserPreferencesManager
, so for many tests this will be enough as-is.
If you need additional mocked components to be resolved in this way, then you can
add them as well. An example might look something like this:
@Before
public void setUp()
{
final ApplicationUser fred = new MockApplicationUser("Fred");
final JiraAuthenticationContext jiraAuthenticationContext = Mockito.mock(JiraAuthenticationContext.class);
Mockito.when(jiraAuthenticationContext.getUser()).thenReturn(fred);
Mockito.when(jiraAuthenticationContext.getLoggedInUser()).thenReturn(fred.getDirectoryUser());
new MockComponentWorker()
.addMock
(ConstantsManager.class, new MockStatusConstantsManager())
.addMock
(JiraAuthenticationContext.class, jiraAuthenticationContext)
.init()
;
}
JUnit 4 annotations can also be used to initialise the MockComponentWorker
.
See the
MockComponentContainer
and
MockitoContainer
@Rule
s for examples.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Registers a mock component to be returned by this component worker.
| |||||||||||
Registers a mock component to be returned by this component worker.
| |||||||||||
Obtains the registered mock of the specified interface type.
| |||||||||||
Although the
ComponentAccessor specifies different semantics for this method,
in this mock implementation it behaves identically to getComponent(Class) . | |||||||||||
Although the
ComponentAccessor specifies different semantics for this method,
in this mock implementation it behaves identically to getComponent(Class) . | |||||||||||
Convenience method that just calls
ComponentAccessor .initialiseWorker(this) . | |||||||||||
Registers a mock component to be returned by this component worker.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.component.ComponentAccessor.Worker
|
Registers a mock component to be returned by this component worker.
This method is exactly equivalent toregisterMock(Class, Object)
, except that
it also returns this
, making it possible to use it in the convenient call chaining
style illustrated in the documentation for this class.componentInterface | the interface that the mock component must implement |
---|---|
componentMock | the component that implements the interface |
this
, for convenience
Registers a mock component to be returned by this component worker.
This method accepts a lazy reference to the implementation in order to allow lazy initialisation on first access.componentInterface | the interface that the mock component must implement |
---|---|
componentMockRef | the lazy reference to the component that implements the interface |
this
, for convenience
Obtains the registered mock of the specified interface type. Test code would normally only
need to call this to retrieve access to mocks that were provided automatically (such as the
UserKeyService
) or that the test registered earlier and is now ready to stub.
getComponentOfType(Class)
) to
resolve dependencies. Arguably, this method should throw an exception rather than return
null
when a component is requested without a mock provided for it; however, some
unit tests will resolve the component during construction without the test code path
actually needing to use it, so this method just generates a warning message in the log
for this case.componentClass | the interface for which an implementation is desired |
---|
null
if no mock implementation has been
provided for it.
Although the ComponentAccessor
specifies different semantics for this method,
in this mock implementation it behaves identically to getComponent(Class)
.
componentClass | as for getComponent(Class) |
---|
getComponent(Class)
Although the ComponentAccessor
specifies different semantics for this method,
in this mock implementation it behaves identically to getComponent(Class)
.
componentClass | as for getComponent(Class) |
---|
getComponent(Class)
Convenience method that just calls
ComponentAccessor
.initialiseWorker(this)
.
If you are developing a plugin that must support JIRA versions prior to v6.0, then that @Internal
method must be used directly, instead.
Registers a mock component to be returned by this component worker.
SinceaddMock(Class, Object)
is identical but also returns this
for call chaining, it may be more convenient to use.componentInterface | the interface that the mock component must implement |
---|---|
componentMock | the component that implements the interface |