Added description to agent and usage command tests , add .gitignore

Author: abhishekanne

e2etests/.gitignore

@@ -0,0 +1,2 @@
+qcli_test_summary*.json
+qcli_test_summary*.html

e2etests/tests/agent/test_agent_commands.rs

@@ -20,10 +20,12 @@ const TEST_NAMES: &[&str] = &[
 #[allow(dead_code)]
 const TOTAL_TESTS: usize = TEST_NAMES.len();
 
+/// Tests the /agent command without subcommands to display help information
+/// Verifies agent management description, usage, available subcommands, and options
 #[test]
-#[cfg(all(feature = "agent", any(feature = "sanity"))]
+#[cfg(all(feature = "agent", feature = "sanity"))]
 fn agent_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent command...");
+    println!("🔍 Testing /agent command... | Description: Tests the /agent command without subcommands to display help information. Verifies agent management description, usage, available subcommands, and options");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -71,10 +73,12 @@ fn agent_without_subcommand() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent create command to create a new agent with specified name
+/// Verifies agent creation process, file system operations, and cleanup
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_create_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent create --name <agent_name> command...");
+    println!("🔍 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");
 
     let timestamp = std::time::SystemTime::now()
         .duration_since(std::time::UNIX_EPOCH)
@@ -138,10 +142,12 @@ fn test_agent_create_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent create command without required arguments to verify error handling
+/// Verifies proper error messages, usage information, and help suggestions
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_create_missing_args() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent create without required arguments...");
+    println!("🔍 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");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -187,10 +193,12 @@ fn test_agent_create_missing_args() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent help command to display comprehensive agent help information
+/// Verifies agent descriptions, usage notes, launch instructions, and configuration paths
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent help...");
+    println!("🔍 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");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -242,10 +250,12 @@ fn test_agent_help_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent command with invalid subcommand to verify error handling
+/// Verifies that invalid commands display help information with available commands and options
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent invalidcommand...");
+    println!("🔍 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");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -279,10 +289,12 @@ fn test_agent_invalid_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent list command to display all available agents
+/// Verifies agent listing format and presence of default agent
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_list_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent list command...");
+    println!("🔍 Testing /agent list command... | Description: Tests the /agent list command to display all available agents. Verifies agent listing format and presence of default agent");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -311,10 +323,12 @@ fn test_agent_list_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent schema command to display agent configuration schema
+/// Verifies JSON schema structure with required keys and properties
 // #[test]
 // #[cfg(feature = "agent")]
 // fn test_agent_schema_command() -> Result<(), Box<dyn std::error::Error>> {
-//     println!("🔍 Testing /agent schema...");
+//     println!("🔍 Testing /agent schema... | Description: Tests the /agent schema command to display agent configuration schema. Verifies JSON schema structure with required keys and properties");
 
 //     let session = get_chat_session();
 //     let mut chat = session.lock().unwrap();
@@ -350,10 +364,12 @@ fn test_agent_list_command() -> Result<(), Box<dyn std::error::Error>> {
 //     Ok(())
 // }
 
+/// Tests the /agent set-default command with valid arguments to set default agent
+/// Verifies success messages and confirmation of default agent configuration
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_set_default_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent set-default with valid arguments...");
+    println!("🔍 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");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -389,10 +405,12 @@ fn test_agent_set_default_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /agent set-default command without required arguments to verify error handling
+/// Verifies error messages, usage information, and available options display
 #[test]
 #[cfg(all(feature = "agent", feature = "sanity"))]
 fn test_agent_set_default_missing_args() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /agent set-default without required arguments...");
+    println!("🔍 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");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();

e2etests/tests/session_mgmt/test_usage_command.rs

@@ -15,10 +15,12 @@ const TEST_NAMES: &[&str] = &[
 #[allow(dead_code)]
 const TOTAL_TESTS: usize = TEST_NAMES.len();
 
+/// Tests the /usage command to display current context window usage
+/// Verifies token usage information, progress bar, breakdown sections, and Pro Tips
 #[test]
 #[cfg(all(feature = "usage", feature = "sanity"))]
 fn test_usage_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /usage command...");
+    println!("🔍 Testing /usage command... | Description: Tests the /usage command to display current context window usage. Verifies token usage information, progress bar, breakdown sections, and Pro Tips");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -74,10 +76,12 @@ fn test_usage_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /usage --help command to display help information for the usage command
+/// Verifies Usage section, Options section, and help flags (-h, --help)
 #[test]
 #[cfg(all(feature = "usage", feature = "sanity"))]
 fn test_usage_help_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /usage --help command...");
+    println!("🔍 Testing /usage --help command... | Description: Tests the /usage --help command to display help information for the usage command. Verifies Usage section, Options section, and help flags (-h, --help)");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();
@@ -90,7 +94,7 @@ fn test_usage_help_command() -> Result<(), Box<dyn std::error::Error>> {
     println!("📝 END OUTPUT");
 
     // Verify Usage section
-    assert!(response.contains("Usage:"), "Missing Usage section");
+    assert!(response.contains("Usage: XX "), "Missing Usage section");
     assert!(response.contains("/usage"), "Missing /usage command in usage section");
     println!("✅ Found Usage section with /usage command");
 
@@ -115,10 +119,12 @@ fn test_usage_help_command() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+/// Tests the /usage -h command (short form of --help)
+/// Verifies Usage section, Options section, and help flags (-h, --help)
 #[test]
 #[cfg(all(any(feature = "usage", feature = "session_mgmt"), feature = "regression"))]
 fn test_usage_h_command() -> Result<(), Box<dyn std::error::Error>> {
-    println!("🔍 Testing /usage -h command...");
+    println!("🔍 Testing /usage -h command... | Description: Tests the /usage -h command (short form of --help). Verifies Usage section, Options section, and help flags (-h, --help)");
 
     let session = get_chat_session();
     let mut chat = session.lock().unwrap();