Skip to content

test: Add tests for OpenAiApi.Builder mutation and configuration isolation #4731

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.

Sign up for GitHub

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
wants to merge 1 commit into from
Closed

test: Add tests for OpenAiApi.Builder mutation and configuration isolation #4731

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 65 additions & 0 deletions ...ring-ai-openai/src/test/java/org/springframework/ai/openai/api/OpenAiApiBuilderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import org.opentest4j.AssertionFailedError;

import org.springframework.ai.model.ApiKey;
import org.springframework.ai.model.NoopApiKey;
import org.springframework.ai.model.SimpleApiKey;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
Expand Down Expand Up @@ -275,6 +276,70 @@ void testDifferentApiKeyTypes() {
assertThat(api2).isNotNull();
}

@Test
void testBuilderCreatesIndependentInstances() {
MultiValueMap<String, String> sharedHeaders = new LinkedMultiValueMap<>();
sharedHeaders.add("X-Shared", "value");

OpenAiApi.Builder builder = OpenAiApi.builder()
.apiKey(TEST_API_KEY)
.baseUrl(TEST_BASE_URL)
.headers(sharedHeaders);

OpenAiApi api1 = builder.build();

// Modify the shared headers
sharedHeaders.add("X-Modified", "new-value");

OpenAiApi api2 = builder.build();

// Both APIs should have the modified headers since they share the same reference
assertThat(api1.getHeaders()).containsKey("X-Modified");
assertThat(api2.getHeaders()).containsKey("X-Modified");
}

@Test
void testMutatePreservesResponseErrorHandler() {
ResponseErrorHandler customHandler = mock(ResponseErrorHandler.class);

OpenAiApi original = OpenAiApi.builder().apiKey(TEST_API_KEY).responseErrorHandler(customHandler).build();

OpenAiApi mutated = original.mutate().apiKey("new-key").build();

assertThat(original.getResponseErrorHandler()).isSameAs(customHandler);
assertThat(mutated.getResponseErrorHandler()).isSameAs(customHandler);
}

@Test
void testMutateCreatesIndependentHeaders() {
MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
headers.add("X-Original", "value1");

OpenAiApi original = OpenAiApi.builder().apiKey(TEST_API_KEY).headers(headers).build();

MultiValueMap<String, String> newHeaders = new LinkedMultiValueMap<>();
newHeaders.add("X-New", "value2");

OpenAiApi mutated = original.mutate().headers(newHeaders).build();

// Original headers should be unchanged
assertThat(original.getHeaders()).containsKey("X-Original");
assertThat(original.getHeaders()).doesNotContainKey("X-New");

// Mutated should have new headers
assertThat(mutated.getHeaders()).doesNotContainKey("X-Original");
assertThat(mutated.getHeaders()).containsKey("X-New");
}

@Test
void testNoopApiKey() {
OpenAiApi api = OpenAiApi.builder().apiKey(new NoopApiKey()).build();

assertThat(api).isNotNull();
assertThat(api.getApiKey()).isInstanceOf(NoopApiKey.class);
assertThat(api.getApiKey().getValue()).isEmpty();
}

@Nested
class MockRequests {

Expand Down