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

runbooks/inventory/check_landingzone_readiness.py

@@ -8,10 +8,9 @@ import Inventory_Modules
 from account_class import aws_acct_access
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
-from prettytable import PrettyTable
+from runbooks.common.rich_utils import console, print_success, print_error, print_info
+from runbooks.common.rich_utils import console, create_table
 
-init()
 __version__ = "2023.05.04"
 
 parser = CommonArguments()
@@ -109,7 +108,6 @@ else:
         "us-west-2",
     ]
 
-ERASE_LINE = "\x1b[2K"
 
 ExplainMessage = """
 
@@ -175,37 +173,37 @@ but that's sometime in the future.
 
 print("This script does 6 things... ")
 print(
-    f"{Fore.BLUE}  0.{Fore.RESET} Checks to ensure you have the necessary cross-account role access to the child account."
+    f"[blue]  0. Checks to ensure you have the necessary cross-account role access to the child account."
 )
-print(f"{Fore.BLUE}  1.{Fore.RESET} Checks to ensure the {Fore.RED}Default VPCs {Fore.RESET}in each region are deleted")
+print(f"[blue]  1. Checks to ensure the [red]Default VPCs in each region are deleted")
 if FixRun and not pVPCConfirm:
     print(
-        f"{Fore.BLUE}	You've asked to delete any default VPCs we find - with confirmation on each one.{Fore.RESET}"
+        f"[blue]	You've asked to delete any default VPCs we find - with confirmation on each one."
     )
 elif FixRun and pVPCConfirm:
     print()
     print(
-        f"{Fore.RED}	You've asked to delete any default VPCs we find - WITH NO CONFIRMATION on each one.{Fore.RESET}"
+        f"[red]	You've asked to delete any default VPCs we find - WITH NO CONFIRMATION on each one."
     )
     print()
 elif pVPCConfirm and not FixRun:
     print()
     print(
-        f"{Fore.BLUE}	You asked us to delete the default VPCs with no confirmation, but didn't provide the '+fixrun' parameter, so we're proceeding with NOT deleting. You can safely interupt this script and run it again with the necessary parameters.{Fore.RESET}"
+        f"[blue]	You asked us to delete the default VPCs with no confirmation, but didn't provide the '+fixrun' parameter, so we're proceeding with NOT deleting. You can safely interupt this script and run it again with the necessary parameters."
     )
     print()
-print(f"{Fore.BLUE}  2.{Fore.RESET} Checks the child account in each of the regions")
-print(f"     to see if there's already a {Fore.RED}Config Recorder and Delivery Channel {Fore.RESET}enabled...")
+print(f"[blue]  2. Checks the child account in each of the regions")
+print(f"     to see if there's already a [red]Config Recorder and Delivery Channel enabled...")
 print(
-    f"{Fore.BLUE}  3.{Fore.RESET} Checks that there isn't a duplicate {Fore.RED}CloudTrail{Fore.RESET} trail in the account."
+    f"[blue]  3. Checks that there isn't a duplicate [red]CloudTrail trail in the account."
 )
 print(
-    f"{Fore.BLUE}  4.{Fore.RESET} Checks to see if {Fore.RED}GuardDuty{Fore.RESET} has been enabled for this child account."
+    f"[blue]  4. Checks to see if [red]GuardDuty has been enabled for this child account."
 )
 print("     If it has been, it needs to be deleted before we can adopt this new account")
 print("     into the Org's Automated Landing Zone.")
 print(
-    f"{Fore.BLUE}  5.{Fore.RESET} This child account {Fore.RED}must exist{Fore.RESET} within the Parent Organization."
+    f"[blue]  5. This child account [red]must exist within the Parent Organization."
 )
 print("     If it doesn't - then you must move it into this Org")
 print("     (this script can't do that for you).")
@@ -277,10 +275,10 @@ for childaccount in ChildAccountList:
     finally:
         if not account_credentials.get("Success", False):
             logging.error(
-                f"Was {Fore.RED}not{Fore.RESET} able to successfully connect to account {childaccount} using credentials from account {aws_account.acct_number}... "
+                f"Was [red]not able to successfully connect to account {childaccount} using credentials from account {aws_account.acct_number}... "
             )
             print()
-            print(f"{Fore.RED}** Step 0 failed for account {childaccount}{Fore.RESET}")
+            print(f"[red]** Step 0 failed for account {childaccount}")
             print()
             ProcessStatus[childaccount]["Step0"]["Success"] = False
             ProcessStatus[childaccount]["Step0"]["IssuesFound"] += 1
@@ -290,7 +288,7 @@ for childaccount in ChildAccountList:
                 f"Was able to successfully connect to account {childaccount} using credentials from account {aws_account.acct_number}... "
             )
             print()
-            print(f"{Fore.GREEN}** Step 0 completed without issues{Fore.RESET}")
+            print(f"[green]** Step 0 completed without issues")
             print()
             ProcessStatus[childaccount]["Step0"]["Success"] = True
 
@@ -305,7 +303,7 @@ for childaccount in ChildAccountList:
         for region in RegionList:
             print(
                 ERASE_LINE,
-                f"Checking account {childaccount} in region {region} for {Fore.RED}default VPCs{Fore.RESET}",
+                f"Checking account {childaccount} in region {region} for [red]default VPCs",
                 end="\r",
             )
             logging.info("Looking for Default VPCs in account {} from Region {}}", childaccount, region)
@@ -364,18 +362,18 @@ for childaccount in ChildAccountList:
 
     print()
     if ProcessStatus[childaccount]["Step1"]["Success"]:
-        print(f"{ERASE_LINE + Fore.GREEN}** Step 1 completed with no issues{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.GREEN}** Step 1 completed with no issues")
     elif ProcessStatus[childaccount]["Step1"]["IssuesFound"] - ProcessStatus[childaccount]["Step1"]["IssuesFixed"] == 0:
         print(
-            f"{ERASE_LINE + Fore.GREEN}** Step 1 found {ProcessStatus[childaccount]['Step1']['IssuesFound']} issues, but they were fixed by deleting the default vpcs{Fore.RESET}"
+            f"{ERASE_LINE + Fore.GREEN}** Step 1 found {ProcessStatus[childaccount]['Step1']['IssuesFound']} issues, but they were fixed by deleting the default vpcs"
         )
         ProcessStatus[childaccount]["Step1"]["Success"] = True
     elif ProcessStatus[childaccount]["Step1"]["IssuesFound"] > ProcessStatus[childaccount]["Step1"]["IssuesFixed"]:
         print(
-            f"{ERASE_LINE + Fore.RED}** Step 1 completed, but there were {ProcessStatus[childaccount]['Step1']['IssuesFound'] - ProcessStatus[childaccount]['Step1']['IssuesFixed']} vpcs that couldn't be fixed{Fore.RESET}"
+            f"{ERASE_LINE + Fore.RED}** Step 1 completed, but there were {ProcessStatus[childaccount]['Step1']['IssuesFound'] - ProcessStatus[childaccount]['Step1']['IssuesFixed']} vpcs that couldn't be fixed"
         )
     else:
-        print(f"{ERASE_LINE + Fore.RED}** Step 1 completed with blockers found{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.RED}** Step 1 completed with blockers found")
 
     # Step 2
     # This part will check the Config Recorder and  Delivery Channel. If they have one, we need to delete it, so we can create another. We'll ask whether this is ok before we delete.
@@ -422,7 +420,7 @@ for childaccount in ChildAccountList:
 
     for i in range(len(ConfigList)):
         logging.error(
-            f"{Fore.RED}Found a config recorder for account %s in region %s",
+            f"[red]Found a config recorder for account %s in region %s",
             ConfigList[i]["AccountID"],
             ConfigList[i]["Region"] + Fore.RESET,
         )
@@ -442,7 +440,7 @@ for childaccount in ChildAccountList:
             ProcessStatus[childaccount]["Step2"]["IssuesFixed"] += 1
     for i in range(len(DeliveryChanList)):
         logging.error(
-            f"{Fore.RED}I found a delivery channel for account %s in region %s",
+            f"[red]I found a delivery channel for account %s in region %s",
             DeliveryChanList[i]["AccountID"],
             DeliveryChanList[i]["Region"] + Fore.RESET,
         )
@@ -466,18 +464,18 @@ for childaccount in ChildAccountList:
         ProcessStatus[childaccount]["Step2"]["Success"] = True
 
     if ProcessStatus[childaccount]["Step2"]["Success"]:
-        print(f"{ERASE_LINE + Fore.GREEN}** Step 2 completed with no issues{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.GREEN}** Step 2 completed with no issues")
     elif ProcessStatus[childaccount]["Step2"]["IssuesFound"] - ProcessStatus[childaccount]["Step2"]["IssuesFixed"] == 0:
         print(
-            f"{ERASE_LINE + Fore.GREEN}** Step 2 found {ProcessStatus[childaccount]['Step2']['IssuesFound']} issues, but they were fixed by deleting the existing Config Recorders and Delivery Channels{Fore.RESET}"
+            f"{ERASE_LINE + Fore.GREEN}** Step 2 found {ProcessStatus[childaccount]['Step2']['IssuesFound']} issues, but they were fixed by deleting the existing Config Recorders and Delivery Channels"
         )
         ProcessStatus[childaccount]["Step2"]["Success"] = True
     elif ProcessStatus[childaccount]["Step2"]["IssuesFound"] > ProcessStatus[childaccount]["Step2"]["IssuesFixed"]:
         print(
-            f"{ERASE_LINE + Fore.RED}** Step 2 completed, but there were {ProcessStatus[childaccount]['Step2']['IssuesFound'] - ProcessStatus[childaccount]['Step2']['IssuesFixed']} items found that couldn't be deleted{Fore.RESET}"
+            f"{ERASE_LINE + Fore.RED}** Step 2 completed, but there were {ProcessStatus[childaccount]['Step2']['IssuesFound'] - ProcessStatus[childaccount]['Step2']['IssuesFixed']} items found that couldn't be deleted"
         )
     else:
-        print(f"{ERASE_LINE + Fore.RED}** Step 2 completed with blockers found{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.RED}** Step 2 completed with blockers found")
     print()
 
     # Step 3
@@ -505,7 +503,7 @@ for childaccount in ChildAccountList:
 
     for i in range(len(CTtrails2)):
         logging.error(
-            f"{Fore.RED}Found a CloudTrail trail for account {childaccount} in region {CTtrails2[i]['HomeRegion']} named {CTtrails2[i]['Name']}{Fore.RESET}"
+            f"[red]Found a CloudTrail trail for account {childaccount} in region {CTtrails2[i]['HomeRegion']} named {CTtrails2[i]['Name']}"
         )
         ProcessStatus[childaccount]["Step3"]["IssuesFound"] += 1
         if FixRun:
@@ -523,18 +521,18 @@ for childaccount in ChildAccountList:
         ProcessStatus[childaccount]["Step3"]["Success"] = True
 
     if ProcessStatus[childaccount]["Step3"]["Success"]:
-        print(f"{ERASE_LINE + Fore.GREEN}** Step 3 completed with no issues{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.GREEN}** Step 3 completed with no issues")
     elif ProcessStatus[childaccount]["Step3"]["IssuesFound"] - ProcessStatus[childaccount]["Step3"]["IssuesFixed"] == 0:
         print(
-            f"{ERASE_LINE + Fore.GREEN}** Step 3 found {ProcessStatus[childaccount]['Step3']['IssuesFound']} issues, but they were fixed by deleting the existing CloudTrail trail names{Fore.RESET}"
+            f"{ERASE_LINE + Fore.GREEN}** Step 3 found {ProcessStatus[childaccount]['Step3']['IssuesFound']} issues, but they were fixed by deleting the existing CloudTrail trail names"
         )
         ProcessStatus[childaccount]["Step3"]["Success"] = True
     elif ProcessStatus[childaccount]["Step3"]["IssuesFound"] > ProcessStatus[childaccount]["Step3"]["IssuesFixed"]:
         print(
-            f"{ERASE_LINE + Fore.RED}** Step 3 completed, but there were {ProcessStatus[childaccount]['Step3']['IssuesFound'] - ProcessStatus[childaccount]['Step3']['IssuesFixed']} trail names found that couldn't be deleted{Fore.RESET}"
+            f"{ERASE_LINE + Fore.RED}** Step 3 completed, but there were {ProcessStatus[childaccount]['Step3']['IssuesFound'] - ProcessStatus[childaccount]['Step3']['IssuesFixed']} trail names found that couldn't be deleted"
         )
     else:
-        print(f"{ERASE_LINE + Fore.RED}** Step 3 completed with blockers found{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.RED}** Step 3 completed with blockers found")
     print()
 
     # Step 4
@@ -545,7 +543,7 @@ for childaccount in ChildAccountList:
         print(f"Checking account {childaccount} for any GuardDuty invites")
         for region in RegionList:
             print(
-                f"{ERASE_LINE}Checking account {childaccount} in region {region} for {Fore.RED}GuardDuty{Fore.RESET}invitations",
+                f"{ERASE_LINE}Checking account {childaccount} in region {region} for [red]GuardDutyinvitations",
                 end="\r",
             )
             GDinvites = Inventory_Modules.find_gd_invites2(account_credentials, region)
@@ -570,7 +568,7 @@ for childaccount in ChildAccountList:
 
     for i in range(len(GDinvites2)):
         logging.error(
-            f"{Fore.RED}I found a GuardDuty invitation for account %s in region %s from account %s ",
+            f"[red]I found a GuardDuty invitation for account %s in region %s from account %s ",
             childaccount,
             GDinvites2[i]["Region"],
             GDinvites2[i]["AccountId"] + Fore.RESET,
@@ -593,18 +591,18 @@ for childaccount in ChildAccountList:
         ProcessStatus[childaccount]["Step4"]["Success"] = True
 
     if ProcessStatus[childaccount]["Step4"]["Success"]:
-        print(f"{ERASE_LINE + Fore.GREEN}** Step 4 completed with no issues{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.GREEN}** Step 4 completed with no issues")
     elif ProcessStatus[childaccount]["Step4"]["IssuesFound"] - ProcessStatus[childaccount]["Step4"]["IssuesFixed"] == 0:
         print(
-            f"{ERASE_LINE + Fore.GREEN}** Step 4 found {ProcessStatus[childaccount]['Step4']['IssuesFound']} guardduty invites, but they were deleted{Fore.RESET}"
+            f"{ERASE_LINE + Fore.GREEN}** Step 4 found {ProcessStatus[childaccount]['Step4']['IssuesFound']} guardduty invites, but they were deleted"
         )
         ProcessStatus[childaccount]["Step4"]["Success"] = True
     elif ProcessStatus[childaccount]["Step4"]["IssuesFound"] > ProcessStatus[childaccount]["Step4"]["IssuesFixed"]:
         print(
-            f"{ERASE_LINE + Fore.RED}** Step 4 completed, but there were {ProcessStatus[childaccount]['Step4']['IssuesFound'] - ProcessStatus[childaccount]['Step4']['IssuesFixed']} guardduty invites found that couldn't be deleted{Fore.RESET}"
+            f"{ERASE_LINE + Fore.RED}** Step 4 completed, but there were {ProcessStatus[childaccount]['Step4']['IssuesFound'] - ProcessStatus[childaccount]['Step4']['IssuesFixed']} guardduty invites found that couldn't be deleted"
         )
     else:
-        print(f"{ERASE_LINE + Fore.RED}** Step 4 completed with blockers found{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.RED}** Step 4 completed with blockers found")
     print()
 
     """
