Merge branch 'feature/logging' into develop

core/helper.py

@@ -1,7 +1,7 @@
 """
 This module contains helper different functions.
 """
-
+import logging
 import os
 import sys
 import time
@@ -12,6 +12,7 @@
 
 from core.network import get_json_response
 
+logger = logging.getLogger('CraftyDiscordBot')
 
 def check_env_vars():
     """
@@ -38,16 +39,16 @@ def check_env_vars():
         required_env_vars.append('or CRAFTY_TOKEN')
 
     if required_env_vars:
-        print('Not all environment variables set')
+        logger.info('Not all environment variables set')
         for env_var in required_env_vars:
-            print(f'{env_var} not set')
+            logger.info(f'{env_var} not set')
         sys.exit()
 
-    print('All environment variables set')
+    logger.info('All environment variables set')
 
     for var in ['SERVER_URL', 'CRAFTY_TOKEN', 'DISCORD_TOKEN']:
         if not os.environ.get(var):
-            print(f'{var} not set')
+            logger.info(f'{var} not set')
             sys.exit()
 
 
@@ -64,14 +65,14 @@ async def check_server_id(server_id: str, ctx=None) -> bool:
     """
 
     try:
-        print('Checking server ID')
+        logger.debug('Checking server ID')
         uuid.UUID(server_id, version=4)
     except ValueError:
-        print('Invalid server ID')
+        logger.debug('Invalid server ID')
         if ctx:
             await ctx.reply('Invalid server ID')
         return False
-    print('Valid server ID')
+    logger.debug('Valid server ID')
     return True
 
 

core/main.py

@@ -21,7 +21,7 @@
 
 ch = logging.StreamHandler()
 ch.setLevel(logging.DEBUG)
-formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+formatter = logging.Formatter('%(asctime)s - [CraftyBot] - [%(levelname)s] -> %(message)s')
 ch.setFormatter(formatter)
 logger.addHandler(ch)
 
@@ -74,7 +74,7 @@ async def auto_stop():
 @bot.event
 async def on_ready():
     logger.info('Bot is ready. {}'.format(bot.user))
-    logger.debug("Crafty Bot version {}".format(CRAFTY_BOT_VERSION))
+    logger.info("Crafty Bot version {}".format(CRAFTY_BOT_VERSION))
     logger.debug("Server URL: {}".format(SERVER_URL))
     logger.debug("GUILD ID: {}".format(GUILD_ID))
 

core/network.py

@@ -1,11 +1,15 @@
 import json
+import logging
 import os
 import requests
 from requests import Response
 from enum import Enum
 
 from core.constants import STATUS_SUCCESS
 
+logger = logging.getLogger('CraftyDiscordBot')
+
+
 class HttpMethod(Enum):
     GET = 'GET'
     POST = 'POST'
@@ -45,7 +49,7 @@ def send_request(path: str, verify: bool = False, timeout: int = 6, data: dict =
         response = requests.request(method.value, url, headers=headers, verify=verify, timeout=timeout, json=data)
         return response
     except requests.RequestException as e:
-        print(f"Request failed: {e}")
+        logger.debug(f"Request failed: {e}")
         return Response()
 
 def get_json_response(path: str, error_message: str = "Error while response", method: HttpMethod = HttpMethod.GET, data: dict = None) -> json:
@@ -63,6 +67,6 @@ def get_json_response(path: str, error_message: str = "Error while response", me
     """
     response = send_request(path, method=method, data=data)
     if not is_response_successful(response):
-        print(error_message)
+        logger.debug(error_message)
         return {}
     return response.json()

core/printing.py

@@ -1,6 +1,10 @@
 """
 This module contains functions to print the server information as text.
 """
+import logging
+
+logger = logging.getLogger('CraftyDiscordBot')
+
 
 
 def print_server_info(data) -> str:

core/server.py

@@ -1,8 +1,10 @@
 """This module contains the Server class."""
+import logging
 
 from core.constants import API_ENDPOINT
 from core.network import get_json_response, HttpMethod
 
+logger = logging.getLogger('CraftyDiscordBot')
 
 def stop_server(server_id) -> bool:
     """
@@ -11,10 +13,10 @@ def stop_server(server_id) -> bool:
     data = get_json_response(API_ENDPOINT + str(server_id) + '/action/stop_server',
                              'failed to stop server', method=HttpMethod.POST)
     if data['status'] == "ok":
-        print('Server stopped', str(server_id))
+        logger.debug('Server stopped', str(server_id))
         return True
 
-    print('failed to stop server')
+    logger.debug('failed to stop server')
     return False