Added descriptions to tests

Author: abhishekanne

e2etests/tests/ai_prompts/test_ai_prompt.rs

@@ -4,7 +4,7 @@ use q_cli_e2e_tests::q_chat_helper::QChatSession;
 #[test]
 #[cfg(all(feature = "ai_prompts", feature = "sanity"))]
 fn test_what_is_aws_prompt() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 [AI PROMPTS] Testing 'What is AWS?' AI prompt...");
+    println!("🔍 [AI PROMPTS] Testing 'What is AWS?' AI prompt... | Description: Tests AI prompt functionality by sending 'What is AWS?' and verifying the response contains relevant AWS information and technical terms");
 
     let mut chat = QChatSession::new()?;
     println!("✅ Q Chat session started");
@@ -57,7 +57,7 @@ fn test_what_is_aws_prompt() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "ai_prompts", feature = "sanity"))]
 fn test_simple_greeting() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing simple 'Hello' prompt...");
+    println!("🔍 Testing simple 'Hello' prompt... | Description: Tests basic AI interaction by sending a simple greeting and verifying the AI responds appropriately with greeting-related content");
 
     let mut chat = QChatSession::new()?;
     println!("✅ Q Chat session started");

e2etests/tests/ai_prompts/test_prompts_commands.rs

@@ -19,7 +19,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
 #[test]
 #[cfg(all(feature = "ai_prompts", feature = "sanity"))]
 fn test_prompts_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /prompts command...");
+    println!("🔍 Testing /prompts command... | Description: Tests the /prompts command to display available prompts with usage instructions and argument requirements");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -58,7 +58,7 @@ fn test_prompts_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "ai_prompts", feature = "sanity"))]
 fn test_prompts_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /prompts --help command...");
+    println!("🔍 Testing /prompts --help command... | Description: Tests the /prompts --help command to display comprehensive help information about prompts functionality and MCP server integration");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -119,7 +119,7 @@ fn test_prompts_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "ai_prompts", feature = "sanity"))]
 fn test_prompts_list_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /prompts list command...");
+    println!("🔍 Testing /prompts list command... | Description: Tests the /prompts list command to display all available prompts with their arguments and usage information");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();

e2etests/tests/context/test_context_command.rs

@@ -25,7 +25,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_context_show_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context show command...");
+    println!("🔍 Testing /context show command... | Description: Tests the /context show command to display current context information including agent configuration and context files");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -59,7 +59,7 @@ fn test_context_show_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_context_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context help command...");
+    println!("🔍 Testing /context help command... | Description: Tests the /context help command to display comprehensive help information for context management including usage, commands, and options");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -101,7 +101,7 @@ fn test_context_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_context_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context without sub command...");
+    println!("🔍 Testing /context without sub command... | Description: Tests the /context command without subcommands to verify it displays help information with usage and available commands");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -139,7 +139,7 @@ fn test_context_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_context_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context invalid command...");
+    println!("🔍 Testing /context invalid command... | Description: Tests the /context command with invalid subcommand to verify proper error handling and help display");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -169,7 +169,7 @@ fn test_context_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_add_non_existing_file_context() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context add non-existing file command...");
+    println!("🔍 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");
 
     let non_existing_file_path = "/tmp/non_existing_file.py";
 
@@ -200,7 +200,7 @@ fn test_add_non_existing_file_context() -> Result<(), Box<dyn std::error::Error>
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_context_remove_command_of_non_existent_file() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context remove non existing file command...");
+    println!("🔍 Testing /context remove non existing file command... | Description: Tests the /context remove command with non-existing file to verify proper error handling");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -228,7 +228,7 @@ fn test_context_remove_command_of_non_existent_file() -> Result<(), Box<dyn std:
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_add_remove_file_context() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context add <filename> command and /context remove <filename> command...");
+    println!("🔍 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");
 
     let test_file_path = "/tmp/test_context_file_.py";
     // Create a test file
@@ -302,7 +302,7 @@ fn test_add_remove_file_context() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_add_glob_pattern_file_context()-> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context add *.py glob pattern command...");
+    println!("🔍 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");
 
     let test_file1_path = "/tmp/test_context_file1.py";
     let test_file2_path = "/tmp/test_context_file2.py";
@@ -384,7 +384,7 @@ fn test_add_glob_pattern_file_context()-> Result<(), Box<dyn std::error::Error>>
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_add_remove_multiple_file_context()-> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context add <filename1> <filename2> <filename3> command and /context remove <filename1> <filename2> <filename3>...");
+    println!("🔍 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");
 
     let test_file1_path = "/tmp/test_context_file1.py";
     let test_file2_path = "/tmp/test_context_file2.py";
@@ -469,7 +469,7 @@ fn test_add_remove_multiple_file_context()-> Result<(), Box<dyn std::error::Erro
 #[test]
 #[cfg(all(feature = "context", feature = "sanity"))]
 fn test_clear_context_command()-> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /context clear command...");
+    println!("🔍 Testing /context clear command... | Description: Tests the /context clear command to remove all files from context and verify the context is completely cleared");
 
     let test_file_path = "/tmp/test_context_file.py";
 

e2etests/tests/core_session/test_clear_command.rs

@@ -4,7 +4,7 @@ use q_cli_e2e_tests::q_chat_helper::QChatSession;
 #[test]
 #[cfg(all(feature = "clear", feature = "sanity"))]
 fn test_clear_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /clear command...");