@@ -631,21 +629,21 @@ for childaccount in ChildAccountList:
         ProcessStatus[childaccount]["Step5"]["IssuesFound"] += 1
 
     if ProcessStatus[childaccount]["Step5"]["Success"]:
-        print(f"{ERASE_LINE + Fore.GREEN}** Step 5 completed with no issues{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.GREEN}** Step 5 completed with no issues")
     elif ProcessStatus[childaccount]["Step5"]["IssuesFound"] - ProcessStatus[childaccount]["Step5"]["IssuesFixed"] == 0:
         print(
-            f"{ERASE_LINE + Fore.GREEN}** Step 5 found {ProcessStatus[childaccount]['Step5']['IssuesFound']} issues, but we were able to move the account into the they were able to be fixed{Fore.RESET}"
+            f"{ERASE_LINE + Fore.GREEN}** Step 5 found {ProcessStatus[childaccount]['Step5']['IssuesFound']} issues, but we were able to move the account into the they were able to be fixed"
         )
         ProcessStatus[childaccount]["Step5"]["Success"] = True
     elif ProcessStatus[childaccount]["Step5"]["IssuesFound"] > ProcessStatus[childaccount]["Step5"]["IssuesFixed"]:
         print(
-            f"{ERASE_LINE + Fore.RED}** Step 5 completed, but there were {ProcessStatus[childaccount]['Step5']['IssuesFound'] - ProcessStatus[childaccount]['Step5']['IssuesFixed']} blockers found that couldn't be fixed{Fore.RESET}"
+            f"{ERASE_LINE + Fore.RED}** Step 5 completed, but there were {ProcessStatus[childaccount]['Step5']['IssuesFound'] - ProcessStatus[childaccount]['Step5']['IssuesFixed']} blockers found that couldn't be fixed"
         )
     else:
