Skip to content

Commit 6e0903e

Browse files
committed
Refactor test descriptions to use HTML code tags for command formatting
- Updated test output messages in various test files to wrap command names in <code> tags for better readability.
1 parent aeb975b commit 6e0903e

19 files changed

+115
-440
lines changed

e2etests/tests/agent/test_agent_commands.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
5656
#[test]
5757
#[cfg(all(feature = "agent", feature = "sanity"))]
5858
fn agent_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
59-
println!("\n🔍 Testing /agent command... | Description: Tests the /agent command without subcommands to display help information. Verifies agent management description, usage, available subcommands, and options");
59+
println!("\n🔍 Testing /agent command... | Description: Tests the <code> /agent</code> command without subcommands to display help information. Verifies agent management description, usage, available subcommands, and options");
6060

6161
let session = get_chat_session();
6262
let mut chat = session.lock().unwrap();
@@ -109,7 +109,7 @@ fn agent_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
109109
#[test]
110110
#[cfg(all(feature = "agent", feature = "sanity"))]
111111
fn test_agent_create_command() -> Result<(), Box<dyn std::error::Error>> {
112-
println!("\n🔍 Testing /agent create --name <agent_name> command... | Description: Tests the /agent create command to create a new agent with specified name. Verifies agent creation process, file system operations, and cleanup");
112+
println!("\n🔍 Testing /agent create --name <agent_name> command... | Description: Tests the <code> /agent create</code> command to create a new agent with specified name. Verifies agent creation process, file system operations, and cleanup");
113113

114114
let timestamp = std::time::SystemTime::now()
115115
.duration_since(std::time::UNIX_EPOCH)
@@ -178,7 +178,7 @@ fn test_agent_create_command() -> Result<(), Box<dyn std::error::Error>> {
178178
#[test]
179179
#[cfg(all(feature = "agent", feature = "sanity"))]
180180
fn test_agent_create_missing_args() -> Result<(), Box<dyn std::error::Error>> {
181-
println!("\n🔍 Testing /agent create without required arguments... | Description: Tests the /agent create command without required arguments to verify error handling. Verifies proper error messages, usage information, and help suggestions");
181+
println!("\n🔍 Testing /agent create without required arguments... | Description: Tests the <code> /agent create</code> command without required arguments to verify error handling. Verifies proper error messages, usage information, and help suggestions");
182182

183183
let session = get_chat_session();
184184
let mut chat = session.lock().unwrap();
@@ -229,7 +229,7 @@ fn test_agent_create_missing_args() -> Result<(), Box<dyn std::error::Error>> {
229229
#[test]
230230
#[cfg(all(feature = "agent", feature = "sanity"))]
231231
fn test_agent_help_command() -> Result<(), Box<dyn std::error::Error>> {
232-
println!("\n🔍 Testing /agent help... | Description: Tests the /agent help command to display comprehensive agent help information. Verifies agent descriptions, usage notes, launch instructions, and configuration paths");
232+
println!("\n🔍 Testing /agent help... | Description: Tests the <code> /agent help</code> command to display comprehensive agent help information. Verifies agent descriptions, usage notes, launch instructions, and configuration paths");
233233

234234
let session = get_chat_session();
235235
let mut chat = session.lock().unwrap();
@@ -286,7 +286,7 @@ fn test_agent_help_command() -> Result<(), Box<dyn std::error::Error>> {
286286
#[test]
287287
#[cfg(all(feature = "agent", feature = "sanity"))]
288288
fn test_agent_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
289-
println!("\n🔍 Testing /agent invalidcommand... | Description: Tests the /agent command with invalid subcommand to verify error handling. Verifies that invalid commands display help information with available commands and options");
289+
println!("\n🔍 Testing /agent invalidcommand... | Description: Tests the <code> /agent</code> command with invalid subcommand to verify error handling. Verifies that invalid commands display help information with available commands and options");
290290

291291
let session = get_chat_session();
292292
let mut chat = session.lock().unwrap();
@@ -325,7 +325,7 @@ fn test_agent_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
325325
#[test]
326326
#[cfg(all(feature = "agent", feature = "sanity"))]
327327
fn test_agent_list_command() -> Result<(), Box<dyn std::error::Error>> {
328-
println!("\n🔍 Testing /agent list command... | Description: Tests the /agent list command to display all available agents. Verifies agent listing format and presence of default agent");
328+
println!("\n🔍 Testing /agent list command... | Description: Tests the <code> /agent list</code> command to display all available agents. Verifies agent listing format and presence of default agent");
329329

330330
let session = get_chat_session();
331331
let mut chat = session.lock().unwrap();
@@ -400,7 +400,7 @@ fn test_agent_list_command() -> Result<(), Box<dyn std::error::Error>> {
400400
#[test]
401401
#[cfg(all(feature = "agent", feature = "sanity"))]
402402
fn test_agent_set_default_command() -> Result<(), Box<dyn std::error::Error>> {
403-
println!("\n🔍 Testing /agent set-default with valid arguments... | Description: Tests the /agent set-default command with valid arguments to set default agent. Verifies success messages and confirmation of default agent configuration");
403+
println!("\n🔍 Testing /agent set-default with valid arguments... | Description: Tests the <code> /agent set-default</code> command with valid arguments to set default agent. Verifies success messages and confirmation of default agent configuration");
404404

405405
let session = get_chat_session();
406406
let mut chat = session.lock().unwrap();
@@ -441,7 +441,7 @@ fn test_agent_set_default_command() -> Result<(), Box<dyn std::error::Error>> {
441441
#[test]
442442
#[cfg(all(feature = "agent", feature = "sanity"))]
443443
fn test_agent_set_default_missing_args() -> Result<(), Box<dyn std::error::Error>> {
444-
println!("\n🔍 Testing /agent set-default without required arguments... | Description: Tests the /agent set-default command without required arguments to verify error handling. Verifies error messages, usage information, and available options display");
444+
println!("\n🔍 Testing /agent set-default without required arguments... | Description: Tests the <code> /agent set-default</code> command without required arguments to verify error handling. Verifies error messages, usage information, and available options display");
445445

446446
let session = get_chat_session();
447447
let mut chat = session.lock().unwrap();

e2etests/tests/ai_prompts/test_prompts_commands.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
5050
#[test]
5151
#[cfg(all(feature = "ai_prompts", feature = "sanity"))]
5252
fn test_prompts_command() -> Result<(), Box<dyn std::error::Error>> {
53-
println!("\n🔍 Testing /prompts command... | Description: Tests the /prompts command to display available prompts with usage instructions and argument requirements");
53+
println!("\n🔍 Testing /prompts command... | Description: Tests the <code> /prompts</code> command to display available prompts with usage instructions and argument requirements");
5454

5555
let session = get_chat_session();
5656
let mut chat = session.lock().unwrap();
@@ -89,7 +89,7 @@ fn test_prompts_command() -> Result<(), Box<dyn std::error::Error>> {
8989
#[test]
9090
#[cfg(all(feature = "ai_prompts", feature = "sanity"))]
9191
fn test_prompts_help_command() -> Result<(), Box<dyn std::error::Error>> {
92-
println!("\n🔍 Testing /prompts --help command... | Description: Tests the /prompts --help command to display comprehensive help information about prompts functionality and MCP server integration");
92+
println!("\n🔍 Testing /prompts --help command... | Description: Tests the <code> /prompts --help</code> command to display comprehensive help information about prompts functionality and MCP server integration");
9393

9494
let session = get_chat_session();
9595
let mut chat = session.lock().unwrap();
@@ -150,7 +150,7 @@ fn test_prompts_help_command() -> Result<(), Box<dyn std::error::Error>> {
150150
#[test]
151151
#[cfg(all(feature = "ai_prompts", feature = "sanity"))]
152152
fn test_prompts_list_command() -> Result<(), Box<dyn std::error::Error>> {
153-
println!("\n🔍 Testing /prompts list command... | Description: Tests the /prompts list command to display all available prompts with their arguments and usage information");
153+
println!("\n🔍 Testing /prompts list command... | Description: Tests the <code> /prompts list</code> command to display all available prompts with their arguments and usage information");
154154

155155
let session = get_chat_session();
156156
let mut chat = session.lock().unwrap();

e2etests/tests/context/test_context_command.rs

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
5656
#[test]
5757
#[cfg(all(feature = "context", feature = "sanity"))]
5858
fn test_context_show_command() -> Result<(), Box<dyn std::error::Error>> {
59-
println!("\n🔍 Testing /context show command... | Description: Tests the /context show command to display current context information including agent configuration and context files");
59+
println!("\n🔍 Testing /context show command... | Description: Tests the <code> /context show</code> command to display current context information including agent configuration and context files");
6060

6161
let session = get_chat_session();
6262
let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -90,7 +90,7 @@ fn test_context_show_command() -> Result<(), Box<dyn std::error::Error>> {
9090
#[test]
9191
#[cfg(all(feature = "context", feature = "sanity"))]
9292
fn test_context_help_command() -> Result<(), Box<dyn std::error::Error>> {
93-
println!("\n🔍 Testing /context help command... | Description: Tests the /context help command to display comprehensive help information for context management including usage, commands, and options");
93+
println!("\n🔍 Testing /context help command... | Description: Tests the <code> /context help</code> command to display comprehensive help information for context management including usage, commands, and options");
9494

9595
let session = get_chat_session();
9696
let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -132,7 +132,7 @@ fn test_context_help_command() -> Result<(), Box<dyn std::error::Error>> {
132132
#[test]
133133
#[cfg(all(feature = "context", feature = "sanity"))]
134134
fn test_context_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
135-
println!("\n🔍 Testing /context without sub command... | Description: Tests the /context command without subcommands to verify it displays help information with usage and available commands");
135+
println!("\n🔍 Testing /context without sub command... | Description: Tests the <code> /context</code> command without subcommands to verify it displays help information with usage and available commands");
136136

137137
let session = get_chat_session();
138138
let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -170,7 +170,7 @@ fn test_context_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
170170
#[test]
171171
#[cfg(all(feature = "context", feature = "sanity"))]
172172
fn test_context_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
173-
println!("\n🔍 Testing /context invalid command... | Description: Tests the /context command with invalid subcommand to verify proper error handling and help display");
173+
println!("\n🔍 Testing /context invalid command... | Description: Tests the <code> /context test</code> command with invalid subcommand to verify proper error handling and help display");
174174

175175
let session = get_chat_session();
176176
let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -200,7 +200,7 @@ fn test_context_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
200200
#[test]
201201
#[cfg(all(feature = "context", feature = "sanity"))]
202202
fn test_add_non_existing_file_context() -> Result<(), Box<dyn std::error::Error>> {
203-
println!("\n🔍 Testing /context add non-existing file command... | Description: Tests the /context add command with non-existing file to verify proper error handling and force option suggestion");
203+
println!("\n🔍 Testing /context add non-existing file command... | Description: Tests the <code> /context add</code> command with non-existing file to verify proper error handling and force option suggestion");
204204

205205
let non_existing_file_path = "/tmp/non_existing_file.py";
206206

@@ -231,7 +231,7 @@ fn test_add_non_existing_file_context() -> Result<(), Box<dyn std::error::Error>
231231
#[test]
232232
#[cfg(all(feature = "context", feature = "sanity"))]
233233
fn test_context_remove_command_of_non_existent_file() -> Result<(), Box<dyn std::error::Error>> {
234-
println!("\n🔍 Testing /context remove non existing file command... | Description: Tests the /context remove command with non-existing file to verify proper error handling");
234+
println!("\n🔍 Testing /context remove non existing file command... | Description: Tests the <code> /context remove</code> command with non-existing file to verify proper error handling");
235235

236236
let session = get_chat_session();
237237
let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -259,7 +259,7 @@ fn test_context_remove_command_of_non_existent_file() -> Result<(), Box<dyn std:
259259
#[test]
260260
#[cfg(all(feature = "context", feature = "sanity"))]
261261
fn test_add_remove_file_context() -> Result<(), Box<dyn std::error::Error>> {
262-
println!("\n🔍 Testing /context add <filename> command and /context remove <filename> command... | Description: Tests the complete workflow of adding a file to context, verifying it appears in context show, then removing it and verifying removal");
262+
println!("\n🔍 Testing /context add <filename> command and /context remove <filename> command... | Description: Tests the <code> /context add</code> command to add a file to context and <code> /context remove</code> command to remove a file from context");
263263

264264
let test_file_path = "/tmp/test_context_file_.py";
265265
// Create a test file
@@ -333,7 +333,7 @@ fn test_add_remove_file_context() -> Result<(), Box<dyn std::error::Error>> {
333333
#[test]
334334
#[cfg(all(feature = "context", feature = "sanity"))]
335335
fn test_add_glob_pattern_file_context()-> Result<(), Box<dyn std::error::Error>> {
336-
println!("\n🔍 Testing /context add *.py glob pattern command... | Description: Tests the /context add command with glob patterns to add multiple files matching a pattern and verify pattern-based context management");
336+
println!("\n🔍 Testing /context add *.py glob pattern command... | Description: Tests the <code> /context add</code> command with glob patterns to add multiple files matching a pattern and verify pattern-based context management");
337337

338338
let test_file1_path = "/tmp/test_context_file1.py";
339339
let test_file2_path = "/tmp/test_context_file2.py";
@@ -415,8 +415,7 @@ fn test_add_glob_pattern_file_context()-> Result<(), Box<dyn std::error::Error>>
415415
#[test]
416416
#[cfg(all(feature = "context", feature = "sanity"))]
417417
fn test_add_remove_multiple_file_context()-> Result<(), Box<dyn std::error::Error>> {
418-
println!("\n🔍 Testing /context add <filename1> <filename2> <filename3> command and /context remove <filename1> <filename2> <filename3>... | Description: Tests adding and removing multiple files in a single command to verify batch context operations");
419-
418+
println!("\n🔍 Testing /context add <filename1> <filename2> <filename3> command and /context remove <filename1> <filename2> <filename3>... | Description: Tests the <code> /context add</code> command with multiple files to verify batch context operations and <code> /context remove</code> command with multiple files to verify");
420419
let test_file1_path = "/tmp/test_context_file1.py";
421420
let test_file2_path = "/tmp/test_context_file2.py";
422421
let test_file3_path = "/tmp/test_context_file.js";
@@ -500,7 +499,7 @@ fn test_add_remove_multiple_file_context()-> Result<(), Box<dyn std::error::Erro
500499
#[test]
501500
#[cfg(all(feature = "context", feature = "sanity"))]
502501
fn test_clear_context_command()-> Result<(), Box<dyn std::error::Error>> {
503-
println!("\n🔍 Testing /context clear command... | Description: Tests the /context clear command to remove all files from context and verify the context is completely cleared");
502+
println!("\n🔍 Testing /context clear command... | Description: Tests the <code> /context clear</code> command to remove all files from context and verify the context is completely cleared");
504503

505504
let test_file_path = "/tmp/test_context_file.py";
506505

e2etests/tests/core_session/test_clear_command.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
4747
#[test]
4848
#[cfg(all(feature = "clear", feature = "sanity"))]
4949
fn test_clear_command() -> Result<(), Box<dyn std::error::Error>> {
50-
println!("\n🔍 Testing /clear command... | Description: Tests the /clear command to clear conversation history and verify that previous context is no longer remembered by the AI");
50+
println!("\n🔍 Testing /clear command... | Description: Tests the <code> /clear</code> command to clear conversation history and verify that previous context is no longer remembered by the AI");
5151

5252
let session = get_chat_session();
5353
let mut chat = session.lock().unwrap();

e2etests/tests/core_session/test_help_command.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
4747
#[test]
4848
#[cfg(all(feature = "help", feature = "sanity"))]
4949
fn test_help_command() -> Result<(), Box<dyn std::error::Error>> {
50-
println!("\n🔍 Testing /help command... | Description: Tests the /help command to display all available commands and verify core functionality like quit, clear, tools, and help commands are present");
50+
println!("\n🔍 Testing /help command... | Description: Tests the <code> /help</code> command to display all available commands and verify core functionality like quit, clear, tools, and help commands are present");
5151

5252
let session = get_chat_session();
5353
let mut chat = session.lock().unwrap();

e2etests/tests/core_session/test_quit_command.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
3232
#[test]
3333
#[cfg(all(feature = "quit", feature = "sanity"))]
3434
fn test_quit_command() -> Result<(), Box<dyn std::error::Error>> {
35-
println!("\n🔍 Testing /quit command... | Description: Tests the /quit command to properly terminate the Q Chat session and exit cleanly");
35+
println!("\n🔍 Testing /quit command... | Description: Tests the <code> /quit</code> command to properly terminate the Q Chat session and exit cleanly");
3636

3737
let session = get_chat_session();
3838
let mut chat = session.lock().unwrap();

0 commit comments

Comments
 (0)