+    println!("🔍 Testing /clear command... | Description: Tests the /clear command to clear conversation history and verify that previous context is no longer remembered by the AI");
 
     let mut chat = QChatSession::new()?;
     println!("✅ Q Chat session started");

e2etests/tests/core_session/test_help_command.rs

@@ -4,7 +4,7 @@ use q_cli_e2e_tests::q_chat_helper::QChatSession;
 #[test]
 #[cfg(all(feature = "help", feature = "sanity"))]
 fn test_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /help command...");
+    println!("🔍 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");
 
     let mut chat = QChatSession::new()?;
     println!("✅ Q Chat session started");

e2etests/tests/core_session/test_quit_command.rs

@@ -4,7 +4,7 @@ use q_cli_e2e_tests::q_chat_helper::QChatSession;
 #[test]
 #[cfg(all(feature = "quit", feature = "sanity"))]
 fn test_quit_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /quit command...");
+    println!("🔍 Testing /quit command... | Description: Tests the /quit command to properly terminate the Q Chat session and exit cleanly");
 
     let mut chat = QChatSession::new()?;
     println!("✅ Q Chat session started");

e2etests/tests/core_session/test_tools_command.rs

@@ -24,7 +24,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools command...");
+    println!("🔍 Testing /tools command... | Description: Tests the /tools command to display all available tools with their permission status including built-in and MCP tools");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -79,7 +79,7 @@ fn test_tools_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools --help command...");
+    println!("🔍 Testing /tools --help command... | Description: Tests the /tools --help command to display comprehensive help information about tools management including available subcommands and options");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -125,7 +125,7 @@ fn test_tools_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_trust_all_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools trust-all command...");
+    println!("🔍 Testing /tools trust-all command... | Description: Tests the /tools trust-all command to trust all available tools and verify all tools show trusted status, then tests reset functionality");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -205,7 +205,7 @@ fn test_tools_trust_all_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_trust_all_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools trust-all --help command...");
+    println!("🔍 Testing /tools trust-all --help command... | Description: Tests the /tools trust-all --help command to display help information for the trust-all subcommand");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -241,7 +241,7 @@ fn test_tools_trust_all_help_command() -> Result<(), Box<dyn std::error::Error>>
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_reset_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools reset --help command...");
+    println!("🔍 Testing /tools reset --help command... | Description: Tests the /tools reset --help command to display help information for the reset subcommand");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -276,7 +276,7 @@ fn test_tools_reset_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_trust_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools trust command...");
+    println!("🔍 Testing /tools trust command... | Description: Tests the /tools trust and untrust commands to manage individual tool permissions and verify trust status changes");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -354,7 +354,7 @@ fn test_tools_trust_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_trust_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools trust --help command...");
+    println!("🔍 Testing /tools trust --help command... | Description: Tests the /tools trust --help command to display help information for trusting specific tools");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -393,7 +393,7 @@ fn test_tools_trust_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_untrust_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools untrust --help command...");
+    println!("🔍 Testing /tools untrust --help command... | Description: Tests the /tools untrust --help command to display help information for untrusting specific tools");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -432,7 +432,7 @@ fn test_tools_untrust_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "tools", feature = "sanity"))]
 fn test_tools_schema_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /tools schema --help command...");
+    println!("🔍 Testing /tools schema --help command... | Description: Tests the /tools schema --help command to display help information for viewing tool schemas");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();

e2etests/tests/integration/test_editor_help_command.rs

@@ -18,7 +18,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
 #[test]
 #[cfg(all(feature = "editor", feature = "sanity"))]
 fn test_editor_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /editor --help command...");
+    println!("🔍 Testing /editor --help command... | Description: Tests the /editor --help command to display help information for the editor functionality including usage and options");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -61,7 +61,7 @@ fn test_editor_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "editor", feature = "sanity"))]
 fn test_help_editor_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /help editor command...");
+    println!("🔍 Testing /help editor command... | Description: Tests the /help editor command to display editor-specific help information and usage instructions");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -104,7 +104,7 @@ fn test_help_editor_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "editor", feature = "sanity"))]
 fn test_editor_h_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /editor -h command...");
+    println!("🔍 Testing /editor -h command... | Description: Tests the /editor -h command (short form) to display editor help information and verify proper flag handling");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());

e2etests/tests/integration/test_hooks_command.rs

@@ -18,7 +18,7 @@ const TOTAL_TESTS: usize = TEST_NAMES.len();
 #[test]
 #[cfg(all(feature = "hooks", feature = "sanity"))]
 fn test_hooks_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /hooks command...");
+    println!("🔍 Testing /hooks command... | Description: Tests the /hooks command to display configured hooks or show no hooks message when none are configured");
 
     let session = get_chat_session();
    let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -48,7 +48,7 @@ fn test_hooks_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "hooks", feature = "sanity"))]
 fn test_hooks_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /hooks --help command...");
+    println!("🔍 Testing /hooks --help command... | Description: Tests the /hooks --help command to display comprehensive help information for hooks functionality and configuration");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());
@@ -87,7 +87,7 @@ fn test_hooks_help_command() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 #[cfg(all(feature = "hooks", feature = "sanity"))]
 fn test_hooks_h_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /hooks -h command...");
+    println!("🔍 Testing /hooks -h command... | Description: Tests the /hooks -h command (short form) to display hooks help information and verify flag handling");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap_or_else(|poisoned| poisoned.into_inner());