-
Notifications
You must be signed in to change notification settings - Fork 11.2k
Add CLI streaming integration tests #1542
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
Merged
aibrahim-oai
merged 6 commits into
main
from
codex/implement-end-to-end-cli-integration-tests
Jul 13, 2025
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4612121
Fix CLI stream tests to invoke cargo run
aibrahim-oai 4a2d9bc
fix import style in cli stream test
aibrahim-oai 973ad8b
Merge branch 'main' into codex/implement-end-to-end-cli-integration-t…
aibrahim-oai 1c42ade
Merge branch 'main' into codex/implement-end-to-end-cli-integration-t…
aibrahim-oai 599eaff
addressing review
aibrahim-oai 6af372e
addressing review
aibrahim-oai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| event: response.created | ||
| data: {"type":"response.created","response":{"id":"resp1"}} | ||
|
|
||
| event: response.output_item.done | ||
| data: {"type":"response.output_item.done","item":{"type":"message","role":"assistant","content":[{"type":"output_text","text":"fixture hello"}]}} | ||
|
|
||
| event: response.completed | ||
| data: {"type":"response.completed","response":{"id":"resp1","output":[]}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| #![expect(clippy::unwrap_used)] | ||
|
|
||
| use assert_cmd::Command as AssertCommand; | ||
| use codex_core::exec::CODEX_SANDBOX_NETWORK_DISABLED_ENV_VAR; | ||
| use tempfile::TempDir; | ||
| use wiremock::Mock; | ||
| use wiremock::MockServer; | ||
| use wiremock::ResponseTemplate; | ||
| use wiremock::matchers::method; | ||
| use wiremock::matchers::path; | ||
|
|
||
| /// Tests streaming chat completions through the CLI using a mock server. | ||
| /// This test: | ||
| /// 1. Sets up a mock server that simulates OpenAI's chat completions API | ||
| /// 2. Configures codex to use this mock server via a custom provider | ||
| /// 3. Sends a simple "hello?" prompt and verifies the streamed response | ||
| /// 4. Ensures the response is received exactly once and contains "hi" | ||
| #[tokio::test(flavor = "multi_thread", worker_threads = 2)] | ||
| async fn chat_mode_stream_cli() { | ||
| if std::env::var(CODEX_SANDBOX_NETWORK_DISABLED_ENV_VAR).is_ok() { | ||
| println!( | ||
| "Skipping test because it cannot execute when network is disabled in a Codex sandbox." | ||
| ); | ||
| return; | ||
| } | ||
|
|
||
| let server = MockServer::start().await; | ||
| let sse = concat!( | ||
| "data: {\"choices\":[{\"delta\":{\"content\":\"hi\"}}]}\n\n", | ||
| "data: {\"choices\":[{\"delta\":{}}]}\n\n", | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this empty
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah |
||
| "data: [DONE]\n\n" | ||
| ); | ||
| Mock::given(method("POST")) | ||
| .and(path("/v1/chat/completions")) | ||
| .respond_with( | ||
| ResponseTemplate::new(200) | ||
| .insert_header("content-type", "text/event-stream") | ||
| .set_body_raw(sse, "text/event-stream"), | ||
| ) | ||
| .expect(1) | ||
| .mount(&server) | ||
| .await; | ||
|
|
||
| let home = TempDir::new().unwrap(); | ||
| let provider_override = format!( | ||
| "model_providers.mock={{ name = \"mock\", base_url = \"{}/v1\", env_key = \"PATH\", wire_api = \"chat\" }}", | ||
| server.uri() | ||
| ); | ||
| let mut cmd = AssertCommand::new("cargo"); | ||
| cmd.arg("run") | ||
| .arg("-p") | ||
| .arg("codex-cli") | ||
| .arg("--quiet") | ||
| .arg("--") | ||
| .arg("exec") | ||
| .arg("--skip-git-repo-check") | ||
| .arg("-c") | ||
| .arg(&provider_override) | ||
| .arg("-c") | ||
| .arg("model_provider=\"mock\"") | ||
| .arg("-C") | ||
| .arg(env!("CARGO_MANIFEST_DIR")) | ||
| .arg("hello?"); | ||
| cmd.env("CODEX_HOME", home.path()) | ||
| .env("OPENAI_API_KEY", "dummy") | ||
| .env("OPENAI_BASE_URL", format!("{}/v1", server.uri())); | ||
|
|
||
| let output = cmd.output().unwrap(); | ||
| println!("Status: {}", output.status); | ||
| println!("Stdout:\n{}", String::from_utf8_lossy(&output.stdout)); | ||
| println!("Stderr:\n{}", String::from_utf8_lossy(&output.stderr)); | ||
| assert!(output.status.success()); | ||
| let stdout = String::from_utf8_lossy(&output.stdout); | ||
| assert!(stdout.contains("hi")); | ||
| assert_eq!(stdout.matches("hi").count(), 1); | ||
|
|
||
| server.verify().await; | ||
| } | ||
|
|
||
| /// Tests streaming responses through the CLI using a local SSE fixture file. | ||
| /// This test: | ||
| /// 1. Uses a pre-recorded SSE response fixture instead of a live server | ||
| /// 2. Configures codex to read from this fixture via CODEX_RS_SSE_FIXTURE env var | ||
| /// 3. Sends a "hello?" prompt and verifies the response | ||
| /// 4. Ensures the fixture content is correctly streamed through the CLI | ||
| #[tokio::test(flavor = "multi_thread", worker_threads = 2)] | ||
| async fn responses_api_stream_cli() { | ||
| if std::env::var(CODEX_SANDBOX_NETWORK_DISABLED_ENV_VAR).is_ok() { | ||
| println!( | ||
| "Skipping test because it cannot execute when network is disabled in a Codex sandbox." | ||
| ); | ||
| return; | ||
| } | ||
|
|
||
| let fixture = | ||
| std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/cli_responses_fixture.sse"); | ||
|
|
||
| let home = TempDir::new().unwrap(); | ||
| let mut cmd = AssertCommand::new("cargo"); | ||
| cmd.arg("run") | ||
| .arg("-p") | ||
| .arg("codex-cli") | ||
| .arg("--quiet") | ||
| .arg("--") | ||
| .arg("exec") | ||
| .arg("--skip-git-repo-check") | ||
| .arg("-C") | ||
| .arg(env!("CARGO_MANIFEST_DIR")) | ||
| .arg("hello?"); | ||
| cmd.env("CODEX_HOME", home.path()) | ||
| .env("OPENAI_API_KEY", "dummy") | ||
| .env("CODEX_RS_SSE_FIXTURE", fixture) | ||
| .env("OPENAI_BASE_URL", "http://unused.local"); | ||
|
|
||
| let output = cmd.output().unwrap(); | ||
| assert!(output.status.success()); | ||
| let stdout = String::from_utf8_lossy(&output.stdout); | ||
| assert!(stdout.contains("fixture hello")); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would use
r#here. Since it isn't a format string, you won't have to escape{.