Support ChromaDB's CHROMA_SERVER_AUTHN_CREDENTIALS env var in Docker Compose and Testcontainers

Read `CHROMA_SERVER_AUTHN_CREDENTIALS` env var from compose file and
Testcontainers definition to configure the connection details for
ChromaDB.
This commit is contained in:
Eddú Meléndez
2024-06-18 21:34:24 -05:00
committed by Christian Tzolov
parent b134a8d7ea
commit e4607a6c29
13 changed files with 242 additions and 14 deletions

View File

@@ -45,12 +45,15 @@ public class ChromaDockerComposeConnectionDetailsFactory
static class ChromaDockerComposeConnectionDetails extends DockerComposeConnectionDetails
implements ChromaConnectionDetails {
private final ChromaEnvironment environment;
private final String host;
private final int port;
ChromaDockerComposeConnectionDetails(RunningService service) {
super(service);
this.environment = new ChromaEnvironment(service.env());
this.host = service.host();
this.port = service.ports().get(CHROMA_PORT);
}
@@ -65,6 +68,11 @@ public class ChromaDockerComposeConnectionDetailsFactory
return this.port;
}
@Override
public String getKeyToken() {
return this.environment.getKeyToken();
}
}
}

View File

@@ -0,0 +1,32 @@
/*
* Copyright 2023 - 2024 the original author or authors.
*
* 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
*
* https://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 org.springframework.ai.docker.compose.service.connection.chroma;
import java.util.Map;
class ChromaEnvironment {
private final String keyToken;
ChromaEnvironment(Map<String, String> env) {
this.keyToken = env.get("CHROMA_SERVER_AUTHN_CREDENTIALS");
}
public String getKeyToken() {
return this.keyToken;
}
}

View File

@@ -0,0 +1,39 @@
/*
* Copyright 2023 - 2024 the original author or authors.
*
* 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
*
* https://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 org.springframework.ai.docker.compose.service.connection.chroma;
import org.junit.jupiter.api.Test;
import java.util.Collections;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
class ChromaEnvironmentTests {
@Test
void getKeyTokenWhenNoCredential() {
ChromaEnvironment environment = new ChromaEnvironment(Collections.emptyMap());
assertThat(environment.getKeyToken()).isNull();
}
@Test
void getKeyTokenWhenHasCredential() {
ChromaEnvironment environment = new ChromaEnvironment(Map.of("CHROMA_SERVER_AUTHN_CREDENTIALS", "secret"));
assertThat(environment.getKeyToken()).isEqualTo("secret");
}
}

View File

@@ -0,0 +1,39 @@
/*
* Copyright 2023 - 2024 the original author or authors.
*
* 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
*
* https://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 org.springframework.ai.docker.compose.service.connection.chroma;
import org.junit.jupiter.api.Test;
import org.springframework.ai.autoconfigure.vectorstore.chroma.ChromaConnectionDetails;
import org.springframework.boot.docker.compose.service.connection.test.AbstractDockerComposeIntegrationTests;
import org.testcontainers.utility.DockerImageName;
import static org.assertj.core.api.Assertions.assertThat;
class ChromaWithTokenDockerComposeConnectionDetailsFactoryTests extends AbstractDockerComposeIntegrationTests {
ChromaWithTokenDockerComposeConnectionDetailsFactoryTests() {
super("chroma-with-token-compose.yaml", DockerImageName.parse("chromadb/chroma"));
}
@Test
void runCreatesConnectionDetails() {
ChromaConnectionDetails connectionDetails = run(ChromaConnectionDetails.class);
assertThat(connectionDetails.getHost()).isNotNull();
assertThat(connectionDetails.getPort()).isGreaterThan(0);
assertThat(connectionDetails.getKeyToken()).isEqualTo("secret");
}
}

View File

@@ -0,0 +1,8 @@
services:
chroma:
image: '{imageName}'
ports:
- '8000'
environment:
- CHROMA_SERVER_AUTHN_CREDENTIALS=secret
- CHROMA_SERVER_AUTHN_PROVIDER=chromadb.auth.token_authn.TokenAuthenticationServerProvider