kalix.javasdk.testkit.MockRegistry Maven / Gradle / Ivy
/*
* Copyright 2021 Lightbend Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package kalix.javasdk.testkit;
import kalix.javasdk.testkit.impl.MockRegistryImpl;
/**
* This trait is meant to allow for unit testing when a service has cross-component or cross-service
* calls. The set of mocks or stubs will be matched by its class type upon a call of an external
* component or service.
*/
public interface MockRegistry {
/**
* Returns a new MockRegistry with the new mock added to previous ones.
*
* @param clazz The class type used to identify the mock.
* @param instance The instance object to be used as a mock-
* @return A copy of this MockRegistry.
* @param The service interface to be mocked.
*/
MockRegistry withMock(Class clazz, T instance);
/**
* Returns an empty instance of MockRegistry that can be chained with `withMock`
*
* @return a new instance of MockRegistry
*/
static MockRegistry create() {
return MockRegistryImpl.empty();
}
MockRegistry EMPTY = MockRegistryImpl.empty();
}