Skip to content

Use TypesenseContainer for Service Connection #1785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following service connection factories are provided in the `spring-ai-spring
| Containers of type `QdrantContainer`

| `TypesenseConnectionDetails`
| Containers named "typesense/typesense"
| Containers of type `TypesenseContainer`

| `WeaviateConnectionDetails`
| Containers of type `WeaviateContainer`
Expand Down
7 changes: 7 additions & 0 deletions spring-ai-spring-boot-autoconfigure/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,13 @@
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>typesense</artifactId>
<version>1.20.4</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>weaviate</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@

package org.springframework.ai.autoconfigure.vectorstore.typesense;

import java.time.Duration;
import java.util.List;
import java.util.Map;

import io.micrometer.observation.tck.TestObservationRegistry;
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.typesense.TypesenseContainer;

import org.springframework.ai.ResourceUtils;
import org.springframework.ai.document.Document;
Expand Down Expand Up @@ -53,10 +52,7 @@
public class TypesenseVectorStoreAutoConfigurationIT {

@Container
private static final GenericContainer<?> typesenseContainer = new GenericContainer<>("typesense/typesense:26.0")
.withExposedPorts(8108)
.withCommand("--data-dir", "/tmp", "--api-key=xyz", "--enable-cors")
.withStartupTimeout(Duration.ofSeconds(100));
private static final TypesenseContainer typesense = new TypesenseContainer("typesense/typesense:26.0");

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(TypesenseVectorStoreAutoConfiguration.class))
Expand All @@ -73,10 +69,10 @@ public void addAndSearch() {
.withPropertyValues("spring.ai.vectorstore.typesense.embeddingDimension=384",
"spring.ai.vectorstore.typesense.collectionName=myTestCollection",
"spring.ai.vectorstore.typesense.initialize-schema=true",
"spring.ai.vectorstore.typesense.client.apiKey=xyz",
"spring.ai.vectorstore.typesense.client.apiKey=" + typesense.getApiKey(),
"spring.ai.vectorstore.typesense.client.protocol=http",
"spring.ai.vectorstore.typesense.client.host=" + typesenseContainer.getHost(),
"spring.ai.vectorstore.typesense.client.port=" + typesenseContainer.getMappedPort(8108).toString())
"spring.ai.vectorstore.typesense.client.host=" + typesense.getHost(),
"spring.ai.vectorstore.typesense.client.port=" + typesense.getHttpPort())
.run(context -> {
VectorStore vectorStore = context.getBean(VectorStore.class);
TestObservationRegistry observationRegistry = context.getBean(TestObservationRegistry.class);
Expand Down
7 changes: 7 additions & 0 deletions spring-ai-spring-boot-testcontainers/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,13 @@
<artifactId>ollama</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>typesense</artifactId>
<version>1.20.4</version>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.opensearch</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

package org.springframework.ai.testcontainers.service.connection.typesense;

import org.testcontainers.containers.Container;
import org.testcontainers.typesense.TypesenseContainer;

import org.springframework.ai.autoconfigure.vectorstore.typesense.TypesenseConnectionDetails;
import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
Expand All @@ -26,24 +26,21 @@
* @author Eddú Meléndez
*/
class TypesenseContainerConnectionDetailsFactory
extends ContainerConnectionDetailsFactory<Container<?>, TypesenseConnectionDetails> {

TypesenseContainerConnectionDetailsFactory() {
super("typesense/typesense");
}
extends ContainerConnectionDetailsFactory<TypesenseContainer, TypesenseConnectionDetails> {

@Override
protected TypesenseConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
protected TypesenseConnectionDetails getContainerConnectionDetails(
ContainerConnectionSource<TypesenseContainer> source) {
return new TypesenseContainerConnectionDetails(source);
}

/**
* {@link TypesenseConnectionDetails} backed by a {@link ContainerConnectionSource}.
*/
private static final class TypesenseContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
implements TypesenseConnectionDetails {
private static final class TypesenseContainerConnectionDetails
extends ContainerConnectionDetails<TypesenseContainer> implements TypesenseConnectionDetails {

private TypesenseContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
private TypesenseContainerConnectionDetails(ContainerConnectionSource<TypesenseContainer> source) {
super(source);
}

Expand All @@ -59,12 +56,12 @@ public String getProtocol() {

@Override
public int getPort() {
return getContainer().getMappedPort(8108);
return Integer.parseInt(getContainer().getHttpPort());
}

@Override
public String getApiKey() {
return getContainer().getEnvMap().get("TYPESENSE_API_KEY");
return getContainer().getApiKey();
}

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@

package org.springframework.ai.testcontainers.service.connection.typesense;

import java.time.Duration;
import java.util.List;
import java.util.Map;

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.typesense.TypesenseContainer;

import org.springframework.ai.ResourceUtils;
import org.springframework.ai.autoconfigure.vectorstore.typesense.TypesenseVectorStoreAutoConfiguration;
Expand Down Expand Up @@ -51,11 +50,7 @@ class TypesenseContainerConnectionDetailsFactoryIT {

@Container
@ServiceConnection
private static final GenericContainer<?> typesense = new GenericContainer<>(TypesenseImage.DEFAULT_IMAGE)
.withExposedPorts(8108)
.withCommand("--data-dir", "/tmp", "--enable-cors")
.withEnv("TYPESENSE_API_KEY", "secret")
.withStartupTimeout(Duration.ofSeconds(100));
private static final TypesenseContainer typesense = new TypesenseContainer(TypesenseImage.DEFAULT_IMAGE);

List<Document> documents = List.of(
new Document(ResourceUtils.getText("classpath:/test/data/spring.ai.txt"), Map.of("spring", "great")),
Expand Down
7 changes: 7 additions & 0 deletions vector-stores/spring-ai-typesense-store/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>typesense</artifactId>
<version>1.20.4</version>
<scope>test</scope>
</dependency>


<dependency>
<groupId>io.micrometer</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@
import java.util.UUID;

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.GenericContainer;

import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.typesense.TypesenseContainer;
import org.typesense.api.Client;
import org.typesense.api.Configuration;
import org.typesense.resources.Node;
Expand Down Expand Up @@ -58,9 +59,7 @@
public class TypesenseVectorStoreIT {

@Container
private static GenericContainer<?> typesenseContainer = new GenericContainer<>(TypesenseImage.DEFAULT_IMAGE)
.withExposedPorts(8108)
.withCommand("--data-dir", "/tmp", "--api-key=xyz", "--enable-cors");
private static TypesenseContainer typesense = new TypesenseContainer(TypesenseImage.DEFAULT_IMAGE);

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withUserConfiguration(TestApplication.class);
Expand Down Expand Up @@ -262,10 +261,9 @@ public VectorStore vectorStore(Client client, EmbeddingModel embeddingModel) {
@Bean
public Client typesenseClient() {
List<Node> nodes = new ArrayList<>();
nodes
.add(new Node("http", typesenseContainer.getHost(), typesenseContainer.getMappedPort(8108).toString()));
nodes.add(new Node("http", typesense.getHost(), typesense.getMappedPort(8108).toString()));

Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), "xyz");
Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), typesense.getApiKey());
return new Client(configuration);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
import io.micrometer.observation.tck.TestObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistryAssert;
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.typesense.TypesenseContainer;
import org.typesense.api.Client;
import org.typesense.api.Configuration;
import org.typesense.resources.Node;
Expand Down Expand Up @@ -57,16 +57,15 @@
/**
* @author Christian Tzolov
* @author Thomas Vitale
* @author Eddú Meléndez
*/
@Testcontainers
public class TypesenseVectorStoreObservationIT {

private static final String TEST_COLLECTION_NAME = "test_vector_store";

@Container
private static GenericContainer<?> typesenseContainer = new GenericContainer<>(TypesenseImage.DEFAULT_IMAGE)
.withExposedPorts(8108)
.withCommand("--data-dir", "/tmp", "--api-key=xyz", "--enable-cors");
private static TypesenseContainer typesense = new TypesenseContainer(TypesenseImage.DEFAULT_IMAGE);

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withUserConfiguration(Config.class);
Expand Down Expand Up @@ -183,10 +182,9 @@ public VectorStore vectorStore(Client client, EmbeddingModel embeddingModel,
@Bean
public Client typesenseClient() {
List<Node> nodes = new ArrayList<>();
nodes
.add(new Node("http", typesenseContainer.getHost(), typesenseContainer.getMappedPort(8108).toString()));
nodes.add(new Node("http", typesense.getHost(), typesense.getMappedPort(8108).toString()));

Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), "xyz");
Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), typesense.getApiKey());
return new Client(configuration);
}

Expand Down
Loading