template bot (#15)

dome9CloudBots/bots/TEMPLATE_BOT.py

@@ -0,0 +1,44 @@
+# This file use as template for writting new bots.
+# Program flow in general :
+# Azure CloudBots is trigger by webhook, the main function in init.py is triggered first, it call the handle_event that iterate the bots from compliance tags section
+# and run them one by one. Bot run start from it run_action function
+# run_action recive credentials as parameter, which are generated from the global variabled CLIENT_ID, SECRET and TENANT, entity and rule that are recived from Dome9 finding and params.
+# Params are optional and are available by need. Example: AUTO: some_bot param1 param2
+
+# Basic import for Bot execution. you should import the right Azure SDK library for your bot
+from msrestazure.azure_exceptions import CloudError
+import logging
+
+def run_action(credentials ,rule, entity, params):
+    logging.info(f'{__file__} - run_action started')
+    # Gets the relevant subscription from Dome9 finding
+    subscription_id = entity.get('accountNumber')
+
+    # Make sure you have the relevant subscription and credentials to perform action in Azure
+    if not subscription_id or not credentials:
+        msg = 'Error! Subscription id or credentials are missing.'
+        logging.info(f'{__file__} - {msg}')
+        return f'{msg}'
+
+    # Generate the suitable Azure client object for API calls
+    # Example : compute_client = ComputeManagementClient(credentials, subscription_id)
+    try:
+        # Execute Azure API call
+        # Example : compute_client.virtual_machines.power_off(group_name, vm_name)
+        # If there is no exception the API call succeeded and create message that summarize bot execution
+        # Example:
+        id = entity.get('id')
+        msg = f'Virtual machine was stopped. id: {id}'
+        logging.info(f'{__file__} - {msg}')
+        # Return the message, this is the Bot message in the remediation output
+        return f'{msg}'
+    except CloudError as e:
+        # If there is exception the API call failed so create message summarize the failure
+        msg = f'Unexpected error : {e.message}'
+        logging.info(f'{__file__} - {msg}')
+        # Return the message, this is the Bot message in the remediation output
+        return f'{msg}'
+
+
+# The bot return value is the Bot_message in the rule violation found in the remediation output
+# It is highly important to add as many relevant logs as possible