From a0102d455cdef6e6e21d723e4b1fdf7c786e4a06 Mon Sep 17 00:00:00 2001
From: midays <92722851+midays@users.noreply.github.com>
Date: Thu, 23 May 2024 08:19:53 -0400
Subject: [PATCH] Add logger (#142)

* add logger to VSCode class

* pre-commit

* fix logger import error

* remove assertion to check if the analysis has started
---
 src/models/IDE/VisualStudioCode.py | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/src/models/IDE/VisualStudioCode.py b/src/models/IDE/VisualStudioCode.py
index 84625c4..7a8145b 100644
--- a/src/models/IDE/VisualStudioCode.py
+++ b/src/models/IDE/VisualStudioCode.py
@@ -1,3 +1,4 @@
+import logging
 import subprocess
 import time
 
@@ -9,6 +10,10 @@
 from src.utils.general import get_clipboard_text
 from src.utils.general import parse_kantra_cli_command
 
+logging.basicConfig(level=logging.DEBUG)
+
+logger = logging.getLogger(__name__)
+
 
 class VisualStudioCode(Application):
     """
@@ -27,8 +32,10 @@ def cmd_palette_exec_command(self, command: VSCodeCommandEnum):
         """
         Execute commands in the command palette in vscode
         """
+        logger.info("Open command palette")
         self.press_keys("ctrl", "shift", "p")
         time.sleep(1)
+        logger.info(f"Execute command: {command.value}")
         self.type_text(command.value)
         time.sleep(1)
         self.press_keys("enter")
@@ -52,6 +59,7 @@ def close_ide(self):
         """
         Closes the IDE
         """
+        logger.info("Close IDE")
         self.set_focus()
         self.press_keys("ctrl", "q")
 
@@ -76,9 +84,12 @@ def run_simple_analysis(self, configuration_name: str):
         Runs analysis after creating an analysis configuration
         """
         # Wait for new configuration' to become visible
+        logger.info("Refresh configuration")
         self.refresh_configuration()
         self.cmd_palette_exec_command(VSCodeCommandEnum.RUN_ANALYSIS)
+        logger.info(f"Type text: [{configuration_name}]")
         self.type_text(configuration_name)
+        logger.info("CLick enter")
         self.press_keys("enter")
 
         # todo: There's is really no need to verify if the analysis started or not, because it will eventually go to one of 3 states, analysis failed, analysis completed, or timout error
@@ -104,11 +115,14 @@ def is_analysis_complete(self, timeout=300):
         while True:
             output_log_lines = self.copy_terminal_output()
             if output_log_lines[-1:][0] == "Analysis completed successfully":
+                logger.info("Analysis completed successfully")
                 self.update_analysis_summery()
                 return True, ""
             elif output_log_lines[-1:][0] == "Analysis failed":
+                logger.info("Analysis failed")
                 return False, "Analysis Failed"
             elif time.time() - start_time > timeout:
+                logger.info("Timeout analysis not complete")
                 return False, "Timeout analysis not complete"
             time.sleep(15)
 
@@ -135,11 +149,15 @@ def copy_terminal_output(self):
         Copy the content of the output panel to the clipboard
         split into lines, and return the list
         """
+        logger.info("Focus output MTA console")
         self.focus_terminal_output_panel()
+        logger.info("Copy Console output")
         self.press_keys("ctrl", "a")
         self.press_keys("ctrl", "c")
         self.press_keys("esc")
-        return get_clipboard_text(True)
+        clipboard_text = get_clipboard_text(True)
+        logger.info(clipboard_text)
+        return clipboard_text
 
     def clear_terminal_output_panel(self):
         """