-        print(f"{ERASE_LINE + Fore.RED}** Step 5 completed with blockers found{Fore.RESET}")
+        print(f"{ERASE_LINE + Fore.RED}** Step 5 completed with blockers found")
     print()
 
-    print(f"{Fore.CYAN}Account {childaccount} is complete. {accountsleft} more to go!!{Fore.RESET}")
+    print(f"[cyan]Account {childaccount} is complete. {accountsleft} more to go!!")
 
     """
 	# Step 6
@@ -653,59 +651,62 @@ for childaccount in ChildAccountList:
 	So we'll need to verify that the parent OU of the account is the root of the organization.
 	"""
 
-x = PrettyTable()
-y = PrettyTable()
-
-x.field_names = ["Account", "Issues Found", "Issues Fixed", "Ready?"]
-# The following headers represent Step0 through Step5,
-y.field_names = [
-    "Account",
-    "Account Access",
-    "Default VPCs",
-    "Recorders",
-    "CloudTrail",
-    "GuardDuty",
-    "Org Member",
-    "Ready?",
-]
+x = create_table(
+    title="Account Readiness Summary",
+    columns=[
+        {"header": "Account", "justify": "left"},
+        {"header": "Issues Found", "justify": "center"},
+        {"header": "Issues Fixed", "justify": "center"},
+        {"header": "Ready?", "justify": "center"},
+    ]
+)
+y = create_table(
+    title="Account Issue Details",
+    columns=[
+        {"header": "Account", "justify": "left"},
+        {"header": "Account Access", "justify": "center"},
+        {"header": "Default VPCs", "justify": "center"},
+        {"header": "Recorders", "justify": "center"},
+        {"header": "CloudTrail", "justify": "center"},
+        {"header": "GuardDuty", "justify": "center"},
+        {"header": "Org Member", "justify": "center"},
+        {"header": "Ready?", "justify": "center"},
+    ]
+)
 for item in ProcessStatus:
     for _ in range(Steps):
         Step = f"Step{str(_)}"
         ProcessStatus[item]["IssuesFound"] += ProcessStatus[item][Step]["IssuesFound"]
         ProcessStatus[item]["IssuesFound"] += ProcessStatus[item][Step]["IssuesFixed"]
     x.add_row(
-        [
-            item,
-            ProcessStatus[item]["IssuesFound"],
-            ProcessStatus[item]["IssuesFixed"],
-            ProcessStatus[item]["ChildIsReady"],
-        ]
+        item,
+        str(ProcessStatus[item]["IssuesFound"]),
+        str(ProcessStatus[item]["IssuesFixed"]),
+        str(ProcessStatus[item]["ChildIsReady"]),
     )
     y.add_row(
-        [
-            item,
-            ProcessStatus[item]["Step0"]["IssuesFound"] - ProcessStatus[item]["Step0"]["IssuesFixed"],
-            ProcessStatus[item]["Step1"]["IssuesFound"] - ProcessStatus[item]["Step1"]["IssuesFixed"],
-            ProcessStatus[item]["Step2"]["IssuesFound"] - ProcessStatus[item]["Step2"]["IssuesFixed"],
-            ProcessStatus[item]["Step3"]["IssuesFound"] - ProcessStatus[item]["Step3"]["IssuesFixed"],
-            ProcessStatus[item]["Step4"]["IssuesFound"] - ProcessStatus[item]["Step4"]["IssuesFixed"],
-            ProcessStatus[item]["Step5"]["IssuesFound"] - ProcessStatus[item]["Step5"]["IssuesFixed"],
-            ProcessStatus[item]["Step0"]["Success"]
+        item,
+        str(ProcessStatus[item]["Step0"]["IssuesFound"] - ProcessStatus[item]["Step0"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step1"]["IssuesFound"] - ProcessStatus[item]["Step1"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step2"]["IssuesFound"] - ProcessStatus[item]["Step2"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step3"]["IssuesFound"] - ProcessStatus[item]["Step3"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step4"]["IssuesFound"] - ProcessStatus[item]["Step4"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step5"]["IssuesFound"] - ProcessStatus[item]["Step5"]["IssuesFixed"]),
+        str(ProcessStatus[item]["Step0"]["Success"]
             and ProcessStatus[item]["Step1"]["Success"]
             and ProcessStatus[item]["Step2"]["Success"]
             and ProcessStatus[item]["Step3"]["Success"]
             and ProcessStatus[item]["Step4"]["Success"]
-            and ProcessStatus[item]["Step5"]["Success"],
-        ]
+            and ProcessStatus[item]["Step5"]["Success"]),
     )
-print(
-    "The following table represents the accounts looked at, and whether they are ready to be incorporated into an ALZ environment."
+console.print(
+    "\n[bold cyan]The following table represents the accounts looked at, and whether they are ready to be incorporated into an ALZ environment.[/bold cyan]"
 )
-print(x)
-print()
-print(
-    "The following table represents the accounts looked at, and gives details under each type of issue as to what might prevent a successful migration of this account into an ALZ environment."
+console.print(x)
+console.print()
+console.print(
+    "[bold cyan]The following table represents the accounts looked at, and gives details under each type of issue as to what might prevent a successful migration of this account into an ALZ environment.[/bold cyan]"
 )
-print(y)
+console.print(y)
 
-print("Thanks for using this script...")
+console.print("\n[green]Thanks for using this script...[/green]")