runbooks 1.1.4__py3-none-any.whl → 1.1.6__py3-none-any.whl

runbooks/inventory/find_ec2_security_groups.py

@@ -62,18 +62,17 @@ from time import time
 
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import (
     display_results,
     find_references_to_security_groups2,
     find_security_groups2,
     get_all_credentials,
 )
-from tqdm.auto import tqdm
+# Migrated to Rich.Progress - see rich_utils.py for enterprise UX standards
+# from tqdm.auto import tqdm
 
-init()
 __version__ = "2024.09.24"
-ERASE_LINE = "\x1b[2K"
 begin_time = time()
 
 
@@ -387,7 +386,7 @@ def check_accounts_for_security_groups(
                     logging.info(
                         f"{ERASE_LINE}Finished finding security groups in account {c_account_credentials['AccountId']} in region {c_account_credentials['Region']}"
                     )
-                    pbar.update()
+                    pbar.update(pbar_task, advance=1)  # Update Rich progress bar
                     self.queue.task_done()
 
     ###########
@@ -406,43 +405,50 @@ def check_accounts_for_security_groups(
     # Initialize thread-safe work queue
     checkqueue = Queue()
 
-    # Initialize progress bar for user feedback during long-running analysis
-    pbar = tqdm(
-        desc=f"Finding security groups from {len(fCredentialList)} locations",
-        total=len(fCredentialList),
-        unit=" locations",
-    )
+    # Import Rich display utilities for professional progress tracking
+    from runbooks.common.rich_utils import create_progress_bar
+
+    # Initialize progress tracking for user feedback during long-running analysis
+    with create_progress_bar() as progress:
+        task = progress.add_task(
+            f"[cyan]Finding security groups from {len(fCredentialList)} locations...",
+            total=len(fCredentialList)
+        )
+
+        # Make progress object available to worker threads via global (multi-threaded pattern)
+        global pbar
+        pbar = progress
+        global pbar_task
+        pbar_task = task
+
+        # Start worker thread pool for concurrent security group analysis
+        for x in range(WorkerThreads):
+            worker = FindSecurityGroups(checkqueue)
+            # Daemon threads will terminate when main thread exits
+            # This prevents hanging if an exception occurs in main thread
+            worker.daemon = True
+            worker.start()
+
+        # Queue all credential work items for concurrent processing
+        for credential in fCredentialList:
+            logging.info(f"Connecting to account {credential['AccountId']}")
+            try:
+                # Add credential set and parameters to work queue for worker thread processing
+                checkqueue.put((credential, fFragment, fExact, fDefault))
+            except ClientError as my_Error:
+                # Handle credential validation errors during queue population
+                if "AuthFailure" in str(my_Error):
+                    logging.error(
+                        f"Authorization Failure accessing account {credential['AccountId']} in '{credential['Region']}' region"
+                    )
+                    logging.warning(f"It's possible that the region '{credential['Region']}' hasn't been opted-into")
+                    # Continue queuing other credentials despite this failure
+                    pass
 
-    # Start worker thread pool for concurrent security group analysis
-    for x in range(WorkerThreads):
-        worker = FindSecurityGroups(checkqueue)
-        # Daemon threads will terminate when main thread exits
-        # This prevents hanging if an exception occurs in main thread
-        worker.daemon = True
-        worker.start()
-
-    # Queue all credential work items for concurrent processing
-    for credential in fCredentialList:
-        logging.info(f"Connecting to account {credential['AccountId']}")
-        try:
-            # Add credential set and parameters to work queue for worker thread processing
-            checkqueue.put((credential, fFragment, fExact, fDefault))
-        except ClientError as my_Error:
-            # Handle credential validation errors during queue population
-            if "AuthFailure" in str(my_Error):
-                logging.error(
-                    f"Authorization Failure accessing account {credential['AccountId']} in '{credential['Region']}' region"
-                )
-                logging.warning(f"It's possible that the region '{credential['Region']}' hasn't been opted-into")
-                # Continue queuing other credentials despite this failure
-                pass
-
-    # Wait for all queued work items to be processed by worker threads
-    # This blocks until all worker threads call task_done()
-    checkqueue.join()
-
-    # Clean up progress bar
-    pbar.close()
+        # Wait for all queued work items to be processed by worker threads
+        # This blocks until all worker threads call task_done()
+        checkqueue.join()
+        # Progress bar auto-closes when exiting context manager
 
     return AllSecurityGroups
 
@@ -659,7 +665,7 @@ if __name__ == "__main__":
         print(f"Data has been saved to {saved_filename}")
     if pTiming:
         print(ERASE_LINE)
-        print(f"{Fore.GREEN}This script took {time() - begin_time:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script took {time() - begin_time:.2f} seconds")
 
     print(
         f"We found {len(AllSecurityGroups)} {'default ' if pDefault else ''}security group{'' if len(AllSecurityGroups) == 1 else 's'} across {len(AccountList)} accounts and {len(RegionList)} regions"

runbooks/inventory/find_landingzone_versions.py

@@ -76,10 +76,9 @@ import boto3
 import Inventory_Modules
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError, CredentialRetrievalError, InvalidConfigError
-from colorama import init
+# colorama removed - migrated to Rich
 
 # Initialize colorama for cross-platform colored terminal output
-init()
 
 __version__ = "2023.05.31"
 
@@ -101,7 +100,6 @@ logging.basicConfig(
 
 ##########################
 # Terminal control and operational configuration constants
-ERASE_LINE = "\x1b[2K"  # ANSI escape sequence for clearing terminal line during progress display
 SkipProfiles = ["default"]  # Profile exclusion list for organizational Landing Zone discovery
 
 # Configure AWS profile discovery strategy based on user input
@@ -129,7 +127,7 @@ ALZProfiles = []  # Initialize Landing Zone profile collection for discovered Ma
 
 for profile in AllProfiles:
     # Display real-time progress during profile analysis with terminal line clearing
-    print(f"{ERASE_LINE}Checking profile: {profile}", end="\r")
+    print(f"Checking profile: {profile}", end="\r")
 
     try:
         # Analyze current profile to determine if it represents an AWS Landing Zone Management Account
@@ -164,7 +162,7 @@ for profile in AllProfiles:
             pass
 
 # Clear progress display and initialize tabular output formatting for Landing Zone inventory
-print(ERASE_LINE)
+console.print()
 fmt = "%-20s %-13s %-15s %-35s %-21s"  # Column formatting for structured Landing Zone data display
 print(fmt % ("Profile", "Account", "Region", "ALZ Stack Name", "ALZ Version"))
 print(fmt % ("-------", "-------", "------", "--------------", "-----------"))
@@ -194,7 +192,7 @@ for item in ALZProfiles:
                     )
 
 # Display comprehensive operational summary with discovery metrics
-print(ERASE_LINE)
+console.print()
 print(f"Checked {len(AllProfiles)} accounts/ Orgs. Found {len(ALZProfiles)} ALZs")
 print()
 print("Thank you for using this script.")

runbooks/inventory/find_vpc_flow_logs.py

@@ -93,13 +93,11 @@ from account_class import aws_acct_access
 from ArgumentsClass import CommonArguments
 from botocore.config import Config
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import RemoveCoreAccounts, display_results, get_all_credentials, get_regions3
 
 # Initialize colorama for cross-platform colored terminal output
-init()
 __version__ = "2024.03.10"
-ERASE_LINE = "\x1b[2K"  # ANSI escape sequence for clearing terminal line during progress display
 begin_time = time()  # Script execution timing for performance monitoring
 sleep_interval = 5  # Default wait interval for CloudWatch Logs query processing
 
@@ -305,13 +303,13 @@ def setup_auth_accounts_and_regions(fProfile: str) -> (aws_acct_access, list, li
 
     # Display comprehensive operational context for user confirmation and audit logging
     print(f"You asked to sum flow log data")
-    print(f"\tin these accounts: {Fore.RED}{AccountList}{Fore.RESET}")
-    print(f"\tin these regions: {Fore.RED}{RegionList}{Fore.RESET}")
+    print(f"\tin these accounts: [red]{AccountList}")
+    print(f"\tin these regions: [red]{RegionList}")
     print(f"\tFrom: {pStartDate} until {pEndDate}")
 
     # Display account exclusion information for operational transparency
     if pSkipAccounts is not None:
-        print(f"\tWhile skipping these accounts: {Fore.RED}{pSkipAccounts}{Fore.RESET}")
+        print(f"\tWhile skipping these accounts: [red]{pSkipAccounts}")
 
     return aws_acct, AccountList, RegionList
 
@@ -1040,13 +1038,13 @@ def get_cw_query_results(fquery_requests: list) -> list[dict]:
             # Implement timeout protection for long-running queries
             if waited_seconds_total > (SpannedDaysChecked * 5):
                 print(
-                    f"{ERASE_LINE}Query is still running... Waited {waited_seconds_total} seconds already, we'll have to check manually later. "
+                    f"Query is still running... Waited {waited_seconds_total} seconds already, we'll have to check manually later. "
                 )
                 break
 
             # Display real-time progress for query execution monitoring
             print(
-                f"{ERASE_LINE}Query for vpc {query['VPCId']} in account {query['AccountId']} in region {query['Region']} is still running... It's been {waited_seconds_total} seconds so far",
+                f"Query for vpc {query['VPCId']} in account {query['AccountId']} in region {query['Region']} is still running... It's been {waited_seconds_total} seconds so far",
                 end="\r",
             )
 
@@ -1181,7 +1179,7 @@ if __name__ == "__main__":
                 f"Account {credential['AccountId']} was successfully connected via role {credential.get('Role', pAccessRole)} from {aws_acct.acct_number}"
             )
             print(
-                f"{ERASE_LINE}Checking account {Fore.BLUE}{credential['AccountId']}{Fore.RESET} in region {Fore.BLUE}{credential['Region']}{Fore.RESET}...",
+                f"Checking account [blue]{credential['AccountId']} in region [blue]{credential['Region']}...",
                 end="\r",
             )
             """

runbooks/inventory/inventory_mcp_cli.py

@@ -25,22 +25,28 @@ from .mcp_inventory_validator import create_inventory_mcp_validator
 
 
 @click.command()
-@click.option('--profile', help='AWS profile name (takes precedence over environment variables)')
-@click.option('--resource-types', multiple=True, 
-              type=click.Choice(['ec2', 's3', 'rds', 'lambda', 'vpc', 'iam', 'cloudformation']),
-              default=['ec2', 's3', 'vpc'], 
-              help='Resource types to validate')
-@click.option('--test-mode', is_flag=True, default=True, 
-              help='Run in test mode with sample data')
-@click.option('--real-validation', is_flag=True, default=False,
-              help='Run validation against real AWS APIs (requires valid profiles)')
+@click.option("--profile", help="AWS profile name (takes precedence over environment variables)")
+@click.option(
+    "--resource-types",
+    multiple=True,
+    type=click.Choice(["ec2", "s3", "rds", "lambda", "vpc", "iam", "cloudformation"]),
+    default=["ec2", "s3", "vpc"],
+    help="Resource types to validate",
+)
+@click.option("--test-mode", is_flag=True, default=True, help="Run in test mode with sample data")
+@click.option(
+    "--real-validation",
+    is_flag=True,
+    default=False,
+    help="Run validation against real AWS APIs (requires valid profiles)",
+)
 def validate_inventory_mcp(profile: Optional[str], resource_types: List[str], test_mode: bool, real_validation: bool):
     """
     Test inventory MCP validation functionality.
-    
+
     This command demonstrates inventory MCP validation integration
     following proven enterprise patterns from FinOps module success.
-    
+
     Examples:
         runbooks inventory validate-mcp --profile my-profile --resource-types ec2,s3
         runbooks inventory validate-mcp --test-mode --resource-types ec2,vpc,rds
@@ -48,7 +54,9 @@ def validate_inventory_mcp(profile: Optional[str], resource_types: List[str], te
     """
     try:
         console.print(f"[blue]🔍 Inventory MCP Validation Test[/blue]")
-        console.print(f"[dim]Profile: {profile or 'environment fallback'} | Resources: {', '.join(resource_types)} | Test mode: {test_mode}[/dim]")
+        console.print(
+            f"[dim]Profile: {profile or 'environment fallback'} | Resources: {', '.join(resource_types)} | Test mode: {test_mode}[/dim]"
+        )
 
         # Apply profile priority system following proven patterns
         operational_profile = get_profile_for_operation("operational", profile)
@@ -61,7 +69,7 @@ def validate_inventory_mcp(profile: Optional[str], resource_types: List[str], te
         if test_mode and not real_validation:
             # Test mode: Use sample data to demonstrate validation
             print_info("Running test mode with sample inventory data")
-            
+
             # Create sample inventory data for testing
             sample_inventory = {
                 operational_profile: {
@@ -72,89 +80,83 @@ def validate_inventory_mcp(profile: Optional[str], resource_types: List[str], te
                         "lambda": 12,
                         "vpc": 4,
                         "iam": 25,
-                        "cloudformation": 6
+                        "cloudformation": 6,
                     },
-                    "regions": ["us-east-1", "us-west-2"]
+                    "regions": ["us-east-1", "us-west-2"],
                 }
             }
-            
+
             # Filter to requested resource types
             filtered_inventory = {
                 operational_profile: {
                     "resource_counts": {
-                        rt: sample_inventory[operational_profile]["resource_counts"].get(rt, 0)
-                        for rt in resource_types
+                        rt: sample_inventory[operational_profile]["resource_counts"].get(rt, 0) for rt in resource_types
                     },
-                    "regions": sample_inventory[operational_profile]["regions"]
+                    "regions": sample_inventory[operational_profile]["regions"],
                 }
             }
-            
-            print_info(f"Testing validation with sample resource counts: {filtered_inventory[operational_profile]['resource_counts']}")
-            
+
+            print_info(
+                f"Testing validation with sample resource counts: {filtered_inventory[operational_profile]['resource_counts']}"
+            )
+
             # Note: In test mode, this will compare sample data against real AWS APIs
             # This demonstrates the validation mechanism without requiring mock data
             validation_results = validator.validate_inventory_data(filtered_inventory)
-            
+
         elif real_validation:
             # Real validation mode: Requires actual inventory collection
             print_warning("Real validation mode requires actual inventory collection")
             print_info("This would typically be called from the main inventory collector")
-            
+
             # For demonstration, we'll validate empty inventory (should show 0 vs actual counts)
             empty_inventory = {
-                operational_profile: {
-                    "resource_counts": {rt: 0 for rt in resource_types},
-                    "regions": ["us-east-1"]
-                }
+                operational_profile: {"resource_counts": {rt: 0 for rt in resource_types}, "regions": ["us-east-1"]}
             }
-            
+
             print_info("Validating empty inventory against real AWS APIs (demonstrates detection capability)")
             validation_results = validator.validate_inventory_data(empty_inventory)
-            
+
         else:
             # Resource count validation only
             print_info("Running resource count validation test")
-            
-            sample_counts = {
-                "ec2": 10,
-                "s3": 5,
-                "vpc": 2
-            }
-            
+
+            sample_counts = {"ec2": 10, "s3": 5, "vpc": 2}
+
             # Filter to requested resource types
             test_counts = {rt: sample_counts.get(rt, 0) for rt in resource_types if rt in sample_counts}
-            
+
             validation_results = validator.validate_resource_counts(test_counts)
 
         # Display results summary
         console.print(f"\n[bright_cyan]📊 Validation Test Results Summary[/]")
-        
+
         if isinstance(validation_results, dict):
             if "total_accuracy" in validation_results:
                 accuracy = validation_results.get("total_accuracy", 0)
                 passed = validation_results.get("passed_validation", False)
-                
+
                 if passed:
                     print_success(f"✅ Test validation completed: {accuracy:.1f}% accuracy")
                 else:
                     print_warning(f"⚠️ Test validation: {accuracy:.1f}% accuracy (target: ≥99.5%)")
-                
+
                 profiles_validated = validation_results.get("profiles_validated", 0)
                 console.print(f"[dim]Profiles validated: {profiles_validated}[/dim]")
-                
+
                 # Show resource summary if available
                 resource_summary = validation_results.get("resource_validation_summary", {})
                 if resource_summary:
                     console.print(f"[dim]Resource types validated: {len(resource_summary)}[/dim]")
-                    
+
             elif "validated_count" in validation_results:
                 validated_count = validation_results.get("validated_count", 0)
                 passed_count = validation_results.get("passed_count", 0)
                 print_info(f"Resource count validation: {passed_count}/{validated_count} passed")
-                
+
             else:
                 print_info("Validation completed - see detailed output above")
-        
+
         # Integration guidance
         console.print(f"\n[bright_cyan]💡 Integration Information[/]")
         console.print(f"[dim]This MCP validator is automatically integrated into:[/dim]")
@@ -168,4 +170,4 @@ def validate_inventory_mcp(profile: Optional[str], resource_types: List[str], te
 
 
 if __name__ == "__main__":
-    validate_inventory_mcp()
+    validate_inventory_mcp()