kalix.javasdk.testkit.junit.KalixTestKitResource Maven / Gradle / Ivy
/*
* Copyright 2024 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.junit;
import akka.actor.ActorSystem;
import akka.grpc.GrpcClientSettings;
import akka.stream.Materializer;
import kalix.javasdk.Kalix;
import kalix.javasdk.impl.MessageCodec;
import kalix.javasdk.testkit.EventingTestKit;
import kalix.javasdk.testkit.EventingTestKit.IncomingMessages;
import kalix.javasdk.testkit.EventingTestKit.OutgoingMessages;
import kalix.javasdk.testkit.EventingTestKit.Topic;
import kalix.javasdk.testkit.KalixTestKit;
import org.junit.rules.ExternalResource;
/**
* A JUnit 4 external resource for {@link KalixTestKit}, which automatically manages the lifecycle of
* the testkit. The testkit will be automatically stopped when the test completes or fails.
*
* If you prefer JUnit 5 "Jupiter" use {@link KalixTestKitExtension}.
*
* Example:
*
*
* import kalix.javasdk.testkit.junit.KalixTestKitResource;
*
* public class MyKalixIntegrationTest {
*
* private static final Kalix MY_KALIX = new Kalix(); // with registered services
*
* @ClassRule
* public static final KalixTestKitResource testKit = new KalixTestKitResource(MY_KALIX);
*
* private final MyServiceClient client; // generated Akka gRPC client
*
* public MyKalixIntegrationTest() {
* this.client = MyServiceClient.create(testKit.getGrpcClientSettings(), testKit.getActorSystem());
* }
*
* @Test
* public void test() {
* // use client to test service
* }
* }
*
*/
public final class KalixTestKitResource extends ExternalResource {
private final KalixTestKit testKit;
public KalixTestKitResource(Kalix kalix) {
this(kalix, kalix.getMessageCodec(), KalixTestKit.Settings.DEFAULT);
}
public KalixTestKitResource(Kalix kalix, KalixTestKit.Settings settings) {
this(kalix, kalix.getMessageCodec(), settings);
}
public KalixTestKitResource(Kalix kalix, MessageCodec messageCodec, KalixTestKit.Settings settings) {
this.testKit = new KalixTestKit(kalix, messageCodec, settings);
}
/**
* JUnit4 support - rule based
*/
@Override
protected void before() {
testKit.start();
}
/**
* JUnit4 support - rule based
*/
@Override
protected void after() {
testKit.stop();
}
/**
* Use getTopicIncomingMessages or getTopicOutgoingMessages instead.
*
* If your Kalix service publishes or consumes from/to an eventing services (i.e. kafka or pub/sub),
* this will allow assertions on messages consumed / produced to such broker.
*
* @param topic name of the topic to interact with
* @return a structure to allow interactions with a topic
*/
@Deprecated
public Topic getTopic(String topic) {
return testKit.getTopic(topic);
}
/**
* Get incoming messages for ValueEntity.
*
* @param typeId @TypeId or entity_type of the ValueEntity (depending on the used SDK)
*/
public IncomingMessages getValueEntityIncomingMessages(String typeId) {
return testKit.getValueEntityIncomingMessages(typeId);
}
/**
* Get incoming messages for EventSourcedEntity.
*
* @param typeId @TypeId or entity_type of the EventSourcedEntity (depending on the used SDK)
*/
public IncomingMessages getEventSourcedEntityIncomingMessages(String typeId) {
return testKit.getEventSourcedEntityIncomingMessages(typeId);
}
/**
* Get incoming messages for Stream (eventing.in.direct in case of protobuf SDKs).
*
* @param service service name
* @param streamId service stream id
*/
public IncomingMessages getStreamIncomingMessages(String service, String streamId) {
return testKit.getStreamIncomingMessages(service, streamId);
}
/**
* Get incoming messages for Topic.
*
* @param topic topic name
*/
public IncomingMessages getTopicIncomingMessages(String topic) {
return testKit.getTopicIncomingMessages(topic);
}
/**
* Get mocked topic destination.
*
* @param topic topic name
*/
public OutgoingMessages getTopicOutgoingMessages(String topic) {
return testKit.getTopicOutgoingMessages(topic);
}
/**
* Returns {@link kalix.javasdk.testkit.EventingTestKit.MessageBuilder} utility
* to create {@link kalix.javasdk.testkit.EventingTestKit.Message}s for the eventing testkit.
*/
public EventingTestKit.MessageBuilder getMessageBuilder() {
return testKit.getMessageBuilder();
}
/**
* Get the host name/IP address where the Kalix service is available. This is relevant in certain
* Continuous Integration environments.
*
* @return Kalix host
*/
public String getHost() {
return testKit.getHost();
}
/**
* Get the local port where the Kalix service is available.
*
* @return local Kalix port
*/
public int getPort() {
return testKit.getPort();
}
/**
* Get an Akka gRPC client for the given service name. The same client instance is shared for the
* test. The lifecycle of the client is managed by the SDK and it should not be stopped by user
* code.
*
* @param The "service" interface generated for the service by Akka gRPC
* @param clientClass The class of a gRPC service generated by Akka gRPC
*/
public T getGrpcClient(Class clientClass) {
return testKit.getGrpcClient(clientClass);
}
/**
* An Akka Stream materializer to use for running streams. Needed for example in a command handler
* which accepts streaming elements but returns a single async reply once all streamed elements
* has been consumed.
*/
public Materializer getMaterializer() {
return testKit.getMaterializer();
}
/**
* Get an {@link ActorSystem} for creating Akka HTTP clients.
*
* @return test actor system
*/
public ActorSystem getActorSystem() {
return testKit.getActorSystem();
}
/**
* Get {@link GrpcClientSettings} for creating Akka gRPC clients.
*
* @return test gRPC client settings
* @deprecated Use getGrpcClient instead.
*/
@Deprecated(since = "0.8.1", forRemoval = true)
public GrpcClientSettings getGrpcClientSettings() {
return testKit.getGrpcClientSettings();
}
}